Public Member Functions | |
ClearWarnings () | |
Clears all warnings reported for this Connection object. | |
Close () | |
Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released. | |
Commit () | |
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection. | |
CommitPrepared (const string transactionid) | |
IZCallableStatement | CreateCallableStatement (const string SQL, TStrings Info) |
Creates a CallableStatement object for calling database stored procedures. | |
IZNotification | CreateNotification (const string Event) |
Creates an object to send/recieve notifications from SQL server. | |
IZPreparedStatement | CreatePreparedStatement (const string SQL, TStrings Info) |
Creates a PreparedStatement object for sending parameterized SQL statements to the database. | |
IZStatement | CreateRegularStatement (TStrings Info) |
Creates a Statement object for sending SQL statements to the database. | |
IZSequence | CreateSequence (const string Sequence, Integer BlockSize) |
Creates a sequence generator object. | |
IZStatement | CreateStatement () |
Creates a Statement object for sending SQL statements to the database. | |
IZStatement | CreateStatementWithParams (TStrings Info) |
Creates a Statement object for sending SQL statements to the database. | |
String | EscapeString (String Value) |
Escape a string so it's acceptable for the Connection's server. | |
Boolean | GetAutoCommit () |
Gets the current auto-commit state. | |
string | GetCatalog () |
Returns the Connection's current catalog name. | |
Integer | GetClientVersion () |
Gets the client's full version number. | |
IZDriver | GetDriver () |
Gets the parent ZDBC driver. | |
Integer | GetHostVersion () |
Gets the host's full version number. | |
IZDatabaseMetadata | GetMetadata () |
Gets the metadata regarding this connection's database. | |
TStrings | GetParameters () |
Gets a connection parameters. | |
TZTransactIsolationLevel | GetTransactionIsolation () |
Gets this Connection's current transaction isolation level. | |
EZSQLWarning | GetWarnings () |
Returns the first warning reported by calls on this Connection. | |
Boolean | IsClosed () |
Tests to see if a Connection is closed. | |
Boolean | IsReadOnly () |
Tests to see if the connection is in read-only mode. | |
string | NativeSQL (const string SQL) |
Converts the given SQL statement into the system's native SQL grammar. | |
Open () | |
Opens a connection to database server with specified parameters. | |
Integer | PingServer () |
Ping Current Connection's server, if client was disconnected, the connection is resumed. | |
IZCallableStatement | PrepareCall (const string SQL) |
Creates a CallableStatement object for calling database stored procedures. | |
IZCallableStatement | PrepareCallWithParams (const string SQL, TStrings Info) |
Creates a CallableStatement object for calling database stored procedures. | |
IZPreparedStatement | PrepareStatement (const string SQL) |
Creates a PreparedStatement object for sending parameterized SQL statements to the database. | |
IZPreparedStatement | PrepareStatementWithParams (const string SQL, TStrings Info) |
Creates a PreparedStatement object for sending parameterized SQL statements to the database. | |
PrepareTransaction (const string transactionid) | |
Rollback () | |
Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection. | |
RollbackPrepared (const string transactionid) | |
SetAutoCommit (Boolean AutoCommit) | |
Sets this connection's auto-commit mode. | |
SetCatalog (const string Catalog) | |
Sets a catalog name in order to select a subspace of this Connection's database in which to work. | |
SetReadOnly (Boolean ReadOnly) | |
Puts this connection in read-only mode as a hint to enable database optimizations. | |
SetTransactionIsolation (TZTransactIsolationLevel Level) | |
Attempts to change the transaction isolation level to the one given. | |
TZDBLibConnection (IZDriver Driver, const string Url, IZDBLibPlainDriver PlainDriver, const string HostName, Integer Port, const string Database, const string User, const string Password, TStrings Info) | |
Constructs this object and assignes the main properties. | |
~TZDBLibConnection () | |
Destroys this object and cleanups the memory. | |
Protected Member Functions | |
CheckDBLibError (TZLoggingCategory LogCategory, const string LogMessage) | |
PDBPROCESS | GetConnectionHandle () |
IZDBLibPlainDriver | GetPlainDriver () |
InternalExecuteStatement (const string SQL) | |
Executes simple statements internally. | |
InternalLogin () | |
Login procedure can be overriden for special settings. | |
RaiseUnsupportedException () | |
Raises unsupported operation exception. | |
StartTransaction () | |
Starts a new transaction. | |
Protected Attributes | |
Boolean | AutoCommit |
Boolean | Closed |
string | Database |
IZDriver | Driver |
PDBPROCESS | FHandle |
IZDBLibPlainDriver | FPlainDriver |
string | HostName |
TStrings | Info |
string | Password |
Integer | Port |
Boolean | ReadOnly |
TZTransactIsolationLevel | TransactIsolationLevel |
string | User |
Private Member Functions | |
InternalSetTransactionIsolation (TZTransactIsolationLevel Level) | |
ReStartTransactionSupport () | |
Starts a transaction support. |
Definition at line 143 of file ZDbcDbLib.pas.
TZDBLibConnection::TZDBLibConnection | ( | IZDriver | Driver, | |
const string | Url, | |||
IZDBLibPlainDriver | PlainDriver, | |||
const string | HostName, | |||
Integer | Port, | |||
const string | Database, | |||
const string | User, | |||
const string | Password, | |||
TStrings | Info | |||
) |
Constructs this object and assignes the main properties.
Driver | the parent ZDBC driver interface. | |
HostName | a name of the host. | |
Port | a port number (0 for default port). | |
Database | a name pof the database. | |
User | a user name. | |
Password | a user password. | |
Info | a string list with extra connection parameters. |
Definition at line 410 of file ZDbcDbLib.pas.
TZDBLibConnection::~TZDBLibConnection | ( | ) |
TZDBLibConnection::CheckDBLibError | ( | TZLoggingCategory | LogCategory, | |
const string | LogMessage | |||
) | [protected] |
TZDBLibConnection::ClearWarnings | ( | ) |
Clears all warnings reported for this Connection
object.
After a call to this method, the method getWarnings
returns null until a new warning is reported for this Connection.
Reimplemented from TZAbstractConnection.
Definition at line 1012 of file ZDbcDbLib.pas.
TZDBLibConnection::Close | ( | ) |
Releases a Connection's database and JDBC resources immediately instead of waiting for them to be automatically released.
Note: A Connection is automatically closed when it is garbage collected. Certain fatal errors also result in a closed Connection.
Reimplemented from TZAbstractConnection.
Definition at line 908 of file ZDbcDbLib.pas.
TZDBLibConnection::Commit | ( | ) |
Makes all changes made since the previous commit/rollback permanent and releases any database locks currently held by the Connection.
This method should be used only when auto-commit mode has been disabled.
Reimplemented from TZAbstractConnection.
Definition at line 870 of file ZDbcDbLib.pas.
TZAbstractConnection::CommitPrepared | ( | const string | transactionid | ) | [inherited] |
Reimplemented from IZConnection.
Reimplemented in TZPostgreSQLConnection.
Definition at line 1111 of file ZDbcConnection.pas.
IZCallableStatement TZDBLibConnection::CreateCallableStatement | ( | const string | SQL, | |
TStrings | Info | |||
) |
Creates a CallableStatement
object for calling database stored procedures.
The CallableStatement
object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.
Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall
is done; others may wait until the CallableStatement
object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.
Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default.
sql | a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string. | |
Info | a statement parameters. |
Reimplemented from TZAbstractConnection.
Definition at line 735 of file ZDbcDbLib.pas.
References P.
IZNotification TZAbstractConnection::CreateNotification | ( | const string | Event | ) | [inherited] |
Creates an object to send/recieve notifications from SQL server.
Event | an event name. |
Reimplemented from IZConnection.
Definition at line 1008 of file ZDbcConnection.pas.
IZPreparedStatement TZDBLibConnection::CreatePreparedStatement | ( | const string | SQL, | |
TStrings | Info | |||
) |
Creates a PreparedStatement
object for sending parameterized SQL statements to the database.
A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.
Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement
will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement
is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.
Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.
sql | a SQL statement that may contain one or more '?' IN parameter placeholders | |
Info | a statement parameters. |
Reimplemented from TZAbstractConnection.
Definition at line 698 of file ZDbcDbLib.pas.
IZStatement TZDBLibConnection::CreateRegularStatement | ( | TStrings | Info | ) |
Creates a Statement
object for sending SQL statements to the database.
SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement
object.
Result sets created using the returned Statement
object will by default have forward-only type and read-only concurrency.
Reimplemented from TZAbstractConnection.
Definition at line 660 of file ZDbcDbLib.pas.
IZSequence TZAbstractConnection::CreateSequence | ( | const string | Sequence, | |
Integer | BlockSize | |||
) | [inherited] |
Creates a sequence generator object.
Sequence | a name of the sequence generator. | |
BlockSize | a number of unique keys requested in one trip to SQL server. |
Reimplemented from IZConnection.
Reimplemented in TZInterbase6Connection, TZOracleConnection, and TZPostgreSQLConnection.
Definition at line 1024 of file ZDbcConnection.pas.
IZStatement TZAbstractConnection::CreateStatement | ( | ) | [inherited] |
Creates a Statement
object for sending SQL statements to the database.
SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement
object.
Result sets created using the returned Statement
object will by default have forward-only type and read-only concurrency.
Reimplemented from IZConnection.
Definition at line 797 of file ZDbcConnection.pas.
IZStatement TZAbstractConnection::CreateStatementWithParams | ( | TStrings | Info | ) | [inherited] |
Creates a Statement
object for sending SQL statements to the database.
SQL statements without parameters are normally executed using Statement objects. If the same SQL statement is executed many times, it is more efficient to use a PreparedStatement
object.
Result sets created using the returned Statement
object will by default have forward-only type and read-only concurrency.
Info | a statement parameters. |
Reimplemented from IZConnection.
Definition at line 820 of file ZDbcConnection.pas.
String TZAbstractConnection::EscapeString | ( | String | Value | ) | [inherited] |
Escape a string so it's acceptable for the Connection's server.
value | string that should be escaped |
Reimplemented from IZConnection.
Reimplemented in TZMySQLConnection.
Definition at line 1163 of file ZDbcConnection.pas.
Boolean TZAbstractConnection::GetAutoCommit | ( | ) | [inherited] |
Gets the current auto-commit state.
Reimplemented from IZConnection.
Definition at line 1088 of file ZDbcConnection.pas.
string TZDBLibConnection::GetCatalog | ( | ) |
Returns the Connection's current catalog name.
Reimplemented from TZAbstractConnection.
Definition at line 984 of file ZDbcDbLib.pas.
Integer TZAbstractConnection::GetClientVersion | ( | ) | [inherited] |
Gets the client's full version number.
Initially this should be 0. The format of the version resturned must be XYYYZZZ where X = Major version YYY = Minor version ZZZ = Sub version
Reimplemented from IZConnection.
Reimplemented in TZMySQLConnection.
Definition at line 1252 of file ZDbcConnection.pas.
PDBPROCESS TZDBLibConnection::GetConnectionHandle | ( | ) | [protected] |
IZDriver TZAbstractConnection::GetDriver | ( | ) | [inherited] |
Gets the parent ZDBC driver.
Reimplemented from IZConnection.
Definition at line 1206 of file ZDbcConnection.pas.
Integer TZAbstractConnection::GetHostVersion | ( | ) | [inherited] |
Gets the host's full version number.
Initially this should be 0. The format of the version returned must be XYYYZZZ where X = Major version YYY = Minor version ZZZ = Sub version
Reimplemented from IZConnection.
Reimplemented in TZMySQLConnection, and TZPostgreSQLConnection.
Definition at line 1268 of file ZDbcConnection.pas.
IZDatabaseMetadata TZAbstractConnection::GetMetadata | ( | ) | [inherited] |
Gets the metadata regarding this connection's database.
A Connection's database is able to provide information describing its tables, its supported SQL grammar, its stored procedures, the capabilities of this connection, and so on. This information is made available through a DatabaseMetaData object.
Reimplemented from IZConnection.
Definition at line 1224 of file ZDbcConnection.pas.
TStrings TZAbstractConnection::GetParameters | ( | ) | [inherited] |
Gets a connection parameters.
Reimplemented from IZConnection.
Definition at line 1236 of file ZDbcConnection.pas.
IZDBLibPlainDriver TZDBLibConnection::GetPlainDriver | ( | ) | [protected] |
TZTransactIsolationLevel TZAbstractConnection::GetTransactionIsolation | ( | ) | [inherited] |
Gets this Connection's current transaction isolation level.
Reimplemented from IZConnection.
Definition at line 1359 of file ZDbcConnection.pas.
EZSQLWarning TZDBLibConnection::GetWarnings | ( | ) |
Returns the first warning reported by calls on this Connection.
Note: Subsequent warnings will be chained to this SQLWarning.
Reimplemented from TZAbstractConnection.
Definition at line 999 of file ZDbcDbLib.pas.
TZDBLibConnection::InternalExecuteStatement | ( | const string | SQL | ) | [protected] |
Executes simple statements internally.
Reimplemented from IZDBLibConnection.
Definition at line 459 of file ZDbcDbLib.pas.
TZDBLibConnection::InternalLogin | ( | ) | [protected] |
Login procedure can be overriden for special settings.
Definition at line 494 of file ZDbcDbLib.pas.
TZDBLibConnection::InternalSetTransactionIsolation | ( | TZTransactIsolationLevel | Level | ) | [private] |
Definition at line 797 of file ZDbcDbLib.pas.
Boolean TZAbstractConnection::IsClosed | ( | ) | [inherited] |
Tests to see if a Connection is closed.
Reimplemented from IZConnection.
Definition at line 1194 of file ZDbcConnection.pas.
Boolean TZAbstractConnection::IsReadOnly | ( | ) | [inherited] |
Tests to see if the connection is in read-only mode.
Reimplemented from IZConnection.
Definition at line 1300 of file ZDbcConnection.pas.
string TZDBLibConnection::NativeSQL | ( | const string | SQL | ) |
Converts the given SQL statement into the system's native SQL grammar.
A driver may convert the JDBC sql grammar into its system's native SQL grammar prior to sending it; this method returns the native form of the statement that the driver would have sent.
sql | a SQL statement that may contain one or more '?' parameter placeholders |
Reimplemented from TZAbstractConnection.
Definition at line 756 of file ZDbcDbLib.pas.
TZDBLibConnection::Open | ( | ) |
Opens a connection to database server with specified parameters.
Reimplemented from TZAbstractConnection.
Definition at line 612 of file ZDbcDbLib.pas.
Integer TZAbstractConnection::PingServer | ( | ) | [inherited] |
Ping Current Connection's server, if client was disconnected, the connection is resumed.
Reimplemented from IZConnection.
Reimplemented in TZInterbase6Connection, TZMySQLConnection, and TZPostgreSQLConnection.
Definition at line 1149 of file ZDbcConnection.pas.
IZCallableStatement TZAbstractConnection::PrepareCall | ( | const string | SQL | ) | [inherited] |
Creates a CallableStatement
object for calling database stored procedures.
The CallableStatement
object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.
Note: This method is optimized for handling stored procedure call statements. Some drivers may send the call statement to the database when the method prepareCall
is done; others may wait until the CallableStatement
object is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.
Result sets created using the returned CallableStatement will have forward-only type and read-only concurrency, by default.
sql | a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string. |
Reimplemented from IZConnection.
Definition at line 953 of file ZDbcConnection.pas.
IZCallableStatement TZAbstractConnection::PrepareCallWithParams | ( | const string | SQL, | |
TStrings | Info | |||
) | [inherited] |
Creates a CallableStatement
object for calling database stored procedures.
The CallableStatement
object provides methods for setting up its IN and OUT parameters, and methods for executing the call to a stored procedure.
SQL | a SQL statement that may contain one or more '?' parameter placeholders. Typically this statement is a JDBC function call escape string. | |
Info | a statement parameters. |
Reimplemented from IZConnection.
Definition at line 976 of file ZDbcConnection.pas.
IZPreparedStatement TZAbstractConnection::PrepareStatement | ( | const string | SQL | ) | [inherited] |
Creates a PreparedStatement
object for sending parameterized SQL statements to the database.
A SQL statement with or without IN parameters can be pre-compiled and stored in a PreparedStatement object. This object can then be used to efficiently execute this statement multiple times.
Note: This method is optimized for handling parametric SQL statements that benefit from precompilation. If the driver supports precompilation, the method prepareStatement
will send the statement to the database for precompilation. Some drivers may not support precompilation. In this case, the statement may not be sent to the database until the PreparedStatement
is executed. This has no direct effect on users; however, it does affect which method throws certain SQLExceptions.
Result sets created using the returned PreparedStatement will have forward-only type and read-only concurrency, by default.
sql | a SQL statement that may contain one or more '?' IN parameter placeholders |
Reimplemented from IZConnection.
Definition at line 872 of file ZDbcConnection.pas.
IZPreparedStatement TZAbstractConnection::PrepareStatementWithParams | ( | const string | SQL, | |
TStrings | Info | |||
) | [inherited] |
Creates a PreparedStatement
object for sending parameterized SQL statements to the database.
SQL | a SQL statement that may contain one or more '?' IN parameter placeholders | |
Info | a statement parameters. |
Reimplemented from IZConnection.
Definition at line 891 of file ZDbcConnection.pas.
TZAbstractConnection::PrepareTransaction | ( | const string | transactionid | ) | [inherited] |
Reimplemented from IZConnection.
Reimplemented in TZPostgreSQLConnection.
Definition at line 901 of file ZDbcConnection.pas.
References P.
TZAbstractConnection::RaiseUnsupportedException | ( | ) | [protected, inherited] |
TZDBLibConnection::ReStartTransactionSupport | ( | ) | [private] |
TZDBLibConnection::Rollback | ( | ) |
Drops all changes made since the previous commit/rollback and releases any database locks currently held by this Connection.
This method should be used only when auto- commit has been disabled.
Reimplemented from TZAbstractConnection.
Definition at line 888 of file ZDbcDbLib.pas.
TZAbstractConnection::RollbackPrepared | ( | const string | transactionid | ) | [inherited] |
Reimplemented from IZConnection.
Reimplemented in TZPostgreSQLConnection.
Definition at line 1135 of file ZDbcConnection.pas.
TZDBLibConnection::SetAutoCommit | ( | Boolean | AutoCommit | ) |
Sets this connection's auto-commit mode.
If a connection is in auto-commit mode, then all its SQL statements will be executed and committed as individual transactions. Otherwise, its SQL statements are grouped into transactions that are terminated by a call to either the method commit
or the method rollback
. By default, new connections are in auto-commit mode.
The commit occurs when the statement completes or the next execute occurs, whichever comes first. In the case of statements returning a ResultSet, the statement completes when the last row of the ResultSet has been retrieved or the ResultSet has been closed. In advanced cases, a single statement may return multiple results as well as output parameter values. In these cases the commit occurs when all results and output parameter values have been retrieved.
autoCommit | true enables auto-commit; false disables auto-commit. |
Reimplemented from TZAbstractConnection.
Definition at line 785 of file ZDbcDbLib.pas.
TZDBLibConnection::SetCatalog | ( | const string | Catalog | ) |
Sets a catalog name in order to select a subspace of this Connection's database in which to work.
If the driver does not support catalogs, it will silently ignore this request.
Reimplemented from TZAbstractConnection.
Definition at line 960 of file ZDbcDbLib.pas.
TZDBLibConnection::SetReadOnly | ( | Boolean | ReadOnly | ) |
Puts this connection in read-only mode as a hint to enable database optimizations.
Note: This method cannot be called while in the middle of a transaction.
readOnly | true enables read-only mode; false disables read-only mode. |
Reimplemented from TZAbstractConnection.
Definition at line 944 of file ZDbcDbLib.pas.
TZDBLibConnection::SetTransactionIsolation | ( | TZTransactIsolationLevel | Level | ) |
Attempts to change the transaction isolation level to the one given.
The constants defined in the interface Connection
are the possible transaction isolation levels.
Note: This method cannot be called while in the middle of a transaction.
level | one of the TRANSACTION_* isolation values with the exception of TRANSACTION_NONE; some databases may not support other values |
Reimplemented from TZAbstractConnection.
Definition at line 833 of file ZDbcDbLib.pas.
TZDBLibConnection::StartTransaction | ( | ) | [protected] |
Boolean TZAbstractConnection::AutoCommit [protected, inherited] |
FAutoCommit For writing
Definition at line 221 of file ZDbcConnection.pas.
Boolean TZAbstractConnection::Closed [protected, inherited] |
string TZAbstractConnection::Database [protected, inherited] |
Definition at line 209 of file ZDbcConnection.pas.
IZDriver TZAbstractConnection::Driver [protected, inherited] |
PDBPROCESS TZDBLibConnection::FHandle [protected] |
Definition at line 158 of file ZDbcDbLib.pas.
IZDBLibPlainDriver TZDBLibConnection::FPlainDriver [protected] |
Definition at line 156 of file ZDbcDbLib.pas.
string TZAbstractConnection::HostName [protected, inherited] |
Definition at line 203 of file ZDbcConnection.pas.
TStrings TZAbstractConnection::Info [protected, inherited] |
string TZAbstractConnection::Password [protected, inherited] |
Definition at line 215 of file ZDbcConnection.pas.
Integer TZAbstractConnection::Port [protected, inherited] |
Boolean TZAbstractConnection::ReadOnly [protected, inherited] |
Definition at line 224 of file ZDbcConnection.pas.
TZTransactIsolationLevel TZAbstractConnection::TransactIsolationLevel [protected, inherited] |
FTransactIsolationLevel For writing
Definition at line 228 of file ZDbcConnection.pas.
string TZAbstractConnection::User [protected, inherited] |