Skip to content

fix: README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Sassine merged 1 commit into from
Apr 10, 2022
Merged

fix: README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 67 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,67 @@
# sqlschema2java
# SQLSchema2Java [![Publish package to GitHub Packages](https://github.com/Sassine/sqlschema2java/actions/workflows/deploy.yml/badge.svg)](https://github.com/Sassine/sqlschema2java/actions/workflows/deploy.yml) [![CodeQL main](https://github.com/Sassine/sqlschema2java/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/Sassine/sqlschema2java/actions/workflows/codeql-analysis.yml)

![Logo SQL2JAVA and website adress sassine.dev/sqlschema2java](https://sassine.dev/assets/images/SQLSchema2Java_Logo2.png)


_sqlschema2java_ generates Java types from SQLSchema and annotate those types for data-binding with Jackson 2.x, Javax Persistence and Spring Repository.

You can use sqlschema2java as a Maven plugin.
[**Try at the sample project exemple**](https://github.com/Sassine/sqlschema2java/tree/main/sqlschema2java-example)

## Implementation

#### A very simple Maven example:
```xml
pom.xml
<plugins>
<plugin>
<groupId>dev.sassine.api</groupId>
<artifactId>sqlschema2java-maven-plugin</artifactId>
<version>1.0.0</version>
<executions>
<execution>
<goals>
<goal>sqlschema2java</goal>
</goals>
</execution>
</executions>
<configuration>
<sourceDirectory>/user/home/example.sql</sourceDirectory>
<packageName>dev.sassine.api</packageName>
<useAutoIncrement>true</useAutoIncrement>
<isPostgres>false</isPostgres>
</configuration>
</plugin>
</plugins>

<repositories>
<repository>
<id>github</id>
<name>GitHub Packages SQLSchema2Java</name>
<url>https://maven.pkg.github.com/Sassine/sqlschema2java</url>
</repository>
</repositories>
```
### Parameters
| Name | required | type | description |
|--|--|--|--|
| sourceDirectory | true | String | SQL file path |
| packageName | true | String | package name with points that will be generated |
| useAutoIncrement| false | Boolean| disable or enable whether the primary key will have its value generated automatically |
| isPostgres| true | Boolean | disable or enable query conversion compatible with postgres database |


##### Run command
```bash
mvn dev.sassine.api:sqlschema2java-maven-plugin:generate
```
Successful ✨

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

[MIT ](https://github.com/Sassine/sqlschema2java/blob/main/LICENSE)