summaryrefslogtreecommitdiff
path: root/source3/lib/dbwrap/dbwrap_open.h
blob: 9ed2245afd6386f8ac117d0786dd3f9cf161a5ba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
/* 
   Unix SMB/CIFS implementation.
   Database interface wrapper around tdb

   Copyright (C) Volker Lendecke 2005-2007

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 3 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef __DBWRAP_OPEN_H__
#define __DBWRAP_OPEN_H__

struct db_context;

/**
 * Convenience function to check whether a tdb database
 * is local or clustered (ctdb) in a clustered environment.
 */
bool db_is_local(const char *name);

enum dbwrap_lock_order {
	DBWRAP_LOCK_ORDER_1 = 1,
	DBWRAP_LOCK_ORDER_2 = 2,
	DBWRAP_LOCK_ORDER_3 = 3
};

/**
 * Convenience function that will determine whether to
 * open a tdb database via the tdb backend or via the ctdb
 * backend, based on lp_clustering() and a db-specific
 * settings.
 */
struct db_context *db_open(TALLOC_CTX *mem_ctx,
			   const char *name,
			   int hash_size, int tdb_flags,
			   int open_flags, mode_t mode,
			   enum dbwrap_lock_order lock_order);

#endif /* __DBWRAP_OPEN_H__ */