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