← Back to branch summary

~zulcss/samba/server-dailies-3.4

« back to all changes in this revision

Viewing changes to source4/lib/ldb/mainpage.dox

  • Committer: Chuck Short
  • Date: 2010-09-28 20:38:39 UTC
  • Revision ID: zulcss@ubuntu.com-20100928203839-pgjulytsi9ue63x1
Initial version

Show diffs side-by-side

added added

removed removed

Lines of Context:
source4/lib/ldb/mainpage.dox
 
1
/**
 
2
 
 
3
\mainpage ldb
 
4
 
 
5
\section Overview
 
6
 
 
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>
 
11
 
 
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>
 
16
 
 
17
ldb is the database engine used in Samba4.
 
18
 
 
19
\section Features
 
20
 
 
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
 
32
 
 
33
\section Documentation
 
34
 
 
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>
 
40
 
 
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>. 
 
44
 
 
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>. 
 
48
 
 
49
\section Support
 
50
 
 
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.
 
56
 
 
57
\section Download
 
58
 
 
59
You can download the latest release either via rsync or anonymous
 
60
svn. To fetch via svn use the following commands:
 
61
 
 
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
 
67
 
 
68
To fetch via rsync use these commands:
 
69
 
 
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
 
75
 
 
76
\section Credits
 
77
 
 
78
ldb is another product of the prolific <a href="http://samba.org/~tridge/">Andrew Tridgell</a>.
 
79
 
 
80
*/