feat: init core module
This commit is contained in:
parent
f92a89a473
commit
d20a400931
80
README.md
80
README.md
|
@ -1 +1,79 @@
|
||||||
# Databasir
|
# Databasir
|
||||||
|
|
||||||
|
Database document generator
|
||||||
|
|
||||||
|
you could use `databasir` to generate database meta model, or render it as markdown / pdf (TODO) / html (TODO)
|
||||||
|
|
||||||
|
# How to use
|
||||||
|
|
||||||
|
## Database Meta to Java Model
|
||||||
|
|
||||||
|
```java
|
||||||
|
java.sql.Connection connection = ...;
|
||||||
|
DatabaseDocConfig config = DatabaseDocConfig.builder()
|
||||||
|
.databaseName("Demo")
|
||||||
|
.connection(connection)
|
||||||
|
.build();
|
||||||
|
DatabaseDoc doc = JdbcDatabaseDocFactory.of().create(config).orElseThrow();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Render as Markdown
|
||||||
|
```java
|
||||||
|
java.sql.Connection connection = ...;
|
||||||
|
DatabaseDocConfig config = DatabaseDocConfig.builder()
|
||||||
|
.databaseName("Demo")
|
||||||
|
.connection(connection)
|
||||||
|
.build();
|
||||||
|
DatabaseDoc doc = JdbcDatabaseDocFactory.of().create(config).orElseThrow();
|
||||||
|
try (FileOutputStream out = new FileOutputStream("doc.md")) {
|
||||||
|
RenderConfig renderConfig = new RenderConfig();
|
||||||
|
Render.markdownRender(renderConfig).rendering(doc, out);
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Example
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
## Ignore tables or columns
|
||||||
|
|
||||||
|
support regex pattern to ignore table or column
|
||||||
|
|
||||||
|
```java
|
||||||
|
java.sql.Connection connection = ...;
|
||||||
|
DatabaseDocConfig config = DatabaseDocConfig.builder()
|
||||||
|
.databaseName("Demo")
|
||||||
|
.connection(connection)
|
||||||
|
.ignoreTableRegexes(Arrays.asList("mysql_*"))
|
||||||
|
.ignoreColumnRegexes(Arrays.asList("id"))
|
||||||
|
.build();
|
||||||
|
DatabaseDoc doc = JdbcDatabaseDocFactory.of().create(config).orElseThrow();
|
||||||
|
```
|
||||||
|
|
||||||
|
## Extension
|
||||||
|
|
||||||
|
Default factory
|
||||||
|
|
||||||
|
- tableDocFactory -> `com.databasir.core.doc.factory.jdbc.JdbcTableDocFactory`
|
||||||
|
- columnDocFactory -> `com.databasir.core.doc.factory.jdbc.JdbcTableColumnDocFactory`
|
||||||
|
- indexDocFactory -> `com.databasir.core.doc.factory.jdbc.JdbcTableIndexDocFactory`
|
||||||
|
- triggerDocFactory -> `com.databasir.core.doc.factory.jdbc.JdbcTableTriggerDocFactory`
|
||||||
|
|
||||||
|
Custom configuration
|
||||||
|
```java
|
||||||
|
java.sql.Connection connection = ...;
|
||||||
|
DatabaseDocConfig config = DatabaseDocConfig.builder()
|
||||||
|
.databaseName("Demo")
|
||||||
|
.connection(connection)
|
||||||
|
.tableDocFactory(...) // your custom table doc factory
|
||||||
|
.tableColumnDocFactory(...) // your custom column doc factory
|
||||||
|
.tableIndexDocFactory(...) // your custom index doc factory
|
||||||
|
.tableTriggerDocFactory(...) // your custom trigger doc factory
|
||||||
|
.build();
|
||||||
|
DatabaseDoc doc = JdbcDatabaseDocFactory.of().create(config).orElseThrow();
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
Binary file not shown.
After Width: | Height: | Size: 53 KiB |
|
@ -0,0 +1,42 @@
|
||||||
|
plugins {
|
||||||
|
id 'java'
|
||||||
|
}
|
||||||
|
|
||||||
|
subprojects {
|
||||||
|
|
||||||
|
apply plugin: 'java'
|
||||||
|
|
||||||
|
group 'cc.cc1234'
|
||||||
|
version '1.0-SNAPSHOT'
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
ext {
|
||||||
|
lombokVersion = '1.18.22'
|
||||||
|
mapstructVersion = '1.4.2.Final'
|
||||||
|
junitVersion = '5.7.0'
|
||||||
|
slf4jVersion = '1.7.32'
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
testImplementation "org.junit.jupiter:junit-jupiter-api:${junitVersion}"
|
||||||
|
testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:${junitVersion}"
|
||||||
|
|
||||||
|
implementation "org.projectlombok:lombok:${lombokVersion}"
|
||||||
|
annotationProcessor "org.projectlombok:lombok:${lombokVersion}"
|
||||||
|
|
||||||
|
implementation "org.mapstruct:mapstruct:${mapstructVersion}"
|
||||||
|
annotationProcessor "org.mapstruct:mapstruct:${mapstructVersion}"
|
||||||
|
|
||||||
|
implementation "org.slf4j:slf4j-api:${slf4jVersion}"
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
test {
|
||||||
|
useJUnitPlatform()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
dependencies {
|
||||||
|
implementation 'mysql:mysql-connector-java:8.0.27'
|
||||||
|
implementation 'commons-io:commons-io:2.11.0'
|
||||||
|
implementation 'org.commonmark:commonmark:0.18.1'
|
||||||
|
}
|
|
@ -0,0 +1,49 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.jdbc.*;
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Getter;
|
||||||
|
import lombok.NonNull;
|
||||||
|
|
||||||
|
import java.sql.Connection;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.regex.Pattern;
|
||||||
|
|
||||||
|
@Builder
|
||||||
|
@Getter
|
||||||
|
public class DatabaseDocConfig {
|
||||||
|
|
||||||
|
@NonNull
|
||||||
|
private String databaseName;
|
||||||
|
|
||||||
|
@NonNull
|
||||||
|
private Connection connection;
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<String> ignoreTableRegexes = Collections.emptyList();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<String> ignoreColumnRegexes = Collections.emptyList();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private TableDocFactory tableDocFactory = new JdbcTableDocFactory();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private TableIndexDocFactory tableIndexDocFactory = new JdbcTableIndexDocFactory();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private TableTriggerDocFactory tableTriggerDocFactory = new JdbcTableTriggerDocFactory();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private TableColumnDocFactory tableColumnDocFactory = new JdbcTableColumnDocFactory();
|
||||||
|
|
||||||
|
public boolean tableIsIgnored(String tableName) {
|
||||||
|
return ignoreTableRegexes.stream().anyMatch(regex -> Pattern.matches(regex, tableName));
|
||||||
|
}
|
||||||
|
|
||||||
|
public boolean columnIsIgnored(String column) {
|
||||||
|
return ignoreColumnRegexes.stream().anyMatch(regex -> Pattern.matches(regex, column));
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,11 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.DatabaseDoc;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public interface DatabaseDocFactory extends Sortable<DatabaseDocFactory> {
|
||||||
|
|
||||||
|
Optional<DatabaseDoc> create(DatabaseDocConfig configuration);
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,16 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
public interface Sortable<T extends Sortable<?>> extends Comparable<T> {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return priority, min -> max means low -> high
|
||||||
|
*/
|
||||||
|
default int order() {
|
||||||
|
return Integer.MIN_VALUE;
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
default int compareTo(T o) {
|
||||||
|
return Integer.compare(this.order(), o.order());
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,12 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.ColumnDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public interface TableColumnDocFactory extends Sortable<TableColumnDocFactory> {
|
||||||
|
|
||||||
|
List<ColumnDoc> create(String tableName, DatabaseMetaData metaData, DatabaseDocConfig configuration);
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,12 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.TableDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public interface TableDocFactory extends Sortable<TableDocFactory> {
|
||||||
|
|
||||||
|
List<TableDoc> create(DatabaseMetaData metaData, DatabaseDocConfig configuration);
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,12 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.IndexDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public interface TableIndexDocFactory extends Sortable<TableIndexDocFactory> {
|
||||||
|
|
||||||
|
List<IndexDoc> create(String tableName, DatabaseMetaData metaData, DatabaseDocConfig configuration);
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,11 @@
|
||||||
|
package com.databasir.core.doc.factory;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.TriggerDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public interface TableTriggerDocFactory extends Sortable<TableTriggerDocFactory> {
|
||||||
|
|
||||||
|
List<TriggerDoc> create(String tableName, DatabaseMetaData metaData, DatabaseDocConfig configuration);
|
||||||
|
}
|
|
@ -0,0 +1,72 @@
|
||||||
|
package com.databasir.core.doc.factory.extension.mysql;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.TableTriggerDocFactory;
|
||||||
|
import com.databasir.core.doc.model.TriggerDoc;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.sql.PreparedStatement;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
public class MysqlTableTriggerDocFactory implements TableTriggerDocFactory {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<TriggerDoc> create(String tableName,
|
||||||
|
DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration) {
|
||||||
|
String sql = "SELECT TRIGGER_CATALOG,\n" +
|
||||||
|
" TRIGGER_SCHEMA,\n" +
|
||||||
|
" TRIGGER_NAME,\n" +
|
||||||
|
" EVENT_MANIPULATION,\n" +
|
||||||
|
" EVENT_OBJECT_CATALOG,\n" +
|
||||||
|
" EVENT_OBJECT_SCHEMA,\n" +
|
||||||
|
" EVENT_OBJECT_TABLE,\n" +
|
||||||
|
" ACTION_ORDER,\n" +
|
||||||
|
" ACTION_CONDITION,\n" +
|
||||||
|
" ACTION_STATEMENT,\n" +
|
||||||
|
" ACTION_ORIENTATION,\n" +
|
||||||
|
" ACTION_TIMING,\n" +
|
||||||
|
" ACTION_REFERENCE_OLD_TABLE,\n" +
|
||||||
|
" ACTION_REFERENCE_NEW_TABLE,\n" +
|
||||||
|
" ACTION_REFERENCE_OLD_ROW,\n" +
|
||||||
|
" ACTION_REFERENCE_NEW_ROW,\n" +
|
||||||
|
" CREATED,\n" +
|
||||||
|
" SQL_MODE,\n" +
|
||||||
|
" DEFINER\n " +
|
||||||
|
"FROM information_schema.TRIGGERS WHERE EVENT_OBJECT_SCHEMA = ? AND EVENT_OBJECT_TABLE = ?";
|
||||||
|
try {
|
||||||
|
PreparedStatement preparedStatement = configuration.getConnection()
|
||||||
|
.prepareStatement(sql);
|
||||||
|
preparedStatement.setObject(1, configuration.getDatabaseName());
|
||||||
|
preparedStatement.setObject(2, tableName);
|
||||||
|
ResultSet results = preparedStatement.executeQuery();
|
||||||
|
List<TriggerDoc> triggers = new ArrayList<>();
|
||||||
|
while (results.next()) {
|
||||||
|
String name = results.getString("TRIGGER_NAME");
|
||||||
|
String statement = results.getString("ACTION_STATEMENT");
|
||||||
|
String timing = results.getString("ACTION_TIMING");
|
||||||
|
String manipulation = results.getString("EVENT_MANIPULATION");
|
||||||
|
String created = results.getString("CREATED");
|
||||||
|
TriggerDoc doc = TriggerDoc.builder()
|
||||||
|
.name(name)
|
||||||
|
.manipulation(manipulation)
|
||||||
|
.timing(timing)
|
||||||
|
.statement(statement)
|
||||||
|
.createAt(created)
|
||||||
|
.build();
|
||||||
|
triggers.add(doc);
|
||||||
|
}
|
||||||
|
return triggers;
|
||||||
|
} catch (SQLException e) {
|
||||||
|
log.warn("create trigger doc failed", e);
|
||||||
|
return Collections.emptyList();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,45 @@
|
||||||
|
package com.databasir.core.doc.factory.jdbc;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.*;
|
||||||
|
import com.databasir.core.doc.model.DatabaseDoc;
|
||||||
|
import com.databasir.core.doc.model.TableDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.Optional;
|
||||||
|
|
||||||
|
public class JdbcDatabaseDocFactory implements DatabaseDocFactory {
|
||||||
|
|
||||||
|
public static JdbcDatabaseDocFactory of() {
|
||||||
|
return new JdbcDatabaseDocFactory();
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public Optional<DatabaseDoc> create(DatabaseDocConfig configuration) {
|
||||||
|
try {
|
||||||
|
DatabaseMetaData metaData = configuration.getConnection().getMetaData();
|
||||||
|
ResultSet catalogs = metaData.getCatalogs();
|
||||||
|
while (catalogs.next()) {
|
||||||
|
String catalogName = catalogs.getString("TABLE_CAT");
|
||||||
|
if (Objects.equals(configuration.getDatabaseName(), catalogName)) {
|
||||||
|
TableDocFactory tableDocFactory = configuration.getTableDocFactory();
|
||||||
|
List<TableDoc> tableDocs = tableDocFactory.create(metaData, configuration);
|
||||||
|
DatabaseDoc databaseDoc = DatabaseDoc.builder()
|
||||||
|
.productName(metaData.getDatabaseProductName())
|
||||||
|
.productVersion(metaData.getDatabaseProductVersion())
|
||||||
|
.databaseName(catalogName)
|
||||||
|
.tables(tableDocs)
|
||||||
|
.build();
|
||||||
|
return Optional.of(databaseDoc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return Optional.empty();
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,72 @@
|
||||||
|
package com.databasir.core.doc.factory.jdbc;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.TableColumnDocFactory;
|
||||||
|
import com.databasir.core.doc.model.ColumnDoc;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Objects;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
public class JdbcTableColumnDocFactory implements TableColumnDocFactory {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<ColumnDoc> create(String tableName,
|
||||||
|
DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration) {
|
||||||
|
try {
|
||||||
|
return doCreate(tableName, metaData, configuration);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<ColumnDoc> doCreate(String tableName,
|
||||||
|
DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration) throws SQLException {
|
||||||
|
List<ColumnDoc> columnDocs = new ArrayList<>();
|
||||||
|
String database = configuration.getDatabaseName();
|
||||||
|
ResultSet columnsResult;
|
||||||
|
try {
|
||||||
|
columnsResult = metaData.getColumns(database, null, tableName, null);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
log.warn("warn: ignore columns in " + database + "." + tableName);
|
||||||
|
return columnDocs;
|
||||||
|
}
|
||||||
|
while (columnsResult.next()) {
|
||||||
|
String columnName = columnsResult.getString("COLUMN_NAME");
|
||||||
|
if (configuration.columnIsIgnored(columnName)) {
|
||||||
|
if (log.isWarnEnabled()) {
|
||||||
|
log.warn("ignore column: " + columnName);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
String columnType = columnsResult.getString("TYPE_NAME");
|
||||||
|
Integer columnSize = columnsResult.getInt("COLUMN_SIZE");
|
||||||
|
Integer decimalDigits = columnsResult.getInt("DECIMAL_DIGITS");
|
||||||
|
String defaultValue = columnsResult.getString("COLUMN_DEF");
|
||||||
|
boolean isNullable = Objects.equals("YES", columnsResult.getString("IS_NULLABLE"));
|
||||||
|
boolean isAutoIncrement = Objects.equals("YES", columnsResult.getString("IS_AUTOINCREMENT"));
|
||||||
|
String columnComment = columnsResult.getString("REMARKS");
|
||||||
|
ColumnDoc columnDoc = ColumnDoc.builder()
|
||||||
|
.name(columnName)
|
||||||
|
.type(columnType)
|
||||||
|
.size(columnSize)
|
||||||
|
.decimalDigits(decimalDigits)
|
||||||
|
.isNullable(isNullable)
|
||||||
|
.isAutoIncrement(isAutoIncrement)
|
||||||
|
.comment(columnComment)
|
||||||
|
.defaultValue(defaultValue)
|
||||||
|
.build();
|
||||||
|
columnDocs.add(columnDoc);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
return columnDocs;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,59 @@
|
||||||
|
package com.databasir.core.doc.factory.jdbc;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.*;
|
||||||
|
import com.databasir.core.doc.model.TableDoc;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
public class JdbcTableDocFactory implements TableDocFactory {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<TableDoc> create(DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration) {
|
||||||
|
try {
|
||||||
|
return doCreateTableDoc(metaData, configuration);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<TableDoc> doCreateTableDoc(DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration) throws SQLException {
|
||||||
|
List<TableDoc> tableDocs = new ArrayList<>();
|
||||||
|
if (metaData == null) {
|
||||||
|
return tableDocs;
|
||||||
|
}
|
||||||
|
|
||||||
|
String databaseName = configuration.getDatabaseName();
|
||||||
|
ResultSet tablesResult = metaData.getTables(databaseName, null, null, null);
|
||||||
|
while (tablesResult.next()) {
|
||||||
|
String tableName = tablesResult.getString("TABLE_NAME");
|
||||||
|
if (configuration.tableIsIgnored(tableName)) {
|
||||||
|
if (log.isWarnEnabled()) {
|
||||||
|
log.warn("ignore table: " + configuration.getDatabaseName() + "." + tableName);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
String tableType = tablesResult.getString("TABLE_TYPE");
|
||||||
|
String tableComment = tablesResult.getString("REMARKS");
|
||||||
|
TableDoc tableDoc = TableDoc.builder()
|
||||||
|
.tableName(tableName)
|
||||||
|
.tableType(tableType)
|
||||||
|
.tableComment(tableComment)
|
||||||
|
.columns(configuration.getTableColumnDocFactory().create(tableName, metaData, configuration))
|
||||||
|
.indexes(configuration.getTableIndexDocFactory().create(tableName, metaData, configuration))
|
||||||
|
.triggers(configuration.getTableTriggerDocFactory().create(tableName, metaData, configuration))
|
||||||
|
.build();
|
||||||
|
tableDocs.add(tableDoc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return tableDocs;
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,64 @@
|
||||||
|
package com.databasir.core.doc.factory.jdbc;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.TableIndexDocFactory;
|
||||||
|
import com.databasir.core.doc.model.IndexDoc;
|
||||||
|
import lombok.extern.slf4j.Slf4j;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.sql.ResultSet;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.*;
|
||||||
|
|
||||||
|
@Slf4j
|
||||||
|
public class JdbcTableIndexDocFactory implements TableIndexDocFactory {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<IndexDoc> create(String tableName, DatabaseMetaData metaData, DatabaseDocConfig configuration) {
|
||||||
|
try {
|
||||||
|
return doCreateIndexDocs(tableName, metaData, configuration);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<IndexDoc> doCreateIndexDocs(String tableName,
|
||||||
|
DatabaseMetaData metaData,
|
||||||
|
DatabaseDocConfig configuration)
|
||||||
|
throws SQLException {
|
||||||
|
List<IndexDoc> indexDocs = new ArrayList<>();
|
||||||
|
String databaseName = configuration.getDatabaseName();
|
||||||
|
if (tableName == null || metaData == null) {
|
||||||
|
return indexDocs;
|
||||||
|
}
|
||||||
|
ResultSet indexResults;
|
||||||
|
try {
|
||||||
|
indexResults = metaData.getIndexInfo(databaseName, null, tableName, false, false);
|
||||||
|
} catch (SQLException e) {
|
||||||
|
log.warn("warn: ignore " + databaseName + "." + tableName);
|
||||||
|
return indexDocs;
|
||||||
|
}
|
||||||
|
|
||||||
|
Map<String, IndexDoc> docsGroupByName = new HashMap<>();
|
||||||
|
while (indexResults.next()) {
|
||||||
|
Boolean nonUnique = indexResults.getBoolean("NON_UNIQUE");
|
||||||
|
String indexName = indexResults.getString("INDEX_NAME");
|
||||||
|
String columnName = indexResults.getString("COLUMN_NAME");
|
||||||
|
if (docsGroupByName.containsKey(indexName)) {
|
||||||
|
docsGroupByName.get(indexName).getColumnNames().add(columnName);
|
||||||
|
} else {
|
||||||
|
List<String> columns = new ArrayList<>();
|
||||||
|
columns.add(columnName);
|
||||||
|
IndexDoc columnDoc = IndexDoc.builder()
|
||||||
|
.indexName(indexName)
|
||||||
|
.columnNames(columns)
|
||||||
|
.isPrimaryKey(Objects.equals("PRIMARY", indexName))
|
||||||
|
.isUniqueKey(Objects.equals(nonUnique, false))
|
||||||
|
.build();
|
||||||
|
docsGroupByName.put(indexName, columnDoc);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return new ArrayList<>(docsGroupByName.values());
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,18 @@
|
||||||
|
package com.databasir.core.doc.factory.jdbc;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.TableTriggerDocFactory;
|
||||||
|
import com.databasir.core.doc.model.TriggerDoc;
|
||||||
|
|
||||||
|
import java.sql.DatabaseMetaData;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public class JdbcTableTriggerDocFactory implements TableTriggerDocFactory {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public List<TriggerDoc> create(String tableName, DatabaseMetaData metaData, DatabaseDocConfig configuration) {
|
||||||
|
// note: jdbc not support get triggers
|
||||||
|
return Collections.emptyList();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,26 @@
|
||||||
|
package com.databasir.core.doc.model;
|
||||||
|
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Builder
|
||||||
|
public class ColumnDoc {
|
||||||
|
|
||||||
|
private String name;
|
||||||
|
|
||||||
|
private String comment;
|
||||||
|
|
||||||
|
private String type;
|
||||||
|
|
||||||
|
private String defaultValue;
|
||||||
|
|
||||||
|
private Integer size;
|
||||||
|
|
||||||
|
private Integer decimalDigits;
|
||||||
|
|
||||||
|
private Boolean isNullable;
|
||||||
|
|
||||||
|
private Boolean isAutoIncrement;
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,28 @@
|
||||||
|
package com.databasir.core.doc.model;
|
||||||
|
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Builder
|
||||||
|
public class DatabaseDoc {
|
||||||
|
|
||||||
|
private String productName;
|
||||||
|
|
||||||
|
private String productVersion;
|
||||||
|
|
||||||
|
private String driverName;
|
||||||
|
|
||||||
|
private String driverVersion;
|
||||||
|
|
||||||
|
private String databaseName;
|
||||||
|
|
||||||
|
private String remark;
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<TableDoc> tables = Collections.emptyList();
|
||||||
|
|
||||||
|
}
|
|
@ -0,0 +1,21 @@
|
||||||
|
package com.databasir.core.doc.model;
|
||||||
|
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Builder
|
||||||
|
public class IndexDoc {
|
||||||
|
|
||||||
|
private String indexName;
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<String> columnNames = Collections.emptyList();
|
||||||
|
|
||||||
|
private Boolean isPrimaryKey;
|
||||||
|
|
||||||
|
private Boolean isUniqueKey;
|
||||||
|
}
|
|
@ -0,0 +1,29 @@
|
||||||
|
package com.databasir.core.doc.model;
|
||||||
|
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
@Builder
|
||||||
|
public class TableDoc {
|
||||||
|
|
||||||
|
private String tableName;
|
||||||
|
|
||||||
|
private String tableType;
|
||||||
|
|
||||||
|
private String tableComment;
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<ColumnDoc> columns = Collections.emptyList();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<TriggerDoc> triggers = Collections.emptyList();
|
||||||
|
|
||||||
|
@Builder.Default
|
||||||
|
private List<IndexDoc> indexes = Collections.emptyList();
|
||||||
|
|
||||||
|
private String remark;
|
||||||
|
}
|
|
@ -0,0 +1,28 @@
|
||||||
|
package com.databasir.core.doc.model;
|
||||||
|
|
||||||
|
import lombok.Builder;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* now: only support mysql, postgresql.
|
||||||
|
*/
|
||||||
|
@Data
|
||||||
|
@Builder
|
||||||
|
public class TriggerDoc {
|
||||||
|
|
||||||
|
private String name;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* example: BEFORE, AFTER
|
||||||
|
*/
|
||||||
|
private String timing;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* example: INSERT, UPDATE
|
||||||
|
*/
|
||||||
|
private String manipulation;
|
||||||
|
|
||||||
|
private String statement;
|
||||||
|
|
||||||
|
private String createAt;
|
||||||
|
}
|
|
@ -0,0 +1,16 @@
|
||||||
|
package com.databasir.core.doc.render;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.DatabaseDoc;
|
||||||
|
import com.databasir.core.doc.render.markdown.MarkdownRender;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
|
||||||
|
public interface Render {
|
||||||
|
|
||||||
|
void rendering(DatabaseDoc doc, OutputStream outputStream) throws IOException;
|
||||||
|
|
||||||
|
static Render markdownRender(RenderConfig configuration) {
|
||||||
|
return MarkdownRender.of(configuration);
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,75 @@
|
||||||
|
package com.databasir.core.doc.render;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.ColumnDoc;
|
||||||
|
import com.databasir.core.doc.model.IndexDoc;
|
||||||
|
import com.databasir.core.doc.model.TriggerDoc;
|
||||||
|
import lombok.Data;
|
||||||
|
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
import java.util.function.Function;
|
||||||
|
|
||||||
|
@Data
|
||||||
|
public class RenderConfig {
|
||||||
|
|
||||||
|
private Boolean renderTables = true;
|
||||||
|
|
||||||
|
private Boolean renderColumns = true;
|
||||||
|
|
||||||
|
private Boolean renderIndexes = true;
|
||||||
|
|
||||||
|
private Boolean renderTriggers = true;
|
||||||
|
|
||||||
|
private LinkedHashMap<String, Function<ColumnDoc, String>> columnTitleAndValueMapping = columnTitleAndValueMapping();
|
||||||
|
|
||||||
|
private LinkedHashMap<String, Function<IndexDoc, String>> indexTitleAndValueMapping = indexTitleAndValueMapping();
|
||||||
|
|
||||||
|
private LinkedHashMap<String, Function<TriggerDoc, String>> triggerTitleAndValueMapping = triggerTitleAndValueMapping();
|
||||||
|
|
||||||
|
protected LinkedHashMap<String, Function<ColumnDoc, String>> columnTitleAndValueMapping() {
|
||||||
|
LinkedHashMap<String, Function<ColumnDoc, String>> mapping = new LinkedHashMap<>();
|
||||||
|
mapping.put("Name", ColumnDoc::getName);
|
||||||
|
mapping.put("Type", column -> {
|
||||||
|
String type;
|
||||||
|
if (column.getDecimalDigits() == null || column.getDecimalDigits().equals(0)) {
|
||||||
|
type = column.getType()
|
||||||
|
+ "(" + column.getSize().toString() + ")";
|
||||||
|
} else {
|
||||||
|
type = column.getType()
|
||||||
|
+ "(" + column.getSize().toString() + ", " + column.getDecimalDigits().toString() + ")";
|
||||||
|
}
|
||||||
|
return type;
|
||||||
|
});
|
||||||
|
mapping.put("Not Null", column -> column.getIsNullable() ? "" : "YES");
|
||||||
|
mapping.put("Auto Increment", column -> column.getIsAutoIncrement() ? "YES" : "");
|
||||||
|
mapping.put("Default", column -> {
|
||||||
|
if (column.getDefaultValue() == null) {
|
||||||
|
return "";
|
||||||
|
}
|
||||||
|
if (column.getDefaultValue().trim().equals("")) {
|
||||||
|
return "'" + column.getDefaultValue() + "'";
|
||||||
|
}
|
||||||
|
return column.getDefaultValue();
|
||||||
|
});
|
||||||
|
mapping.put("Comment", ColumnDoc::getComment);
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected LinkedHashMap<String, Function<IndexDoc, String>> indexTitleAndValueMapping() {
|
||||||
|
LinkedHashMap<String, Function<IndexDoc, String>> mapping = new LinkedHashMap<>();
|
||||||
|
mapping.put("Name", IndexDoc::getIndexName);
|
||||||
|
mapping.put("IsPrimary", index -> index.getIsPrimaryKey() ? "YES" : "");
|
||||||
|
mapping.put("IsUnique", index -> index.getIsUniqueKey() ? "YES" : "");
|
||||||
|
mapping.put("Columns", index -> String.join(", ", index.getColumnNames()));
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
|
||||||
|
protected LinkedHashMap<String, Function<TriggerDoc, String>> triggerTitleAndValueMapping() {
|
||||||
|
LinkedHashMap<String, Function<TriggerDoc, String>> mapping = new LinkedHashMap<>();
|
||||||
|
mapping.put("Name", TriggerDoc::getName);
|
||||||
|
mapping.put("Timing", trigger -> trigger.getTiming() + " " + trigger.getManipulation());
|
||||||
|
mapping.put("Statement", trigger -> trigger.getStatement().replace("\n", " ")
|
||||||
|
.replace("\r", " "));
|
||||||
|
mapping.put("Create At", TriggerDoc::getCreateAt);
|
||||||
|
return mapping;
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,108 @@
|
||||||
|
package com.databasir.core.doc.render.markdown;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
|
public class MarkdownBuilder {
|
||||||
|
|
||||||
|
private static final String LINE = "\n";
|
||||||
|
|
||||||
|
private static final String DOUBLE_LINE = LINE + LINE;
|
||||||
|
|
||||||
|
private StringBuilder builder = new StringBuilder(1024);
|
||||||
|
|
||||||
|
private MarkdownBuilder() {
|
||||||
|
}
|
||||||
|
|
||||||
|
public static MarkdownBuilder builder() {
|
||||||
|
return new MarkdownBuilder();
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder primaryTitle(String title) {
|
||||||
|
builder.append("# ").append(title).append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder secondTitle(String title) {
|
||||||
|
builder.append("## ").append(title).append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder thirdTitle(String title) {
|
||||||
|
builder.append("### ").append(title).append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder text(String text) {
|
||||||
|
builder.append(text).append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder table(List<String> titles, List<List<String>> rows) {
|
||||||
|
if (titles == null || titles.isEmpty()) {
|
||||||
|
throw new IllegalArgumentException("titles must not be null or empty");
|
||||||
|
}
|
||||||
|
// build titles
|
||||||
|
builder.append("| ");
|
||||||
|
for (String title : titles) {
|
||||||
|
builder.append(title).append(" | ");
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
|
||||||
|
// build separators
|
||||||
|
builder.append("| ");
|
||||||
|
for (String title : titles) {
|
||||||
|
builder.append("------").append(" | ");
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
|
||||||
|
// build rows
|
||||||
|
for (List<String> row : rows) {
|
||||||
|
builder.append("| ");
|
||||||
|
for (String column : row) {
|
||||||
|
builder.append(column).append(" | ");
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder orderedList(List<String> list) {
|
||||||
|
for (int i = 0; i < list.size(); i++) {
|
||||||
|
builder.append(i + 1).append(". ").append(list.get(i)).append(LINE);
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder unorderedList(List<String> list) {
|
||||||
|
for (String item : list) {
|
||||||
|
builder.append("- ").append(item).append(LINE);
|
||||||
|
}
|
||||||
|
builder.append(LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder blockquotes(String content) {
|
||||||
|
builder.append("> ").append(content).append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder code(String languageType, String statement) {
|
||||||
|
builder.append("```").append(languageType).append(LINE)
|
||||||
|
.append(statement)
|
||||||
|
.append("```")
|
||||||
|
.append(DOUBLE_LINE);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public MarkdownBuilder link(String text, String link) {
|
||||||
|
builder.append("[").append(text).append("]")
|
||||||
|
.append("(").append(link).append(")");
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public String build() {
|
||||||
|
return builder.toString();
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,112 @@
|
||||||
|
package com.databasir.core.doc.render.markdown;
|
||||||
|
|
||||||
|
import com.databasir.core.doc.model.DatabaseDoc;
|
||||||
|
import com.databasir.core.doc.model.TableDoc;
|
||||||
|
import com.databasir.core.doc.render.Render;
|
||||||
|
import com.databasir.core.doc.render.RenderConfig;
|
||||||
|
import lombok.Getter;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.OutputStream;
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.*;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
|
public class MarkdownRender implements Render {
|
||||||
|
|
||||||
|
@Getter
|
||||||
|
private final RenderConfig config;
|
||||||
|
|
||||||
|
protected MarkdownRender(RenderConfig config) {
|
||||||
|
this.config = config;
|
||||||
|
}
|
||||||
|
|
||||||
|
public static MarkdownRender of(RenderConfig config) {
|
||||||
|
return new MarkdownRender(config);
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void rendering(DatabaseDoc doc,
|
||||||
|
OutputStream outputStream) throws IOException {
|
||||||
|
MarkdownBuilder contentBuilder = MarkdownBuilder.builder();
|
||||||
|
contentBuilder.primaryTitle(doc.getDatabaseName());
|
||||||
|
if (config.getRenderTables()) {
|
||||||
|
for (TableDoc table : doc.getTables()) {
|
||||||
|
buildTableName(contentBuilder, table);
|
||||||
|
if (config.getRenderColumns()) {
|
||||||
|
buildColumns(contentBuilder, table);
|
||||||
|
}
|
||||||
|
if (config.getRenderIndexes()) {
|
||||||
|
buildIndexes(contentBuilder, table);
|
||||||
|
}
|
||||||
|
if (config.getRenderTriggers()) {
|
||||||
|
buildTriggers(contentBuilder, table);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
outputStream.write(contentBuilder.build().getBytes(StandardCharsets.UTF_8));
|
||||||
|
}
|
||||||
|
|
||||||
|
private void buildTableName(MarkdownBuilder contentBuilder, TableDoc table) {
|
||||||
|
String tableName;
|
||||||
|
if (table.getTableComment() == null || table.getTableComment().trim().isEmpty()) {
|
||||||
|
tableName = table.getTableName();
|
||||||
|
} else {
|
||||||
|
tableName = table.getTableName() + "(" + table.getTableComment() + ")";
|
||||||
|
}
|
||||||
|
contentBuilder.secondTitle(tableName);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void buildColumns(MarkdownBuilder contentBuilder, TableDoc table) {
|
||||||
|
contentBuilder.unorderedList(Collections.singletonList("columns"));
|
||||||
|
List<List<String>> allColumnRows = table.getColumns()
|
||||||
|
.stream()
|
||||||
|
.map(column -> config.getColumnTitleAndValueMapping()
|
||||||
|
.values()
|
||||||
|
.stream()
|
||||||
|
.map(mapping -> mapping.apply(column))
|
||||||
|
.collect(Collectors.toList()))
|
||||||
|
.collect(Collectors.toList());
|
||||||
|
contentBuilder.table(tableTitles(), allColumnRows);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void buildIndexes(MarkdownBuilder contentBuilder, TableDoc table) {
|
||||||
|
contentBuilder.unorderedList(Collections.singletonList("indexes"));
|
||||||
|
List<List<String>> allIndexRows = table.getIndexes().stream()
|
||||||
|
.map(index -> config.getIndexTitleAndValueMapping()
|
||||||
|
.values()
|
||||||
|
.stream()
|
||||||
|
.map(mapping -> mapping.apply(index))
|
||||||
|
.collect(Collectors.toList()))
|
||||||
|
.collect(Collectors.toList());
|
||||||
|
contentBuilder.table(indexTitles(), allIndexRows);
|
||||||
|
}
|
||||||
|
|
||||||
|
private void buildTriggers(MarkdownBuilder contentBuilder, TableDoc table) {
|
||||||
|
if (table.getTriggers() == null || table.getTriggers().isEmpty()) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
contentBuilder.unorderedList(Collections.singletonList("triggers"));
|
||||||
|
List<List<String>> allRows = table.getTriggers().stream()
|
||||||
|
.map(trigger -> config.getTriggerTitleAndValueMapping()
|
||||||
|
.values()
|
||||||
|
.stream()
|
||||||
|
.map(mapping -> mapping.apply(trigger))
|
||||||
|
.collect(Collectors.toList()))
|
||||||
|
.collect(Collectors.toList());
|
||||||
|
contentBuilder.table(triggerTitles(), allRows);
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<String> tableTitles() {
|
||||||
|
return new ArrayList<>(config.getColumnTitleAndValueMapping().keySet());
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<String> indexTitles() {
|
||||||
|
return new ArrayList<>(config.getIndexTitleAndValueMapping().keySet());
|
||||||
|
}
|
||||||
|
|
||||||
|
private List<String> triggerTitles() {
|
||||||
|
return new ArrayList<>(config.getTriggerTitleAndValueMapping().keySet());
|
||||||
|
}
|
||||||
|
}
|
|
@ -0,0 +1,43 @@
|
||||||
|
import com.databasir.core.doc.factory.DatabaseDocConfig;
|
||||||
|
import com.databasir.core.doc.factory.extension.mysql.MysqlTableTriggerDocFactory;
|
||||||
|
import com.databasir.core.doc.factory.jdbc.JdbcDatabaseDocFactory;
|
||||||
|
import com.databasir.core.doc.model.DatabaseDoc;
|
||||||
|
import com.databasir.core.doc.render.Render;
|
||||||
|
import com.databasir.core.doc.render.RenderConfig;
|
||||||
|
|
||||||
|
import java.io.FileOutputStream;
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.sql.DriverManager;
|
||||||
|
import java.sql.SQLException;
|
||||||
|
import java.util.Properties;
|
||||||
|
|
||||||
|
public class App {
|
||||||
|
public static void main(String[] args) throws SQLException, ClassNotFoundException {
|
||||||
|
// get database connection
|
||||||
|
Class.forName("com.mysql.cj.jdbc.Driver");
|
||||||
|
Properties info = new Properties();
|
||||||
|
info.put("user", "root");
|
||||||
|
info.put("password", "123456");
|
||||||
|
// this config is used by mysql
|
||||||
|
info.put("useInformationSchema", "true");
|
||||||
|
String url = "jdbc:mysql://localhost:3306/patient?useUnicode=true&characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true";
|
||||||
|
var connection = DriverManager.getConnection(url, info);
|
||||||
|
|
||||||
|
// generate doc model
|
||||||
|
var config = DatabaseDocConfig.builder()
|
||||||
|
.databaseName("user")
|
||||||
|
.connection(connection)
|
||||||
|
.tableTriggerDocFactory(new MysqlTableTriggerDocFactory())
|
||||||
|
.build();
|
||||||
|
DatabaseDoc doc = JdbcDatabaseDocFactory.of().create(config).orElseThrow();
|
||||||
|
|
||||||
|
// render as markdown
|
||||||
|
try (FileOutputStream out = new FileOutputStream("user.md")) {
|
||||||
|
RenderConfig renderConfig = new RenderConfig();
|
||||||
|
renderConfig.setRenderTriggers(true);
|
||||||
|
Render.markdownRender(renderConfig).rendering(doc, out);
|
||||||
|
} catch (IOException e) {
|
||||||
|
throw new IllegalStateException(e);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
Binary file not shown.
|
@ -0,0 +1,5 @@
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-7.1-bin.zip
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
|
@ -0,0 +1,185 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright 2015 the original author or authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
##
|
||||||
|
## Gradle start up script for UN*X
|
||||||
|
##
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
PRG="$0"
|
||||||
|
# Need this for relative symlinks.
|
||||||
|
while [ -h "$PRG" ] ; do
|
||||||
|
ls=`ls -ld "$PRG"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
PRG="$link"
|
||||||
|
else
|
||||||
|
PRG=`dirname "$PRG"`"/$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
SAVED="`pwd`"
|
||||||
|
cd "`dirname \"$PRG\"`/" >/dev/null
|
||||||
|
APP_HOME="`pwd -P`"
|
||||||
|
cd "$SAVED" >/dev/null
|
||||||
|
|
||||||
|
APP_NAME="Gradle"
|
||||||
|
APP_BASE_NAME=`basename "$0"`
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD="maximum"
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
}
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "`uname`" in
|
||||||
|
CYGWIN* )
|
||||||
|
cygwin=true
|
||||||
|
;;
|
||||||
|
Darwin* )
|
||||||
|
darwin=true
|
||||||
|
;;
|
||||||
|
MSYS* | MINGW* )
|
||||||
|
msys=true
|
||||||
|
;;
|
||||||
|
NONSTOP* )
|
||||||
|
nonstop=true
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||||
|
else
|
||||||
|
JAVACMD="$JAVA_HOME/bin/java"
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD="java"
|
||||||
|
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||||
|
MAX_FD_LIMIT=`ulimit -H -n`
|
||||||
|
if [ $? -eq 0 ] ; then
|
||||||
|
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||||
|
MAX_FD="$MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
ulimit -n $MAX_FD
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Darwin, add options to specify how the application appears in the dock
|
||||||
|
if $darwin; then
|
||||||
|
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
|
||||||
|
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||||
|
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||||
|
|
||||||
|
JAVACMD=`cygpath --unix "$JAVACMD"`
|
||||||
|
|
||||||
|
# We build the pattern for arguments to be converted via cygpath
|
||||||
|
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||||
|
SEP=""
|
||||||
|
for dir in $ROOTDIRSRAW ; do
|
||||||
|
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||||
|
SEP="|"
|
||||||
|
done
|
||||||
|
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||||
|
# Add a user-defined pattern to the cygpath arguments
|
||||||
|
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||||
|
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||||
|
fi
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
i=0
|
||||||
|
for arg in "$@" ; do
|
||||||
|
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||||
|
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||||
|
|
||||||
|
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||||
|
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||||
|
else
|
||||||
|
eval `echo args$i`="\"$arg\""
|
||||||
|
fi
|
||||||
|
i=`expr $i + 1`
|
||||||
|
done
|
||||||
|
case $i in
|
||||||
|
0) set -- ;;
|
||||||
|
1) set -- "$args0" ;;
|
||||||
|
2) set -- "$args0" "$args1" ;;
|
||||||
|
3) set -- "$args0" "$args1" "$args2" ;;
|
||||||
|
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||||
|
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||||
|
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||||
|
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||||
|
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||||
|
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Escape application args
|
||||||
|
save () {
|
||||||
|
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||||
|
echo " "
|
||||||
|
}
|
||||||
|
APP_ARGS=`save "$@"`
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||||
|
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
|
@ -0,0 +1,89 @@
|
||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%" == "" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%" == "" set DIRNAME=.
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if "%ERRORLEVEL%" == "0" goto execute
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||||
|
exit /b 1
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
|
@ -0,0 +1,3 @@
|
||||||
|
rootProject.name = 'databasir'
|
||||||
|
include 'core'
|
||||||
|
|
Loading…
Reference in New Issue