DBMS (Jailer Subsetter API)

java.lang.Object
- net.sf.jailer.configuration.DBMS

```
public class DBMS
extends Object
```
Describes a specific DBMS.

Author:

Ralf Wisser

Field Summary

Fields
Modifier and Type	Field and Description
`static DBMS`	`CLOADSCAPE`
`static DBMS`	`DB2`
`static DBMS`	`DB2_ZOS`
`static DBMS`	`DERBY`
`static DBMS`	`FIREBIRD`
`static DBMS`	`H2`
`static DBMS`	`HSQL`
`static DBMS`	`INFORMIX`
`static DBMS`	`MSSQL`
`static DBMS`	`MySQL`
`static DBMS`	`ORACLE`
`static DBMS`	`POSTGRESQL`
`static DBMS`	`SQLITE`
`static DBMS`	`SYBASE`

Constructor Summary

Constructors
Constructor and Description

DBMS()
Default constructor.

DBMS(DBMS other)
Copy constructor.

Constructors
Constructor and Description
`DBMS()` Default constructor.
`DBMS(DBMS other)` Copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`convertToStringLiteral(String string)` Converts a string to a string literal according to the `getStringLiteralEscapeSequences()`.
`SimpleDateFormat`	`createDateFormat()`
`SimpleDateFormat`	`createTimestampFormat()`
`boolean`	`equals(Object obj)`
`static DBMS`	`forDBMS(String dbmsId)` Gets DBMS specific configuration.
`String`	`getBinaryPattern()`
`String`	`getDatePattern()`
`String`	`getDisplayName()`
`int`	`getEmbeddedLobSizeLimit()`
`String`	`getEmptyBLOBValue()`
`String`	`getEmptyCLOBValue()`
`String`	`getEmptyNCLOBValue()`
`Set<String>`	`getExportBlocks()`
`String`	`getId()`
`String`	`getIdentifierQuoteString()`
`String`	`getImportedKeysQuery()`
`String`	`getIndexInfoQuery()`
`Map<String,String>`	`getJdbcProperties()` Gets the JDBC properties.
`String`	`getNcharPrefix()`
`String`	`getNullableContraint()`
`String`	`getPrimaryKeysQuery()`
`String`	`getRowidName()`
`String`	`getRowidType()`
`DefaultTemporaryTableManager`	`getSessionTemporaryTableManager()`
`SQLDialect`	`getSqlDialect()`
`String`	`getSqlLimitSuffix()`
`SqlScriptBasedStatisticRenovator`	`getStatisticRenovator()` Gets the `SqlScriptBasedStatisticRenovator`.
`Map<String,String>`	`getStringLiteralEscapeSequences()` Gets replacement map for special characters in string literals.
`Boolean`	`getSupportsSchemasInIndexDefinitions()`
`String`	`getTableProperties()`
`String`	`getTestQuery()`
`String`	`getTimestampPattern()`
`String`	`getToBlob()`
`String`	`getToClob()`
`String`	`getToNClob()`
`DefaultTemporaryTableManager`	`getTransactionTemporaryTableManager()`
`Map<String,String>`	`getTypeReplacement()` Gets replacement map for column types used for DDL generation.
`String`	`getUrlPattern()`
`String`	`getUserDefinedColumnsQuery()`
`Integer`	`getVarcharLengthLimit()`
`String`	`getVirtualColumnsQuery()`
`int`	`hashCode()`
`boolean`	`isAvoidLeftJoin()`
`boolean`	`isIdentityInserts()`
`boolean`	`isUseInlineViewsInDataBrowser()`
`void`	`setAvoidLeftJoin(boolean avoidLeftJoin)`
`void`	`setBinaryPattern(String binaryPattern)`
`void`	`setDatePattern(String datePattern)`
`void`	`setDisplayName(String displayName)`
`void`	`setEmbeddedLobSizeLimit(int embeddedLobSizeLimit)`
`void`	`setEmptyBLOBValue(String emptyBLOBValue)`
`void`	`setEmptyCLOBValue(String emptyCLOBValue)`
`void`	`setEmptyNCLOBValue(String emptyNCLOBValue)`
`void`	`setExportBlocks(Set<String> exportBlocks)`
`void`	`setId(String id)`
`void`	`setIdentifierQuoteString(String identifierQuoteString)`
`void`	`setIdentityInserts(boolean identityInserts)`
`void`	`setImportedKeysQuery(String importedKeysQuery)`
`void`	`setIndexInfoQuery(String indexInfoQuery)`
`void`	`setJdbcProperties(Map<String,String> jdbcProperties)` Sets the JDBC properties.
`void`	`setNcharPrefix(String ncharPrefix)`
`void`	`setNullableContraint(String nullableContraint)`
`void`	`setPrimaryKeysQuery(String primaryKeysQuery)`
`void`	`setRowidName(String rowidName)`
`void`	`setRowidType(String rowidType)`
`void`	`setSessionTemporaryTableManager(DefaultTemporaryTableManager tableManager)` Sets manager for session local temporary tables.
`void`	`setSqlDialect(SQLDialect sqlDialect)`
`void`	`setSqlLimitSuffix(String sqlLimitSuffix)`
`void`	`setStatisticRenovator(SqlScriptBasedStatisticRenovator statisticRenovator)` Sets the `SqlScriptBasedStatisticRenovator`.
`void`	`setStringLiteralEscapeSequences(Map<String,String> stringLiteralEscapeSequences)` Sets replacement map for special characters in string literals.
`void`	`setSupportsSchemasInIndexDefinitions(Boolean supportsSchemasInIndexDefinitions)`
`void`	`setTableProperties(String tableProperties)`
`void`	`setTestQuery(String testQuery)`
`void`	`setTimestampPattern(String timestampPattern)`
`void`	`setToBlob(String toBlob)`
`void`	`setToClob(String toClob)`
`void`	`setToNClob(String toNClob)`
`void`	`setTransactionTemporaryTableManager(DefaultTemporaryTableManager tableManager)` Sets manager for transaction local temporary tables.
`void`	`setTypeReplacement(Map<String,String> tr)` Sets replacement map for column types used for DDL generation.
`void`	`setUrlPattern(String urlPattern)` Sets DB-URL pattern of DBMS for which this holds the configuration.
`void`	`setUseInlineViewsInDataBrowser(boolean useInlineViewsInDataBrowser)`
`void`	`setUserDefinedColumnsQuery(String userDefinedColumnsQuery)`
`void`	`setVarcharLengthLimit(Integer varcharLengthLimit)`
`void`	`setVirtualColumnsQuery(String virtualColumnsQuery)`
`static DBMS[]`	`values()` Gets all DBMSes.

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

