com.aquafold.openapi.rdbms
Interface AQScriptOptions

public interface AQScriptOptions

The AQScriptOption object defines parameters for generating DDL scripts within AquaScript environment.

Method Summary

void	forCreateFull() Enables options required to script a complete CREATE statement.
boolean	getIncludeComments() Returns true if comments should be included in the script.
boolean	getIncludeIndexesTriggers() Returns true if CREATE statement should include table indexes and triggers, if applicable.
boolean	getIncludePermissions() Returns true if CREATE statement should include permissions, if applicable.
boolean	getIncludeStorage() Returns true if CREATE statement should include storage, if applicable.
boolean	getIncludeTableConstraintNames() Returns true if the table constraint names should be included.
boolean	getIncludeTableConstraints() Returns true if the table constraints should be included.
String	getLeadingQuoteIdentifier() Returns the leading quote identifier string.
String	getLineSeparator() Returns the current line separator string.
boolean	getQualifyObject() Returns either true or false, indicating whether the qualify object value is set or cleared.
boolean	getSortTableColumns() Returns true if table columns should be sorted by name.
String	getStatementSeparator() Returns the current statement separator string.
String	getTrailingQuoteIdentifier() Returns the trailing quote identifier string.
void	setIncludeComments(boolean include) Defines whether comments should be included in the script.
void	setIncludeIndexesTriggers(boolean include) Defines whether CREATE statement should include table indexes and triggers, if applicable.
void	setIncludePermissions(boolean include) Defines whether CREATE statement should include permissions, if applicable.
void	setIncludeStorage(boolean include) Defines whether CREATE statement should include storage, if applicable.
void	setIncludeTableConstraintNames(boolean include) Sets the flag to include or exclude the table constraint names.
void	setIncludeTableConstraints(boolean include) Sets the flag to include or exclude the table constraints.
void	setLineSeparator(String separator) Sets the default line separator string (null value is acceptable).
void	setQualifyObject(boolean qualifyObject) Sets the flag to include or exclude the name of the schema in the generation of scripts for the database object.
void	setQuoteIdentifier(String identifier) Sets the leading and trailing quote identifier strings at the same time (null value is acceptable).
void	setQuoteIdentifier(String leading, String trailing) Sets leading and trailing quote identifier strings (null values are acceptable).
void	setSortTableColumns(boolean sort) Defines whether table columns should be sorted by name.
void	setStatementSeparator(String separator) Sets statement separator string (null value is acceptable).

Method Detail

forCreateFull

void forCreateFull()

Enables options required to script a complete CREATE statement.

setIncludeComments

void setIncludeComments(boolean include)

Defines whether comments should be included in the script. Default value is true.

Parameters:

include -

getIncludeComments

boolean getIncludeComments()

Returns true if comments should be included in the script.

setSortTableColumns

void setSortTableColumns(boolean sort)

Defines whether table columns should be sorted by name. This option only affects script generated for AQIndex and AQTable objects.

Default value is false.

Parameters:

sort -

getSortTableColumns

boolean getSortTableColumns()

Returns true if table columns should be sorted by name. This option only affects script generated for AQIndex and AQTable objects.

setIncludeIndexesTriggers

void setIncludeIndexesTriggers(boolean include)

Defines whether CREATE statement should include table indexes and triggers, if applicable. This option only affects script generated for AQIndex and AQTable objects.

Default value is false.

Parameters:

include -

getIncludeIndexesTriggers

boolean getIncludeIndexesTriggers()

Returns true if CREATE statement should include table indexes and triggers, if applicable. This option only affects script generated for AQIndex and AQTable objects.

setIncludePermissions

void setIncludePermissions(boolean include)

Defines whether CREATE statement should include permissions, if applicable. This option only affects script generated for AQIndex and AQTable objects.

Default value is false.

Parameters:

include -

getIncludePermissions

boolean getIncludePermissions()

Returns true if CREATE statement should include permissions, if applicable. This option only affects script generated for AQIndex and AQTable objects.

setIncludeStorage

void setIncludeStorage(boolean include)

Defines whether CREATE statement should include storage, if applicable. This option only affects script generated for AQIndex and AQTable objects.

Default value is false.

Parameters:

include -

getIncludeStorage

boolean getIncludeStorage()

Returns true if CREATE statement should include storage, if applicable. This option only affects script generated for AQIndex and AQTable objects.

setStatementSeparator

void setStatementSeparator(String separator)

Sets statement separator string (null value is acceptable).

Parameters:

separator - The statement separator.

getStatementSeparator

String getStatementSeparator()

Returns the current statement separator string.

Returns:

The statement separator.

setLineSeparator

void setLineSeparator(String separator)

Sets the default line separator string (null value is acceptable). Default value is "\n".

Parameters:

separator - The string representing the line separator.

getLineSeparator

String getLineSeparator()

Returns the current line separator string.

Returns:

The string representing the line separator.

setQuoteIdentifier

void setQuoteIdentifier(String leading,
                        String trailing)

Sets leading and trailing quote identifier strings (null values are acceptable). Default value for both strings are null.

Parameters:

leading - A string representing the leading quote identifier.

trailing - A string representing the trailing quote identifier.

setQuoteIdentifier

void setQuoteIdentifier(String identifier)

Sets the leading and trailing quote identifier strings at the same time (null value is acceptable).

Parameters:

identifier - A string representing both the leading and trailing quote identifier.

getLeadingQuoteIdentifier

String getLeadingQuoteIdentifier()

Returns the leading quote identifier string.

Returns:

The string representing the leading quote identifier.

getTrailingQuoteIdentifier

String getTrailingQuoteIdentifier()

Returns the trailing quote identifier string.

Returns:

The string representing the trailing quote identifier.

setQualifyObject

void setQualifyObject(boolean qualifyObject)

Sets the flag to include or exclude the name of the schema in the generation of scripts for the database object.

Parameters:

qualifyObject - If value is set to true, then include the schema name in the script; otherwise setting the value to false will exclude schema name in the script.

getQualifyObject

boolean getQualifyObject()

Returns either true or false, indicating whether the qualify object value is set or cleared. The qualify object flag indicates whether the name of the schema is included or excluded during the generation of the scripts for all database objects within a session.

Returns:

true or false; the default value is true unless it's explicitly set to false.

setIncludeTableConstraints

void setIncludeTableConstraints(boolean include)

Sets the flag to include or exclude the table constraints.

Parameters:

include -

getIncludeTableConstraints

boolean getIncludeTableConstraints()

Returns true if the table constraints should be included.

setIncludeTableConstraintNames

void setIncludeTableConstraintNames(boolean include)

Sets the flag to include or exclude the table constraint names.

Parameters:

include -

getIncludeTableConstraintNames

boolean getIncludeTableConstraintNames()

Returns true if the table constraint names should be included.