com.northconcepts.datapipeline.sql.postgresql

Class CreateForeignKey

java.lang.Object

com.northconcepts.datapipeline.jdbc.sql.SqlPart

com.northconcepts.datapipeline.sql.postgresql.PostgresSqlPart

com.northconcepts.datapipeline.sql.postgresql.CreateForeignKey

public class CreateForeignKey
extends PostgresSqlPart

Generates an ALTER TABLE...ADD CONSTRAINT statement to add a foreign key constraint in PostgreSQL.

Sample Generated SQL:

ALTER TABLE "products"
ADD CONSTRAINT "fk_products_product_groups" FOREIGN KEY ("product_group_id")
REFERENCES "product_groups"
ON DELETE CASCADE
ON UPDATE CASCADE


Constructor Summary

Constructors

Constructor and Description
CreateForeignKey()
CreateForeignKey(String constraintName, String primaryTableName, String foreignTableName)

Method Summary

Modifier and Type	Method and Description
void	collectSqlFragment(CodeWriter writer)
String	getConstraintName()
List<String>	getForeignKeyColumnNames()
String	getForeignTableName()
ForeignKeyAction	getOnDeleteAction()
ForeignKeyAction	getOnUpdateAction()
List<String>	getPrimaryKeyColumnNames()
String	getPrimaryTableName()
boolean	isCheckIfForeignTableExists() Indicates if IF EXISTS clause should be included in the ALTER TABLE...ADD CONSTRAINT statement (default true).
CreateForeignKey	setCheckIfForeignTableExists(boolean checkIfForeignTableExists) Indicates if IF EXISTS clause should be included in the ALTER TABLE...ADD CONSTRAINT statement (default true).
CreateForeignKey	setConstraintName(String constraintName)
CreateForeignKey	setForeignKeyColumnNames(List<String> foreignKeyColumnNames)
CreateForeignKey	setForeignKeyColumnNames(String... foreignKeyColumnNames)
CreateForeignKey	setForeignTableName(String foreignTableName)
CreateForeignKey	setOnDeleteAction(ForeignKeyAction onDeleteAction)
CreateForeignKey	setOnUpdateAction(ForeignKeyAction onUpdateAction)
CreateForeignKey	setPretty(boolean pretty) Indicates if line breaks and indentations should be added to output DDL (default false). Example output (pretty = true): ALTER TABLE "products" ADD CONSTRAINT "fk_products_product_groups" FOREIGN KEY ("product_group_id") REFERENCES "product_groups" ON DELETE CASCADE ON UPDATE CASCADE Example output (pretty = false): ALTER TABLE "products" ADD CONSTRAINT "fk_products_product_groups" FOREIGN KEY ("product_group_id") REFERENCES "product_groups" ON DELETE CASCADE ON UPDATE CASCADE
CreateForeignKey	setPrimaryKeyColumnNames(List<String> primaryKeyColumnNames)
CreateForeignKey	setPrimaryKeyColumnNames(String... primaryKeyColumnNames)
CreateForeignKey	setPrimaryTableName(String primaryTableName)

Methods inherited from class com.northconcepts.datapipeline.sql.postgresql.PostgresSqlPart

escapeKeyword

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

CreateForeignKey

public CreateForeignKey()

CreateForeignKey

public CreateForeignKey(String constraintName,
                        String primaryTableName,
                        String foreignTableName)

Method Detail

setPretty

public CreateForeignKey setPretty(boolean pretty)

Indicates if line breaks and indentations should be added to output DDL (default false).

Example output (pretty = true):
ALTER TABLE "products"
ADD CONSTRAINT "fk_products_product_groups" FOREIGN KEY ("product_group_id")
REFERENCES "product_groups"
ON DELETE CASCADE
ON UPDATE CASCADE

Example output (pretty = false):
ALTER TABLE "products" ADD CONSTRAINT "fk_products_product_groups" FOREIGN KEY ("product_group_id") REFERENCES "product_groups" ON DELETE CASCADE ON UPDATE CASCADE

Overrides:

setPretty in class SqlPart

collectSqlFragment

public void collectSqlFragment(CodeWriter writer)

Specified by:

collectSqlFragment in class SqlPart

getForeignTableName

public String getForeignTableName()

setForeignTableName

public CreateForeignKey setForeignTableName(String foreignTableName)

getPrimaryTableName

public String getPrimaryTableName()

setPrimaryTableName

public CreateForeignKey setPrimaryTableName(String primaryTableName)

getConstraintName

public String getConstraintName()

setConstraintName

public CreateForeignKey setConstraintName(String constraintName)

isCheckIfForeignTableExists

public boolean isCheckIfForeignTableExists()

Indicates if IF EXISTS clause should be included in the ALTER TABLE...ADD CONSTRAINT statement (default true).

setCheckIfForeignTableExists

public CreateForeignKey setCheckIfForeignTableExists(boolean checkIfForeignTableExists)

Indicates if IF EXISTS clause should be included in the ALTER TABLE...ADD CONSTRAINT statement (default true).

getForeignKeyColumnNames

public List<String> getForeignKeyColumnNames()

setForeignKeyColumnNames

public CreateForeignKey setForeignKeyColumnNames(List<String> foreignKeyColumnNames)

setForeignKeyColumnNames

public CreateForeignKey setForeignKeyColumnNames(String... foreignKeyColumnNames)

getPrimaryKeyColumnNames

public List<String> getPrimaryKeyColumnNames()

setPrimaryKeyColumnNames

public CreateForeignKey setPrimaryKeyColumnNames(List<String> primaryKeyColumnNames)

setPrimaryKeyColumnNames

public CreateForeignKey setPrimaryKeyColumnNames(String... primaryKeyColumnNames)

getOnUpdateAction

public ForeignKeyAction getOnUpdateAction()

setOnUpdateAction

public CreateForeignKey setOnUpdateAction(ForeignKeyAction onUpdateAction)

getOnDeleteAction

public ForeignKeyAction getOnDeleteAction()

setOnDeleteAction

public CreateForeignKey setOnDeleteAction(ForeignKeyAction onDeleteAction)