git.sur5r.net Git - bacula/bacula/blob - bacula/src/cats/protos.h

   1 /*
   2    Bacula(R) - The Network Backup Solution
   3
   4    Copyright (C) 2000-2016 Kern Sibbald
   5
   6    The original author of Bacula is Kern Sibbald, with contributions
   7    from many others, a complete list can be found in the file AUTHORS.
   8
   9    You may use this file and others of this release according to the
  10    license defined in the LICENSE file, which includes the Affero General
  11    Public License, v3.0 ("AGPLv3") and some additional permissions and
  12    terms pursuant to its AGPLv3 Section 7.
  13
  14    This notice must be preserved when any source code is
  15    conveyed and/or propagated.
  16
  17    Bacula(R) is a registered trademark of Kern Sibbald.
  18 */
  19 /*
  20  *
  21  *  Database routines that are exported by the cats library for
  22  *    use elsewhere in Bacula (mainly the Director).
  23  *
  24  * Note: the interface that is used by the core Bacula code outside
  25  *  of the cats directory has names that are:
  26  *  db_xxx(x, db, y, ...)
  27  *  usually with a database pointer such as db as an argument.
  28  *  This simplifies the vast bulk of the code and makes it easier to read.
  29  *  These are translated into class calls on the db pointer by a #define
  30  *  in this file.
  31  *
  32  *  The actual class code is named bdb_xxx(x, y, ...) and is called with
  33  *  the class pointer such as db->bdb_xxx(x, y, ...)  The code in this
  34  *  cats directory can use the db_xxx() calls or the db->bdb_xxx() calls.
  35  *  In the Bacula core code we prefer using only the db_xxx() calls.
  36  *
  37  *    Written by Kern Sibbald, MM
  38  */
  39
  40 #ifndef __SQL_PROTOS_H
  41 #define __SQL_PROTOS_H
  42
  43 #include "cats.h"
  44
  45 BDB *db_init_database(JCR *jcr, const char *db_driver, const char *db_name,
  46         const char *db_user, const char *db_password,
  47         const char *db_address, int db_port,
  48         const char *db_socket, const char *db_ssl_key,
  49         const char *db_ssl_cert, const char *db_ssl_ca,
  50         const char *db_ssl_capath, const char *db_ssl_cipher,
  51         bool mult_db_connections, bool disable_batch_insert);
  52
  53 /* Database prototypes and defines */
  54
  55 /* Misc */
  56 #define db_lock(mdb) \
  57            mdb->bdb_lock()
  58 #define db_unlock(mdb) \
  59            mdb->bdb_unlock()
  60
  61
  62 /* Virtual methods */
  63 #define db_escape_string(jcr, mdb, snew, old, len) \
  64            mdb->bdb_escape_string(jcr, snew, old, len)
  65 #define db_escape_object(jcr, mdb, old, len) \
  66            mdb->bdb_escape_object(jcr, old, len)
  67 #define db_unescape_object(jcr, mdb, from, expected_len, dest, len) \
  68            mdb->bdb_unescape_object(jcr, from, expected_len, dest, len)
  69 #define db_open_database(jcr, mdb) \
  70            mdb->bdb_open_database(jcr)
  71 #define db_close_database(jcr, mdb) \
  72            mdb->bdb_close_database(jcr)
  73 #define db_close_database(jcr, mdb) \
  74            mdb->bdb_close_database(jcr)
  75 #define db_start_transaction(jcr, mdb) \
  76            mdb->bdb_start_transaction(jcr)
  77 #define db_end_transaction(jcr, mdb) \
  78            if (mdb) mdb->bdb_end_transaction(jcr)
  79 #define db_sql_query(mdb, query, result_handler, ctx) \
  80            mdb->bdb_sql_query(query, result_handler, ctx)
  81 #define db_thread_cleanup(mdb) \
  82            if (mdb) mdb->bdb_thread_cleanup()
  83
  84 /* sql.c */
  85 int db_int64_handler(void *ctx, int num_fields, char **row);
  86 int db_strtime_handler(void *ctx, int num_fields, char **row);
  87 int db_list_handler(void *ctx, int num_fields, char **row);
  88 int db_string_list_handler(void *ctx, int num_fields, char **row);
  89 int db_int_handler(void *ctx, int num_fields, char **row);
  90 void bdb_debug_print(JCR *jcr, FILE *fp);
  91 void db_free_restoreobject_record(JCR *jcr, ROBJECT_DBR *rr);
  92
  93 #define db_open_batch_connexion(jcr, mdb) \
  94            mdb->bdb_open_batch_connexion(jcr)
  95 #define db_strerror(mdb) \
  96            mdb->bdb_strerror()
  97 #define db_debug_print(jcr, fp) \
  98            bdb_debug_print(jcr, fp)
  99 #define db_check_max_connections(jcr, mdb, maxc) \
 100            mdb->bdb_check_max_connections(jcr, maxc)
 101
 102 /* sql_create.c */
 103 bool bdb_write_batch_file_records(JCR *jcr);
 104 void bdb_disable_batch_insert(bool disable);
 105
 106 /* sql_get.c */
 107 void bdb_free_restoreobject_record(JCR *jcr, ROBJECT_DBR *rr);
 108
 109
 110 /* sql_create.c */
 111 #define db_create_path_record(jcr, mdb, ar) \
 112            mdb->bdb_create_path_record(jcr, ar)
 113 #define db_create_file_attributes_record(jcr, mdb, ar) \
 114            mdb->bdb_create_file_attributes_record(jcr, ar)
 115 #define db_create_job_record(jcr, mdb, jr) \
 116            mdb->bdb_create_job_record(jcr, jr)
 117 #define db_create_media_record(jcr, mdb, media_dbr) \
 118            mdb->bdb_create_media_record(jcr, media_dbr)
 119 #define db_create_client_record(jcr, mdb, cr) \
 120            mdb->bdb_create_client_record(jcr, cr)
 121 #define db_create_fileset_record(jcr, mdb, fsr) \
 122            mdb->bdb_create_fileset_record(jcr, fsr)
 123 #define db_create_pool_record(jcr, mdb, pool_dbr) \
 124            mdb->bdb_create_pool_record(jcr, pool_dbr)
 125 #define db_create_jobmedia_record(jcr, mdb, jr) \
 126            mdb->bdb_create_jobmedia_record(jcr, jr)
 127 #define db_create_counter_record(jcr, mdb, cr) \
 128            mdb->bdb_create_counter_record(jcr, cr)
 129 #define db_create_device_record(jcr, mdb, dr) \
 130            mdb->bdb_create_device_record(jcr, dr)
 131 #define db_create_storage_record(jcr, mdb, sr) \
 132            mdb->bdb_create_storage_record(jcr, sr)
 133 #define db_create_mediatype_record(jcr, mdb, mr) \
 134            mdb->bdb_create_mediatype_record(jcr, mr)
 135 #define db_write_batch_file_records(jcr) \
 136            bdb_write_batch_file_records(jcr)
 137 #define db_create_attributes_record(jcr, mdb, ar) \
 138            mdb->bdb_create_attributes_record(jcr, ar)
 139 #define db_create_restore_object_record(jcr, mdb, ar) \
 140            mdb->bdb_create_restore_object_record(jcr, ar)
 141 #define db_create_base_file_attributes_record(jcr, mdb, ar) \
 142            mdb->bdb_create_base_file_attributes_record(jcr, ar)
 143 #define db_commit_base_file_attributes_record(jcr, mdb) \
 144            mdb->bdb_commit_base_file_attributes_record(jcr)
 145 #define db_create_base_file_list(jcr, mdb, jobids) \
 146            mdb->bdb_create_base_file_list(jcr, jobids)
 147 #define db_disable_batch_insert(disable) \
 148            bdb_disable_batch_insert(disable)
 149 #define db_create_snapshot_record(jcr, mdb, sr) \
 150            mdb->bdb_create_snapshot_record(jcr, sr)
 151 #define db_get_job_statistics(jcr, mdb, jr)      \
 152            mdb->bdb_get_job_statistics(jcr, jr)
 153
 154 /* sql_delete.c */
 155 #define db_delete_pool_record(jcr, mdb, pool_dbr) \
 156            mdb->bdb_delete_pool_record(jcr, pool_dbr)
 157 #define db_delete_media_record(jcr, mdb, mr) \
 158            mdb->bdb_delete_media_record(jcr, mr)
 159 #define db_purge_media_record(jcr, mdb, mr) \
 160            mdb->bdb_purge_media_record(jcr, mr)
 161 #define db_delete_snapshot_record(jcr, mdb, sr) \
 162            mdb->bdb_delete_snapshot_record(jcr, sr)
 163
 164
 165 /* sql_find.c */
 166 #define db_find_last_job_end_time(jcr, mdb, jr, etime, job) \
 167            mdb->bdb_find_last_job_end_time(jcr, jr, etime, job)
 168 #define db_find_last_job_start_time(jcr, mdb, jr, stime, job, JobLevel) \
 169            mdb->bdb_find_last_job_start_time(jcr, jr, stime, job, JobLevel)
 170 #define db_find_job_start_time(jcr, mdb, jr, stime, job) \
 171            mdb->bdb_find_job_start_time(jcr, jr, stime, job)
 172 #define db_find_last_jobid(jcr, mdb, Name, jr) \
 173            mdb->bdb_find_last_jobid(jcr, Name, jr)
 174 #define db_find_next_volume(jcr, mdb, index, InChanger, mr) \
 175            mdb->bdb_find_next_volume(jcr, index, InChanger, mr)
 176 #define db_find_failed_job_since(jcr, mdb, jr, stime, JobLevel) \
 177            mdb->bdb_find_failed_job_since(jcr, jr, stime, JobLevel)
 178
 179 /* sql_get.c */
 180 #define db_get_volume_jobids(jcr, mdb, mr, lst) \
 181            mdb->bdb_get_volume_jobids(jcr, mr, lst)
 182 #define db_get_base_file_list(jcr, mdb, use_md5, result_handler, ctx) \
 183            mdb->bdb_get_base_file_list(jcr, use_md5, result_handler, ctx)
 184 #define db_get_path_record(jcr, mdb) \
 185            mdb->bdb_get_path_record(jcr)
 186 #define db_get_pool_record(jcr, mdb, pdbr) \
 187            mdb->bdb_get_pool_record(jcr, pdbr)
 188 #define db_get_pool_numvols(jcr, mdb, pdbr) \
 189            mdb->bdb_get_pool_numvols(jcr, pdbr)
 190 #define db_get_client_record(jcr, mdb, cr) \
 191            mdb->bdb_get_client_record(jcr, cr)
 192 #define db_get_job_record(jcr, mdb, jr) \
 193            mdb->bdb_get_job_record(jcr, jr)
 194 #define db_get_job_volume_names(jcr, mdb, JobId, VolumeNames) \
 195            mdb->bdb_get_job_volume_names(jcr, JobId, VolumeNames)
 196 #define db_get_file_attributes_record(jcr, mdb, fname, jr, fdbr) \
 197            mdb->bdb_get_file_attributes_record(jcr, fname, jr, fdbr)
 198 #define db_get_fileset_record(jcr, mdb, fsr) \
 199            mdb->bdb_get_fileset_record(jcr, fsr)
 200 #define db_get_media_record(jcr, mdb, mr) \
 201            mdb->bdb_get_media_record(jcr, mr)
 202 #define db_get_num_media_records(jcr, mdb) \
 203            mdb->bdb_get_num_media_records(jcr)
 204 #define db_get_num_pool_records(jcr, mdb) \
 205            mdb->bdb_get_num_pool_records(jcr)
 206 #define db_get_pool_ids(jcr, mdb, num_ids, ids) \
 207            mdb->bdb_get_pool_ids(jcr, num_ids, ids)
 208 #define db_get_client_ids(jcr, mdb, num_ids, ids) \
 209            mdb->bdb_get_client_ids(jcr, num_ids, ids)
 210 #define db_get_media_ids(jcr, mdb, mr, num_ids, ids) \
 211            mdb->bdb_get_media_ids(jcr, mr, num_ids, ids)
 212 #define db_get_job_volume_parameters(jcr, mdb, JobId, VolParams) \
 213            mdb->bdb_get_job_volume_parameters(jcr, JobId, VolParams)
 214 #define db_get_counter_record(jcr, mdb, cr) \
 215            mdb->bdb_get_counter_record(jcr, cr)
 216 #define db_get_query_dbids(jcr, mdb, query, ids) \
 217            mdb->bdb_get_query_dbids(jcr, query, ids)
 218 #define db_get_file_list(jcr, mdb, jobids, use_md5, use_delta, result_handler, ctx) \
 219            mdb->bdb_get_file_list(jcr, jobids, use_md5, use_delta, result_handler, ctx)
 220 #define db_get_base_jobid(jcr, mdb, jr, jobid) \
 221            mdb->bdb_get_base_jobid(jcr, jr, jobid)
 222 #define db_get_accurate_jobids(jcr, mdb, jr, jobids) \
 223            mdb->bdb_get_accurate_jobids(jcr, jr, jobids)
 224 #define db_get_used_base_jobids(jcr, mdb, jobids, result) \
 225            mdb->bdb_get_used_base_jobids(jcr, jobids, result)
 226 #define db_get_restoreobject_record(jcr, mdb, rr) \
 227            mdb->bdb_get_restoreobject_record(jcr, rr)
 228 #define db_get_type_index(mdb) \
 229            mdb->bdb_get_type_index()
 230 #define db_get_engine_name(mdb) \
 231            mdb->bdb_get_engine_name()
 232 #define db_get_snapshot_record(jcr, mdb, sr) \
 233            mdb->bdb_get_snapshot_record(jcr, sr)
 234
 235 /* sql_list.c */
 236 #define db_list_pool_records(jcr, mdb, pr, sendit, ctx, type) \
 237            mdb->bdb_list_pool_records(jcr, pr, sendit, ctx, type)
 238 #define db_list_job_records(jcr, mdb, jr, sendit, ctx, type) \
 239            mdb->bdb_list_job_records(jcr, jr, sendit, ctx, type)
 240 #define db_list_job_totals(jcr, mdb, jr, sendit, ctx) \
 241            mdb->bdb_list_job_totals(jcr, jr, sendit, ctx)
 242 #define db_list_files_for_job(jcr, mdb, jobid, deleted, sendit, ctx)     \
 243            mdb->bdb_list_files_for_job(jcr, jobid, deleted, sendit, ctx)
 244 #define db_list_media_records(jcr, mdb, mdbr, sendit, ctx, type) \
 245            mdb->bdb_list_media_records(jcr, mdbr, sendit, ctx, type)
 246 #define db_list_jobmedia_records(jcr, mdb, JobId, sendit, ctx, type) \
 247            mdb->bdb_list_jobmedia_records(jcr, JobId, sendit, ctx, type)
 248 #define db_list_joblog_records(jcr, mdb, JobId, sendit, ctx, type) \
 249            mdb->bdb_list_joblog_records(jcr, JobId, sendit, ctx, type)
 250 #define db_list_sql_query(jcr, mdb, query, sendit, ctx, verbose, type) \
 251            mdb->bdb_list_sql_query(jcr, query, sendit, ctx, verbose, type)
 252 #define db_list_client_records(jcr, mdb, sendit, ctx, type) \
 253            mdb->bdb_list_client_records(jcr, sendit, ctx, type)
 254 #define db_list_copies_records(jcr, mdb, limit, jobids, sendit, ctx, type) \
 255            mdb->bdb_list_copies_records(jcr, limit, jobids, sendit, ctx, type)
 256 #define db_list_base_files_for_job(jcr, mdb, jobid, sendit, ctx) \
 257            mdb->bdb_list_base_files_for_job(jcr, jobid, sendit, ctx)
 258 #define db_list_restore_objects(jcr, mdb, rr, sendit, ctx, type) \
 259            mdb->bdb_list_restore_objects(jcr, rr, sendit, ctx, type)
 260 #define db_list_snapshot_records(jcr, mdb, snapdbr, sendit, ua, llist) \
 261            mdb->bdb_list_snapshot_records(jcr, snapdbr, sendit, ua, llist)
 262
 263
 264
 265 /* sql_update.c */
 266 #define db_update_job_start_record(jcr, mdb, jr) \
 267            mdb->bdb_update_job_start_record(jcr, jr)
 268 #define db_update_job_end_record(jcr, mdb, jr) \
 269            mdb->bdb_update_job_end_record(jcr, jr)
 270 #define db_update_client_record(jcr, mdb, cr) \
 271            mdb->bdb_update_client_record(jcr, cr)
 272 #define db_update_pool_record(jcr, mdb, pr) \
 273            mdb->bdb_update_pool_record(jcr, pr)
 274 #define db_update_storage_record(jcr, mdb, sr) \
 275            mdb->bdb_update_storage_record(jcr, sr)
 276 #define db_update_media_record(jcr, mdb, mr) \
 277            mdb->bdb_update_media_record(jcr, mr)
 278 #define db_update_media_defaults(jcr, mdb, mr) \
 279            mdb->bdb_update_media_defaults(jcr, mr)
 280 #define db_update_counter_record(jcr, mdb, cr) \
 281            mdb->bdb_update_counter_record(jcr, cr)
 282 #define db_add_digest_to_file_record(jcr, mdb, FileId, digest, type) \
 283            mdb->bdb_add_digest_to_file_record(jcr, FileId, digest, type)
 284 #define db_mark_file_record(jcr, mdb, FileId, JobId) \
 285            mdb->bdb_mark_file_record(jcr, FileId, JobId)
 286 #define db_make_inchanger_unique(jcr, mdb, mr) \
 287            mdb->bdb_make_inchanger_unique(jcr, mr)
 288 #define db_update_stats(jcr, mdb, age) \
 289            mdb->bdb_update_stats(jcr, age)
 290 #define db_update_snapshot_record(jcr, mdb, sr) \
 291            mdb->bdb_update_snapshot_record(jcr, sr)
 292
 293
 294 #endif /* __SQL_PROTOS_H */