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 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
  33 NTSTATUS dbwrap_record_delete(struct db_record *rec);
  34 struct db_record *dbwrap_fetch_locked(struct db_context *db,
  35                                       TALLOC_CTX *mem_ctx,
  36                                       TDB_DATA key);
  37
  38 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
  39 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
  40                       TDB_DATA data, int flags);
  41 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
  42                       TDB_DATA key, TDB_DATA *value);
  43 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
  44 NTSTATUS dbwrap_traverse(struct db_context *db,
  45                          int (*f)(struct db_record*, void*),
  46                          void *private_data,
  47                          int *count);
  48 NTSTATUS dbwrap_traverse_read(struct db_context *db,
  49                               int (*f)(struct db_record*, void*),
  50                               void *private_data,
  51                               int *count);
  52 int dbwrap_parse_record(struct db_context *db, TDB_DATA key,
  53                         int (*parser)(TDB_DATA key, TDB_DATA data,
  54                                       void *private_data),
  55                         void *private_data);
  56 int dbwrap_wipe(struct db_context *db);
  57 int dbwrap_get_seqnum(struct db_context *db);
  58 int dbwrap_get_flags(struct db_context *db);
  59 int dbwrap_transaction_start(struct db_context *db);
  60 int dbwrap_transaction_commit(struct db_context *db);
  61 int dbwrap_transaction_cancel(struct db_context *db);
  62
  63
  64 /* The following definitions come from lib/dbwrap_util.c  */
  65
  66 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
  67 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
  68                                TDB_DATA data, int flags);
  69 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
  70                                const char *key, TDB_DATA *value);
  71
  72 NTSTATUS dbwrap_fetch_int32(struct db_context *db, const char *keystr,
  73                             int32_t *result);
  74 NTSTATUS dbwrap_store_int32(struct db_context *db, const char *keystr,
  75                             int32_t v);
  76 NTSTATUS dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
  77                              uint32_t *val);
  78 NTSTATUS dbwrap_store_uint32(struct db_context *db, const char *keystr,
  79                              uint32_t v);
  80 NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
  81                                      uint32_t *oldval, uint32_t change_val);
  82 NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
  83                                            const char *keystr,
  84                                            uint32_t *oldval,
  85                                            uint32_t change_val);
  86 NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
  87                                     int32_t *oldval, int32_t change_val);
  88 NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
  89                                           const char *keystr,
  90                                           int32_t *oldval,
  91                                           int32_t change_val);
  92 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
  93                             int flag);
  94 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
  95 NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
  96                                   int32_t v);
  97 NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
  98                                    uint32_t v);
  99 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
 100                                      TDB_DATA data, int flags);
 101 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
 102 NTSTATUS dbwrap_trans_do(struct db_context *db,
 103                          NTSTATUS (*action)(struct db_context *, void *),
 104                          void *private_data);
 105 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
 106                                int (*f)(struct db_record*, void*),
 107                                void *private_data);
 108
 109 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
 110 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
 111                                      TDB_DATA data, int flags);
 112 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
 113                                      const char *key, TDB_DATA *value);
 114
 115 #endif /* __DBWRAP_H__ */