4c569caa251d07c0ef1fd95f035288dd69ff7a4d
[samba.git] / source3 / lib / ldb / web / index.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>ldb</TITLE>
5 </HEAD>
6 <BODY BGCOLOR="#ffffff" TEXT="#000000" VLINK="#292555" LINK="#292555" ALINK="#cc0033">
7
8 <h1>ldb</h1>
9
10 ldb is a LDAP-like embedded database. It is not at all LDAP standards
11 compliant, so if you want a standards compliant database then please
12 see the excellent <a href="http://www.openldap.org/">OpenLDAP</a>
13 project.<p>
14
15 What ldb does is provide a fast database with an LDAP-like API
16 designed to be used within an application. In some ways it can be seen
17 as a intermediate solution between key-value pair databases and a real
18 LDAP database.<p>
19
20 ldb is the database engine used in Samba4.
21
22 <h2>Features</h2>
23
24 The main features that separate ldb from other solutions are:
25
26 <ul>
27 <li>Safe multi-reader, multi-writer, using byte range locking
28 <li>LDAP-like API
29 <li>fast operation
30 <li>choice of local tdb or remote LDAP backends
31 <li>integration with <a href="http://talloc.samba.org">talloc</a>
32 <li>schema-less operation, for trivial setup
33 <li>modules for extensions (such as schema support)
34 <li>easy setup of indexes and attribute properties
35 <li>ldbedit tool for database editing (reminiscent of 'vipw')
36 <li>ldif for import/export
37 </ul>
38
39 <h2>Documentation</h2>
40
41 Currently ldb is completely lacking in programmer or user
42 documentation. This is your opportunity to make a contribution! Start
43 with the public functions declared in <a
44 href="http://samba.org/ftp/unpacked/ldb/include/ldb.h">ldb.h</a>
45 and the example code in the <a
46 href="http://samba.org/ftp/unpacked/ldb/tools/">tools
47 directory</a>. Documentation in the same docbook format used by Samba
48 would be preferred.
49
50 <h2>Discussion and bug reports</h2>
51
52 ldb does not currently have its own mailing list or bug tracking
53 system. For now, please use the <a
54 href="https://lists.samba.org/mailman/listinfo/samba-technical">samba-technical</a>
55 mailing list or the <a href="https://lists.samba.org/mailman/listinfo/ldb">ldb</a>
56 mailing list, and the <a href="http://bugzilla.samba.org/">Samba bugzilla</a> bug tracking system.
57
58 <h2>Download</h2>
59
60 You can download the latest release either via rsync or thtough git.<br>
61 <br>
62 To fetch via git see the following guide:<br>
63 <a href="http://wiki.samba.org/index.php/Using_Git_for_Samba_Development">Using Git for Samba Development</a><br>
64 Once you have cloned the tree switch to the v4-0-test branch and cd into the source/lib/ldb directory.<br>
65 <br>
66 To fetch via rsync use these commands:
67
68 <pre>
69   rsync -Pavz samba.org::ftp/unpacked/ldb .
70   rsync -Pavz samba.org::ftp/unpacked/tdb .
71   rsync -Pavz samba.org::ftp/unpacked/talloc .
72   rsync -Pavz samba.org::ftp/unpacked/libreplace .
73 </pre>
74
75 and build in ldb. It will find the other libraries in the directory
76 above automatically.
77
78 <hr>
79 <tiny>
80 <a href="http://samba.org/~tridge/">Andrew Tridgell</a><br>
81 ldb AT tridgell.net
82 </tiny>
83
84 </BODY>
85 </HTML>