Field Detail

ORACLE
```
public static final DBMS ORACLE
```

MSSQL
```
public static final DBMS MSSQL
```

DB2
```
public static final DBMS DB2
```

DB2_ZOS
```
public static final DBMS DB2_ZOS
```

MySQL
```
public static final DBMS MySQL
```

POSTGRESQL
```
public static final DBMS POSTGRESQL
```

SQLITE
```
public static final DBMS SQLITE
```

HSQL
```
public static final DBMS HSQL
```

H2
```
public static final DBMS H2
```

SYBASE
```
public static final DBMS SYBASE
```

INFORMIX
```
public static final DBMS INFORMIX
```

CLOADSCAPE
```
public static final DBMS CLOADSCAPE
```

FIREBIRD
```
public static final DBMS FIREBIRD
```

DERBY
```
public static final DBMS DERBY
```

Constructor Detail
- DBMS
```
public DBMS()
```
  Default constructor.
- DBMS
```
public DBMS(DBMS other)
```
  Copy constructor.

Method Detail
- values
```
public static DBMS[] values()
```
  Gets all DBMSes.
  
  Returns:
  array of all DBMSes
- forDBMS
```
public static DBMS forDBMS(String dbmsId)
```
  Gets DBMS specific configuration.
  
  Parameters:
  dbmsId - the DBMS id
  
  Returns:
  the DBMS with given id, or the default DBMS if id is null
- getVirtualColumnsQuery
```
public String getVirtualColumnsQuery()
```
  Returns:
  the virtualColumnsQuery
