Alphabetical List of DPB Parameters
From InterBase
Go Up to Working with Databases
| Parameter | Purpose | Length | Value |
|---|---|---|---|
| isc_dpb_activate_shadow | Directive to activate the database shadow, which is an optional, duplicate, in-sync copy of the database. | 1 (Ignored) | 0 (Ignored) |
| isc_dpb_archive_database | Backup database to archive. The equivalent command line is: gbak-archive_database. | ||
| isc_dpb_archive_journals | Backup journals to archive. The equivalent command line is: gbak-archive_journals. | ||
| isc_dpb_archive_dumps | Configures the maximum number of database dumps allowed in the archive. The equivalent command line is: gfixarchive_dumps<n>. | ||
| isc_dpb_archive_recover | Recover database from archive. The equivalent command line is: gbakarchive_recover. | ||
| isc_dpb_archive_sweep | Deletes all files in RDB$JOURNAL_ARCHIVES with RDB$ARCHIVE_SEQUENCE less than the requested sequence. The equivalent command line is: gfix-archive_sweep<n>. | ||
| isc_dpb_damaged | Number signifying whether or not the database should be marked as damaged.
|
1 | 0 or 1 |
| isc_dpb_dbkey_scope | Scope of dbkey context. 0 limits scope to the current transaction, 1 extends scope to the database session. | 1 | 0 or 1 |
| isc_dpb_delete_shadow | Directive to delete a database shadow that is no longer needed. | 1 (Ignored) | 0 (Ignored) |
| isc_dpb_encrypt_key | String encryption key, up to 255 characters. | Number of bytes in string | String containing key |
| isc_dpb_force_write | Specifies whether database writes are synchronous or asynchronous. 0 = asynchronous; 1 = synchronous |
1 | 0 or 1 |
| isc_dpb_gbak_validate | Instructs server to include validation checks during a database restore. | ||
| isc_dpb_lc_ctype | String specifying the character set to be used. | Number of bytes in string | String containing character set name |
| isc_dpb_lc_messages | String specifying a language-specific message file | Number of bytes in string | String containing message file name |
| sc_dpb_license | String authorization key for a software license | Number of bytes in string | String containing key |
| isc_dpb_no_reserve | Specifies whether or not a small amount of space on each database page is reserved for holding backup versions of records when modifications are made; keep backup versions on the same page as the primary
record to optimize update activity. |
1 | 0 or 1 |
| isc_dpb_num_buffers | Number of database cache buffers to allocate for use with the database; default=2,048. | Number of bytes in the length indicator (1, 2, or 4) | Number of buffers to allocate |
| isc_dpb_online_dump | Directive to initiate an online dump. | 1 | 0 or 1 |
| isc_dpb_old_overwrite | Indicates that the current online dump files should be deleted and a full database dump executed (optional). | 1 | 0 or 1 |
| isc_dpb_old_file_name | String specifying the name of an online dump file, up to 255 characters. | Number of bytes in string | Dump file name string |
| sc_dpb_old_file_size | Number of pages for online dump file (optional). | Number of bytes for length indicator (1, 2, or 4) | Number of pages for dump length |
| isc_dpb_password | String password, up to 255 characters | Number of bytes in string | String containing password |
| isc_dpb_password_enc | String encrypted password, up to 255 characters | Number of bytes in string | String containing password |
| isc_dpb_preallocate | Specifies database preallocation. It is only recognized and processed by isc_create_database().
isc_attach_database() silently ignores isc_dpb_preallocate. Use the isc_info_db_preallocate database info parameter to request database preallocate information stored on the database header page. |
4 | |
| isc_dpb_set_db_sql_dialect | Number indicating the SQL dialect used by the client; used by the gfix utility to set the dialect in the database header page Dialect 3 gives access to features introduced in InterBase XE. | 1 | 1 - V5.x & V6 compatible 2 - diagnostic |
| isc_dpb_sql_dialect | Number indicating the SQL dialect used by the client. Dialect 3 gives access to features introduced in InterBase XE. | 1 | 1 - V5.x & V6 compatible 2 - diagnostic |
| isc_dpb_sql_role_name | String login role name. | Number of bytes in string | String |
| isc_dpb_sys_encrypt_password | Database system encryption password (SEP), up to 255 characters. | Number of bytes in string | String containing SEP |
| isc_dpb_sys_user_name | String system DBA name, up to 255 characters. | Number of bytes in string | String containing SYSDBA name |
| isc_dpb_user_name | String user name, up to 255 characters. | Number of bytes in string | String containing user name |
Some parameters, such as isc_dpb_delete_shadow, are directives that do not require additional parameters. Even so, you must still provide length and value bytes for these parameters. Set length to 1 and value to 0. InterBase ignores these parameter values, but they are required to maintain the format of the DPB.
Note:
With the InterBase service API, actions isc_action_svc_backup (isc_action_svc_restore) take new parameters, isc_spb_bkp_preallocate (isc_spb_res_preallocate), respectively. Both parameters take a 4-byte argument to specify the database preallocation in units of database pages. The service parameters have the same numeric value but two symbolic constants are provided for source code clarity to show the proper intent.
With the InterBase service API, actions isc_action_svc_backup (isc_action_svc_restore) take new parameters, isc_spb_bkp_preallocate (isc_spb_res_preallocate), respectively. Both parameters take a 4-byte argument to specify the database preallocation in units of database pages. The service parameters have the same numeric value but two symbolic constants are provided for source code clarity to show the proper intent.