Interface IConnectionProperties
- 
- All Superinterfaces:
- IAttachProperties<IConnectionProperties>
 - All Known Implementing Classes:
- FbConnectionProperties,- FbImmutableConnectionProperties
 
 public interface IConnectionProperties extends IAttachProperties<IConnectionProperties> Connection properties for the Firebird connection.TODO Remove overlap/duplication with FirebirdConnectionProperties- Since:
- 3.0
- Author:
- Mark Rotteveel
 
- 
- 
Field SummaryFields Modifier and Type Field Description static intDEFAULT_BUFFERS_NUMBERstatic shortDEFAULT_DIALECTstatic java.lang.StringSESSION_TIME_ZONE_SERVERValue forsessionTimeZonethat indicates the session time zone should not be set and use server default.- 
Fields inherited from interface org.firebirdsql.gds.ng.IAttachPropertiesDEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT, DEFAULT_SERVER_NAME, DEFAULT_SO_TIMEOUT, DEFAULT_SOCKET_BUFFER_SIZE
 
- 
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description IConnectionPropertiesasImmutable()IConnectionPropertiesasNewMutable()shortgetConnectionDialect()Get the dialect of the client connectionjava.lang.StringgetDatabaseName()DatabaseParameterBuffergetExtraDatabaseParameters()Gets the extra database parameters.intgetPageCacheSize()Get the page cache size.java.lang.StringgetSessionTimeZone()Get thesessionTimeZone.booleanisColumnLabelForName()Gets the current setting ofcolumnLabelForNamebooleanisResultSetDefaultHoldable()Get whether ResultSets are holdable by default.voidsetColumnLabelForName(boolean columnLabelForName)Set ifResultSetMetaData.getColumnName(int)returns thecolumnLabelinstead of thecolumnName.voidsetConnectionDialect(short connectionDialect)Set the dialect of the client connectionvoidsetDatabaseName(java.lang.String databaseName)voidsetPageCacheSize(int pageCacheSize)Set the page cache size.voidsetResultSetDefaultHoldable(boolean holdable)Set ifResultSetshould beResultSet.HOLD_CURSORS_OVER_COMMITby default.voidsetSessionTimeZone(java.lang.String sessionTimeZone)Sets thesessionTimeZone.- 
Methods inherited from interface org.firebirdsql.gds.ng.IAttachPropertiesgetAttachObjectName, getAuthPlugins, getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getPassword, getPortNumber, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getUser, getWireCrypt, isWireCompression, setAuthPlugins, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setPassword, setPortNumber, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setUser, setWireCompression, setWireCrypt
 
- 
 
- 
- 
- 
Field Detail- 
SESSION_TIME_ZONE_SERVERstatic final java.lang.String SESSION_TIME_ZONE_SERVER Value forsessionTimeZonethat indicates the session time zone should not be set and use server default.- See Also:
- Constant Field Values
 
 - 
DEFAULT_DIALECTstatic final short DEFAULT_DIALECT - See Also:
- Constant Field Values
 
 - 
DEFAULT_BUFFERS_NUMBERstatic final int DEFAULT_BUFFERS_NUMBER - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getDatabaseNamejava.lang.String getDatabaseName() - Returns:
- Name or alias of the database
 
 - 
setDatabaseNamevoid setDatabaseName(java.lang.String databaseName) - Parameters:
- databaseName- Name or alias of the database
 
 - 
getConnectionDialectshort getConnectionDialect() Get the dialect of the client connectionNOTE: Implementer should take care to return DEFAULT_DIALECTif the value hasn't been set yet.- Returns:
- SQL dialect of the client.
 
 - 
setConnectionDialectvoid setConnectionDialect(short connectionDialect) Set the dialect of the client connectionNOTE: Implementer should take care to use DEFAULT_DIALECTif the value hasn't been set yet.- Parameters:
- connectionDialect- SQL dialect of the client.
 
 - 
getPageCacheSizeint getPageCacheSize() Get the page cache size.A value of 0indicates that the value is not set, and that the server default is used.This option is only relevant for Firebird implementations with per connection cache (eg Classic) NOTE: Implementer should take care to return DEFAULT_BUFFERS_NUMBERif the value hasn't been set yet.- Returns:
- number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances, SuperServer has a server-wide configuration parameter.
 
 - 
setPageCacheSizevoid setPageCacheSize(int pageCacheSize) Set the page cache size.A value of 0indicates that the value is not set, and that the server default is used.This option is only relevant for Firebird implementations with per connection cache (eg Classic) NOTE: Implementer should take care to use DEFAULT_BUFFERS_NUMBERif the value hasn't been set yet.- Parameters:
- pageCacheSize- number of cache buffers that should be allocated for this connection, should be specified for ClassicServer instances, SuperServer has a server-wide configuration parameter.
 
 - 
setResultSetDefaultHoldablevoid setResultSetDefaultHoldable(boolean holdable) Set ifResultSetshould beResultSet.HOLD_CURSORS_OVER_COMMITby default.- Parameters:
- holdable-- trueResultSets are holdable,- false(default) ResultSets are- ResultSet.CLOSE_CURSORS_AT_COMMIT
 
 - 
isResultSetDefaultHoldableboolean isResultSetDefaultHoldable() Get whether ResultSets are holdable by default.- Returns:
- trueResultSets by default are- ResultSet.HOLD_CURSORS_OVER_COMMIT,- false(default), ResultSets are- ResultSet.CLOSE_CURSORS_AT_COMMIT
 
 - 
setColumnLabelForNamevoid setColumnLabelForName(boolean columnLabelForName) Set ifResultSetMetaData.getColumnName(int)returns thecolumnLabelinstead of thecolumnName.The default behaviour (with columnLabelForName=falseis JDBC-compliant. The behavior for valuetrueis to provide compatibility with tools with a wrong expectation.- Parameters:
- columnLabelForName-- falseJDBC compliant behavior (- columnNameis returned),- truecompatibility option (- columnLabelis returned)
 
 - 
isColumnLabelForNameboolean isColumnLabelForName() Gets the current setting ofcolumnLabelForName- Returns:
- falseJDBC compliant behavior (- columnNameis returned),- truecompatibility option (- columnLabelis returned)
- See Also:
- setColumnLabelForName(boolean)
 
 - 
setSessionTimeZonevoid setSessionTimeZone(java.lang.String sessionTimeZone) Sets thesessionTimeZone.- Parameters:
- sessionTimeZone- Firebird 4+ session time zone name (we strongly suggest to use Java compatible names only), use- "server"to use server default time zone (note: conversion will use JVM default time zone)
- Since:
- 4.0
 
 - 
getSessionTimeZonejava.lang.String getSessionTimeZone() Get thesessionTimeZone.- Returns:
- value for sessionTimeZone
- Since:
- 4.0
 
 - 
getExtraDatabaseParametersDatabaseParameterBuffer getExtraDatabaseParameters() Gets the extra database parameters. This can be used to pass extra database parameters that are not directly supported.An immutable instance of IConnectionPropertiesmust return a copy.- Returns:
- DatabaseParameterBuffer instance.
 
 - 
asImmutableIConnectionProperties asImmutable() - Specified by:
- asImmutablein interface- IAttachProperties<IConnectionProperties>
- Returns:
- An immutable version of this instance as an implementation of IConnectionProperties
 
 - 
asNewMutableIConnectionProperties asNewMutable() - Specified by:
- asNewMutablein interface- IAttachProperties<IConnectionProperties>
- Returns:
- A new, mutable, instance as an implementation of IConnectionPropertieswith all properties copied.
 
 
- 
 
-