]> git.sur5r.net Git - bacula/bacula/blobdiff - bacula/src/cats/protos.h
Merge branch 'master' into basejobv3
[bacula/bacula] / bacula / src / cats / protos.h
index 59335b2edcde9e5ab84524670d75f3b56aa7b473..1349aa4e56e2d706ba7c652f034283f785f85bdb 100644 (file)
@@ -1,21 +1,36 @@
 /*
-   Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
+   Bacula® - The Network Backup Solution
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of
-   the License, or (at your option) any later version.
+   Copyright (C) 2000-2008 Free Software Foundation Europe e.V.
 
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   The main author of Bacula is Kern Sibbald, with contributions from
+   many others, a complete list can be found in the file AUTHORS.
+   This program is Free Software; you can redistribute it and/or
+   modify it under the terms of version two of the GNU General Public
+   License as published by the Free Software Foundation and included
+   in the file LICENSE.
+
+   This program is distributed in the hope that it will be useful, but
+   WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
    General Public License for more details.
 
-   You should have received a copy of the GNU General Public
-   License along with this program; if not, write to the Free
-   Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
-   MA 02111-1307, USA.
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+   02110-1301, USA.
 
+   Bacula® is a registered trademark of Kern Sibbald.
+   The licensor of Bacula is the Free Software Foundation Europe
+   (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
+   Switzerland, email:ftf@fsfeurope.org.
+*/
+/*
+ *
+ *  Database routines that are exported by the cats library for
+ *    use elsewhere in Bacula (mainly the Director).
+ *
+ *    Version $Id$
  */
 
 #ifndef __SQL_PROTOS_H
 /* Database prototypes */
 
 /* sql.c */
-B_DB *db_init_database(char *db_name, char *db_user, char *db_password);
-int db_open_database(B_DB *db);
-void db_close_database(B_DB *db);
-void db_escape_string(char *snew, char *old, int len);
+B_DB *db_init(JCR *jcr, const char *db_driver, const char *db_name, const char *db_user, 
+              const char *db_password, const char *db_address, int db_port, 
+              const char *db_socket, int mult_db_connections);
+B_DB *db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
+                       const char *db_address, int db_port, const char *db_socket,
+                       int mult_db_connections);
+int  db_open_database(JCR *jcr, B_DB *db);
+void db_close_database(JCR *jcr, B_DB *db);
+bool db_open_batch_connexion(JCR *jcr, B_DB *mdb);
+void db_escape_string(JCR *jcr, B_DB *db, char *snew, char *old, int len);
 char *db_strerror(B_DB *mdb);
