an_unload_db structure

Holds information needed to unload a database using the DBTools library or extract a remote database for SQL Remote.

• compress_output a_bit_field
  Set TRUE to compress table data files.
• confirmrtn MSG_CALLBACK
  Address of a confirmation request callback routine or NULL.
• connectparms const char *
  Parameters needed to connect to the database.
• debug a_bit_field
  Reserved; set FALSE.
• display_create a_bit_field
  Set TRUE to display database creation command (sql or dbinit).
• display_create_dbinit a_bit_field
  Set TRUE to display dbinit database creation command.
• encrypted_tables a_bit_field
  Set TRUE to enable encrypted tables in new database (with -an or -ar).
• encryption_algorithm const char *
  The encryption algorithm which may be "simple", "aes", "aes256", "aes_fips", "aes256_fips", or NULL for none.
• encryption_key const char *
  The encryption key for the database file.
• errorrtn MSG_CALLBACK
  Address of an error message callback routine or NULL.
• escape_char char
  The escape character (normally, "\").
• escape_char_present a_bit_field
  Set TRUE to indicate that the escape character in escape_char is defined.
• exclude_foreign_keys a_bit_field
  Set TRUE to exclude foreign keys.
• exclude_hooks a_bit_field
  Set TRUE to exclude procedure hooks.
• exclude_procedures a_bit_field
  Set TRUE to exclude stored procedures.
• exclude_tables a_bit_field
  Set FALSE to indicate that the list contains tables to be included.
• exclude_triggers a_bit_field
  Set TRUE to exclude triggers.
• exclude_views a_bit_field
  Set TRUE to exclude views.
• extract a_bit_field
  Set TRUE if performing a remote database extraction.
• genscript a_bit_field
  Reserved; set FALSE.
• include_where_subscribe a_bit_field
  Set TRUE to extract fully qualified publications.
• isolation_level unsigned short
  The isolation level at which to operate.
• isolation_set a_bit_field
  Set TRUE to indicate that isolation_level has been set for all extraction operations.
• locale const char *
  Reserved; use NULL.
• make_auxiliary a_bit_field
  Set TRUE to make auxiliary catalog (for use with diagnostic tracing).
• 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.
• no_reload_status a_bit_field
  Set TRUE to suppress reload status messages for tables and indexes.
• notemp_size long
  Reserved; use 0.
• preserve_identity_values a_bit_field
  Set TRUE to preserve identity values for AUTOINCREMENT columns.
• preserve_ids a_bit_field
  Set TRUE to preserve user IDs.
• profiling_uses_single_dbspace a_bit_field
  Set TRUE to collapse to a single dbspace file (for use with diagnostic tracing).
• recompute a_bit_field
  Set TRUE to redo computed columns.
• refresh_mat_view a_bit_field
  Set TRUE to generate statements to refresh text indexes and valid materialized views.
• reload_connectparms char *
  Connection parameters such as user ID, password, and database for the reload database.
• reload_db_filename char *
  Name of the new database file to create and reload.
• reload_db_logname char *
  Filename of the new database transaction log or NULL.
• reload_filename const char *
  Name to use for the reload SQL script file (for example, reload.sql).
• reload_page_size unsigned short
  The reloaded database page size.
• 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.
• replace_db a_bit_field
  Set TRUE to replace the database.
• 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.
• 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.
• suppress_statistics a_bit_field
  Set TRUE to suppress inclusion of column statistics.
• sysinfo a_sysinfo
  Reserved; use NULL.
• table_list p_name
  Selective table list.
• table_list_provided a_bit_field
  Set TRUE to indicate that a list of tables has been provided.
• 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).
• unordered a_bit_field
  Set TRUE for unordered data.
• use_internal_reload a_bit_field
  Set TRUE to perform an internal reload.
• use_internal_unload a_bit_field
  Set TRUE to Perform an internal unload.
• verbose char
  See Verbosity enumeration (VB_QUIET, VB_NORMAL, VB_VERBOSE).
• version unsigned short
  DBTools version number (DB_TOOLS_VERSION_NUMBER).