source: trunk/server/source3/include/dbwrap.h@ 1012

Last change on this file since 1012 was 751, checked in by Silvan Scherrer, 13 years ago

Samba Server: updated trunk to 3.6.9
File size: 5.5 KB
Line 
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.h>
24
25struct db_record {
26 TDB_DATA key, value;
27 NTSTATUS (*store)(struct db_record *rec, TDB_DATA data, int flag);
28 NTSTATUS (*delete_rec)(struct db_record *rec);
29 void *private_data;
30};
31
32struct db_context {
33 struct db_record *(*fetch_locked)(struct db_context *db,
34 TALLOC_CTX *mem_ctx,
35 TDB_DATA key);
36 int (*fetch)(struct db_context *db, TALLOC_CTX *mem_ctx,
37 TDB_DATA key, TDB_DATA *data);
38 int (*traverse)(struct db_context *db,
39 int (*f)(struct db_record *rec,
40 void *private_data),
41 void *private_data);
42 int (*traverse_read)(struct db_context *db,
43 int (*f)(struct db_record *rec,
44 void *private_data),
45 void *private_data);
46 int (*get_seqnum)(struct db_context *db);
47 int (*get_flags)(struct db_context *db);
48 int (*transaction_start)(struct db_context *db);
49 int (*transaction_commit)(struct db_context *db);
50 int (*transaction_cancel)(struct db_context *db);
51 int (*parse_record)(struct db_context *db, TDB_DATA key,
52 int (*parser)(TDB_DATA key, TDB_DATA data,
53 void *private_data),
54 void *private_data);
55 void *private_data;
56 bool persistent;
57};
58
59bool db_is_local(const char *name);
60
61struct db_context *db_open(TALLOC_CTX *mem_ctx,
62 const char *name,
63 int hash_size, int tdb_flags,
64 int open_flags, mode_t mode);
65
66struct db_context *db_open_rbt(TALLOC_CTX *mem_ctx);
67
68struct db_context *db_open_tdb(TALLOC_CTX *mem_ctx,
69 const char *name,
70 int hash_size, int tdb_flags,
71 int open_flags, mode_t mode);
72
73struct messaging_context;
74
75#ifdef CLUSTER_SUPPORT
76struct db_context *db_open_ctdb(TALLOC_CTX *mem_ctx,
77 const char *name,
78 int hash_size, int tdb_flags,
79 int open_flags, mode_t mode);
80#endif
81
82struct db_context *db_open_file(TALLOC_CTX *mem_ctx,
83 struct messaging_context *msg_ctx,
84 const char *name,
85 int hash_size, int tdb_flags,
86 int open_flags, mode_t mode);
87
88
89NTSTATUS dbwrap_delete(struct db_context *db, TDB_DATA key);
90NTSTATUS dbwrap_store(struct db_context *db, TDB_DATA key,
91 TDB_DATA data, int flags);
92TDB_DATA dbwrap_fetch(struct db_context *db, TALLOC_CTX *mem_ctx,
93 TDB_DATA key);
94NTSTATUS dbwrap_delete_bystring(struct db_context *db, const char *key);
95NTSTATUS dbwrap_store_bystring(struct db_context *db, const char *key,
96 TDB_DATA data, int flags);
97TDB_DATA dbwrap_fetch_bystring(struct db_context *db, TALLOC_CTX *mem_ctx,
98 const char *key);
99
100/* The following definitions come from lib/dbwrap_util.c */
101
102int32_t dbwrap_fetch_int32(struct db_context *db, const char *keystr);
103int dbwrap_store_int32(struct db_context *db, const char *keystr, int32_t v);
104bool dbwrap_fetch_uint32(struct db_context *db, const char *keystr,
105 uint32_t *val);
106int dbwrap_store_uint32(struct db_context *db, const char *keystr, uint32_t v);
107NTSTATUS dbwrap_change_uint32_atomic(struct db_context *db, const char *keystr,
108 uint32_t *oldval, uint32_t change_val);
109NTSTATUS dbwrap_trans_change_uint32_atomic(struct db_context *db,
110 const char *keystr,
111 uint32_t *oldval,
112 uint32_t change_val);
113NTSTATUS dbwrap_change_int32_atomic(struct db_context *db, const char *keystr,
114 int32_t *oldval, int32_t change_val);
115NTSTATUS dbwrap_trans_change_int32_atomic(struct db_context *db,
116 const char *keystr,
117 int32_t *oldval,
118 int32_t change_val);
119NTSTATUS dbwrap_trans_store(struct db_context *db, TDB_DATA key, TDB_DATA dbuf,
120 int flag);
121NTSTATUS dbwrap_trans_delete(struct db_context *db, TDB_DATA key);
122NTSTATUS dbwrap_trans_store_int32(struct db_context *db, const char *keystr,
123 int32_t v);
124NTSTATUS dbwrap_trans_store_uint32(struct db_context *db, const char *keystr,
125 uint32_t v);
126NTSTATUS dbwrap_trans_store_bystring(struct db_context *db, const char *key,
127 TDB_DATA data, int flags);
128NTSTATUS dbwrap_trans_delete_bystring(struct db_context *db, const char *key);
129NTSTATUS dbwrap_trans_do(struct db_context *db,
130 NTSTATUS (*action)(struct db_context *, void *),
131 void *private_data);
132NTSTATUS dbwrap_trans_traverse(struct db_context *db,
133 int (*f)(struct db_record*, void*),
134 void *private_data);
135NTSTATUS dbwrap_traverse(struct db_context *db,
136 int (*f)(struct db_record*, void*),
137 void *private_data,
138 int *count);
139
140NTSTATUS dbwrap_delete_bystring_upper(struct db_context *db, const char *key);
141NTSTATUS dbwrap_store_bystring_upper(struct db_context *db, const char *key,
142 TDB_DATA data, int flags);
143TDB_DATA dbwrap_fetch_bystring_upper(struct db_context *db, TALLOC_CTX *mem_ctx,
144 const char *key);
145
146#endif /* __DBWRAP_H__ */
Note: See TracBrowser for help on using the repository browser.