public final class FbConnectionProperties extends AbstractAttachProperties<IConnectionProperties> implements IConnectionProperties
IConnectionProperties
FbImmutableConnectionProperties
DEFAULT_BUFFERS_NUMBER, DEFAULT_DIALECT
DEFAULT_CONNECT_TIMEOUT, DEFAULT_PORT, DEFAULT_SERVER_NAME, DEFAULT_SO_TIMEOUT, DEFAULT_SOCKET_BUFFER_SIZE
Constructor and Description |
---|
FbConnectionProperties()
Default constructor for FbConnectionProperties
|
FbConnectionProperties(IConnectionProperties src)
Copy constructor for FbConnectionProperties.
|
Modifier and Type | Method and Description |
---|---|
IConnectionProperties |
asImmutable() |
IConnectionProperties |
asNewMutable() |
protected void |
dirtied()
Called by setters if they have been called.
|
void |
fromDpb(DatabaseParameterBuffer dpb)
Deprecated.
TODO: This method is only intended to simplify migration of the protocol implementation and needs to be removed.
|
java.lang.String |
getAttachObjectName() |
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.
|
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. |
getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getPassword, getPortNumber, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getUser, getWireCrypt, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setPassword, setPortNumber, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setUser, setWireCrypt
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getCharSet, getConnectTimeout, getDbCryptConfig, getEncoding, getPassword, getPortNumber, getRoleName, getServerName, getSocketBufferSize, getSoTimeout, getUser, getWireCrypt, setCharSet, setConnectTimeout, setDbCryptConfig, setEncoding, setPassword, setPortNumber, setRoleName, setServerName, setSocketBufferSize, setSoTimeout, setUser, setWireCrypt
public FbConnectionProperties(IConnectionProperties src)
All properties defined in IConnectionProperties
are
copied from src
to the new instance.
src
- Source to copy frompublic FbConnectionProperties()
public java.lang.String getDatabaseName()
getDatabaseName
in interface IConnectionProperties
public void setDatabaseName(java.lang.String databaseName)
setDatabaseName
in interface IConnectionProperties
databaseName
- Name or alias of the databasepublic java.lang.String getAttachObjectName()
getAttachObjectName
in interface IAttachProperties<IConnectionProperties>
public short getConnectionDialect()
IConnectionProperties
NOTE: Implementer should take care to return IConnectionProperties.DEFAULT_DIALECT
if
the value hasn't been set yet.
getConnectionDialect
in interface IConnectionProperties
public void setConnectionDialect(short connectionDialect)
IConnectionProperties
NOTE: Implementer should take care to use IConnectionProperties.DEFAULT_DIALECT
if the
value hasn't been set yet.
setConnectionDialect
in interface IConnectionProperties
connectionDialect
- SQL dialect of the client.public int getPageCacheSize()
IConnectionProperties
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 IConnectionProperties.DEFAULT_BUFFERS_NUMBER
if
the value hasn't been set yet.
getPageCacheSize
in interface IConnectionProperties
public void setPageCacheSize(int pageCacheSize)
IConnectionProperties
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 IConnectionProperties.DEFAULT_BUFFERS_NUMBER
if
the value hasn't been set yet.
setPageCacheSize
in interface IConnectionProperties
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.public void setResultSetDefaultHoldable(boolean holdable)
IConnectionProperties
ResultSet
should be ResultSet.HOLD_CURSORS_OVER_COMMIT
by default.setResultSetDefaultHoldable
in interface IConnectionProperties
holdable
- true
ResultSets are holdable, false
(default) ResultSets are ResultSet.CLOSE_CURSORS_AT_COMMIT
public boolean isResultSetDefaultHoldable()
IConnectionProperties
isResultSetDefaultHoldable
in interface IConnectionProperties
true
ResultSets by default are ResultSet.HOLD_CURSORS_OVER_COMMIT
,
false
(default), ResultSets
are ResultSet.CLOSE_CURSORS_AT_COMMIT
public void setColumnLabelForName(boolean columnLabelForName)
IConnectionProperties
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.
setColumnLabelForName
in interface IConnectionProperties
columnLabelForName
- false
JDBC compliant behavior (columnName
is returned), true
compatibility option (columnLabel
is returned)public boolean isColumnLabelForName()
IConnectionProperties
columnLabelForName
isColumnLabelForName
in interface IConnectionProperties
false
JDBC compliant behavior (columnName
is returned), true
compatibility option (columnLabel
is returned)IConnectionProperties.setColumnLabelForName(boolean)
public DatabaseParameterBuffer getExtraDatabaseParameters()
IConnectionProperties
An immutable instance of IConnectionProperties
must return a copy.
getExtraDatabaseParameters
in interface IConnectionProperties
public IConnectionProperties asImmutable()
asImmutable
in interface IAttachProperties<IConnectionProperties>
asImmutable
in interface IConnectionProperties
IConnectionProperties
public IConnectionProperties asNewMutable()
asNewMutable
in interface IAttachProperties<IConnectionProperties>
asNewMutable
in interface IConnectionProperties
IConnectionProperties
with all properties
copied.@Deprecated public void fromDpb(DatabaseParameterBuffer dpb) throws java.sql.SQLException
Unsupported or unknown properties are ignored.
dpb
- Database parameter bufferjava.sql.SQLException
protected void dirtied()
AbstractAttachProperties
dirtied
in class AbstractAttachProperties<IConnectionProperties>
Copyright © 2001-2021 Jaybird (Firebird JDBC/JCA) team. All rights reserved.