2 Bacula® - The Network Backup Solution
4 Copyright (C) 2003-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of Kern Sibbald.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
29 * Bacula Catalog Database routines specific to PostgreSQL
30 * These are PostgreSQL specific routines
32 * Dan Langille, December 2003
33 * based upon work done by Kern Sibbald, March 2000
39 /* The following is necessary so that we do not include
40 * the dummy external definition of DB.
42 #define __SQL_C /* indicate that this is sql.c */
47 #ifdef HAVE_POSTGRESQL
49 #include "postgres_ext.h" /* needed for NAMEDATALEN */
50 #include "pg_config_manual.h" /* get NAMEDATALEN on version 8.3 or later */
52 /* -----------------------------------------------------------------------
54 * PostgreSQL dependent defines and subroutines
56 * -----------------------------------------------------------------------
59 /* List of open databases */
60 static BQUEUE db_list = {&db_list, &db_list};
62 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
65 * Retrieve database type
75 * Initialize database data structure. In principal this should
76 * never have errors, or it is really fatal.
79 db_init_database(JCR *jcr, const char *db_name, const char *db_user, const char *db_password,
80 const char *db_address, int db_port, const char *db_socket,
81 int mult_db_connections)
86 Jmsg(jcr, M_FATAL, 0, _("A user name for PostgreSQL must be supplied.\n"));
89 P(mutex); /* lock DB queue */
90 if (!mult_db_connections) {
91 /* Look to see if DB already open */
92 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
93 if (bstrcmp(mdb->db_name, db_name) &&
94 bstrcmp(mdb->db_address, db_address) &&
95 mdb->db_port == db_port) {
96 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
99 return mdb; /* already open */
103 Dmsg0(100, "db_open first time\n");
104 mdb = (B_DB *)malloc(sizeof(B_DB));
105 memset(mdb, 0, sizeof(B_DB));
106 mdb->db_name = bstrdup(db_name);
107 mdb->db_user = bstrdup(db_user);
109 mdb->db_password = bstrdup(db_password);
112 mdb->db_address = bstrdup(db_address);
115 mdb->db_socket = bstrdup(db_socket);
117 mdb->db_port = db_port;
118 mdb->have_insert_id = TRUE;
119 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
121 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
122 mdb->cached_path = get_pool_memory(PM_FNAME);
123 mdb->cached_path_id = 0;
125 mdb->fname = get_pool_memory(PM_FNAME);
126 mdb->path = get_pool_memory(PM_FNAME);
127 mdb->esc_name = get_pool_memory(PM_FNAME);
128 mdb->esc_path = get_pool_memory(PM_FNAME);
129 mdb->allow_transactions = mult_db_connections;
130 qinsert(&db_list, &mdb->bq); /* put db in list */
135 /* Check that the database correspond to the encoding we want */
136 static bool check_database_encoding(JCR *jcr, B_DB *mdb)
141 if (!db_sql_query(mdb, "SELECT getdatabaseencoding()", NULL, NULL)) {
142 Jmsg(jcr, M_ERROR, 0, "%s", mdb->errmsg);
146 if ((row = sql_fetch_row(mdb)) == NULL) {
147 Mmsg1(mdb->errmsg, _("error fetching row: %s\n"), sql_strerror(mdb));
148 Jmsg(jcr, M_ERROR, 0, "Can't check database encoding %s", mdb->errmsg);
150 ret = bstrcmp(row[0], "SQL_ASCII");
153 /* if we are in SQL_ASCII, we can force the client_encoding to SQL_ASCII too */
154 db_sql_query(mdb, "SET client_encoding TO 'SQL_ASCII'", NULL, NULL);
156 } else { /* something is wrong with database encoding */
158 _("Encoding error for database \"%s\". Wanted SQL_ASCII, got %s\n"),
159 mdb->db_name, row[0]);
160 Jmsg(jcr, M_WARNING, 0, "%s", mdb->errmsg);
161 Dmsg1(50, "%s", mdb->errmsg);
168 * Now actually open the database. This can generate errors,
169 * which are returned in the errmsg
171 * DO NOT close the database or free(mdb) here !!!!
174 db_open_database(JCR *jcr, B_DB *mdb)
179 #ifdef xxx /* require libpq >= 8.2 */
180 if (!PQisthreadsafe()) {
181 Jmsg(jcr, M_ABORT, 0, _("PostgreSQL configuration problem. "
182 "PostgreSQL library is not thread safe. Cannot continue.\n"));
186 if (mdb->connected) {
190 mdb->connected = false;
192 if ((errstat=rwl_init(&mdb->lock)) != 0) {
194 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
195 be.bstrerror(errstat));
201 bsnprintf(buf, sizeof(buf), "%d", mdb->db_port);
207 /* If connection fails, try at 5 sec intervals for 30 seconds. */
208 for (int retry=0; retry < 6; retry++) {
209 /* connect to the database */
210 mdb->db = PQsetdbLogin(
211 mdb->db_address, /* default = localhost */
212 port, /* default port */
213 NULL, /* pg options */
214 NULL, /* tty, ignored */
215 mdb->db_name, /* database name */
216 mdb->db_user, /* login name */
217 mdb->db_password); /* password */
219 /* If no connect, try once more in case it is a timing problem */
220 if (PQstatus(mdb->db) == CONNECTION_OK) {
226 Dmsg0(50, "pg_real_connect done\n");
227 Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
228 mdb->db_password==NULL?"(NULL)":mdb->db_password);
230 if (PQstatus(mdb->db) != CONNECTION_OK) {
231 Mmsg2(&mdb->errmsg, _("Unable to connect to PostgreSQL server.\n"
232 "Database=%s User=%s\n"
233 "It is probably not running or your password is incorrect.\n"),
234 mdb->db_name, mdb->db_user);
239 mdb->connected = true;
241 if (!check_tables_version(jcr, mdb)) {
246 sql_query(mdb, "SET datestyle TO 'ISO, YMD'");
248 /* tell PostgreSQL we are using standard conforming strings
249 and avoid warnings such as:
250 WARNING: nonstandard use of \\ in a string literal
252 sql_query(mdb, "set standard_conforming_strings=on");
254 /* check that encoding is SQL_ASCII */
255 check_database_encoding(jcr, mdb);
262 db_close_database(JCR *jcr, B_DB *mdb)
267 db_end_transaction(jcr, mdb);
269 sql_free_result(mdb);
271 if (mdb->ref_count == 0) {
273 if (mdb->connected && mdb->db) {
276 rwl_destroy(&mdb->lock);
277 free_pool_memory(mdb->errmsg);
278 free_pool_memory(mdb->cmd);
279 free_pool_memory(mdb->cached_path);
280 free_pool_memory(mdb->fname);
281 free_pool_memory(mdb->path);
282 free_pool_memory(mdb->esc_name);
283 free_pool_memory(mdb->esc_path);
290 if (mdb->db_password) {
291 free(mdb->db_password);
293 if (mdb->db_address) {
294 free(mdb->db_address);
296 if (mdb->db_socket) {
297 free(mdb->db_socket);
304 void db_thread_cleanup()
308 * Return the next unique index (auto-increment) for
309 * the given table. Return NULL on error.
311 * For PostgreSQL, NULL causes the auto-increment value
314 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
316 strcpy(index, "NULL");
322 * Escape strings so that PostgreSQL is happy
324 * NOTE! len is the length of the old string. Your new
325 * string must be long enough (max 2*old+1) to hold
326 * the escaped output.
329 db_escape_string(JCR *jcr, B_DB *mdb, char *snew, char *old, int len)
333 PQescapeStringConn(mdb->db, snew, old, len, &error);
335 Jmsg(jcr, M_FATAL, 0, _("PQescapeStringConn returned non-zero.\n"));
336 /* error on encoding, probably invalid multibyte encoding in the source string
337 see PQescapeStringConn documentation for details. */
338 Dmsg0(500, "PQescapeStringConn failed\n");
343 * Submit a general SQL command (cmd), and for each row returned,
344 * the sqlite_handler is called with the ctx.
346 bool db_sql_query(B_DB *mdb, const char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
350 Dmsg0(500, "db_sql_query started\n");
353 if (sql_query(mdb, query) != 0) {
354 Mmsg(mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
356 Dmsg0(500, "db_sql_query failed\n");
359 Dmsg0(500, "db_sql_query succeeded. checking handler\n");
361 if (result_handler != NULL) {
362 Dmsg0(500, "db_sql_query invoking handler\n");
363 if ((mdb->result = sql_store_result(mdb)) != NULL) {
364 int num_fields = sql_num_fields(mdb);
366 Dmsg0(500, "db_sql_query sql_store_result suceeded\n");
367 while ((row = sql_fetch_row(mdb)) != NULL) {
369 Dmsg0(500, "db_sql_query sql_fetch_row worked\n");
370 if (result_handler(ctx, num_fields, row))
374 sql_free_result(mdb);
379 Dmsg0(500, "db_sql_query finished\n");
386 POSTGRESQL_ROW my_postgresql_fetch_row(B_DB *mdb)
389 POSTGRESQL_ROW row = NULL; // by default, return NULL
391 Dmsg0(500, "my_postgresql_fetch_row start\n");
393 if (!mdb->row || mdb->row_size < mdb->num_fields) {
394 int num_fields = mdb->num_fields;
395 Dmsg1(500, "we have need space of %d bytes\n", sizeof(char *) * mdb->num_fields);
398 Dmsg0(500, "my_postgresql_fetch_row freeing space\n");
401 num_fields += 20; /* add a bit extra */
402 mdb->row = (POSTGRESQL_ROW)malloc(sizeof(char *) * num_fields);
403 mdb->row_size = num_fields;
405 // now reset the row_number now that we have the space allocated
409 // if still within the result set
410 if (mdb->row_number >= 0 && mdb->row_number < mdb->num_rows) {
411 Dmsg2(500, "my_postgresql_fetch_row row number '%d' is acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
412 // get each value from this row
413 for (j = 0; j < mdb->num_fields; j++) {
414 mdb->row[j] = PQgetvalue(mdb->result, mdb->row_number, j);
415 Dmsg2(500, "my_postgresql_fetch_row field '%d' has value '%s'\n", j, mdb->row[j]);
417 // increment the row number for the next call
422 Dmsg2(500, "my_postgresql_fetch_row row number '%d' is NOT acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
425 Dmsg1(500, "my_postgresql_fetch_row finishes returning %p\n", row);
430 int my_postgresql_max_length(B_DB *mdb, int field_num) {
432 // for a given column, find the max length
439 for (i = 0; i < mdb->num_rows; i++) {
440 if (PQgetisnull(mdb->result, i, field_num)) {
441 this_length = 4; // "NULL"
443 this_length = cstrlen(PQgetvalue(mdb->result, i, field_num));
446 if (max_length < this_length) {
447 max_length = this_length;
454 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb)
458 Dmsg0(500, "my_postgresql_fetch_field starts\n");
460 if (!mdb->fields || mdb->fields_size < mdb->num_fields) {
464 Dmsg1(500, "allocating space for %d fields\n", mdb->num_fields);
465 mdb->fields = (POSTGRESQL_FIELD *)malloc(sizeof(POSTGRESQL_FIELD) * mdb->num_fields);
466 mdb->fields_size = mdb->num_fields;
468 for (i = 0; i < mdb->num_fields; i++) {
469 Dmsg1(500, "filling field %d\n", i);
470 mdb->fields[i].name = PQfname(mdb->result, i);
471 mdb->fields[i].max_length = my_postgresql_max_length(mdb, i);
472 mdb->fields[i].type = PQftype(mdb->result, i);
473 mdb->fields[i].flags = 0;
475 Dmsg4(500, "my_postgresql_fetch_field finds field '%s' has length='%d' type='%d' and IsNull=%d\n",
476 mdb->fields[i].name, mdb->fields[i].max_length, mdb->fields[i].type,
477 mdb->fields[i].flags);
481 // increment field number for the next time around
483 Dmsg0(500, "my_postgresql_fetch_field finishes\n");
484 return &mdb->fields[mdb->field_number++];
487 void my_postgresql_data_seek(B_DB *mdb, int row)
489 // set the row number to be returned on the next call
490 // to my_postgresql_fetch_row
491 mdb->row_number = row;
494 void my_postgresql_field_seek(B_DB *mdb, int field)
496 mdb->field_number = field;
500 * Note, if this routine returns 1 (failure), Bacula expects
501 * that no result has been stored.
502 * This is where QUERY_DB comes with Postgresql.
504 * Returns: 0 on success
508 int my_postgresql_query(B_DB *mdb, const char *query)
510 Dmsg0(500, "my_postgresql_query started\n");
511 // We are starting a new query. reset everything.
513 mdb->row_number = -1;
514 mdb->field_number = -1;
517 PQclear(mdb->result); /* hmm, someone forgot to free?? */
521 Dmsg1(500, "my_postgresql_query starts with '%s'\n", query);
523 for (int i=0; i < 10; i++) {
524 mdb->result = PQexec(mdb->db, query);
531 Dmsg1(50, "Query failed: %s\n", query);
535 mdb->status = PQresultStatus(mdb->result);
536 if (mdb->status == PGRES_TUPLES_OK || mdb->status == PGRES_COMMAND_OK) {
537 Dmsg1(500, "we have a result\n", query);
539 // how many fields in the set?
540 mdb->num_fields = (int)PQnfields(mdb->result);
541 Dmsg1(500, "we have %d fields\n", mdb->num_fields);
543 mdb->num_rows = PQntuples(mdb->result);
544 Dmsg1(500, "we have %d rows\n", mdb->num_rows);
546 mdb->row_number = 0; /* we can start to fetch something */
547 mdb->status = 0; /* succeed */
549 Dmsg1(50, "Result status failed: %s\n", query);
553 Dmsg0(500, "my_postgresql_query finishing\n");
557 Dmsg1(500, "we failed\n", query);
558 PQclear(mdb->result);
560 mdb->status = 1; /* failed */
564 void my_postgresql_free_result(B_DB *mdb)
569 PQclear(mdb->result);
585 int my_postgresql_currval(B_DB *mdb, const char *table_name)
587 // Obtain the current value of the sequence that
588 // provides the serial value for primary key of the table.
590 // currval is local to our session. It is not affected by
591 // other transactions.
593 // Determine the name of the sequence.
594 // PostgreSQL automatically creates a sequence using
595 // <table>_<column>_seq.
596 // At the time of writing, all tables used this format for
597 // for their primary key: <table>id
598 // Except for basefiles which has a primary key on baseid.
599 // Therefore, we need to special case that one table.
601 // everything else can use the PostgreSQL formula.
603 char sequence[NAMEDATALEN-1];
604 char query [NAMEDATALEN+50];
608 if (strcasecmp(table_name, "basefiles") == 0) {
609 bstrncpy(sequence, "basefiles_baseid", sizeof(sequence));
611 bstrncpy(sequence, table_name, sizeof(sequence));
612 bstrncat(sequence, "_", sizeof(sequence));
613 bstrncat(sequence, table_name, sizeof(sequence));
614 bstrncat(sequence, "id", sizeof(sequence));
617 bstrncat(sequence, "_seq", sizeof(sequence));
618 bsnprintf(query, sizeof(query), "SELECT currval('%s')", sequence);
620 Dmsg1(500, "my_postgresql_currval invoked with '%s'\n", query);
621 for (int i=0; i < 10; i++) {
622 result = PQexec(mdb->db, query);
629 Dmsg1(50, "Query failed: %s\n", query);
633 Dmsg0(500, "exec done");
635 if (PQresultStatus(result) == PGRES_TUPLES_OK) {
636 Dmsg0(500, "getting value");
637 id = atoi(PQgetvalue(result, 0, 0));
638 Dmsg2(500, "got value '%s' which became %d\n", PQgetvalue(result, 0, 0), id);
640 Dmsg1(50, "Result status failed: %s\n", query);
641 Mmsg1(&mdb->errmsg, _("error fetching currval: %s\n"), PQerrorMessage(mdb->db));
650 #ifdef HAVE_BATCH_FILE_INSERT
652 int my_postgresql_batch_start(JCR *jcr, B_DB *mdb)
654 const char *query = "COPY batch FROM STDIN";
656 Dmsg0(500, "my_postgresql_batch_start started\n");
658 if (my_postgresql_query(mdb,
659 "CREATE TEMPORARY TABLE batch ("
665 "md5 varchar)") == 1)
667 Dmsg0(500, "my_postgresql_batch_start failed\n");
671 // We are starting a new query. reset everything.
673 mdb->row_number = -1;
674 mdb->field_number = -1;
676 my_postgresql_free_result(mdb);
678 for (int i=0; i < 10; i++) {
679 mdb->result = PQexec(mdb->db, query);
686 Dmsg1(50, "Query failed: %s\n", query);
690 mdb->status = PQresultStatus(mdb->result);
691 if (mdb->status == PGRES_COPY_IN) {
692 // how many fields in the set?
693 mdb->num_fields = (int) PQnfields(mdb->result);
697 Dmsg1(50, "Result status failed: %s\n", query);
701 Dmsg0(500, "my_postgresql_batch_start finishing\n");
706 Mmsg1(&mdb->errmsg, _("error starting batch mode: %s"), PQerrorMessage(mdb->db));
708 PQclear(mdb->result);
713 /* set error to something to abort operation */
714 int my_postgresql_batch_end(JCR *jcr, B_DB *mdb, const char *error)
719 Dmsg0(500, "my_postgresql_batch_end started\n");
721 if (!mdb) { /* no files ? */
726 res = PQputCopyEnd(mdb->db, error);
727 } while (res == 0 && --count > 0);
735 Dmsg0(500, "we failed\n");
737 Mmsg1(&mdb->errmsg, _("error ending batch mode: %s"), PQerrorMessage(mdb->db));
740 /* Check command status and return to normal libpq state */
741 result = PQgetResult(mdb->db);
742 if (PQresultStatus(result) != PGRES_COMMAND_OK) {
743 Mmsg1(&mdb->errmsg, _("error ending batch mode: %s"), PQerrorMessage(mdb->db));
748 Dmsg0(500, "my_postgresql_batch_end finishing\n");
753 int my_postgresql_batch_insert(JCR *jcr, B_DB *mdb, ATTR_DBR *ar)
761 mdb->esc_name = check_pool_memory_size(mdb->esc_name, mdb->fnl*2+1);
762 my_postgresql_copy_escape(mdb->esc_name, mdb->fname, mdb->fnl);
764 mdb->esc_path = check_pool_memory_size(mdb->esc_path, mdb->pnl*2+1);
765 my_postgresql_copy_escape(mdb->esc_path, mdb->path, mdb->pnl);
767 if (ar->Digest == NULL || ar->Digest[0] == 0) {
773 len = Mmsg(mdb->cmd, "%u\t%s\t%s\t%s\t%s\t%s\n",
774 ar->FileIndex, edit_int64(ar->JobId, ed1), mdb->esc_path,
775 mdb->esc_name, ar->attr, digest);
778 res = PQputCopyData(mdb->db,
781 } while (res == 0 && --count > 0);
790 Dmsg0(500, "we failed\n");
792 Mmsg1(&mdb->errmsg, _("error copying in batch mode: %s"), PQerrorMessage(mdb->db));
795 Dmsg0(500, "my_postgresql_batch_insert finishing\n");
800 #endif /* HAVE_BATCH_FILE_INSERT */
803 * Escape strings so that PostgreSQL is happy on COPY
805 * NOTE! len is the length of the old string. Your new
806 * string must be long enough (max 2*old+1) to hold
807 * the escaped output.
809 char *my_postgresql_copy_escape(char *dest, char *src, size_t len)
811 /* we have to escape \t, \n, \r, \ */
814 while (len > 0 && *src) {
849 #ifdef HAVE_BATCH_FILE_INSERT
850 const char *my_pg_batch_lock_path_query =
851 "BEGIN; LOCK TABLE Path IN SHARE ROW EXCLUSIVE MODE";
854 const char *my_pg_batch_lock_filename_query =
855 "BEGIN; LOCK TABLE Filename IN SHARE ROW EXCLUSIVE MODE";
857 const char *my_pg_batch_unlock_tables_query = "COMMIT";
859 const char *my_pg_batch_fill_path_query =
860 "INSERT INTO Path (Path) "
861 "SELECT a.Path FROM "
862 "(SELECT DISTINCT Path FROM batch) AS a "
863 "WHERE NOT EXISTS (SELECT Path FROM Path WHERE Path = a.Path) ";
866 const char *my_pg_batch_fill_filename_query =
867 "INSERT INTO Filename (Name) "
868 "SELECT a.Name FROM "
869 "(SELECT DISTINCT Name FROM batch) as a "
871 "(SELECT Name FROM Filename WHERE Name = a.Name)";
872 #endif /* HAVE_BATCH_FILE_INSERT */
874 #endif /* HAVE_POSTGRESQL */