Holds information needed to unload a database using the DBTools library or extract a remote database for SQL Remote.
typedef struct an_unload_db
Member name | Type | Description |
---|---|---|
compress_output |
a_bit_field |
Set TRUE to compress table data files. Set TRUE by dbunload -cp option. |
confirmrtn |
MSG_CALLBACK |
Address of a confirmation request callback routine or NULL. |
connectparms |
const char * |
Parameters needed to connect to the database. They take the form of connection strings, such as the following: "UID=DBA;PWD=sql;DBF=demo.db". The database server would be started by the connection string START parameter. For example: "START=c:\SQLAny12\bin32\dbeng12.exe". A full example connection string including the START parameter: "UID=DBA;PWD=sql;DBF=demo.db;START=c:\SQLAny12\bin32\dbeng12.exe". |
debug |
a_bit_field |
Reserved; set FALSE. |
display_create |
a_bit_field |
Set TRUE to display database creation command (sql or dbinit). Set TRUE by dbunload -cm sql or -cm dbinit option. |
display_create_dbinit |
a_bit_field |
Set TRUE to display dbinit database creation command. Set TRUE by dbunload -cm dbinit option. |
encrypted_tables |
a_bit_field |
Set TRUE to enable encrypted tables in new database (with -an or -ar). Set TRUE by dbunload/dbxtract -et option. |
encryption_algorithm |
const char * |
The encryption algorithm which may be "simple", "aes", "aes256", "aes_fips", "aes256_fips", or NULL for none. Set by dbunload/dbxtract -ea option. |
encryption_key |
const char * |
The encryption key for the database file. Set by dbunload/dbxtract -ek or -ep option. |
errorrtn |
MSG_CALLBACK |
Address of an error message callback routine or NULL. |
escape_char |
char |
The escape character (normally, "\"). Used when escape_char_present is TRUE. Set TRUE by dbunload/dbxtract -p option. |
escape_char_present |
a_bit_field |
Set TRUE to indicate that the escape character in escape_char is defined. Set TRUE by dbunload/dbxtract -p option. |
exclude_foreign_keys |
a_bit_field |
Set TRUE to exclude foreign keys. Set TRUE by dbxtract -xf option. |
exclude_hooks |
a_bit_field |
Set TRUE to exclude procedure hooks. Set TRUE by dbxtract -xh option. |
exclude_procedures |
a_bit_field |
Set TRUE to exclude stored procedures. Set TRUE by dbxtract -xp option. |
exclude_tables |
a_bit_field |
Set FALSE to indicate that the list contains tables to be included. Set TRUE to indicate that the list contains tables to be excluded. Set TRUE by dbunload -e option. |
exclude_triggers |
a_bit_field |
Set TRUE to exclude triggers. Set TRUE by dbxtract -xt option. |
exclude_views |
a_bit_field |
Set TRUE to exclude views. Set TRUE by dbxtract -xv option. |
extract |
a_bit_field |
Set TRUE if performing a remote database extraction. Set FALSE by dbunload. Set TRUE by dbxtract. |
genscript |
a_bit_field |
Reserved; set FALSE. |
include_where_subscribe |
a_bit_field |
Set TRUE to extract fully qualified publications. Set TRUE by dbxtract -f option. |
isolation_level |
unsigned short |
The isolation level at which to operate. Set by dbxtract -l option. |
isolation_set |
a_bit_field |
Set TRUE to indicate that isolation_level has been set for all extraction operations. Set TRUE by dbxtract -l option. |
locale |
const char * |
Reserved; use NULL. |
make_auxiliary |
a_bit_field |
Set TRUE to make auxiliary catalog (for use with diagnostic tracing). Set TRUE by dbunload -k option. |
ms_filename |
const char * |
Reserved; use NULL. |
ms_reserve |
int |
Reserved; use 0. |
ms_size |
int |
Reserved; use 0. |
msgrtn |
MSG_CALLBACK |
Address of an information message callback routine or NULL. |
no_confirm |
a_bit_field |
Set TRUE to replace an existing SQL script file without confirmation. Set by dbunload/dbxtract -y option. |
no_reload_status |
a_bit_field |
Set TRUE to suppress reload status messages for tables and indexes. Set TRUE by dbunload -qr option. |
notemp_size |
long |
Reserved; use 0. |
preserve_identity_values |
a_bit_field |
Set TRUE to preserve identity values for AUTOINCREMENT columns. Set TRUE by dbunload -l option. |
preserve_ids |
a_bit_field |
Set TRUE to preserve user IDs. This is the normal setting. Set FALSE by dbunload -e option. |
profiling_uses_single_dbspace |
a_bit_field |
Set TRUE to collapse to a single dbspace file (for use with diagnostic tracing). Set TRUE by dbunload -kd option. |
recompute |
a_bit_field |
Set TRUE to redo computed columns. Set TRUE by dbunload -dc option. |
refresh_mat_view |
a_bit_field |
Set TRUE to generate statements to refresh text indexes and valid materialized views. Set TRUE by dbunload/dbxtract -g option. |
reload_connectparms |
char * |
Connection parameters such as user ID, password, and database for the reload database. Set by dbunload/dbxtract -ac option. |
reload_db_filename |
char * |
Name of the new database file to create and reload. Set by dbunload/dbxtract -an option. |
reload_db_logname |
char * |
Filename of the new database transaction log or NULL. Set by dbxtract -al option. |
reload_filename |
const char * |
Name to use for the reload SQL script file (for example, reload.sql). Set by dbunload -r option. |
reload_page_size |
unsigned short |
The reloaded database page size. Set by dbunload -ap option. |
remote_dir |
const char * |
Like temp_dir but for internal unloads on server side. |
remove_encrypted_tables |
a_bit_field |
Set TRUE to remove encryption from encrypted tables. Set TRUE by dbunload/dbxtract -er option. |
replace_db |
a_bit_field |
Set TRUE to replace the database. Set TRUE by dbunload -ar option. |
runscript |
a_bit_field |
Reserved; set FALSE. |
schema_reload |
a_bit_field |
Reserved; set FALSE. |
site_name |
const char * |
The site name to be used by dbxtract. NULL otherwise. |
start_subscriptions |
a_bit_field |
Set TRUE to start subscriptions. This is the default for dbxtract. Set FALSE by dbxtract -b option. |
startline |
const char * |
Reserved; use NULL. |
startline_name |
a_bit_field |
Reserved; set FALSE. |
startline_old |
const char * |
Reserved; use NULL. |
statusrtn |
MSG_CALLBACK |
Address of a status message callback routine or NULL. |
subscriber_username |
const char * |
The subscriber name to be used by dbxtract. NULL otherwise. |
sysinfo |
a_sysinfo |
Reserved; use NULL. |
table_list |
p_name |
Selective table list. Set by dbunload -e and -t options. |
table_list_provided |
a_bit_field |
Set TRUE to indicate that a list of tables has been provided. See table_list field. Set TRUE by dbunload -e or -t options. |
temp_dir |
const char * |
Directory for unloading data files. |
template_name |
const char * |
The template name to be used by dbxtract. NULL otherwise. |
unload_interrupted |
char |
Reserved; set to 0. |
unload_type |
char |
Set Unload enumeration (UNLOAD_ALL and so on). Set by dbunload/dbxtract -d, -k, -n options. |
unordered |
a_bit_field |
Set TRUE for unordered data. Indexes will not be used to unload data. Set by dbunload/dbxtract -u option. |
use_internal_reload |
a_bit_field |
Set TRUE to perform an internal reload. This is the normal setting. Set TRUE by dbunload/dbxtract -ii and -xi option. Set FALSE by dbunload/dbxtract -ix and -xx option. |
use_internal_unload |
a_bit_field |
Set TRUE to Perform an internal unload. Set TRUE by dbunload/dbxtract -i? option. Set FALSE by dbunload/dbxtract -x? option. |
verbose |
char |
See Verbosity enumeration (VB_QUIET, VB_NORMAL, VB_VERBOSE). |
version |
unsigned short |
DBTools version number (DB_TOOLS_VERSION_NUMBER). |
Those fields used by the dbxtract SQL Remote Extraction utility are indicated.
Discuss this page in DocCommentXchange.
|
Copyright © 2012, iAnywhere Solutions, Inc. - SQL Anywhere 12.0.1 |