Package org.pgcodekeeper.core.database.api.schema

Interface IOptionContainer

All Superinterfaces:

IStatement

All Known Subinterfaces:

IIndex, ISimpleOptionContainer, PgForeignOptionContainer

All Known Implementing Classes:

ChIndex, ChTable, ChTableLog, GpExternalTable, GpPartitionTable, MsConstraintPk, MsIndex, MsTable, PgAbstractForeignTable, PgAbstractRegularTable, PgAbstractTable, PgAbstractView, PgColumn, PgForeignDataWrapper, PgFtsDictionary, PgIndex, PgMaterializedView, PgPartitionForeignTable, PgPartitionTable, PgServer, PgSimpleForeignTable, PgSimpleTable, PgTypedTable, PgUserMapping, PgView

public interface IOptionContainer
extends IStatement

Interface for database objects that support storage and configuration options. Provides functionality for managing key-value option pairs.

Method Summary

Modifier and Type	Method	Description
void	addOption(String key, String value)	Adds an option to this container.
void	compareOptions(IOptionContainer newContainer, SQLScript script)	Compares options between this container and a new container, generating SQL to update differences.
Map<String,String>	getOptions()	Gets all options for this container.

Methods inherited from interface org.pgcodekeeper.core.database.api.schema.IStatement

addDependency, appendAlterSQL, appendOwnerSQL, canDrop, canDropBeforeCreate, clearPrivileges, compare, deepCopy, formatSql, getAuthor, getBareName, getChildren, getComment, getCreationSQL, getDatabase, getDependencies, getDescendants, getDropSQL, getLibName, getLocation, getName, getOwner, getParent, getPrivileges, getQualifiedName, getQuotedName, getQuoter, getRenameCommand, getSeparator, getSQL, getStatementType, getTwin, getTypeName, hasChildren, isLib, isOwned, quote, setComment, setLibName, setLocation, setOwner, shallowCopy, toObjectReference

Method Details

addOption

void addOption(String key,
 String value)

Adds an option to this container.

Parameters:

key - the option key

value - the option value

getOptions

Map<String,String> getOptions()

Gets all options for this container.

Returns:

a map of option keys to values

compareOptions

void compareOptions(IOptionContainer newContainer,
 SQLScript script)

Compares options between this container and a new container, generating SQL to update differences.

Parameters:

newContainer - the new container to compare against

script - the script to append changes to