|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void forCreateFull()
void setIncludeComments(boolean include)
include
- boolean getIncludeComments()
void setSortTableColumns(boolean sort)
AQIndex
and
AQTable
objects.
Default value is false.
sort
- boolean getSortTableColumns()
AQIndex
and
AQTable
objects.
void setIncludeIndexesTriggers(boolean include)
AQIndex
and
AQTable
objects.
Default value is false.
include
- boolean getIncludeIndexesTriggers()
AQIndex
and
AQTable
objects.
void setIncludePermissions(boolean include)
AQIndex
and
AQTable
objects.
Default value is false.
include
- boolean getIncludePermissions()
AQIndex
and
AQTable
objects.
void setIncludeStorage(boolean include)
AQIndex
and
AQTable
objects.
Default value is false.
include
- boolean getIncludeStorage()
AQIndex
and
AQTable
objects.
void setStatementSeparator(String separator)
separator
- The statement separator.String getStatementSeparator()
void setLineSeparator(String separator)
separator
- The string representing the line separator.String getLineSeparator()
void setQuoteIdentifier(String leading, String trailing)
leading
- A string representing the leading quote identifier.trailing
- A string representing the trailing quote identifier.void setQuoteIdentifier(String identifier)
identifier
- A string representing both the leading and trailing quote identifier.String getLeadingQuoteIdentifier()
String getTrailingQuoteIdentifier()
void setQualifyObject(boolean qualifyObject)
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.boolean getQualifyObject()
void setIncludeTableConstraints(boolean include)
include
- boolean getIncludeTableConstraints()
void setIncludeTableConstraintNames(boolean include)
include
- boolean getIncludeTableConstraintNames()
|
OpenAPI 1.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |