CreateMySqlDdlFromSchemaDef (Data Pipeline JavaDoc)

java.lang.Object
- com.northconcepts.datapipeline.jdbc.sql.SqlPart
- - com.northconcepts.datapipeline.sql.mysql.MySqlPart
  - - com.northconcepts.datapipeline.sql.mysql.CreateMySqlDdlFromSchemaDef

```
public class CreateMySqlDdlFromSchemaDef
extends MySqlPart
```
Generates MySQL DDL from SchemaDef

Sample Generated SQL:

DROP TABLE IF EXISTS table_name; CREATE TABLE IF NOT EXISTS table_name ( user_id bigint, email text, PRIMARY KEY (user_id) ); CREATE INDEX idx_email ON table_name (email); ALTER TABLE foreign_table_name ADD CONSTRAINT fk_constraint_name FOREIGN KEY(fk_field_name) REFERENCES primary_table_name (pk_field_name) ON DELETE CASCADE ON UPDATE RESTRICT;

Constructor Summary

Constructors
Constructor and Description

CreateMySqlDdlFromSchemaDef(SchemaDef schemaDef)

Constructors
Constructor and Description
`CreateMySqlDdlFromSchemaDef(SchemaDef schemaDef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`collectSqlFragment(CodeWriter writer)` Generates DDL from `schemaDef` and writes the output to `writer`.
`Integer`	`getDefaultBigDecimalPrecision()` Returns the default precision of `FieldType.BIG_DECIMAL` (default 20).
`Integer`	`getDefaultBigDecimalScale()` Sets the default scale of `FieldType.BIG_DECIMAL` (default 5).
`Integer`	`getDefaultBigIntegerPrecision()` Returns the default precision of `FieldType.BIG_INTEGER` (default 20).
`List<String>`	`getEntityNames()` Returns entity names that are specified by `setEntityNames(java.util.List<java.lang.String>)` to be included in the output DDL.
`SchemaDef`	`getSchemaDef()` Returns provided `schemaDef`.
`boolean`	`isCheckIfDropTableExists()` Indicates if `IF EXISTS` clause should be included in the `DROP TABLE` statement (default is true).
`boolean`	`isCheckIfTableNotExists()` Indicates if `IF NOT EXISTS` clause should be included in the `CREATE TABLE` statement (default is true).
`boolean`	`isDropTable()` Indicates if drop table statement should be included in the output DDL for each entity in the `schemaDef` (default true).
`boolean`	`isGenerateIndexes()` Indicates if DDL should be generated for indexes in the `schemaDef` (default is true).
`boolean`	`isGenerateRelationships()` Indicates if DDL should be generated for relationships in the `schemaDef` (default is true).
`CreateMySqlDdlFromSchemaDef`	`setCheckIfDropTableExists(boolean checkIfDropTableExists)` Indicates if `IF EXISTS` clause should be included in the `DROP TABLE` statement (default is true).
`CreateMySqlDdlFromSchemaDef`	`setCheckIfTableNotExists(boolean checkIfTableNotExists)` Indicates if `IF NOT EXISTS` clause should be included in the `CREATE TABLE` statement (default is true).
`CreateMySqlDdlFromSchemaDef`	`setDefaultBigDecimalPrecision(int defaultBigDecimalPrecision)` Sets a default precision for `FieldType.BIG_DECIMAL`. This value will be used if no precision is specified for `BIG_DECIMAL` fields (default 20).
`CreateMySqlDdlFromSchemaDef`	`setDefaultBigDecimalScale(Integer defaultBigDecimalScale)` Sets a default scale for `FieldType.BIG_DECIMAL` (default 5). This value will be used if no scale is specified for `BIG_DECIMAL` fields.
`CreateMySqlDdlFromSchemaDef`	`setDefaultBigIntegerPrecision(int defaultBigIntegerPrecision)` Sets a default precision for `FieldType.BIG_INTEGER` (default 20). This value will be used if no precision is specified for `BIG_INTEGER` fields.
`CreateMySqlDdlFromSchemaDef`	`setDropTable(boolean dropTable)` Indicates if drop table statement should be included in the output DDL for each entity in the `schemaDef` (default true).
`CreateMySqlDdlFromSchemaDef`	`setEntityNames(List<String> entityNames)` Set entity names that should be included in the output DDL (all entities will be included by default).
`CreateMySqlDdlFromSchemaDef`	`setEntityNames(String... entityNames)` Set entity names that should be included in the output DDL (all entities will be included by default).
`CreateMySqlDdlFromSchemaDef`	`setGenerateIndexes(boolean generateIndexes)` Indicates if DDL should be generated for indexes in the `schemaDef` (default is true).
`CreateMySqlDdlFromSchemaDef`	`setGenerateRelationships(boolean generateRelationships)` Indicates if DDL should be generated for indexes in the `schemaDef` (default is true).
`CreateMySqlDdlFromSchemaDef`	`setPretty(boolean pretty)` Indicates if line breaks and indentations should be added to output DDL (default false). Example output (pretty = true): `CREATE TABLE IF NOT EXISTS table_name ( id bigint, email text PRIMARY KEY (user_id) );` Example output (pretty = false): `CREATE TABLE IF NOT EXISTS table_name (id bigint, email text, PRIMARY KEY (user_id));`

Methods inherited from class com.northconcepts.datapipeline.sql.mysql.MySqlPart
escapeKeyword, placeBackTicks

Methods inherited from class com.northconcepts.datapipeline.jdbc.sql.SqlPart
collectParameterValues, getParameterValues, getSqlFragment, isPretty, printSqlParts, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateMySqlDdlFromSchemaDef
```
public CreateMySqlDdlFromSchemaDef(SchemaDef schemaDef)
```
- Method Detail
  - collectSqlFragment
```
public void collectSqlFragment(CodeWriter writer)
```
    Generates DDL from schemaDef and writes the output to writer.
    
    Specified by:
    
    collectSqlFragment in class SqlPart
  - getSchemaDef
```
public SchemaDef getSchemaDef()
```
    Returns provided schemaDef.
  - isGenerateIndexes
```
public boolean isGenerateIndexes()
```
    Indicates if DDL should be generated for indexes in the schemaDef (default is true).
  - setGenerateIndexes
```
public CreateMySqlDdlFromSchemaDef setGenerateIndexes(boolean generateIndexes)
```
    Indicates if DDL should be generated for indexes in the schemaDef (default is true).
  - isGenerateRelationships
```
public boolean isGenerateRelationships()
```
    Indicates if DDL should be generated for relationships in the schemaDef (default is true).
  - setGenerateRelationships
```
public CreateMySqlDdlFromSchemaDef setGenerateRelationships(boolean generateRelationships)
```
    Indicates if DDL should be generated for indexes in the schemaDef (default is true).
  - isCheckIfTableNotExists
```
public boolean isCheckIfTableNotExists()
```
    Indicates if IF NOT EXISTS clause should be included in the CREATE TABLE statement (default is true).
  - setCheckIfTableNotExists
```
public CreateMySqlDdlFromSchemaDef setCheckIfTableNotExists(boolean checkIfTableNotExists)
```
    Indicates if IF NOT EXISTS clause should be included in the CREATE TABLE statement (default is true).
  - isCheckIfDropTableExists
```
public boolean isCheckIfDropTableExists()
```
    Indicates if IF EXISTS clause should be included in the DROP TABLE statement (default is true).
  - setCheckIfDropTableExists
```
public CreateMySqlDdlFromSchemaDef setCheckIfDropTableExists(boolean checkIfDropTableExists)
```
    Indicates if IF EXISTS clause should be included in the DROP TABLE statement (default is true).
  - getEntityNames
```
public List<String> getEntityNames()
```
    Returns entity names that are specified by setEntityNames(java.util.List<java.lang.String>) to be included in the output DDL.
  - setEntityNames
```
public CreateMySqlDdlFromSchemaDef setEntityNames(List<String> entityNames)
```
    Set entity names that should be included in the output DDL (all entities will be included by default).
    
    Entities that are not listed in entityNames will be excluded from the generated SQL including relationships that involve any of them.
  - setEntityNames
```
public CreateMySqlDdlFromSchemaDef setEntityNames(String... entityNames)
```
    Set entity names that should be included in the output DDL (all entities will be included by default).
    
    Entities that are not listed in entityNames will be excluded from the generated SQL including relationships that involve any of them.
  - setPretty
```
public CreateMySqlDdlFromSchemaDef setPretty(boolean pretty)
```
    Indicates if line breaks and indentations should be added to output DDL (default false).
    
    Example output (pretty = true):
    CREATE TABLE IF NOT EXISTS table_name ( id bigint, email text PRIMARY KEY (user_id) );
    Example output (pretty = false):
    CREATE TABLE IF NOT EXISTS table_name (id bigint, email text, PRIMARY KEY (user_id));
    
    Overrides:
    
    setPretty in class SqlPart
  - isDropTable
```
public boolean isDropTable()
```
    Indicates if drop table statement should be included in the output DDL for each entity in the schemaDef (default true).
  - setDropTable
```
public CreateMySqlDdlFromSchemaDef setDropTable(boolean dropTable)
```
    Indicates if drop table statement should be included in the output DDL for each entity in the schemaDef (default true).
  - getDefaultBigIntegerPrecision
```
public Integer getDefaultBigIntegerPrecision()
```
    Returns the default precision of FieldType.BIG_INTEGER (default 20).
  - setDefaultBigIntegerPrecision
```
public CreateMySqlDdlFromSchemaDef setDefaultBigIntegerPrecision(int defaultBigIntegerPrecision)
```
    Sets a default precision for FieldType.BIG_INTEGER (default 20).
    This value will be used if no precision is specified for BIG_INTEGER fields.
  - getDefaultBigDecimalPrecision
```
public Integer getDefaultBigDecimalPrecision()
```
    Returns the default precision of FieldType.BIG_DECIMAL (default 20).
  - setDefaultBigDecimalPrecision
```
public CreateMySqlDdlFromSchemaDef setDefaultBigDecimalPrecision(int defaultBigDecimalPrecision)
```
    Sets a default precision for FieldType.BIG_DECIMAL.
    This value will be used if no precision is specified for BIG_DECIMAL fields (default 20).
  - getDefaultBigDecimalScale
```
public Integer getDefaultBigDecimalScale()
```
    Sets the default scale of FieldType.BIG_DECIMAL (default 5).
  - setDefaultBigDecimalScale
```
public CreateMySqlDdlFromSchemaDef setDefaultBigDecimalScale(Integer defaultBigDecimalScale)
```
    Sets a default scale for FieldType.BIG_DECIMAL (default 5).
    This value will be used if no scale is specified for BIG_DECIMAL fields.

Class CreateMySqlDdlFromSchemaDef

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.sql.mysql.MySqlPart

Methods inherited from class com.northconcepts.datapipeline.jdbc.sql.SqlPart

Methods inherited from class java.lang.Object

Constructor Detail

CreateMySqlDdlFromSchemaDef

Method Detail

collectSqlFragment

getSchemaDef

isGenerateIndexes

setGenerateIndexes

isGenerateRelationships

setGenerateRelationships

isCheckIfTableNotExists

setCheckIfTableNotExists

isCheckIfDropTableExists

setCheckIfDropTableExists

getEntityNames

setEntityNames

setEntityNames

setPretty

isDropTable

setDropTable

getDefaultBigIntegerPrecision

setDefaultBigIntegerPrecision

getDefaultBigDecimalPrecision

setDefaultBigDecimalPrecision

getDefaultBigDecimalScale

setDefaultBigDecimalScale