2 * Bacula Catalog Database routines specific to PostgreSQL
3 * These are PostgreSQL specific routines
5 * Dan Langille, December 2003
6 * based upon work done by Kern Sibbald, March 2000
12 Copyright (C) 2000-2004 Kern Sibbald and John Walker
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License as
16 published by the Free Software Foundation; either version 2 of
17 the License, or (at your option) any later version.
19 This program is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 General Public License for more details.
24 You should have received a copy of the GNU General Public
25 License along with this program; if not, write to the Free
26 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
32 /* The following is necessary so that we do not include
33 * the dummy external definition of DB.
35 #define __SQL_C /* indicate that this is sql.c */
40 #ifdef HAVE_POSTGRESQL
42 #include "postgres_ext.h" /* needed for NAMEDATALEN */
44 /* -----------------------------------------------------------------------
46 * PostgreSQL dependent defines and subroutines
48 * -----------------------------------------------------------------------
51 /* List of open databases */
52 static BQUEUE db_list = {&db_list, &db_list};
54 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
57 * Initialize database data structure. In principal this should
58 * never have errors, or it is really fatal.
61 db_init_database(JCR *jcr, char *db_name, char *db_user, char *db_password,
62 char *db_address, int db_port, char *db_socket)
67 Jmsg(jcr, M_FATAL, 0, _("A user name for PostgreSQL must be supplied.\n"));
70 P(mutex); /* lock DB queue */
71 /* Look to see if DB already open */
72 for (mdb=NULL; (mdb=(B_DB *)qnext(&db_list, &mdb->bq)); ) {
73 if (strcmp(mdb->db_name, db_name) == 0) {
74 Dmsg2(100, "DB REopen %d %s\n", mdb->ref_count, db_name);
77 return mdb; /* already open */
80 Dmsg0(100, "db_open first time\n");
81 mdb = (B_DB *) malloc(sizeof(B_DB));
82 memset(mdb, 0, sizeof(B_DB));
83 mdb->db_name = bstrdup(db_name);
84 mdb->db_user = bstrdup(db_user);
86 mdb->db_password = bstrdup(db_password);
89 mdb->db_address = bstrdup(db_address);
92 mdb->db_socket = bstrdup(db_socket);
94 mdb->db_port = db_port;
95 mdb->have_insert_id = TRUE;
96 mdb->errmsg = get_pool_memory(PM_EMSG); /* get error message buffer */
98 mdb->cmd = get_pool_memory(PM_EMSG); /* get command buffer */
99 mdb->cached_path = get_pool_memory(PM_FNAME);
100 mdb->cached_path_id = 0;
102 mdb->fname = get_pool_memory(PM_FNAME);
103 mdb->path = get_pool_memory(PM_FNAME);
104 mdb->esc_name = get_pool_memory(PM_FNAME);
105 qinsert(&db_list, &mdb->bq); /* put db in list */
111 * Now actually open the database. This can generate errors,
112 * which are returned in the errmsg
114 * DO NOT close the database or free(mdb) here !!!!
117 db_open_database(JCR *jcr, B_DB *mdb)
123 if (mdb->connected) {
127 mdb->connected = FALSE;
129 if ((errstat=rwl_init(&mdb->lock)) != 0) {
130 Mmsg1(&mdb->errmsg, _("Unable to initialize DB lock. ERR=%s\n"),
136 if (mdb->db_port && mdb->db_port[0]) {
137 bsnprintf(port, sizeof(port), "%d", mdb->db_port);
141 /* connect to the database */
142 mdb->db = PQsetdbLogin(
143 mdb->db_address, /* default = localhost */
144 port, /* default port */
145 NULL, /* pg options */
146 NULL, /* tty, ignored */
147 mdb->db_name, /* database name */
148 mdb->db_user, /* login name */
149 mdb->db_password); /* password */
151 /* If no connect, try once more in case it is a timing problem */
152 if (PQstatus(mdb->db) != CONNECTION_OK) {
153 mdb->db = PQsetdbLogin(
154 mdb->db_address, /* default = localhost */
155 port, /* default port */
156 NULL, /* pg options */
157 NULL, /* tty, ignored */
158 mdb->db_name, /* database name */
159 mdb->db_user, /* login name */
160 mdb->db_password); /* password */
163 Dmsg0(50, "pg_real_connect done\n");
164 Dmsg3(50, "db_user=%s db_name=%s db_password=%s\n", mdb->db_user, mdb->db_name,
165 mdb->db_password==NULL?"(NULL)":mdb->db_password);
167 if (PQstatus(mdb->db) != CONNECTION_OK) {
168 Mmsg2(&mdb->errmsg, _("Unable to connect to PostgreSQL server.\n"
169 "Database=%s User=%s\n"
170 "It is probably not running or your password is incorrect.\n"),
171 mdb->db_name, mdb->db_user);
176 if (!check_tables_version(jcr, mdb)) {
181 mdb->connected = TRUE;
187 db_close_database(JCR *jcr, B_DB *mdb)
194 if (mdb->ref_count == 0) {
196 if (mdb->connected && mdb->db) {
199 rwl_destroy(&mdb->lock);
200 free_pool_memory(mdb->errmsg);
201 free_pool_memory(mdb->cmd);
202 free_pool_memory(mdb->cached_path);
203 free_pool_memory(mdb->fname);
204 free_pool_memory(mdb->path);
205 free_pool_memory(mdb->esc_name);
212 if (mdb->db_password) {
213 free(mdb->db_password);
215 if (mdb->db_address) {
216 free(mdb->db_address);
218 if (mdb->db_socket) {
219 free(mdb->db_socket);
227 * Return the next unique index (auto-increment) for
228 * the given table. Return NULL on error.
230 * For PostgreSQL, NULL causes the auto-increment value
233 int db_next_index(JCR *jcr, B_DB *mdb, char *table, char *index)
235 strcpy(index, "NULL");
241 * Escape strings so that PostgreSQL is happy
243 * NOTE! len is the length of the old string. Your new
244 * string must be long enough (max 2*old+1) to hold
245 * the escaped output.
248 db_escape_string(char *snew, char *old, int len)
250 PQescapeString(snew, old, len);
254 * Submit a general SQL command (cmd), and for each row returned,
255 * the sqlite_handler is called with the ctx.
257 int db_sql_query(B_DB *mdb, char *query, DB_RESULT_HANDLER *result_handler, void *ctx)
261 Dmsg0(50, "db_sql_query started\n");
264 if (sql_query(mdb, query) != 0) {
265 Mmsg(&mdb->errmsg, _("Query failed: %s: ERR=%s\n"), query, sql_strerror(mdb));
267 Dmsg0(50, "db_sql_query failed\n");
270 Dmsg0(50, "db_sql_query succeeded. checking handler\n");
272 if (result_handler != NULL) {
273 Dmsg0(50, "db_sql_query invoking handler\n");
274 if ((mdb->result = sql_store_result(mdb)) != NULL) {
275 int num_fields = sql_num_fields(mdb);
277 Dmsg0(50, "db_sql_query sql_store_result suceeded\n");
278 while ((row = sql_fetch_row(mdb)) != NULL) {
280 Dmsg0(50, "db_sql_query sql_fetch_row worked\n");
281 if (result_handler(ctx, num_fields, row))
285 sql_free_result(mdb);
290 Dmsg0(50, "db_sql_query finished\n");
297 POSTGRESQL_ROW my_postgresql_fetch_row(B_DB *mdb)
300 POSTGRESQL_ROW row = NULL; // by default, return NULL
302 Dmsg0(50, "my_postgresql_fetch_row start\n");
304 if (mdb->row_number == -1 || mdb->row == NULL) {
305 Dmsg1(50, "we have need space of %d bytes\n", sizeof(char *) * mdb->num_fields);
307 if (mdb->row != NULL) {
308 Dmsg0(50, "my_postgresql_fetch_row freeing space\n");
313 mdb->row = (POSTGRESQL_ROW) malloc(sizeof(char *) * mdb->num_fields);
315 // now reset the row_number now that we have the space allocated
319 // if still within the result set
320 if (mdb->row_number < mdb->num_rows) {
321 Dmsg2(50, "my_postgresql_fetch_row row number '%d' is acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
322 // get each value from this row
323 for (j = 0; j < mdb->num_fields; j++) {
324 mdb->row[j] = PQgetvalue(mdb->result, mdb->row_number, j);
325 Dmsg2(50, "my_postgresql_fetch_row field '%d' has value '%s'\n", j, mdb->row[j]);
327 // increment the row number for the next call
332 Dmsg2(50, "my_postgresql_fetch_row row number '%d' is NOT acceptable (0..%d)\n", mdb->row_number, mdb->num_rows);
335 Dmsg1(50, "my_postgresql_fetch_row finishes returning %x\n", row);
340 int my_postgresql_max_length(B_DB *mdb, int field_num) {
342 // for a given column, find the max length
349 for (i = 0; i < mdb->num_rows; i++) {
350 if (PQgetisnull(mdb->result, i, field_num)) {
351 this_length = 4; // "NULL"
353 this_length = strlen(PQgetvalue(mdb->result, i, field_num));
356 if (max_length < this_length) {
357 max_length = this_length;
364 POSTGRESQL_FIELD * my_postgresql_fetch_field(B_DB *mdb)
368 Dmsg0(50, "my_postgresql_fetch_field starts\n");
369 if (mdb->fields == NULL) {
370 Dmsg1(50, "allocating space for %d fields\n", mdb->num_fields);
371 mdb->fields = (POSTGRESQL_FIELD *)malloc(sizeof(POSTGRESQL_FIELD) * mdb->num_fields);
373 for (i = 0; i < mdb->num_fields; i++) {
374 Dmsg1(50, "filling field %d\n", i);
375 mdb->fields[i].name = PQfname(mdb->result, i);
376 mdb->fields[i].max_length = my_postgresql_max_length(mdb, i);
377 mdb->fields[i].type = PQftype(mdb->result, i);
378 mdb->fields[i].flags = 0;
380 Dmsg4(50, "my_postgresql_fetch_field finds field '%s' has length='%d' type='%d' and IsNull=%d\n",
381 mdb->fields[i].name, mdb->fields[i].max_length, mdb->fields[i].type,
382 mdb->fields[i].flags);
386 // increment field number for the next time around
388 Dmsg0(50, "my_postgresql_fetch_field finishes\n");
389 return &mdb->fields[mdb->field_number++];
392 void my_postgresql_data_seek(B_DB *mdb, int row)
394 // set the row number to be returned on the next call
395 // to my_postgresql_fetch_row
396 mdb->row_number = row;
399 void my_postgresql_field_seek(B_DB *mdb, int field)
401 mdb->field_number = field;
404 int my_postgresql_query(B_DB *mdb, char *query) {
405 Dmsg0(50, "my_postgresql_query started\n");
406 // We are starting a new query. reset everything.
408 mdb->row_number = -1;
409 mdb->field_number = -1;
412 Dmsg1(50, "my_postgresql_query starts with '%s'\n", query);
413 mdb->result = PQexec(mdb->db, query);
414 mdb->status = PQresultStatus(mdb->result);
415 if (mdb->status == PGRES_TUPLES_OK || mdb->status == PGRES_COMMAND_OK) {
416 Dmsg1(50, "we have a result\n", query);
418 // how many fields in the set?
419 mdb->num_fields = (int) PQnfields(mdb->result);
420 Dmsg1(50, "we have %d fields\n", mdb->num_fields);
422 mdb->num_rows = PQntuples(mdb->result);
423 Dmsg1(50, "we have %d rows\n", mdb->num_rows);
427 Dmsg1(50, "we failed\n", query);
431 Dmsg0(50, "my_postgresql_query finishing\n");
436 void my_postgresql_free_result (B_DB *mdb)
439 PQclear(mdb->result);
453 int my_postgresql_currval(B_DB *mdb, char *table_name)
455 // Obtain the current value of the sequence that
456 // provides the serial value for primary key of the table.
458 // currval is local to our session. It is not affected by
459 // other transactions.
461 // Determine the name of the sequence.
462 // PostgreSQL automatically creates a sequence using
463 // <table>_<column>_seq.
464 // At the time of writing, all tables used this format for
465 // for their primary key: <table>id
466 // Except for basefiles which has a primary key on baseid.
467 // Therefore, we need to special case that one table.
469 // everything else can use the PostgreSQL formula.
471 char sequence[NAMEDATALEN-1];
472 char query [NAMEDATALEN+50];
476 if (strcasecmp(table_name, "basefiles") == 0) {
477 bstrncpy(sequence, "basefiles_baseid", sizeof(sequence));
479 bstrncpy(sequence, table_name, sizeof(sequence));
480 bstrncat(sequence, "_", sizeof(sequence));
481 bstrncat(sequence, table_name, sizeof(sequence));
482 bstrncat(sequence, "id", sizeof(sequence));
485 bstrncat(sequence, "_seq", sizeof(sequence));
486 bsnprintf(query, sizeof(query), "SELECT currval('%s')", sequence);
488 // Mmsg(&query, "SELECT currval('%s')", sequence);
489 Dmsg1(50, "my_postgresql_currval invoked with '%s'\n", query);
490 result = PQexec(mdb->db, query);
492 Dmsg0(50, "exec done");
494 if (PQresultStatus(result) == PGRES_TUPLES_OK) {
495 Dmsg0(50, "getting value");
496 id = atoi(PQgetvalue(result, 0, 0));
497 Dmsg2(50, "got value '%s' which became %d\n", PQgetvalue(result, 0, 0), id);
499 Mmsg1(&mdb->errmsg, _("error fetching currval: %s\n"), PQerrorMessage(mdb->db));
508 #endif /* HAVE_POSTGRESQL */