s3-winbind: use new reconnect logic in rpc_lookup_sids() also.
[Samba.git] / lib / ldb / mainpage.dox
blobbbd8d9c5025cf43c4365395e73926c0da1b7d62f
1 /**
3 \mainpage ldb
5 \section Overview
7 ldb is a LDAP-like embedded database. It is not at all LDAP standards
8 compliant, so if you want a standards compliant database then please
9 see the excellent <a href="http://www.openldap.org/">OpenLDAP</a>
10 project.<p>
12 What ldb does is provide a fast database with an LDAP-like API
13 designed to be used within an application. In some ways it can be seen
14 as a intermediate solution between key-value pair databases and a real
15 LDAP database.<p>
17 ldb is the database engine used in Samba4.
19 \section Features
21 The main features that separate ldb from other solutions are:
22  - Safe multi-reader, multi-writer, using byte range locking
23  - LDAP-like API
24  - fast operation
25  - choice of local tdb, local sqlite3 or remote LDAP backends
26  - integration with <a href="http://talloc.samba.org">talloc</a>
27  - schema-less operation, for trivial setup
28  - modules for extensions (such as schema support)
29  - easy setup of indexes and attribute properties
30  - ldbedit tool for database editing (reminiscent of 'vipw')
31  - ldif for import/export
33 \section Documentation
35 ldb has limited programmer and administrator documentation:
36  - a list of <a href="globals_func.html">functions</a>
37  - a list of <a href="examples.html">examples</a>
38  - a list of <a href="annotated.html">data structures</a>
39  - a list of <a href="globals_defs.html">constants</a>
41 If you need more information than is presented in this document, you
42 may wish to look at the source code, especially the source code in the
43 <a href="http://samba.org/ftp/unpacked/samba4/source/lib/ldb/tools/">tools directory</a>. 
45 ldb makes use of the LDAP Data Interchange Format (LDIF), which is
46 documented in <a href="http://www.ietf.org/rfc/rfc2849.txt">RFC
47 2849</a>. 
49 \section Support
51 ldb does not currently have its own mailing list or bug tracking
52 system. For now, please use the <a
53 href="https://lists.samba.org/mailman/listinfo/samba-technical">samba-technical</a>
54 mailing list, and the <a href="http://bugzilla.samba.org/">Samba
55 bugzilla</a> bug tracking system.
57 \section Download
59 You can download the latest release either via rsync or anonymous
60 svn. To fetch via svn use the following commands:
62 \verbatim
63   svn co svn://svnanon.samba.org/samba/branches/SAMBA_4_0/source/lib/ldb ldb
64   svn co svn://svnanon.samba.org/samba/branches/SAMBA_4_0/source/lib/tdb tdb
65   svn co svn://svnanon.samba.org/samba/branches/SAMBA_4_0/source/lib/talloc talloc
66 \endverbatim
68 To fetch via rsync use these commands:
70 \verbatim
71   rsync -Pavz samba.org::ftp/unpacked/samba4/source/lib/ldb .
72   rsync -Pavz samba.org::ftp/unpacked/samba4/source/lib/tdb .
73   rsync -Pavz samba.org::ftp/unpacked/samba4/source/lib/talloc .
74 \endverbatim
76 \section Credits
78 ldb is another product of the prolific <a href="http://samba.org/~tridge/">Andrew Tridgell</a>.