2 Unix SMB/CIFS implementation.
3 Database interface wrapper around tdb
4 Copyright (C) Volker Lendecke 2005-2007
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.
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.
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/>.
28 enum dbwrap_lock_order {
29 DBWRAP_LOCK_ORDER_1 = 1,
30 DBWRAP_LOCK_ORDER_2 = 2,
31 DBWRAP_LOCK_ORDER_3 = 3
34 /* The following definitions come from lib/dbwrap.c */
36 TDB_DATA dbwrap_record_get_key(const struct db_record *rec);
37 TDB_DATA dbwrap_record_get_value(const struct db_record *rec);
38 NTSTATUS dbwrap_record_store(struct db_record *rec, TDB_DATA data, int flags);
39 NTSTATUS dbwrap_record_delete(struct db_record *rec);
40 struct db_record *dbwrap_fetch_locked(struct db_context *db,
43 struct db_record *dbwrap_try_fetch_locked(struct db_context *db,
46 struct db_record *dbwrap_fetch_locked_timeout(struct db_context *db,
49 unsigned int timeout);
51 struct db_context *dbwrap_record_get_db(struct db_record *rec);
52 void dbwrap_set_stored_callback(
53 struct db_context *db,
54 void (*cb)(struct db_context *db, struct db_record *rec,
58 NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
59 NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
60 TDB_DATA data, int flags);
61 NTSTATUS dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
62 TDB_DATA key, TDB_DATA *value);
63 bool dbwrap_exists(struct db_context *db, TDB_DATA key);
64 NTSTATUS dbwrap_traverse(struct db_context *db,
65 int (*f)(struct db_record*, void*),
68 NTSTATUS dbwrap_traverse_read(struct db_context *db,
69 int (*f)(struct db_record*, void*),
72 NTSTATUS dbwrap_parse_record(struct db_context *db, TDB_DATA key,
73 void (*parser)(TDB_DATA key, TDB_DATA data,
76 int dbwrap_wipe(struct db_context *db);
77 int dbwrap_check(struct db_context *db);
78 int dbwrap_get_seqnum(struct db_context *db);
79 /* Returns 0 if unknown. */
80 int dbwrap_hash_size(struct db_context *db);
81 int dbwrap_transaction_start(struct db_context *db);
82 NTSTATUS dbwrap_transaction_start_nonblock(struct db_context *db);
83 int dbwrap_transaction_commit(struct db_context *db);
84 int dbwrap_transaction_cancel(struct db_context *db);
85 void dbwrap_db_id(struct db_context *db, const uint8_t **id, size_t *idlen);
86 const char *dbwrap_name(struct db_context *db);
88 /* The following definitions come from lib/dbwrap_util.c */
90 NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
91 NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
92 TDB_DATA data, int flags);
93 NTSTATUS dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
94 const char *key, TDB_DATA *value);
96 NTSTATUS dbwrap_fetch_int32_bystring(struct db_context *db, const char *keystr,
98 NTSTATUS dbwrap_store_int32_bystring(struct db_context *db, const char *keystr,
100 NTSTATUS dbwrap_fetch_uint32_bystring(struct db_context *db,
101 const char *keystr, uint32_t *val);
102 NTSTATUS dbwrap_store_uint32_bystring(struct db_context *db,
103 const char *keystr, uint32_t v);
104 NTSTATUS dbwrap_change_uint32_atomic_bystring(struct db_context *db,
107 uint32_t change_val);
108 NTSTATUS dbwrap_trans_change_uint32_atomic_bystring(struct db_context *db,
111 uint32_t change_val);
112 NTSTATUS dbwrap_change_int32_atomic_bystring(struct db_context *db,
116 NTSTATUS dbwrap_trans_change_int32_atomic_bystring(struct db_context *db,
120 NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
122 NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
123 NTSTATUS dbwrap_trans_store_int32_bystring(struct db_context *db,
126 NTSTATUS dbwrap_trans_store_uint32_bystring(struct db_context *db,
129 NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
130 TDB_DATA data, int flags);
131 NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
132 NTSTATUS dbwrap_trans_do(struct db_context *db,
133 NTSTATUS (*action)(struct db_context *, void *),
135 NTSTATUS dbwrap_trans_traverse(struct db_context *db,
136 int (*f)(struct db_record*, void*),
139 NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
140 NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
141 TDB_DATA data, int flags);
142 NTSTATUS dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
143 const char *key, TDB_DATA *value);
146 * This opens an ntdb or tdb file: you can hand it a .ntdb or .tdb extension
147 * and it will decide (based on parameter settings, or else what exists) which
150 * For backwards compatibility, it takes tdb-style open flags, not ntdb!
152 struct db_context *dbwrap_local_open(TALLOC_CTX *mem_ctx,
153 struct loadparm_context *lp_ctx,
155 int hash_size, int tdb_flags,
156 int open_flags, mode_t mode,
157 enum dbwrap_lock_order lock_order);
159 #endif /* __DBWRAP_H__ */