ASA Programming Guide
The Database Tools Interface
DBTools structures
Holds the information needed to carry out dblog tasks using the DBTools library.
typedef struct a_change_log {
unsigned short version;
const char * dbname;
const char * logname;
MSG_CALLBACK errorrtn;
MSG_CALLBACK msgrtn;
a_bit_field query_only : 1;
a_bit_field quiet : 1;
a_bit_field mirrorname_present : 1;
a_bit_field change_mirrorname : 1;
a_bit_field change_logname : 1;
a_bit_field ignore_ltm_trunc : 1;
a_bit_field ignore_remote_trunc : 1;
a_bit_field set_generation_number : 1;
a_bit_field ignore_dbsync_trunc : 1;
const char * mirrorname;
unsigned short generation_number;
const char * key_file;
char * zap_current_offset;
char * sap_starting_offset;
char * encryption_key;
} a_change_log;
| Member | Description |
|---|---|
| version | DBTools version number |
| dbname | Database file name |
| logname | The name of the transaction log. If set to NULL, there is no log |
| errorrtn | Callback routine for handling an error message |
| msgrtn | Callback routine for handling an information message |
| query_only | If 1, just display the name of the transaction log. If 0, permit changing of the log name |
| quiet | Operate without printing messages (1), or print messages (0) |
| mirrorname_present | Set to 1. Indicates that the version of DBTools is recent enough to support the mirrorname field |
| change_mirrorname | If 1, permit changing of the log mirror name |
| change_logname | If 1, permit changing of the transaction log name |
| ignore_ltm_trunc |
When using the Log Transfer Manager, performs the same function as the dbcc settrunc( 'ltm', 'gen_id', n ) Replication Server function:
For information on dbcc, see your Replication Server documentation |
| ignore_remote_trunc | For SQL Remote. Resets the offset kept for the purposes of the DELETE_OLD_LOGS option, allowing transaction logs to be deleted when they are no longer needed |
| set_generation_number | When using the Log Transfer Manager, used after a backup is restored to set the generation number |
| ignore_dbsync_trunc | When using dbmlsync, resets the offset kept for the purposes of the DELETE_OLD_LOGS option, allowing transaction logs to be deleted when they are no longer needed |
| mirrorname | The new name of the transaction log mirror file |
| generation_number | The new generation number. Used together with set_generation_number |
| key_file | A file holding the encryption key |
| zap_current_offset | Change the current offset to the specified value. This is for use only in resetting a transaction log after an unload and reload to match dbremote or dbmlsync settings. |
| zap_starting_offset | Change the starting offset to the specified value. This is for use only in resetting a transaction log after an unload and reload to match dbremote or dbmlsync settings. |
| encryption_key | The encryption key for the database file. |
For more information on callback functions, see Using callback functions.