source3/lib/dbwrap/dbwrap.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Database interface wrapper around tdb
   4    Copyright (C) Volker Lendecke 2005-2007
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef __DBWRAP_H__
  21 #define __DBWRAP_H__
  22
  23 #include "tdb_compat.h"
  24
  25 struct db_record;
  26 struct db_context;
  27
  28 /* The following definitions come from lib/dbwrap.c  */
  29
  30 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
  31 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
  32 void *dbwrap_record_get_private_data(const struct db_record *rec);
  33 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
  34 NTSTATUS dbwrap_record_delete(struct db_record *rec);
  35 struct db_record *dbwrap_fetch_locked(struct db_context *db,
  36                                       TALLOC_CTX *mem_ctx,
  37                                       TDB_DATA key);
  38
  39 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
  40 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
  41                       TDB_DATA data, int flags);
  42 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  43                       TDB_DATA key, TDB_DATA *value);
  44 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
  45 NTSTATUS dbwrap_traverse(struct db_context *db,
  46                          int (*f)(struct db_record*, void*),
  47                          void *private_data,
  48                          int *count);
  49 NTSTATUS dbwrap_traverse_read(struct db_context *db,
  50                               int (*f)(struct db_record*, void*),
  51                               void *private_data,
  52                               int *count);
  53 int dbwrap_parse_record(struct db_context *db, TDB_DATA key,
  54                         int (*parser)(TDB_DATA key, TDB_DATA data,
  55                                       void *private_data),
  56                         void *private_data);
  57 int dbwrap_wipe(struct db_context *db);
  58 int dbwrap_get_seqnum(struct db_context *db);
  59 int dbwrap_get_flags(struct db_context *db);
  60 int dbwrap_transaction_start(struct db_context *db);
  61 int dbwrap_transaction_commit(struct db_context *db);
  62 int dbwrap_transaction_cancel(struct db_context *db);
  63
  64
  65 /* The following definitions come from lib/dbwrap_util.c  */
  66
  67 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
  68 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
  69                                TDB_DATA data, int flags);
  70 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
  71                                const char *key, TDB_DATA *value);
  72
  73 NTSTATUS dbwrap_fetch_int32(struct db_context *db, const char *keystr,
  74                             int32_t *result);
  75 NTSTATUS dbwrap_store_int32(struct db_context *db, const char *keystr,
  76                             int32_t v);
  77 NTSTATUS dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
  78                              uint32_t *val);
  79 NTSTATUS dbwrap_store_uint32(struct db_context *db, const char *keystr,
  80                              uint32_t v);
  81 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
  82                                      uint32_t *oldval, uint32_t change_val);
  83 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
  84                                            const char *keystr,
  85                                            uint32_t *oldval,
  86                                            uint32_t change_val);
  87 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
  88                                     int32_t *oldval, int32_t change_val);
  89 NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
  90                                           const char *keystr,
  91                                           int32_t *oldval,
  92                                           int32_t change_val);
  93 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
  94                             int flag);
  95 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
  96 NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
  97                                   int32_t v);
  98 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
  99                                    uint32_t v);
 100 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 101                                      TDB_DATA data, int flags);
 102 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
 103 NTSTATUS dbwrap_trans_do(struct db_context *db,
 104                          NTSTATUS (*action)(struct db_context *, void *),
 105                          void *private_data);
 106 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 107                                int (*f)(struct db_record*, void*),
 108                                void *private_data);
 109
 110 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
 111 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 112                                      TDB_DATA data, int flags);
 113 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 114                                      const char *key, TDB_DATA *value);
 115
 116 #endif /* __DBWRAP_H__ */