Database Tools C API Reference

The header files are dbtools.h and dbrmt.h.

• DBBackup(const a_backup_db *) method
  Backs up a database.
• DBChangeLogName(const a_change_log *) method
  Changes the name of the transaction log file.
• DBCreate( a_create_db *) method
  Creates a database.
• DBCreatedVersion( a_db_version_info *) method
  Determines the version of SQL Anywhere that was used to create a database file, without attempting to start the database.
• DBErase(const an_erase_db *) method
  Erases a database file and/or transaction log file.
• DBInfo( a_db_info *) method
  Returns information about a database file.
• DBInfoDump( a_db_info *) method
  Returns information about a database file.
• DBInfoFree( a_db_info *) method
  Frees resources after the DBInfoDump function is called.
• DBLicense(const a_dblic_info *) method
  Modifies or reports the licensing information of the database server.
• DBLogFileInfo(const a_log_file_info *) method
  Returns the log file and mirror log file paths of a non-running database file.
• DBRemoteSQL( a_remote_sql *) method
  Accesses the SQL Remote Message Agent.
• DBSynchronizeLog(const a_sync_db *) method
  Synchronize a database with a MobiLink server.
• DBToolsFini(const a_dbtools_info *) method
  Decrements a reference counter and frees resources when an application is finished with the DBTools library.
• DBToolsInit(const a_dbtools_info *) method
  Prepares the DBTools library for use.
• DBToolsVersion(void) method
  Returns the version number of the DBTools library.
• DBTranslateLog(const a_translate_log *) method
  Translates a transaction log file to SQL.
• DBTruncateLog(const a_truncate_log *) method
  Truncates a transaction log file.
• DBUnload( an_unload_db *) method
  Unloads a database.
• DBUpgrade(const an_upgrade_db *) method
  Upgrades a database file.
• DBValidate(const a_validate_db *) method
  Validates all or part of a database.
• Autotune() enumeration
  Used in the a_backup_db structure to control auto tuning of writers.
• Checkpoint() enumeration
  Used in the a_backup_db structure to control copying of the checkpoint log.
• History() enumeration
  Used in the a_backup_db structure to control enabling of backup history.
• Padding() enumeration
  Blank padding enumeration specifies the blank_pad setting in a_create_db.
• Unit() enumeration
  Used in the a_create_db structure, to specify the value of db_size_unit.
• Unload() enumeration
  The type of unload being performed, as used by the an_unload_db structure.
• UserList() enumeration
  The type of a user list, as used by an a_translate_log structure.
• Validation() enumeration
  The type of validation being performed, as used by the a_validate_db structure.
• Verbosity() enumeration
  Verbosity enumeration specifies the volume of output.
• Version() enumeration
  Used in the a_db_version_info structure, to indicate the version of SQL Anywhere that initially created the database.
• a_backup_db structure
  Holds the information needed to perform backup tasks using the DBTools library.
• a_change_log structure
  Holds the information needed to perform dblog tasks using the DBTools library.
• a_create_db structure
  Holds the information needed to create a database using the DBTools library.
• a_db_info structure
  Holds the information needed to return DBInfo information using the DBTools library.
• a_db_version_info structure
  Holds information regarding which version of SQL Anywhere was used to create the database.
• a_dblic_info structure
  Holds information containing licensing information.
• a_dbtools_info structure
  DBTools information callback used to initialize and finalize the DBTools library calls.
• a_log_file_info structure
  Used to obtain the log file and mirror log file information of a non-running database.
• a_name structure
  Specifies a variable list of names.
• a_remote_sql structure
  Holds information needed for the dbremote utility using the DBTools library.
• a_sync_db structure
  Holds information needed for the dbmlsync utility using the DBTools library.
• a_syncpub structure
  Holds information needed for the dbmlsync utility.
• a_sysinfo structure
  Holds information needed for dbinfo and dbunload utilities using the DBTools library.
• a_table_info structure
  Holds information about a table needed as part of the a_db_info structure.
• a_translate_log structure
  Holds information needed for transaction log translation using the DBTools library.
• a_truncate_log structure
  Holds information needed for transaction log truncation using the DBTools library.
• a_validate_db structure
  Holds information needed for database validation using the DBTools library.
• an_erase_db structure
  Holds information needed to erase a database using the DBTools library.
• an_unload_db structure
  Holds information needed to unload a database using the DBTools library or extract a remote database for SQL Remote.
• an_upgrade_db structure
  Holds information needed to upgrade a database using the DBTools library.