Password
Aliases:
PSWD
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
Password for connection to database
|
Persist Security Info
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Remember security info:
| True | — | provider has the right to return the password and to save it in the file |
| False | — | provider cannot save the password |
|
User ID
Aliases:
User
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
User name.
|
new! Integrated Security
Type: VT_BSTR
R/W: R/W
IBProvider v3.
Using a integrated authentication service.
| Empty String | — | The default authentication service |
| "SSPI" | — | Microsoft Windows NT Integrated Security |
When this property is defined, provider will be ignore values of User ID and Password.
|
Data Source
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
Symbol database name. For example, "Employee DB". If the property Location is not defined, than database location is pointed in Data Source.
|
Location
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
Path to database. For example:
- d:\database\db1.gdb
- localhost:d:\database\db1.gdb
- sqlserver:d:\database\db1.gdb
If the property value is not defined, than the location of database will be pointed in the property Data Source.
|
Window Handle
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Handle of parent window for request of additional information.
|
Prompt
Type: VT_I2
R/W: R/W
IBProvider v1, v2, v3.
User prompt:
| 1 | — | Always request of the initialization data from user |
| 2 | — | Only if the additional information is necessary |
| 3 | — | Request unknown information only |
| 4 | — | To not request |
|
Extended Properties
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
The list of the unidentified properties in the connection string.
|
OLE DB Services
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
See OLE DB references
|
ctype
Aliases:
charset
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
Connection character set. For example, win1251 [ russian code page!] or NONE. For IBProvider v3. Supported codepage:ASCII, BIG_5, CYRL, DOS437, DOS737, DOS775, DOS850, DOS852, DOS857, DOS858, DOS860, DOS861, DOS862, DOS863, DOS864, DOS865,
DOS866, DOS869, EUCJ_0208, GBK, GB_2312, ISO8859_1, ISO8859_13, ISO8859_2, ISO8859_3, ISO8859_4, ISO8859_5, ISO8859_6,
ISO8859_7, ISO8859_8, ISO8859_9, KOI8R, KOI8U, KSC_5601, NEXT, SJIS_0208, TIS620, UNICODE_FSS, UTF8, WIN1250, WIN1251,
WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, ICU-Charsets. Allowed use the aliases of charsets. See also:
ctype_user,
ctype_none,
icu_library,
unicode_mode.
|
cmessages
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
See isc_dpb_lc_message in IB API references
|
role
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
User role
|
num_buffers
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
See isc_dbp_num_buffers in IB API references
|
garbage_collect
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Enable/Disable (true/false) garbage collection.
|
dialect
Type: VT_I4
R/W: R/W
| Default: | Is equal to database dialect ( See the information property of provider IB Database Dialect) |
IBProvider v1, v2, v3.
Dialect of connection to the database.Is available for using at client part from IB6.
|
auto_commit
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Automatic commit transactions.
See the session property
Session AutoCommit.
|
auto_commit_level
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Isolation level of automatic and COM+ transactions
| 0x1000 | — | Read Commited (Cursor Stability) |
| 0x10000 | — | Repeatable Read (Snapshot, Concurrency) |
| 0x100000 | — | Serializable (Isolated, Consistency) |
See the session property
Autocommit Isolation Levels.
|
auto_commit_ddl
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
DDL queries execution mode (CREATE/ALTER/DROP). Allowed values:
| 0 | — | Support of DDL queries is off |
| 1 | — | Executing DDL query in a transaction. Ignored if auto-commit mode |
| 2 | — | Execute CommitRetaining after DDL query. Ignored if auto-commit mode |
If you need to execute the mixed sequence of DDL and DML queries you should set the property to 1. Default value is 0. It means that when using the explicit transaction control (auto_commit=false) the metadata update will applied only after commit. See also:
auto_commit,
auto_commit_ddl_level,
Session AutoCommit DDL,
Session AutoCommit DDL Level.
|
auto_commit_ddl_level
|
bicursor
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
default access mode for Rowset objects
| False | — | one-directional |
| True | — | random |
|
free_threading
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
See the information property of provider Data Source Object ThreadingIn Free IBProvider this property is set False by default. Added to resolve the problem with "Test Connection" in MSDASC.DataLinks.
|
array_vt_type
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Convert array elements to VT compatible types.
See the initialization property of provider
array_type.
See the rowset property
array_vt_type.
|
inner_trans
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
To allow an using the own transactions, e.g. for getting metadata. The isolation level of inner transaction defines by auto_commit_level.
See the session property
Session InnerTrans.
|
schema_cache
Type: VT_I2
R/W: R/W
IBProvider v1, v2, v3.
The mode of metadata caching
| 0 | — | forbid |
| 1 | — | global |
| 2 | — | local for session |
See the session property
Session Schema Cache.
|
truncate_char
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Allowing of truncation of the CHAR data.
See the rowset property
truncate_char.
|
support_odbc_query
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Support of queries containing ODBC escape sequences.
See the rowset property
support_odbc_query.
|
force_prepare_stmt
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Forced preparation of queries and forming of parameters descriptions when setting query text.
See the rowset property
force_prepare_stmt.
|
unicode_mode
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Publishing of text data as UNICODE characters. For IBProvider v1/v2 version. UNICODE mode is supported only for the following encodings: NONE, UNICODE_FSS, WIN1250, WIN1251, WIN1252, WIN1253, WIN1254, DOS437, DOS850, DOS852, DOS857, DOS860, DOS861, DOS863, DOS865, CYRL. The chosen code pages are converted by provider into UNICODE singly. The rest - by means of MultiByteToWideChar/ WideCharToMultiByte. If unicode_mode =false, then the client bears responsibility for the correctness of the conversion of text. Do not recommended change this property. For IBProvider v3. This provider has a support of UNICODE mode for all codepages and additional initialize property ctype_user. You can change this property without any problems.
See the initialization property of provider
ctype_user.
|
unicode_stmt
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Translation of SQL-query text from UNICODE.
| True | — | With using a connection code page. |
| False | — | With using a currect OS code page (CP_ACP). |
|
std_exec_sp
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
"exec SP" query interpretation method.
See the rowset property
std_exec_sp.
|
odbc_call_sp
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Method of execution ODBC-query of calling SP.
See the rowset property
odbc_call_sp.
|
clear_param_info
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
It permits to clear the list of parameters descriptions when setting the new query text. If client sets parameters descriptions firstly and query text after this then descriptions will lost. In this case either error of command execution or additional outgo for automatic forming of the list of parameters descriptions.
See the initialization property of provider
auto_param_describe.
See the rowset property
clear_param_info.
|
auto_param_describe
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
If user did not set parameters descriptions when executing the parameterized query then provider will form it automatically through inquiry to server.
See the rowset property
auto_param_describe
|
force_param_describe
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Implicit obtaining of parameters descriptions and using of it for transfer parameters values with that types which database server hopes to get.
See the rowset property
force_param_describe
|
named_param_prefix
Type: VT_BSTR
R/W: R/W
IBProvider v1, v2, v3.
This property determines prefix of the named parameters in the query text.
See the rowset property
named_param_prefix
|
query_pool_size
Type: VT_I2
R/W: R/W
IBProvider v2, v3.
Maximum number of prepared queries used by updatable row set to record changes to database.
See the rowset property
query_pool_size
|
auto_insert_field_rule
Type: VT_I2
R/W: R/W
IBProvider v2, v3.
Rule of the generation SQL-query for the insert of a new row into database table.
See the rowset property
auto_insert_field_rule
|
auto_update_field_rule
Type: VT_I2
R/W: R/W
IBProvider v2, v3.
Rule of the generation SQL-query for the update of a row of database table.
See the rowset property
auto_update_field_rule
|
ignore_unprepare
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Permission to ignore SQL-query command UnPrepare.
See the rowset property
ignore_unprepare
|
rowset_vm_using
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Memory volume (kilobytes) under the cache of result rowset, beginning from which the memory manager based on VirtualAlloc/VirtualFree and SEH will be used. Always the memory manager based on HeapAlloc/HeapFree will be used if value of this property is negative. The use of VirtualAlloc/VirtualFree and SEH based memory manager makes it possible to use process memory more effectively and decreases its fragmentation. For the work with the provider under Delphi, BCB, Visual Studio debuggers it is necessary to switch off the handling of Access Violation exception or to add into connection string rowset_vm_using=-1. See also:
the rowset property
rowset_vm_using,
Memory Usage.
|
new! dbclient_type
Type: VT_BSTR
R/W: R/W
IBProvider v3.
Determines type of database server client. The available values are:
| ib | — | Interbase 4/5/6 client. Default library is gds32.dll |
| fb | — | Firebird v1 client. Default library is gds32.dll |
| fb1.5 | — | Firebird v1.5 client. Default library is fbclient.dll |
Specifying allowable value in register parameter it is possible to change default value: HKEY_CLASSES_ROOT\CLSID\{769A1280-04BF-11D8-AE8B-00A0C907DB93}\def_dbclient_typeSee also:
dbclient_library,
dbclient_lock_rules
|
new! dbclient_library
|
new! nested_trans
Type: VT_BOOL
R/W: R/W
IBProvider v3.
Enabling/disabling nested transactions.
|
new! schema_sp_params
Type: VT_I4
R/W: R/W
IBProvider v3.
Detect schemata's loading modes: PROCEDURE_PARAMETERS or PROCEDURE_COLUMNS. Possible values:
| 0 | — | PROCEDURE_COLUMNS contains all stored procedure OUT-parameters. |
| 1 | — | PROCEDURE_PARAMETERS contains all stored procedure OUT-parameters with IN-parameters. IBProviders v1 and v2 supports only this mode. |
| 2 | — | Automatic mode. If stored procedure return result set, OUT-parameters will be in PROCEDURE_COLUMNS schema, else if SP return OUT-parameters then its info will be in PROCEDURE_PARAMETERS. |
|
new! ado_exec_sp
Type: VT_I4
R/W: R/W
IBProvider v3.
"exec SP" query interpretation method. Possible values:
| 0 | — | Convert query "exec SP" to the "select * from SP" |
| 1 | — | Convert query "exec SP" to the "execute procedure SP" |
| 2 | — | Automatic conversion mode |
This property replace old property std_exec_sp
See the rowset property
ado_exec_sp
|
exec_sp_named_param
Type: VT_BOOL
R/W: R/W
IBProvider v1, v2, v3.
Setting for "exec SP" translation into native query of stored procedure call. Possible values:
| True | — | Generate a query with named parameters: "execute procedure SP (:param1, param2 ...)". |
| False | — | Generate a query with unnamed parameters: "execute procedure SP (?,? ...)". |
See the rowset property
exec_sp_named_param.
|
new! ignore_err_param
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
A bitmask with flags for ignoring errors in command parameters.
| 1 | — | Ignore IN-parameter with unknown name. |
| 2 | — | Ignore IN-parameter with invalid ordinal. |
See the rowset property
ignore_err_param
|
new! support_square_delim_name
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Support of delimiting of database object identifiers with using of square brackets
| 0 | — | Support is disabled. |
| 1 | — | Processing all square brackets. |
| 2 | — | [v3] Parser is trying to distinguish the identifiers and indexing of arrays. |
Parser of square brackets is detecting and ignoring comments and text values
See the rowset property
support_square_delim_name
|
new! keywords_list
Type: VT_I4
R/W: R/W
IBProvider v3.
Contents of keywords list, returning from IDBInfo::GetKeywords
| 0 | — | According to standard of OLEDB. |
| 1 | — | Appending to list all reserved keywords. |
|
new! tr_abort_flags
Type: VT_I4
R/W: R/W
IBProvider v3.
Bit mask of transaction abort modes
| 1 | — | Abort of inactive transaction without any errors. |
See the session property
Session Transaction Abort Flags
|
new! enable_db_triggers
Type: VT_BOOL
R/W: R/W
IBProvider v3.
Enable or disable triggers at database level (FB2.1). Required the client of Firebird server.
|
new! array_type
Type: VT_I4
R/W: R/W
IBProvider v3.
Rules for publication of columns and parameters with arrays
| 0 | — | Columns and parameters with original type of array elements. |
| 1 | — | Used a VARIANT-compatible type of array elements. |
| 2 | — | Used array of VARIANT. This is VBScript-compatible mode. |
| 17 | — | Like "1", but array will be packed into VARIANT. |
| 18 | — | Like "2", but array will be packed into VARIANT. This is VBScript-compatible mode. |
This property replaces the
array_vt_type
See the rowset property
array_type
|
new! reset_ds_tr_rule
Type: VT_I4
R/W: R/W
IBProvider v1, v2, v3.
Rule for retrying of connection with active transaction
| 0 | — | Transaction's state is ignored. |
| 1 | — | Disabling retry of data source. |
| 2 | — | Detach from transaction. Active transaction will be rolled back. |
|
new! numeric_i2_rules
Type: VT_I4
R/W: R/W
IBProvider v3.
Rules for NUMERIC-columns with precisions 1..4. Can be zero or combination of following flags
| 1 | — | NUMERIC with zero scale will be DBTYPE_I2. |
| 2 | — | Precision of NUMERIC will be 5 instead 4. |
If you get the problems with NUMERIC and MSSQL (linked server), add to connection string numeric_i2_rules=2. See also:
numeric_i4_rules,
numeric_i8_rules.
|
new! numeric_i4_rules
Type: VT_I4
R/W: R/W
IBProvider v3.
Rules for NUMERIC-columns with precisions 5..9. Can be zero or combination of following flags
| 1 | — | NUMERIC with zero scale will be DBTYPE_I4. |
| 2 | — | Precision of NUMERIC will be 10 instead 9. |
If you get the problems with NUMERIC and MSSQL (linked server), add to connection string numeric_i4_rules=2. See also:
numeric_i2_rules,
numeric_i8_rules.
|
new! numeric_i8_rules
Type: VT_I4
R/W: R/W
IBProvider v3.
Rules for NUMERIC-columns with precisions 10..18. Can be zero or combination of following flags
| 1 | — | NUMERIC with zero scale will be DBTYPE_I8. |
| 2 | — | Precision of NUMERIC will be 19 instead 18. |
If you get the problems with NUMERIC and MSSQL (linked server), add to connection string numeric_i8_rules=2. See also:
numeric_i2_rules,
numeric_i4_rules.
|
new! icu_library
Type: VT_BSTR
R/W: R/W
IBProvider v3.
Path to DLL with ICU charsets. You can get this DLL from FB2.1 distributive kit - icuuc30.dll. Copy an auxiliary DLL icudt30.dll also. IBProvider 32-bit can work with 32-bit ICU-DLL only. IBProvider 64-bit can work with 64-bit ICU-DLL only.
|
new! dbclient_lock_rules
Type: VT_I4
R/W: R/W
IBProvider v3.
Server's client (gds32.dll, fbclient.dll) lock in memory rules.
| 0 | — | Unload a client's DLL after each detach from database. |
| 1 | — | Unload a client's DLL and a provider's DLL together. |
| 2 | — | Lock a client's DLL in memory. |
Note. The fbclient.dll 1.5.x-2.1.x has memory leaks in uninitialize (unload) code. See also:
dbclient_library
|
new! ctype_user
Type: VT_BSTR
R/W: R/W
IBProvider v3.
User's codepage. Provider makes a translation of text data (simple column, blobs, arrayas) between user codepage and connection codepage (ctype). Special values:
| NONE | — | Default. User codepage is equal to connection codepage. |
| ACP | — | Current ANSI codepage of OS. |
| OCP | — | Current OEM codepage of OS. |
Supported codepage:ASCII, BIG_5, CYRL, DOS437, DOS737, DOS775, DOS850, DOS852, DOS857, DOS858, DOS860, DOS861, DOS862, DOS863, DOS864, DOS865,
DOS866, DOS869, EUCJ_0208, GBK, GB_2312, ISO8859_1, ISO8859_13, ISO8859_2, ISO8859_3, ISO8859_4, ISO8859_5, ISO8859_6,
ISO8859_7, ISO8859_8, ISO8859_9, KOI8R, KOI8U, KSC_5601, NEXT, SJIS_0208, TIS620, UNICODE_FSS, UTF8, WIN1250, WIN1251,
WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, ICU-Charsets. Allowed use the aliases of charsets. See also:
ctype,
ctype_none,
icu_library.
|
new! ctype_none
Type: VT_BSTR
R/W: R/W
IBProvider v3.
Codepage for NONE. Special values:
| NONE | — | Default. |
| ACP | — | Current ANSI codepage of OS. |
| OCP | — | Current OEM codepage of OS. |
Supported codepage:ASCII, BIG_5, CYRL, DOS437, DOS737, DOS775, DOS850, DOS852, DOS857, DOS858, DOS860, DOS861, DOS862, DOS863, DOS864, DOS865,
DOS866, DOS869, EUCJ_0208, GBK, GB_2312, ISO8859_1, ISO8859_13, ISO8859_2, ISO8859_3, ISO8859_4, ISO8859_5, ISO8859_6,
ISO8859_7, ISO8859_8, ISO8859_9, KOI8R, KOI8U, KSC_5601, NEXT, SJIS_0208, TIS620, UNICODE_FSS, UTF8, WIN1250, WIN1251,
WIN1252, WIN1253, WIN1254, WIN1255, WIN1256, WIN1257, WIN1258, ICU-Charsets. Allowed use the aliases of charsets. See also:
ctype,
ctype_user,
icu_library.
|
new! user_type_boolean
Type: VT_BSTR
R/W: R/W
IBProvider v3.
The property specify the domain mask for data types to interpret them as Boolean. The mask supports "*" and "?" symbols. The mask is case sensitive. Domains should be based on SMALLINT type. Emulation works for: - Columns with a simple type;
- Columns with arrays;
- OUT-parameters with a simple type;
- OUT-parameters with arrays;
- IN-parameters with arrays.
Due to ISC API (IB/FB) restrictions, you should explicitly specify parameter type when using simple types for input command parameters. Automatic generation of parameter description is supported for columns with arrays. Emulation of the types also applies to metadata schemes. The provider ensures correspondence of types read at queries running and those displayed in schemes COLUMNS, PROCEDURE_PARAMETERS, PROCEDURE_COLUMNS. Application examples of the types emulation on .Net Framework: Boolean and Guid emulation in Firebird and Interbase.
|
new! user_type_guid
Type: VT_BSTR
R/W: R/W
IBProvider v3.
The property specify the domain mask for data types to interpret them as GUID. The mask supports "*" and "?" symbols. The mask is case sensitive. Domains should be based on CHAR(16) type with OCTETS charset. Emulation works for: - Columns with a simple type;
- Columns with arrays;
- OUT-parameters with a simple type;
- OUT-parameters with arrays;
- IN-parameters with arrays.
Due to ISC API (IB/FB) restrictions, you should explicitly specify parameter type when using simple types for input command parameters. Automatic generation of parameter description is supported for columns with arrays. Emulation of the types also applies to metadata schemes. The provider ensures correspondence of types read at queries running and those displayed in schemes COLUMNS, PROCEDURE_PARAMETERS, PROCEDURE_COLUMNS. Application examples of the types emulation on .Net Framework: Boolean and Guid emulation in Firebird and Interbase.
|
new! stmt_cache__time
Type: VT_I4
R/W: R/W
IBProvider v3.
Minimum lifetime of the initiated or prepared query in seconds. Any query contained in the pool for more than stmt_cache__time seconds will be deleted. - Zero value disables the queries pool.
- Negative value means that the parameter is not taken into consideration.
Read details in news related to: query pooling.
|
new! stmt_cache__req_life_time
Type: VT_I4
R/W: R/W
IBProvider v3.
Minimum lifetime of the prepared query. If a prepared query enters the pool, it will not be used by another query within the specified time. Negative value means that all queries are cached and will not be re-prepared. Read details in news related to: query pooling.
|
new! stmt_cache__size
Type: VT_I4
R/W: R/W
IBProvider v3.
Maximum number of resources in the queries pool. When the specified value is exceeded, the provider will start deleting old queries. Negative value means the parameter is not taken into account. Read details in news related to: query pooling.
|
new! temp_file_dir
Type: VT_BSTR
R/W: R/W
IBProvider v3.
Directory for temporary files of provider. By default the location of the temp files directory is determined by the TMP/TEMP environment variables of the client, which uses the provider.
|
new! rowset_file__sys_flags
Type: VT_I4
R/W: R/W
IBProvider v3.
System flags for temporary file of rowset. Can be zero or combination of following flags:
| 1 | — | Use flag WIN32::FILE_FLAG_NO_BUFFERING. |
| 2 | — | Use flag WIN32::FILE_FLAG_WRITE_THROUGH. |
See also:
the rowset property
rowset_file__sys_flags.
|
new! rowset_file__write_block_size
Type: VT_I4
R/W: R/W
IBProvider v3.
Block size in kilobytes for the unloading of modified data from the cache to a temporary file. See also:
the rowset property
rowset_file__write_block_size.
|
new! rowset__memory_usage
Type: VT_I4
R/W: R/W
IBProvider v3.
Memory size which can use result set:
| 0 | — | The automatic selection of cache size. |
| 1..99 | — | No more indicated percent of available memory. |
| >100 | — | No more indicated size (KB). |
See also:
rowset_vm_using,
the rowset property
Memory Usage.
|
new! enable_updatable_rowset
Type: VT_BOOL
R/W: R/W
IBProvider v3.
Updatable rowset support
|