public interface IConnectionProperties extends IAttachProperties<IConnectionProperties>
TODO Remove overlap/duplication with FirebirdConnectionProperties
| Modifier and Type | Field and Description |
|---|---|
static int |
DEFAULT_BUFFERS_NUMBER |
static short |
DEFAULT_DIALECT |
static java.lang.String |
SESSION_TIME_ZONE_SERVER
Value for
sessionTimeZone that indicates the session time zone should not be set and use server default. |
DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT, DEFAULT_SERVER_NAME, DEFAULT_SO_TIMEOUT, DEFAULT_SOCKET_BUFFER_SIZE| Modifier and Type | Method and Description |
|---|---|
IConnectionProperties |
asImmutable() |
IConnectionProperties |
asNewMutable() |
short |
getConnectionDialect()
Get the dialect of the client connection
|
java.lang.String |
getDatabaseName() |
DatabaseParameterBuffer |
getExtraDatabaseParameters()
Gets the extra database parameters.
|
int |
getPageCacheSize()
Get the page cache size.
|
java.lang.String |
getSessionTimeZone()
Get the
sessionTimeZone. |
boolean |
isColumnLabelForName()
Gets the current setting of
columnLabelForName |
boolean |
isResultSetDefaultHoldable()
Get whether ResultSets are holdable by default.
|
void |
setColumnLabelForName(boolean columnLabelForName)
Set if
ResultSetMetaData.getColumnName(int) returns the columnLabel instead of the
columnName. |
void |
setConnectionDialect(short connectionDialect)
Set the dialect of the client connection
|
void |
setDatabaseName(java.lang.String databaseName) |
void |
setPageCacheSize(int pageCacheSize)
Set the page cache size.
|
void |
setResultSetDefaultHoldable(boolean holdable)
Set if
ResultSet should be ResultSet.HOLD_CURSORS_OVER_COMMIT by default. |
void |
setSessionTimeZone(java.lang.String sessionTimeZone)
Sets the
sessionTimeZone. |
getAttachObjectName, 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, setWireCryptstatic final java.lang.String SESSION_TIME_ZONE_SERVER
sessionTimeZone that indicates the session time zone should not be set and use server default.static final short DEFAULT_DIALECT
static final int DEFAULT_BUFFERS_NUMBER
java.lang.String getDatabaseName()
void setDatabaseName(java.lang.String databaseName)
databaseName - Name or alias of the databaseshort getConnectionDialect()
NOTE: Implementer should take care to return DEFAULT_DIALECT if
the value hasn't been set yet.
void setConnectionDialect(short connectionDialect)
NOTE: Implementer should take care to use DEFAULT_DIALECT if the
value hasn't been set yet.
connectionDialect - SQL dialect of the client.int getPageCacheSize()
A value of 0 indicates 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_NUMBER if
the value hasn't been set yet.
void setPageCacheSize(int pageCacheSize)
A value of 0 indicates 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_NUMBER if
the value hasn't been set yet.
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.void setResultSetDefaultHoldable(boolean holdable)
ResultSet should be ResultSet.HOLD_CURSORS_OVER_COMMIT by default.holdable - true ResultSets are holdable, false (default) ResultSets are ResultSet.CLOSE_CURSORS_AT_COMMITboolean isResultSetDefaultHoldable()
true ResultSets by default are ResultSet.HOLD_CURSORS_OVER_COMMIT,
false (default), ResultSets
are ResultSet.CLOSE_CURSORS_AT_COMMITvoid setColumnLabelForName(boolean columnLabelForName)
ResultSetMetaData.getColumnName(int) returns the columnLabel instead of the
columnName.
The default behaviour (with columnLabelForName=false is JDBC-compliant. The behavior for value
true is
to provide compatibility with tools with a wrong expectation.
columnLabelForName - false JDBC compliant behavior (columnName is returned), true
compatibility option (columnLabel is returned)boolean isColumnLabelForName()
columnLabelForNamefalse JDBC compliant behavior (columnName is returned), true
compatibility option (columnLabel is returned)setColumnLabelForName(boolean)void setSessionTimeZone(java.lang.String sessionTimeZone)
sessionTimeZone.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)java.lang.String getSessionTimeZone()
sessionTimeZone.sessionTimeZoneDatabaseParameterBuffer getExtraDatabaseParameters()
An immutable instance of IConnectionProperties must return a copy.
IConnectionProperties asImmutable()
asImmutable in interface IAttachProperties<IConnectionProperties>IConnectionPropertiesIConnectionProperties asNewMutable()
asNewMutable in interface IAttachProperties<IConnectionProperties>IConnectionProperties with all properties
copied.Copyright © 2001-2023 Jaybird (Firebird JDBC/JCA) team. All rights reserved.