Skip to content

Commit caf4392

Browse files
committed
update readme
1 parent e0d5e31 commit caf4392

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,15 @@ jar to be run as a standalone tool. It internally uses JSqlParser to parse the D
55

66
### Getting Started
77

8+
## Prerequisites
9+
10+
1. The SQL file should contain only SQL statements
11+
2. All SQL statements should terminate with a semicolon(;)
12+
3. Supported DDL statements are:
13+
* CREATE TABLE
14+
* ALTER TABLE ADD CONSTRAINT PRIMARY KEY
15+
* ALTER TABLE ADD CONSTRAINT FOREIGN KEY
16+
817
## Maven
918

1019
**sqlscript2jpa-codegen** is available
@@ -31,7 +40,9 @@ To use it, simply declare the following plugin in your pom file:
3140
</executions>
3241
</plugin>
3342
```
34-
Also, you would need to add lombok to your dependencies
43+
44+
Also, you would need to add lombok to your dependencies:
45+
3546
```xml
3647
<dependency>
3748
<groupId>org.projectlombok</groupId>
@@ -50,11 +61,12 @@ By default, the source code will be generated under `target/generated-sources/sq
5061
## Standalone
5162

5263
Get the jar
53-
from https://repo1.maven.org/maven2/io/github/ngbsn/sqlscript2jpa-codegen-maven-plugin/1.0.4/sqlscript2jpa-codegen-maven-plugin-1.0.4-standalone.jar
64+
from https://repo1.maven.org/maven2/io/github/ngbsn/sqlscript2jpa-codegen-maven-plugin/1.0.5/sqlscript2jpa-codegen-maven-plugin-1.0.5-standalone.jar
5465

5566
```
5667
java -jar sqlscript2jpa-codegen-maven-plugin-1.0.4-standalone.jar "<sql_file_path>" "<package_name>"
5768
```
5869

5970
This will generate the JPA entities in a folder structure as defined by the package name
6071
under `./target/generated-sources/sqlscript2jpa`
72+

0 commit comments

Comments
 (0)