RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
ConnectionProperties Class

Names of connection properties supported by Blackfish SQL driver.

Pascal
ConnectionProperties = class;
C++
class ConnectionProperties;

ConnectionProperties.cs

This class specifies the names of connection properties supported by the Blackfish SQL driver. These constants can be used to ensure that an application is using the correct name for a property. Connection properties should be combined with semicolons into a string, which is used for the ConnectionString property. 

This table contains connection property names.

Name 
Description 
User  
User name for Connection.  
Password for Connection.  
Amount of time in milliseconds to wait for a lock before timing out. Default is 30,000 milliseconds.  
Specifies maximum amount of time in milliseconds the readOnlyTx connection's view of the data can be shared with other read-only transactions. Default is 5,000 milliseconds. This enables the system to optimize by allowing multiple connections to share the same view (cached data). This also controls how "out of date" the readOnly view of the data is for a readOnly transaction. A value of 0 indicates there should be no delay or sharing of the cached view.  
Create a connections with read-only transactions. When set to true, only read access is allowed for this connection. Only committed data is seen. Other connections can write to the same database without being blocked by reads from this connection. Default is false.  
Open database in read-only mode. When set, only read access is allowed. Unlike ReadOnlyTx, this property prevents any connection from performing any write operation to the database. This setting is ideal for databases that reside on read-only devices such as a CD-ROM.  
Disable row locks for the specified tables. List of comma separated names of tables that the lock manager should use table locks instead of row locks. A value of "*" disables row locks for all tables.  
Enable logging for the specified events. This property can be set to one of two types of values: 1) List of comma separated LogFilter String values. 2) The string representation of the one or more LogFilterCodes that have been ORed together before converted to a String value.  
Set the maximal number of row locks per table. If the number of acquired row locks exceeds this number for a table, the lock manager escalates to a table lock. Default is 50.  
Set to true to create the database that is being opened if it does not already exist. Default is false.  
This property is currently only supported for Java applications. This property allows you to control the behavior when one or more databases fail during a two-phase commit. When XA transactions are prepared but not finished (no commit or rollback), you can specify one of three possible string settings for this property:

  • commit: causes the transaction to be heuristically committed when DataStore reopens the database.
  • rollback: causes the transaction to be heuristically rolled back when DataStore reopens the database.
  • none: causes DataStore to keep the transaction state when reopening a database. When this option is used, the locks that were held when the transaction was prepared are reacquired and held until the transaction is committed or rolled back by a JTA /JTS-compliant transaction manager.

 

If true, causes a Blackfish SQL Server to close all open databases and shutdown.  
If true, pings the server without creating a connection.  
Fileio  
This property only affects Java servers file IO. This is used to specify the file IO APIs used for database and log files. This property can be set to new or native. Setting this property can improve performance, but new works only for JDK 1.4 platforms and native is currently only implemented for Win32 platforms. See com.borland.datastore.cons.FileIO for more details.  
Specifies file name of database to open.  
Host  
Specify host server to connect to.  
Port  
Specify port to communicate with a remote server. Default is 2508.  
Add extra columns to metadata requests. This property only affects Java drivers. When this boolean property is set to true, additional columns of information for java.sql.DatabaseMetaData methods like view source for views and additional metadata columns for tables are provided.  
Specify network protocol to access server. The possible values are the strings: TCP and InProcess. Default is InProcess.  
Optional remarks explaining reason for this connection.  
Commit active transaction when connection is closed. Default is true.  
Create a connection pool. Set this to false if no connection pool is wanted. Default is true.  
Maximum number of connections in connection pool. Default is 20.  
Initial number of connections created in a new connection pool. Default is 1.  
Maximum time (in seconds) to wait for a free connection from the pool. Default is 1.  
File name of a prior version of database. This can be used to open the current database. Currently this is only used to open encrypted databases that have been damaged from the crash recovery of an encrypted database. There is also a DataStoreConnection.setPriorFileName. Note that the prior database is only used to decrypt the user table that is not supposed to be encrypted in the first place. If user connecting does not have startup rights in both the prior and current database, the prior database is not used for the open operation. Once the database affected by this defect has been opened, it should be copied or packed into a new database file.  

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!