- setVirtualColumnsQuery
```
public void setVirtualColumnsQuery(String virtualColumnsQuery)
```
  Parameters:
  virtualColumnsQuery - the virtualColumnsQuery to set
- isUseInlineViewsInDataBrowser
```
public boolean isUseInlineViewsInDataBrowser()
```
  Returns:
  the useInlineViewsInDataBrowser
- setUseInlineViewsInDataBrowser
```
public void setUseInlineViewsInDataBrowser(boolean useInlineViewsInDataBrowser)
```
  Parameters:
  useInlineViewsInDataBrowser - the useInlineViewsInDataBrowser to set
- getEmbeddedLobSizeLimit
```
public int getEmbeddedLobSizeLimit()
```
  Returns:
  the embeddedLobSizeLimit
- setEmbeddedLobSizeLimit
```
public void setEmbeddedLobSizeLimit(int embeddedLobSizeLimit)
```
  Parameters:
  embeddedLobSizeLimit - the embeddedLobSizeLimit to set
- getSupportsSchemasInIndexDefinitions
```
public Boolean getSupportsSchemasInIndexDefinitions()
```
  Returns:
  the supportsSchemasInIndexDefinitions
- setSupportsSchemasInIndexDefinitions
```
public void setSupportsSchemasInIndexDefinitions(Boolean supportsSchemasInIndexDefinitions)
```
  Parameters:
  supportsSchemasInIndexDefinitions - the supportsSchemasInIndexDefinitions to set
- getRowidName
```
public String getRowidName()
```
  Returns:
  the rowidName
- setRowidName
```
public void setRowidName(String rowidName)
```
  Parameters:
  rowidName - the rowidName to set
- getRowidType
```
public String getRowidType()
```
  Returns:
  the rowidType
- setRowidType
```
public void setRowidType(String rowidType)
```
  Parameters:
  rowidType - the rowidType to set
- getSqlDialect
```
public SQLDialect getSqlDialect()
```
  Returns:
  the sqlDialect
- setSqlDialect
```
public void setSqlDialect(SQLDialect sqlDialect)
```
- getUrlPattern
```
public String getUrlPattern()
```
  Returns:
  the urlPattern
- setUrlPattern
```
public void setUrlPattern(String urlPattern)
```
  Sets DB-URL pattern of DBMS for which this holds the configuration.
- getExportBlocks
```
public Set<String> getExportBlocks()
```
- setExportBlocks
```
public void setExportBlocks(Set<String> exportBlocks)
```
- getStatisticRenovator
```
public SqlScriptBasedStatisticRenovator getStatisticRenovator()
```
  Gets the SqlScriptBasedStatisticRenovator.
  
  Returns:
  the SqlScriptBasedStatisticRenovator
- setStatisticRenovator
```
public void setStatisticRenovator(SqlScriptBasedStatisticRenovator statisticRenovator)
```
  Sets the SqlScriptBasedStatisticRenovator.
  
  Parameters:
  statisticRenovator - the SqlScriptBasedStatisticRenovator
- setEmptyCLOBValue
```
public void setEmptyCLOBValue(String emptyCLOBValue)
```
- setEmptyBLOBValue
```
public void setEmptyBLOBValue(String emptyBLOBValue)
```
- setBinaryPattern
```
public void setBinaryPattern(String binaryPattern)
```
- setTypeReplacement
```
public void setTypeReplacement(Map<String,String> tr)
```
  Sets replacement map for column types used for DDL generation.
- getToBlob
```
public String getToBlob()
```
  Returns:
  the toBlob
- setToBlob
```
public void setToBlob(String toBlob)
```
  Parameters:
  toBlob - the toBlob to set
- getToClob
```
public String getToClob()
```
  Returns:
  the toClob
- setToClob
```
public void setToClob(String toClob)
```
  Parameters:
  toClob - the toClob to set
- getTypeReplacement
```
public Map<String,String> getTypeReplacement()
```
  Gets replacement map for column types used for DDL generation.
- setSessionTemporaryTableManager
```
public void setSessionTemporaryTableManager(DefaultTemporaryTableManager tableManager)
```
  Sets manager for session local temporary tables.
