Commit 0e5f7e94 authored by -urso-'s avatar -urso-

updated bdb docs

darcs-hash:4e97605f2f90a5762a6299dd061a80faef4626bd
parent c550d7f6
<html
><head
><title
>Berkley DB CFFI-Bindings</title
><link href="style.css" rel="stylesheet"
/><link title="Print" href="print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><h1 class="title"
>Berkley DB CFFI-Bindings</h1
><div class="contents"
><h2
><a name="BDB_0020Classes"
>BDB Classes</a
>&nbsp;</h2
><div class="nav-links"
><a class="nav-link" href="Package_0020definition.html"
>prev</a
> | <span class="dead-nav-link"
>up</span
> | <a href="Constants_002FFlags.html"
>next</a
> | <a href="index.html"
>toc</a
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB-ENV.html" name="class_005FBDB_003A_003ADB-ENV"
>Class DB-ENV</a
> holds database environment</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB-EXT-ENV.html" name="class_005FBDB_003A_003ADB-EXT-ENV"
>Class DB-EXT-ENV</a
> extended db environment using special buffer
readers and writers.</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB.html" name="class_005FBDB_003A_003ADB"
>Class DB</a
> low level database handle</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ACURSOR.html" name="class_005FBDB_003A_003ACURSOR"
>Class CURSOR</a
> </p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003AEXT-CURSOR.html" name="class_005FBDB_003A_003AEXT-CURSOR"
>Class EXT-CURSOR</a
> this cursor is generated, when you use db-cursor with
an database being type of db-ext</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ATXN.html" name="class_005FBDB_003A_003ATXN"
>Class TXN</a
> </p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB-STD.html" name="class_005FBDB_003A_003ADB-STD"
>Class DB-STD</a
> simple standart database class for databases without
transaction support</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB-TXN.html" name="class_005FBDB_003A_003ADB-TXN"
>Class DB-TXN</a
> transactional database class</p
></div
>
<div class="computational-element-link computational-element-link-class"
><p
><a href="api/class_005FBDB_003A_003ADB-EXT.html" name="class_005FBDB_003A_003ADB-EXT"
>Class DB-EXT</a
> when using db-open with an environment of db-ext-env,
this will be returned.</p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028IS-PRIMARY_0020DB-TXN_0029.html" name="method_005FBDB_003A_003A_0028IS-PRIMARY_0020DB-TXN_0029"
>Method (IS-PRIMARY DB-TXN)</a
> </p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028IS-SECONDARY_0020DB-TXN_0029.html" name="method_005FBDB_003A_003A_0028IS-SECONDARY_0020DB-TXN_0029"
>Method (IS-SECONDARY DB-TXN)</a
> </p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028BUF-READER_0020DB-EXT_0029.html" name="method_005FBDB_003A_003A_0028BUF-READER_0020DB-EXT_0029"
>Method (BUF-READER DB-EXT)</a
> </p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028BUF-WRITER_0020DB-EXT_0029.html" name="method_005FBDB_003A_003A_0028BUF-WRITER_0020DB-EXT_0029"
>Method (BUF-WRITER DB-EXT)</a
> </p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028BUF-READER_0020EXT-CURSOR_0029.html" name="method_005FBDB_003A_003A_0028BUF-READER_0020EXT-CURSOR_0029"
>Method (BUF-READER EXT-CURSOR)</a
> </p
></div
>
<div class="computational-element-link computational-element-link-method"
><p
><a href="api/method_005FBDB_003A_003A_0028BUF-WRITER_0020EXT-CURSOR_0029.html" name="method_005FBDB_003A_003A_0028BUF-WRITER_0020EXT-CURSOR_0029"
>Method (BUF-WRITER EXT-CURSOR)</a
> </p
></div
>
</div
></div
></body
></html
>
\ No newline at end of file
......@@ -15,7 +15,7 @@
>Constants/Flags</a
>&nbsp;</h2
><div class="nav-links"
><a class="nav-link" href="Package_0020definition.html"
><a class="nav-link" href="BDB_0020Classes.html"
>prev</a
> | <span class="dead-nav-link"
>up</span
......
......@@ -19,7 +19,7 @@
>prev</a
> | <span class="dead-nav-link"
>up</span
> | <a href="Constants_002FFlags.html"
> | <a href="BDB_0020Classes.html"
>next</a
> | <a href="index.html"
>toc</a
......
<html
><head
><title
>Class CURSOR</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: CURSOR</h1
><div class="contents"
><h2
>Slots</h2
><ul
><li
>CURSOR-HANDLE</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
>STANDARD-OBJECT</li
></ul
><h3
>Sub Classes</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003AEXT-CURSOR.html"
>EXT-CURSOR</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass cursor ()
((cursor-handle :accessor cursor-handle :initarg :handle)))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ACURSOR"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB-ENV</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB-ENV</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>holds database environment</blockquote
><h2
>Slots</h2
><ul
><li
>DB-ENV-HANDLE</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
>STANDARD-OBJECT</li
></ul
><h3
>Sub Classes</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB-EXT-ENV.html"
>DB-EXT-ENV</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db-env ()
((db-env-handle :accessor db-env-handle :initarg :handle))
(:documentation &quot;holds database environment&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB-ENV"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB-EXT-ENV</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB-EXT-ENV</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>extended db environment using special buffer
readers and writers. All Databases and Cursor
opened according to this environment are using
the reader and writer functions</blockquote
><h2
>Slots</h2
><ul
><li
>BUF-READER</li
><li
>BUF-WRITER</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB-ENV.html"
>DB-ENV</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db-ext-env (db-env)
((buf-reader :accessor buf-reader :initarg :buf-reader)
(buf-writer :accessor buf-writer :initarg :buf-writer))
(:documentation &quot;extended db environment using special buffer
readers and writers. All Databases and Cursor
opened according to this environment are using
the reader and writer functions&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB-EXT-ENV"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB-EXT</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB-EXT</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>when using db-open with an environment of db-ext-env,
this will be returned. Using this type of Database, the
user don't need to worry about cbuffers</blockquote
><h2
>Slots</h2
><ul
><li
>ENV</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB-TXN.html"
>DB-TXN</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db-ext (db-txn)
((env :accessor db-get-env :initarg :env))
(:documentation &quot;when using db-open with an environment of db-ext-env,
this will be returned. Using this type of Database, the
user don't need to worry about cbuffers&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB-EXT"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB-STD</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB-STD</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>simple standart database class for databases without
transaction support</blockquote
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB.html"
>DB</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db-std (db)
()
(:documentation &quot;simple standart database class for databases without
transaction support&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB-STD"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB-TXN</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB-TXN</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>transactional database class</blockquote
><h2
>Slots</h2
><ul
><li
>DB-ASSOC - pairs of callbacks and secondaries, if
primary database, else hold primary as reference</li
><li
>SEC-HANDLE</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB.html"
>DB</a
></li
></ul
><h3
>Sub Classes</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB-EXT.html"
>DB-EXT</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db-txn (db)
((db-assoc :accessor db-assoc
:initform (list)
:documentation &quot;pairs of callbacks and secondaries, if
primary database, else hold primary as reference&quot;)
(sec-handle :accessor db-sec-handle
:initform nil))
(:documentation &quot;transactional database class&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB-TXN"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class DB</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: DB</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>low level database handle</blockquote
><h2
>Slots</h2
><ul
><li
>DB-HANDLE</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
>STANDARD-OBJECT</li
></ul
><h3
>Sub Classes</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ADB-TXN.html"
>DB-TXN</a
></li
><li
><a href="../api/class_005FBDB_003A_003ADB-STD.html"
>DB-STD</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass db ()
((db-handle :accessor db-handle :initarg :handle))
(:documentation &quot;low level database handle&quot;))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ADB"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class EXT-CURSOR</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: EXT-CURSOR</h1
><div class="contents"
><h2
>Documentation</h2
><blockquote
>this cursor is generated, when you use db-cursor with
an database being type of db-ext</blockquote
><h2
>Slots</h2
><ul
><li
>ENV</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
><a href="../api/class_005FBDB_003A_003ACURSOR.html"
>CURSOR</a
></li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass ext-cursor (cursor)
((env :accessor db-get-env :initarg :env))
(:documentation &quot;this cursor is generated, when you use db-cursor with
an database being type of db-ext&quot;)
)</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003AEXT-CURSOR"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Class TXN</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Class: TXN</h1
><div class="contents"
><h2
>Slots</h2
><ul
><li
>TXN-HANDLE</li
></ul
><h2
>Hierachy</h2
><h3
>Precedence List</h3
><ul
><li
>STANDARD-OBJECT</li
></ul
><h2
>Source</h2
><pre class="code"
>(defclass txn ()
((txn-handle :accessor txn-handle :initarg :handle)))</pre
><a href="../BDB_0020Classes.html#class_005FBDB_003A_003ATXN"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Method (BUF-READER DB-EXT)</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Method: (BUF-READER DB-EXT)</h1
><div class="contents"
><h2
>Source</h2
><pre class="code"
>(defmethod buf-reader ((db db-ext))
(buf-reader (db-get-env db)))</pre
><a href="../BDB_0020Classes.html#method_005FBDB_003A_003A_0028BUF-READER_0020DB-EXT_0029"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Method (BUF-READER EXT-CURSOR)</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Method: (BUF-READER EXT-CURSOR)</h1
><div class="contents"
><h2
>Source</h2
><pre class="code"
>(defmethod buf-reader ((cursor ext-cursor))
(buf-reader (db-get-env cursor)))</pre
><a href="../BDB_0020Classes.html#method_005FBDB_003A_003A_0028BUF-READER_0020EXT-CURSOR_0029"
>Source Context</a
></div
></div
></div
></body
></html
>
\ No newline at end of file
<html
><head
><title
>Method (BUF-WRITER DB-EXT)</title
><link href="../style.css" rel="stylesheet"
/><link title="Print" href="../print.css" rel="alternate stylesheet"
/></head
><body
><div class="qbook"
><div class="computational-element"
><h1
>Method: (BUF-WRITER DB-EXT)</h1
><div class="contents"
><h2
>Source</h2
><pre class="code"
>(defmethod buf-writer ((db db-ext))
(buf-writer (db-get-env db)))</pre
><a href="../BDB_0020Classes.html#method_005FBDB_003A_003A_0028BUF-WRITER_0020DB-EXT_0029"
>Source Context</a
></div
></div
></div
></body
></html
>