-int get_sql_record_max(B_DB *mdb);
-char *db_next_index(B_DB *mdb, char *table);
-int db_sql_query(B_DB *mdb, char *cmd, DB_RESULT_HANDLER *result_handler, void *ctx);
-
-/* create.c */
-int db_create_file_attributes_record(B_DB *mdb, ATTR_DBR *ar);
-int db_create_job_record(B_DB *db, JOB_DBR *jr);
-int db_create_media_record(B_DB *db, MEDIA_DBR *media_dbr);
-int db_create_client_record(B_DB *db, CLIENT_DBR *cr);
-int db_create_fileset_record(B_DB *db, FILESET_DBR *fsr);
-int db_create_pool_record(B_DB *db, POOL_DBR *pool_dbr);
-int db_create_jobmedia_record(B_DB *mdb, JOBMEDIA_DBR *jr);
-
-/* delete.c */
-int db_delete_pool_record(B_DB *db, POOL_DBR *pool_dbr);
-int db_delete_media_record(B_DB *mdb, MEDIA_DBR *mr);
-
-/* find.c */
-int db_find_job_start_time(B_DB *mdb, JOB_DBR *jr, char *stime);
-int db_find_last_full_verify(B_DB *mdb, JOB_DBR *jr);
-int db_find_next_volume(B_DB *mdb, int index, MEDIA_DBR *mr);
-
-/* get.c */
-int db_get_pool_record(B_DB *db, POOL_DBR *pdbr);
-int db_get_client_record(B_DB *mdb, CLIENT_DBR *cr);
-int db_get_job_record(B_DB *mdb, JOB_DBR *jr);
-int db_get_job_volume_names(B_DB *mdb, uint32_t JobId, char *VolumeNames);
-int db_get_file_attributes_record(B_DB *mdb, char *fname, FILE_DBR *fdbr);
-int db_get_fileset_record(B_DB *mdb, FILESET_DBR *fsr);
-int db_get_media_record(B_DB *mdb, MEDIA_DBR *mr);
-int db_get_num_media_records(B_DB *mdb);
-int db_get_num_pool_records(B_DB *mdb);
-int db_get_pool_ids(B_DB *mdb, int *num_ids, uint32_t **ids);
-int db_get_media_ids(B_DB *mdb, int *num_ids, uint32_t **ids);
-
-
-/* list.c */
-void db_list_pool_records(B_DB *db, DB_LIST_HANDLER sendit, void *ctx);
-void db_list_job_records(B_DB *db, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx);
-void db_list_job_totals(B_DB *db, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx);
-void db_list_files_for_job(B_DB *db, uint32_t jobid, DB_LIST_HANDLER sendit, void *ctx);
-void db_list_media_records(B_DB *mdb, MEDIA_DBR *mdbr, DB_LIST_HANDLER *sendit, void *ctx);
-void db_list_jobmedia_records(B_DB *mdb, uint32_t JobId, DB_LIST_HANDLER *sendit, void *ctx);
-int  db_list_sql_query(B_DB *mdb, char *query, DB_LIST_HANDLER *sendit, void *ctx);
-
-/* update.c */
-int  db_update_job_start_record(B_DB *db, JOB_DBR *jr);
-int  db_update_job_end_record(B_DB *db, JOB_DBR *jr);
-int  db_update_pool_record(B_DB *db, POOL_DBR *pr);
-int  db_update_media_record(B_DB *db, MEDIA_DBR *mr);
-int  db_add_MD5_to_file_record(B_DB *mdb, FileId_t FileId, char *MD5);  
-int  db_mark_file_record(B_DB *mdb, FileId_t FileId, int JobId);
+int  db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index);
+bool db_sql_query(B_DB *mdb, const char *cmd, DB_RESULT_HANDLER *result_handler, void *ctx);
+void db_start_transaction(JCR *jcr, B_DB *mdb);
+void db_end_transaction(JCR *jcr, B_DB *mdb);
+int db_int64_handler(void *ctx, int num_fields, char **row);
+void db_thread_cleanup();
+void _dbg_print_db(JCR *jcr, FILE *fp);
+
+/* sql_create.c */
+bool db_create_file_attributes_record(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
+bool db_create_job_record(JCR *jcr, B_DB *db, JOB_DBR *jr);
+int db_create_media_record(JCR *jcr, B_DB *db, MEDIA_DBR *media_dbr);
+int db_create_client_record(JCR *jcr, B_DB *db, CLIENT_DBR *cr);
+bool db_create_fileset_record(JCR *jcr, B_DB *db, FILESET_DBR *fsr);
+bool db_create_pool_record(JCR *jcr, B_DB *db, POOL_DBR *pool_dbr);
+bool db_create_jobmedia_record(JCR *jcr, B_DB *mdb, JOBMEDIA_DBR *jr);
+int db_create_counter_record(JCR *jcr, B_DB *mdb, COUNTER_DBR *cr);
+bool db_create_device_record(JCR *jcr, B_DB *mdb, DEVICE_DBR *dr);
+bool db_create_storage_record(JCR *jcr, B_DB *mdb, STORAGE_DBR *sr);
+bool db_create_mediatype_record(JCR *jcr, B_DB *mdb, MEDIATYPE_DBR *mr);
+bool db_write_batch_file_records(JCR *jcr);
+bool my_batch_start(JCR *jcr, B_DB *mdb);
+bool my_batch_end(JCR *jcr, B_DB *mdb, const char *error);
+bool my_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
+
+/* sql_delete.c */
+int db_delete_pool_record(JCR *jcr, B_DB *db, POOL_DBR *pool_dbr);
+int db_delete_media_record(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr);
+
+/* sql_find.c */
+bool db_find_last_job_start_time(JCR *jcr, B_DB *mdb, JOB_DBR *jr, POOLMEM **stime, int JobLevel);
+bool db_find_job_start_time(JCR *jcr, B_DB *mdb, JOB_DBR *jr, POOLMEM **stime);
+bool db_find_last_jobid(JCR *jcr, B_DB *mdb, const char *Name, JOB_DBR *jr);
+int db_find_next_volume(JCR *jcr, B_DB *mdb, int index, bool InChanger, MEDIA_DBR *mr);
+bool db_find_failed_job_since(JCR *jcr, B_DB *mdb, JOB_DBR *jr, POOLMEM *stime, int &JobLevel);
+
+/* sql_get.c */
+bool db_get_pool_record(JCR *jcr, B_DB *db, POOL_DBR *pdbr);
+int db_get_client_record(JCR *jcr, B_DB *mdb, CLIENT_DBR *cr);
+bool db_get_job_record(JCR *jcr, B_DB *mdb, JOB_DBR *jr);
+int db_get_job_volume_names(JCR *jcr, B_DB *mdb, JobId_t JobId, POOLMEM **VolumeNames);
+int db_get_file_attributes_record(JCR *jcr, B_DB *mdb, char *fname, JOB_DBR *jr, FILE_DBR *fdbr);
+int db_get_fileset_record(JCR *jcr, B_DB *mdb, FILESET_DBR *fsr);
+bool db_get_media_record(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr);
+int db_get_num_media_records(JCR *jcr, B_DB *mdb);
+int db_get_num_pool_records(JCR *jcr, B_DB *mdb);
+int db_get_pool_ids(JCR *jcr, B_DB *mdb, int *num_ids, DBId_t **ids);
+int db_get_client_ids(JCR *jcr, B_DB *mdb, int *num_ids, DBId_t **ids);
+bool db_get_media_ids(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr, int *num_ids, uint32_t **ids);
+int db_get_job_volume_parameters(JCR *jcr, B_DB *mdb, JobId_t JobId, VOL_PARAMS **VolParams);
+int db_get_client_record(JCR *jcr, B_DB *mdb, CLIENT_DBR *cdbr);
+int db_get_counter_record(JCR *jcr, B_DB *mdb, COUNTER_DBR *cr);
+bool db_get_query_dbids(JCR *jcr, B_DB *mdb, POOL_MEM &query, dbid_list &ids);
+bool db_get_file_list(JCR *jcr, B_DB *mdb, char *jobids, DB_RESULT_HANDLER *result_handler, void *ctx);
+bool db_get_base_jobid(JCR *jcr, B_DB *mdb, JOB_DBR *jr, JobId_t *jobid);
+bool db_accurate_get_jobids(JCR *jcr, B_DB *mdb, JOB_DBR *jr, POOLMEM *jobids);
+int db_get_int_handler(void *ctx, int num_fields, char **row);
+
+
+/* sql_list.c */
+enum e_list_type {
+   HORZ_LIST,
+   VERT_LIST
+};
+void db_list_pool_records(JCR *jcr, B_DB *db, POOL_DBR *pr, DB_LIST_HANDLER sendit, void *ctx, e_list_type type);
+void db_list_job_records(JCR *jcr, B_DB *db, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx, e_list_type type);
+void db_list_job_totals(JCR *jcr, B_DB *db, JOB_DBR *jr, DB_LIST_HANDLER sendit, void *ctx);
+void db_list_files_for_job(JCR *jcr, B_DB *db, uint32_t jobid, DB_LIST_HANDLER sendit, void *ctx);
+void db_list_media_records(JCR *jcr, B_DB *mdb, MEDIA_DBR *mdbr, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
+void db_list_jobmedia_records(JCR *jcr, B_DB *mdb, JobId_t JobId, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
+void db_list_joblog_records(JCR *jcr, B_DB *mdb, JobId_t JobId, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
+int  db_list_sql_query(JCR *jcr, B_DB *mdb, const char *query, DB_LIST_HANDLER *sendit, void *ctx, int verbose, e_list_type type);
+void db_list_client_records(JCR *jcr, B_DB *mdb, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
+void db_list_copies_records(JCR *jcr, B_DB *mdb, uint32_t limit, char *jobids, DB_LIST_HANDLER *sendit, void *ctx, e_list_type type);
+void
+db_list_base_files_for_job(JCR *jcr, B_DB *mdb, JobId_t jobid, DB_LIST_HANDLER *sendit, void *ctx);
+
+
+/* sql_update.c */
+bool db_update_job_start_record(JCR *jcr, B_DB *db, JOB_DBR *jr);
+int  db_update_job_end_record(JCR *jcr, B_DB *db, JOB_DBR *jr);
+int  db_update_client_record(JCR *jcr, B_DB *mdb, CLIENT_DBR *cr);
+int  db_update_pool_record(JCR *jcr, B_DB *db, POOL_DBR *pr);
+bool db_update_storage_record(JCR *jcr, B_DB *mdb, STORAGE_DBR *sr);
+int  db_update_media_record(JCR *jcr, B_DB *db, MEDIA_DBR *mr);
+int  db_update_media_defaults(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr);
+int  db_update_counter_record(JCR *jcr, B_DB *mdb, COUNTER_DBR *cr);
+int  db_add_digest_to_file_record(JCR *jcr, B_DB *mdb, FileId_t FileId, char *digest, int type);
+int  db_mark_file_record(JCR *jcr, B_DB *mdb, FileId_t FileId, JobId_t JobId);
+void db_make_inchanger_unique(JCR *jcr, B_DB *mdb, MEDIA_DBR *mr);
+int db_update_stats(JCR *jcr, B_DB *mdb, utime_t age);
+
+
+bool db_get_used_base_jobids(JCR *jcr, B_DB *mdb, POOLMEM *jobids, POOLMEM *result);
+bool db_create_attributes_record(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
+bool db_create_base_file_attributes_record(JCR *jcr, B_DB *mdb, ATTR_DBR *ar);
+bool db_commit_base_file_attributes_record(JCR *jcr, B_DB *mdb);
+bool db_create_base_file_list(JCR *jcr, B_DB *mdb, char *jobids);
+bool db_get_base_file_list(JCR *jcr, B_DB *mdb, DB_RESULT_HANDLER *result_handler, 
+                           void *ctx);
+
 
 #endif /* __SQL_PROTOS_H */