- setTransactionTemporaryTableManager
```
public void setTransactionTemporaryTableManager(DefaultTemporaryTableManager tableManager)
```
  Sets manager for transaction local temporary tables.
- isIdentityInserts
```
public boolean isIdentityInserts()
```
- setIdentityInserts
```
public void setIdentityInserts(boolean identityInserts)
```
- setStringLiteralEscapeSequences
```
public void setStringLiteralEscapeSequences(Map<String,String> stringLiteralEscapeSequences)
```
  Sets replacement map for special characters in string literals.
- getStringLiteralEscapeSequences
```
public Map<String,String> getStringLiteralEscapeSequences()
```
  Gets replacement map for special characters in string literals.
- convertToStringLiteral
```
public String convertToStringLiteral(String string)
```
  Converts a string to a string literal according to the getStringLiteralEscapeSequences().
  
  Parameters:
  string - the string to convert
  
  Returns:
  the string literal
- isAvoidLeftJoin
```
public boolean isAvoidLeftJoin()
```
- setAvoidLeftJoin
```
public void setAvoidLeftJoin(boolean avoidLeftJoin)
```
- setSqlLimitSuffix
```
public void setSqlLimitSuffix(String sqlLimitSuffix)
```
  Parameters:
  sqlLimitSuffix - the sqlLimitSuffix to set
- getSqlLimitSuffix
```
public String getSqlLimitSuffix()
```
  Returns:
  the sqlLimitSuffix
- getVarcharLengthLimit
```
public Integer getVarcharLengthLimit()
```
- setVarcharLengthLimit
```
public void setVarcharLengthLimit(Integer varcharLengthLimit)
```
- getTimestampPattern
```
public String getTimestampPattern()
```
  Returns:
  the timestampPattern
- setTimestampPattern
```
public void setTimestampPattern(String timestampPattern)
```
  Parameters:
  timestampPattern - the timestampPattern to set
- createTimestampFormat
```
public SimpleDateFormat createTimestampFormat()
```
  Returns:
  the getTimestampPattern() as SimpleDateFormat.
- getDatePattern
```
public String getDatePattern()
```
  Returns:
  the datePattern
- setDatePattern
```
public void setDatePattern(String datePattern)
```
  Parameters:
  datePattern - the datePattern to set
- createDateFormat
```
public SimpleDateFormat createDateFormat()
```
  Returns:
  the getDatePattern() as SimpleDateFormat.
- getNcharPrefix
```
public String getNcharPrefix()
```
  Returns:
  the ncharPrefix
- setNcharPrefix
```
public void setNcharPrefix(String ncharPrefix)
```
  Parameters:
  ncharPrefix - the ncharPrefix to set
- getTableProperties
```
public String getTableProperties()
```
  Returns:
  the tableProperties
- setTableProperties
```
public void setTableProperties(String tableProperties)
```
  Parameters:
  tableProperties - the tableProperties to set
- getJdbcProperties
```
public Map<String,String> getJdbcProperties()
```
  Gets the JDBC properties.
  
  Returns:
  the jdbcProperties
- setJdbcProperties
```
public void setJdbcProperties(Map<String,String> jdbcProperties)
```
  Sets the JDBC properties.
  
  Parameters:
  jdbcProperties - the jdbcProperties to set
- getIdentifierQuoteString
```
public String getIdentifierQuoteString()
```
  Returns:
  the identifierQuoteString
- setIdentifierQuoteString
```
public void setIdentifierQuoteString(String identifierQuoteString)
```
  Parameters:
  identifierQuoteString - the identifierQuoteString to set
- getTestQuery
```
public String getTestQuery()
```
- setTestQuery
```
public void setTestQuery(String testQuery)
```
- getUserDefinedColumnsQuery
```
public String getUserDefinedColumnsQuery()
```
- setUserDefinedColumnsQuery
```
public void setUserDefinedColumnsQuery(String userDefinedColumnsQuery)
```
- getNullableContraint
```
public String getNullableContraint()
```
  Returns:
  the nullableContraint
- setNullableContraint
```
public void setNullableContraint(String nullableContraint)
```
  Parameters:
  nullableContraint - the nullableContraint to set
