index.html 5.26 KB
Newer Older
-urso-'s avatar
-urso- committed
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 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
<?xml version="1.0"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
	<title>BDB</title>
	<link rel="stylesheet" type="text/css" href="style.css"/>
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
    </head>

    <body>
	<div class="header">
	    <h1>BDB</h1>
	    <h2>Berkeley DB CFFI bindings</h2>
	</div>

	<h3>Introduction</h3>
	<p>
	BDB is a small (well it was supposed to be a small...) package offering CFFI-Bindings to Berkeley DB.
	The package is supposed to be as lispy , but as near to the C library as possible.
	<br/>
	You can find more informations about Berkeley db on <a href="http://www.sleepycat.com">http://www.sleepycat.com</a>.
	Since the package is supposed to be as near as possible to the C library, you should read the "Getting starting..." guides,
	using the "bdb-playgound" package, to get a feeling on how to use Berkeley DB and/or bdb.
	</p>

	<h3>State</h3>
	<table border="1">
	    <tr><td>Lisp Platforms:
		</td>
		<td>testest with SBCL 0.9.11 and 0.9.12 only (yet), but should work on other implementations
		    with CFFI support, too
		</td>
	    </tr>
	    <tr><td>Berkeley DB Version: </td>
		<td>4.3</td>
	    </tr>

	    <tr><td>Package version: </td>
		<td>I don't use any versioning (at the moment), so get used to the darcs repo.
		    But at the moment consider this a initial pre pre pre pre pre alpha version...
		</td>
	    </tr>
	    <tr><td>License</td>
		<td> <a href="http://opensource.franz.com">LLGPL</a> </td>
	    </tr>
	</table>

	<h3>Packages</h3>
	<p>
	Sure, the package was supposed too be small, but unfortunatelly it grew and grew, thus it consists/needs several packages:
	</p>
	<table border="1">
	    <tr> <th>Package</th><th>Description</th><th>Dependencies</th><th>Documentation</th> </tr>
	    <tr>
		<td>mycl-util</td>
		<td>My private utility package, which i use/develop in, since I'm lerning CL (I'm just very new to CL...) </td>
		<td>None</td>
		<td> <a href="qbook/mycl-util/index.html">documentation</a> </td>
	    </tr>
	    <tr>
		<td>cffi-util</td>
		<td>Was once part of bdb package, but outsourced as new package.  </td>
		<td> 
		    <a href="http://common-lisp.net/project/cffi">CFFI</a><br/>
		    <a href="http://common-lisp.net/project/bdb">mycl-util</a><br/>
		    <a href="http://cliki.net/trivial-gray-streams">trivial-gray-streams</a><br/>
		    <a href="http://weitz.de/flexi-streams">flexi-streams</a>
		</td>
		<td><a href="qbook/cffi-util/index.html">documentation</a> </td>
	    </tr>
	    <tr>
		<td>bdb</td>
		<td>These are the CFFI bindings to Berkley DB </td>
		<td>
		    <a href="http://common-lisp.net/project/cffi">CFFI</a><br/>
		    <a href="http://common-lisp.net/project/bdb">mycl-util</a><br/>
		    <a href="http://common-lisp.net/project/bdb">cffi-util</a><br/>
		</td>
		<td><a href="qbook/bdb/index.html">documentation</a> </td>
	    </tr>
	    <tr>
		<td>bdb-playground</td>
		<td>
		    If you want to play/test the library, bdb-playground is a nice starting point,
		    since it uses cl-store for writing and reading the data into/from the database and
		    you can immediately start unsing the library.
		</td>
		<td>
		    <a href="http://common-lisp.net/project/bdb">bdb</a><br/>
		    <a href="http://common-lisp.net/project/cl-store">cl-store</a><br/>
		</td>
		<td><a href="qbook/bdb-playground/index.html">documentation</a> </td>
	    </tr>
	</table>

	<h3>Download/darcs</h3>
	<table border="1">
	    <tr><th>project</th><th>darcs repo</th></tr>
	    <tr>
		<td>mycl-util </td>
-urso-'s avatar
-urso- committed
102 103
		<td>darcs get 
		    <a href="http://common-lisp.net/project/bdb/darcs/mycl-util"> http://common-lisp.net/project/bdb/darcs/mycl-util </a></td>
-urso-'s avatar
-urso- committed
104 105 106
	    </tr>
	    <tr>
		<td>cffi-util </td>
-urso-'s avatar
-urso- committed
107 108
		<td>darcs get 
		    <a href="http://common-lisp.net/project/bdb/darcs/cffi-util"> http://common-lisp.net/project/bdb/darcs/cffi-util </a></td>
-urso-'s avatar
-urso- committed
109 110 111
	    </tr>
	    <tr>
		<td>bdb </td>
-urso-'s avatar
-urso- committed
112 113
		<td>darcs get 
		    <a href="http://common-lisp.net/project/bdb/darcs/bdb"> http://common-lisp.net/project/bdb/darcs/bdb </a></td>
-urso-'s avatar
-urso- committed
114 115 116
	    </tr>
	    <tr>
		<td>bdb-playground </td>
-urso-'s avatar
-urso- committed
117 118 119
		<td>darcs get 
		    <a href="http://common-lisp.net/project/bdb/darcs/bdb-playground"> http://common-lisp.net/project/bdb/darcs/bdb-playground </a></td>

-urso-'s avatar
-urso- committed
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
	    </tr>
	</table>

	<h3>Installation</h3>
	<p>
	bdb package:<br/>
	The bdb package comes with a wrapper library for libdb, which must be compiled
	and made available. You can find more infos on how to install in the 
	README file.<br/><br/>

	All packages: <br/>
	Just make all asdf files available and load via asdf.
	</p>

	<h3>Example Usage</h3>
	<ol>
	    <li><a href="examples/simple.html">Simple db Example</a></li>
	    <li><a href="examples/secondary.html">Secondary Databases</a></li>
	</ol>

	<h3>Mailing Lists</h3>
	<ul>
	    <li>
	    <a href="http://www.common-lisp.net/mailman/listinfo/bdb-devel">bdb-devel</a><br/>for developers
	    </li>
	    <li>
	    <a href="http://www.common-lisp.net/mailman/listinfo/bdb-announce">bdb-announce</a><br/>for announcements.
	    </li>
	</ul>


	<div class="footer">
	    <a href="mailto:-urso-@web.de">Email</a>
	</div>

	<div class="check">
	    <a href="http://validator.w3.org/check/referer"> Valid XHTML 1.0 Strict</a>
	</div>
    </body>
</html>