documentation-generator-sqlscript

Documentation Generator SQL Scripts

This generator can generate sql files containing create tables, indexes and views.

Configuration

To use the sql generator, you must configure it with dk.fust.docgen.sqlscript.SqlScriptConfiguration

Setting	Type	Description	Default
documentationFile	File	Location of the documentation file
destination	Destination	Where to send the generated documentation
filterTags	String	If specified, only tables with this filterTags is used
sqlDialect	SqlDialect	SQL Dialect that the sql scripts are generated in	POSTGRES

Model usage

This generator uses these fields in Documentation

Documentation
├── schemaName
├── generation
│   ├── generateIdDataType
│   ├── generateId
│   ├── addCreatedAt
│   ├── columnNameCreatedAt
│   ├── addUpdatedAt
│   ├── columnNameUpdatedAt
│   └── triggerForUpdates
└── tables
    ├── generation (same sub fields as above)
    ├── name
    ├── comment
    ├── tags
    ├── createTableScript
    ├── fields
    │   ├── name
    │   ├── comment
    │   ├── dataType
    │   ├── foreignKey
    │   │   ├── tableName
    │   │   ├── columnName
    │   │   ├── onDelete
    │   │   ├── onUpdate
    │   │   └── enforceReference
    │   ├── primaryKey
    │   ├── collate
    │   ├── unique
    │   ├── nullable
    │   ├── defaultValue
    │   └── check
    ├── views
    │   ├── name
    │   └── sql 
    └── indexes
        ├── name
        ├── unique
        └── fields

---

Foreign Keys

If you want to use foreign keys, you must specify the foreignKey field in the table field. The foreignKey field is an object with the following fields:

Field	Type	Description	Default
tableName	String	Name of the table that the foreign key references
columnName	String	Name of the column that the foreign key references
enforceReference	Boolean	Whether to enforce the foreign key reference
onDelete	String	Action to take when the referenced row is deleted. Only active if enforceReference is true	no_action
onUpdate	String	Action to take when the referenced row is updated Only active if enforceReference is true	no_action

Actions

Theses are the actions available for onDelete and onUpdate:

Action	Description
cascade	Deletes or updates child rows automatically when the parent row is deleted or updated
set_null	Sets the foreign key column in child rows to NULL when the parent is deleted or updated
set_default	Sets the foreign key column in child rows to its default value when the parent key is deleted or updated
restrict	Prevents updating the parent key or delete it, if child rows exist
no_action	Similar to restrict; the update is not allowed if child rows exist. This means no action is generated in the SQL

Examples

gradle.build

import dk.fust.docgen.sqlscript.SqlScriptConfiguration
import dk.fust.docgen.destination.DirectoryDestination

new SqlScriptConfiguration(
        documentationFile: new File(projectDir, 'documentation.yml'),
        destination: new DirectoryDestination(
                directory: new File('scripts'),
                createParentDirectories: true
        )
)

generator-configuration.yml

- className: dk.fust.docgen.sqlscript.SqlScriptConfiguration
  documentationFile: documentation.yml
  destination:
    className: dk.fust.docgen.destination.DirectoryDestination
    directory: scripts
    createParentDirectories: true

Demo

Check the demo in demo-sqlscript