- getEmptyNCLOBValue
```
public String getEmptyNCLOBValue()
```
  Returns:
  the emptyNCLOBValue
- setEmptyNCLOBValue
```
public void setEmptyNCLOBValue(String emptyNCLOBValue)
```
  Parameters:
  emptyNCLOBValue - the emptyNCLOBValue to set
- getImportedKeysQuery
```
public String getImportedKeysQuery()
```
  Returns:
  the importedKeysQuery
- setImportedKeysQuery
```
public void setImportedKeysQuery(String importedKeysQuery)
```
  Parameters:
  importedKeysQuery - the importedKeysQuery to set
- getPrimaryKeysQuery
```
public String getPrimaryKeysQuery()
```
  Returns:
  the primaryKeysQuery
- setPrimaryKeysQuery
```
public void setPrimaryKeysQuery(String primaryKeysQuery)
```
  Parameters:
  primaryKeysQuery - the primaryKeysQuery to set
- getIndexInfoQuery
```
public String getIndexInfoQuery()
```
  Returns:
  the indexInfoQuery
- setIndexInfoQuery
```
public void setIndexInfoQuery(String indexInfoQuery)
```
  Parameters:
  indexInfoQuery - the indexInfoQuery to set
- getToNClob
```
public String getToNClob()
```
  Returns:
  the toNClob
- setToNClob
```
public void setToNClob(String toNClob)
```
  Parameters:
  toNClob - the toNClob to set
- getEmptyCLOBValue
```
public String getEmptyCLOBValue()
```
  Returns:
  the emptyCLOBValue
- getEmptyBLOBValue
```
public String getEmptyBLOBValue()
```
  Returns:
  the emptyBLOBValue
- getBinaryPattern
```
public String getBinaryPattern()
```
  Returns:
  the binaryPattern
- getSessionTemporaryTableManager
```
public DefaultTemporaryTableManager getSessionTemporaryTableManager()
```
  Returns:
  the sessionTemporaryTableManager
- getTransactionTemporaryTableManager
```
public DefaultTemporaryTableManager getTransactionTemporaryTableManager()
```
  Returns:
  the transactionTemporaryTableManager
- getId
```
public String getId()
```
- setId
```
public void setId(String id)
```
- getDisplayName
```
public String getDisplayName()
```
- setDisplayName
```
public void setDisplayName(String displayName)
```
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object

Class DBMS

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ORACLE

MSSQL

DB2

DB2_ZOS

MySQL

POSTGRESQL

SQLITE

HSQL

H2

SYBASE

INFORMIX

CLOADSCAPE

FIREBIRD

DERBY

Constructor Detail

DBMS

DBMS

Method Detail

values

forDBMS

getVirtualColumnsQuery

setVirtualColumnsQuery

isUseInlineViewsInDataBrowser

setUseInlineViewsInDataBrowser

getEmbeddedLobSizeLimit

setEmbeddedLobSizeLimit

getSupportsSchemasInIndexDefinitions

setSupportsSchemasInIndexDefinitions

getRowidName

setRowidName

getRowidType

setRowidType

getSqlDialect

setSqlDialect

getUrlPattern

setUrlPattern

getExportBlocks

setExportBlocks

getStatisticRenovator

setStatisticRenovator

setEmptyCLOBValue

setEmptyBLOBValue

setBinaryPattern

setTypeReplacement

getToBlob

setToBlob

getToClob

setToClob

getTypeReplacement

setSessionTemporaryTableManager

setTransactionTemporaryTableManager

isIdentityInserts

setIdentityInserts

setStringLiteralEscapeSequences

getStringLiteralEscapeSequences

convertToStringLiteral

isAvoidLeftJoin

setAvoidLeftJoin

setSqlLimitSuffix

getSqlLimitSuffix

getVarcharLengthLimit

setVarcharLengthLimit

getTimestampPattern

setTimestampPattern

createTimestampFormat

getDatePattern

setDatePattern

createDateFormat

getNcharPrefix

setNcharPrefix

getTableProperties

setTableProperties

getJdbcProperties

setJdbcProperties