7x31
/
databasir
mirror of https://github.com/vran-dev/databasir.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat: update readme

This commit is contained in:
vran 2021-12-30 10:13:13 +08:00
parent 29b9e8e50f
commit 5c518ba088
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -10,20 +10,20 @@ you could use `databasir` to generate database meta model, or render it as markd
```java ```java
java.sql.Connection connection=...; java.sql.Connection connection=...;
DatabaseMeta meta=Databasir.of().get(connection,"user").orElseThrow(); DatabaseMeta meta=Databasir.of().get(connection,"user").orElseThrow();
``` ```
## Render as Markdown ## Render as Markdown
```java ```java
try(FileOutputStream out=new FileOutputStream("user.md")){ try(FileOutputStream out=new FileOutputStream("user.md")){
java.sql.Connection connection=...; java.sql.Connection connection=...;
Databasir databasir=Databasir.of(); Databasir databasir=Databasir.of();
DatabaseMeta meta=databasir.get(connection,"user").orElseThrow(); DatabaseMeta meta=databasir.get(connection,"user").orElseThrow();
databasir.renderAsMarkdown(doc,out); databasir.renderAsMarkdown(doc,out);
}catch(IOException e){ }catch(IOException e){
throw new IllegalStateException(e); throw new IllegalStateException(e);
} }
``` ```
- Markdown Example - Markdown Example
@ -37,10 +37,10 @@ support regex pattern to ignore table or column
```java ```java
java.sql.Connection connection=...; java.sql.Connection connection=...;
DatabasirConfig config=new DatabasirConfig(); DatabasirConfig config=new DatabasirConfig();
config.ignoreColumn("id*"); config.ignoreColumn("id*");
config.ignoreTable("flyway.*"); config.ignoreTable("flyway.*");
DatabaseMeta meta=Databasir.of(config).get(connection,"user").orElseThrow(); DatabaseMeta meta=Databasir.of(config).get(connection,"user").orElseThrow();
``` ```
## Extension ## Extension
@ -49,13 +49,13 @@ Custom configuration
```java ```java
java.sql.Connection connection=...; java.sql.Connection connection=...;
DatabasirConfig config=new DatabasirConfig(); DatabasirConfig config=new DatabasirConfig();
config.setDatabaseMetaRepository(...); // your custom repository config.setDatabaseMetaRepository(...); // your custom repository
config.setTableMetaRepository(...); // your custom repository config.setTableMetaRepository(...); // your custom repository
config.setColumnMetaRepository(...); // your custom repository config.setColumnMetaRepository(...); // your custom repository
config.setTriggerMetaRepository(...); // your custom repository config.setTriggerMetaRepository(...); // your custom repository
config.setIndexMetaRepository(...); // your custom repository config.setIndexMetaRepository(...); // your custom repository
DatabaseMeta meta=Databasir.of().get(connection,"user").orElseThrow(); DatabaseMeta meta=Databasir.of().get(connection,"user").orElseThrow();
``` ```
Default Repository Is Default Repository Is