Show: Delphi C++
Display Preferences

Data.DBXCommon.TDBXPropertyNames

From RAD Studio API Documentation
Jump to: navigation, search

System.TObjectTDBXPropertyNames

Delphi

TDBXPropertyNames = class

C++

class PASCALIMPLEMENTATION TDBXPropertyNames : public System::TObject

Properties

Type Visibility Source Unit Parent
class public
Data.DBXCommon.pas
Data.DBXCommon.hpp
Data.DBXCommon Data.DBXCommon

Description

Property names for connections and drivers to provide information, such as user names and passwords.

The following table describes existing property names:

Constant Description

AutoUnloadDriver

If True, dynalink drivers will automatically unload their dll when there are no open connections left that use the driver.

BufferKBSize

Buffer size in kilobytes to use for client driver transport read and write operations. Currently used by Data.DBXClient.

CommunicationIPVersion

Specifies the IP version for communications.

CommunicationProtocol

Specifies the communication protocol.

CommunicationTimeout

Specifies the maximum time to wait for a data packet to be exchanged. When the specified time expires, an exception is thrown. Not all drivers support this operation.

ConnectionName

Name of connection. If connection properties are read from the dbxconnections.ini file, this is the ini file section name. AdoDbx Client can use this property setting for a simple one property connection string. Connection names can also be used to load a connection from a TDBXConnectionFactory instance.

ConnectionString

String that provides the information required to establish the connection.

ConnectTimeout

Maximum time, in seconds, to wait for a new connection to be opened. If the specified time expires, an exception is thrown. Not all drivers support this operation.

Database

Name of a database to connect to.

DatasnapContext

Specifies a key for a URL path toward DataSnap HTTP service.

DBHostName

Host name of the machine that hosts the database.

DelegateConnection

Delegate connection used by this connection. Delegate connections implement the dbExpress 4 driver framework. They can perform pre- or post-processing of all public and protected methods before delegating to the real connection or another delegate connection.

DelegateDriver

Indicates that this driver is a delegate and can only be used in conjunction with a nondelegate driver.

DisplayDriverName

Display name of the driver.

DriverAssembly
(deprecated)

Used to load a managed driver dynamically.

Note: You can add a comma plus the package name to the end of the DriverPackageLoader property setting instead of using DriverAssembly.

DriverAssemblyLoader

Managed Driver loader class used to load a managed driver dynamically from an assembly. Comma-separated class and package name.

DriverName

Unique name for a dbExpress driver. Used by the dbxconnections.ini file to refer to a connections driver in the dbxdrivers.ini file.

DriverPackage
(deprecated)

Used to load a native driver dynamically.

Note: You can add a comma plus the package name to the end of the DriverPackageLoader property setting instead of using DriverPackage.

DriverPackageLoader

Native Driver loader class used to load a native driver dynamically from a package. Comma-separated class and package name.

DriverUnit

Used to provide an informative error message when driver cannot be loaded.

DSAuthenticationPassword

Specifies a password required for a DataSnap user to authenticate with the server.

DSAuthenticationScheme

Specifies the URL scheme to use to connect to the DataSnap server for authentication.

DSAuthenticationUser

Specifies the user name that is recognized by the DataSnap server. This is a different concept than a database user that is used for creating a database connection.

DSProxyHost

Specifies the host name of the proxy server used to connect to the DataSnap server.

DSProxyPassword

Specifies the password of DSProxyUsername.

DSProxyPort

Specifies the port of the proxy server used to connect to the DataSnap server.

DSProxyUsername

Specifies the user name that is recognized by the proxy server used to connect to the DataSnap server.

ErrorResourceFile

Used only by Linux versions of dbExpress to specify a localized error message file.

Filters

Specifies the filtering configuration.

The filtering configuration is specified as a string containing data in JSON format. The filtering configuration must be a JSON object with key-value pairs that indicate which filters are used, and the configuration of those.

The following JSON object shows how to use all supported filters and specify all their configuration properties:

{
    "PC1": {
        "Key": "<PC1 key>"
    },
    "RSA": {
        "KeyExponent": "<key exponent>",
        "KeyLength": "<key length>",
        "UseGlobalKey": "<false or true>"
    },
    "ZLibCompression": {
    }
}

For example, to configure the ZLib compression filter, use the following value:

{ "ZLibCompression": {} }

GetDriverFunc

Used by DBXDynalink drivers to specify the exported entry point for loading a driver prior to dbExpress 4.

HostName

Host name of a database server that a driver connects to.

InstalledDrivers

dbxdrivers.ini section that specifies which drivers are enabled.

IPImplementationID

ID of the IP implementation.

IsolationLevel

Initial transaction isolation to use when connecting to a database. Transaction isolation can also be specified when a transaction is started.

LibraryName

Used by DBXDynalink drivers to specify the name of the DBXDynalink DLL.

LibraryNameOsx

Used by DBXDynalink drivers to specify the name of the DBXDynalink dylib for OS X.

MaxBlobSize

Maximum BLOB size. Set to –1 to specify no limit.

MetaDataAssemblyLoader

Managed MetaData loader class used to load a managed driver dynamically from an assembly.

MetaDataPackageLoader

Native MetaData loader class used to load a native driver dynamically from a package.

Password

Login password name used to connect to a database.

Port

Port number of a database server that a driver connects to.

ProductName

Provides the product name for the dbExpress metadata.

ProductVersion

Can be specified as a driver property as an override of the TDBXConnection.ProductVersion property. This may be necessary for drivers that do not have the ability to report the product version. The ProductVersion is a number in the format nn.nn.nnnn.

Role

Login role used to connect to a database.

RowSetSize

Size of the row set.

SchemaOverride

Most applications should not need to use this constant. It is provided for backwards compatibility of the dbExpress VCL. VCL components use this setting to scope metadata requests. This property should be set to user-name.override-schema-name. For example, tables created by the MSSQL sa user are placed in the dbo schema. In this case, SchemaOverride can be set to 'sa.dbo'. This causes VCL to specify the 'dbo' schema for metadata requests when a connection is made using the 'sa' user. An SQL '%' like pattern can also be used for the user-name and the override-schema-name. For example, '%.%' causes the schema not to be specified at all for all users.

ServerConnection

When connecting to a DataSnap server, this is the name of a server method that returns an instance of a TDBXConnection. All SQL statements and SQL stored procedure commands are executed against this TDBXConnection instance. This allows client and server methods to share the same database connection. There is a built-in DSAdmin.GetConnection method that takes a single input parameter, which is the name of a connection in the server-side dbxconnections.ini file and returns a TDBXConnection instance. For example, to set the ServerConnection using this server method for a connection called "myoracleconnection", set ServerConnection: {{{1}}}. Alternatively you can implement your own server method that returns a TDBXConnection instance.

SupportsParameterMetadata

This can be passed to the TDBXConnection.GetVendorProperty method to determine whether the driver supports parameter metadata. If parameter metadata is supported, executing the TDBXCommand.Prepare method causes the TDBXCommand parameter list to be automatically populated with parameters for the command. Note that if parameters were already added to the command, parameters are not automatically added.

URLPath

Specifies the path to a DataSnap server web application. For example, you can use URLPath to specify the virtual directory of a DataSnap server ISAPI dll.

UserName

Login user name used to connect to a database.

VendorLib

Used by DBXDynalink drivers. Name of a vendor-specific client library.

VendorLibOsx

Used by DBXDynalink drivers. Name of a vendor-specific client library for OS X.

VendorLibWin64

Used by DBXDynalink drivers. Name of a vendor-specific client library for 64-bit Windows.

See Also

Personal tools
In Other Languages
Previous Versions
Assistance