[08254fc] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[08254fc] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[75d962dc] | 7 | <!ENTITY db-download-http " ">
|
---|
[93c1bf51] | 8 | <!ENTITY db-download-ftp "ftp://sleepycat1.inetu.net/releases/db-&db-version;.tar.gz">
|
---|
[f62b122b] | 9 | <!ENTITY db-md5sum "fcc481d52c3b80e20a328f8c0cb042bd">
|
---|
[93c1bf51] | 10 | <!ENTITY db-size "5.7 MB">
|
---|
[bcbca63] | 11 | <!ENTITY db-buildsize "68 MB (additional 140 MB to run parallel standard testsuite)">
|
---|
| 12 | <!ENTITY db-time "1.23 SBU (additional 74.5 SBU to run parallel standard testsuite)">
|
---|
[08254fc] | 13 | ]>
|
---|
| 14 |
|
---|
[317034a] | 15 | <sect1 id="db" xreflabel="Berkeley DB-&db-version;">
|
---|
[a0f03b0] | 16 | <sect1info>
|
---|
[5cd0959d] | 17 | <othername>$LastChangedBy$</othername>
|
---|
| 18 | <date>$Date$</date>
|
---|
[a0f03b0] | 19 | </sect1info>
|
---|
[00bb024c] | 20 | <?dbhtml filename="db.html"?>
|
---|
[317034a] | 21 | <title>Berkeley DB-&db-version;</title>
|
---|
[bcbca63] | 22 | <indexterm zone="db">
|
---|
| 23 | <primary sortas="a-Berkeley-DB">Berkeley DB</primary></indexterm>
|
---|
[f45b1953] | 24 |
|
---|
[08254fc] | 25 | <sect2>
|
---|
| 26 | <title>Introduction to <application>Berkeley DB</application></title>
|
---|
| 27 |
|
---|
| 28 | <para>The <application>Berkeley DB</application> package contains programs and
|
---|
| 29 | utilities used by many other applications for database related
|
---|
| 30 | functions.</para>
|
---|
| 31 |
|
---|
| 32 | <sect3><title>Package information</title>
|
---|
| 33 | <itemizedlist spacing='compact'>
|
---|
| 34 | <listitem><para>Download (HTTP): <ulink
|
---|
| 35 | url="&db-download-http;"/></para></listitem>
|
---|
| 36 | <listitem><para>Download (FTP): <ulink
|
---|
| 37 | url="&db-download-ftp;"/></para></listitem>
|
---|
[f62b122b] | 38 | <listitem><para>Download MD5 sum: &db-md5sum;</para></listitem>
|
---|
[08254fc] | 39 | <listitem><para>Download size: &db-size;</para></listitem>
|
---|
[7d9150d] | 40 | <listitem><para>Estimated disk space required:
|
---|
[08254fc] | 41 | &db-buildsize;</para></listitem>
|
---|
| 42 | <listitem><para>Estimated build time:
|
---|
| 43 | &db-time;</para></listitem></itemizedlist>
|
---|
| 44 | </sect3>
|
---|
| 45 |
|
---|
| 46 | <sect3><title><application>Berkeley DB</application> dependencies</title>
|
---|
| 47 | <sect4><title>Optional</title>
|
---|
[5f0bab7] | 48 | <para><xref linkend="tcl"/> and <xref linkend="jdk"/></para>
|
---|
[f62b122b] | 49 | </sect4>
|
---|
[08254fc] | 50 | </sect3>
|
---|
| 51 |
|
---|
| 52 | </sect2>
|
---|
| 53 |
|
---|
| 54 | <sect2>
|
---|
| 55 | <title>Installation of <application>Berkeley DB</application></title>
|
---|
| 56 |
|
---|
[5fef0f97] | 57 | <para>Install <application>Berkeley DB</application> by running the following
|
---|
| 58 | commands:</para>
|
---|
[08254fc] | 59 |
|
---|
[93c1bf51] | 60 | <screen><userinput><command>cd build_unix &&
|
---|
[08254fc] | 61 | ../dist/configure --prefix=/usr \
|
---|
| 62 | --enable-compat185 \
|
---|
| 63 | --enable-cxx &&
|
---|
[bcbca63] | 64 | make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread"</command></userinput></screen>
|
---|
[08254fc] | 65 |
|
---|
[88871f3] | 66 | <para>To test the results, start <command>tclsh</command> and issue:</para>
|
---|
| 67 |
|
---|
| 68 | <screen><userinput><command>source ../test/test.tcl
|
---|
| 69 | run_parallel run_std</command></userinput></screen>
|
---|
| 70 |
|
---|
[bcbca63] | 71 | <para>Now, as the root user:</para>
|
---|
[5fef0f97] | 72 |
|
---|
[bcbca63] | 73 | <screen><userinput role='root'><command>make docdir=/usr/share/doc/db-&db-version; install &&
|
---|
| 74 | chown root:root /usr/bin/db_* \
|
---|
[5fef0f97] | 75 | /usr/lib/libdb* /usr/include/db* &&
|
---|
[93c1bf51] | 76 | chown -R root:root /usr/share/doc/db-&db-version;</command></userinput></screen>
|
---|
[5fef0f97] | 77 |
|
---|
[08254fc] | 78 | </sect2>
|
---|
| 79 |
|
---|
| 80 | <sect2>
|
---|
| 81 | <title>Command explanations</title>
|
---|
| 82 |
|
---|
[5fef0f97] | 83 | <para><command>cd build_unix &&
|
---|
| 84 | ../dist/configure --prefix=/usr...</command>:
|
---|
[08254fc] | 85 | This replaces the normal <command>./configure</command> command, as
|
---|
| 86 | <application>Berkeley DB</application> comes with various
|
---|
| 87 | build directories for different platforms.</para>
|
---|
| 88 |
|
---|
[7d9150d] | 89 | <para><parameter>--enable-compat185</parameter>: This switch enables
|
---|
| 90 | building DB 1.85 compatibility <acronym>API</acronym>.</para>
|
---|
| 91 |
|
---|
| 92 | <para><parameter>--enable-cxx</parameter>: This switch enables building
|
---|
[bcbca63] | 93 | C++ <acronym>API</acronym> libraries.</para>
|
---|
[7d9150d] | 94 |
|
---|
[a136ea0] | 95 | <para><command>make LIBSO_LIBS="-lpthread"
|
---|
[bcbca63] | 96 | LIBXSO_LIBS="-lpthread"</command>: <command>configure</command> does not
|
---|
| 97 | correctly handle <acronym>NPTL</acronym>. These variables force it to
|
---|
| 98 | properly link against <acronym>NPTL</acronym>.</para>
|
---|
[a136ea0] | 99 |
|
---|
[08254fc] | 100 | <para><command>make docdir=/usr/share/doc/db-&db-version;
|
---|
| 101 | install</command>: This installs the documentation in
|
---|
| 102 | the correct place.</para>
|
---|
| 103 |
|
---|
[88871f3] | 104 | <para><option>--enable-test</option>: Enables building the test suite
|
---|
| 105 | (requires the two Tcl switches below).</para>
|
---|
| 106 |
|
---|
[83f40b6] | 107 | <para><option>--enable-tcl --with-tcl=/usr/lib</option>:
|
---|
[6c1d39e4] | 108 | Enables <application>Tcl</application> support in DB and creates the
|
---|
[82f09cd1] | 109 | <filename class="libraryfile">libdb_tcl</filename> libraries.</para>
|
---|
| 110 |
|
---|
[bcbca63] | 111 | <para><option>--enable-java</option>: Enables <application>Java</application>
|
---|
[e578536] | 112 | support in DB and creates the
|
---|
| 113 | <filename class='libraryfile'>libdb_java</filename> libraries.</para>
|
---|
| 114 |
|
---|
[bcbca63] | 115 | <para><option>--enable-rpc</option>: Enables building the
|
---|
| 116 | <application>Berkeley DB</application> <acronym>RPC</acronym> server.</para>
|
---|
| 117 |
|
---|
[08254fc] | 118 | </sect2>
|
---|
| 119 |
|
---|
| 120 | <sect2>
|
---|
| 121 | <title>Contents</title>
|
---|
| 122 |
|
---|
[bcbca63] | 123 | <segmentedlist>
|
---|
| 124 | <segtitle>Installed Programs</segtitle>
|
---|
| 125 | <segtitle>Installed Libraries</segtitle>
|
---|
| 126 | <segtitle>Installed Directory</segtitle>
|
---|
| 127 |
|
---|
| 128 | <seglistitem>
|
---|
| 129 | <seg>berkeley_db_svc, db_archive, db_checkpoint, db_deadlock, db_dump,
|
---|
| 130 | db_load, db_printlog, db_recover, db_stat, db_upgrade and db_verify</seg>
|
---|
| 131 | <seg>libdb.[so,a], libdb_cxx.[so,a], libdb_java.[so,a] and
|
---|
| 132 | libdb_tcl.[so,a]</seg>
|
---|
| 133 | <seg>/usr/share/doc/db-&db-version;</seg>
|
---|
| 134 | </seglistitem>
|
---|
| 135 | </segmentedlist>
|
---|
| 136 |
|
---|
| 137 | <variablelist>
|
---|
| 138 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 139 | <?dbfo list-presentation="list"?>
|
---|
| 140 |
|
---|
| 141 | <varlistentry id="berkeley_db_svc">
|
---|
| 142 | <term><command>berkeley_db_svc</command></term>
|
---|
| 143 | <listitem><para>is the <application>Berkeley DB</application>
|
---|
| 144 | <acronym>RPC</acronym> server.</para>
|
---|
| 145 | <indexterm zone="db berkeley_db_svc">
|
---|
| 146 | <primary sortas="b-berkeley_db_svc">berkeley_db_svc</primary>
|
---|
| 147 | </indexterm></listitem>
|
---|
| 148 | </varlistentry>
|
---|
| 149 |
|
---|
| 150 | <varlistentry id="db_archive">
|
---|
| 151 | <term><command>db_archive</command></term>
|
---|
| 152 | <listitem><para>prints the pathnames of log files that are no longer in
|
---|
| 153 | use.</para>
|
---|
| 154 | <indexterm zone="db db_archive">
|
---|
| 155 | <primary sortas="b-db_archive">db_archive</primary>
|
---|
| 156 | </indexterm></listitem>
|
---|
| 157 | </varlistentry>
|
---|
| 158 |
|
---|
| 159 | <varlistentry id="db_checkpoint">
|
---|
| 160 | <term><command>db_checkpoint</command></term>
|
---|
| 161 | <listitem><para>is a daemon process used to monitor and checkpoint database
|
---|
| 162 | logs.</para>
|
---|
| 163 | <indexterm zone="db db_checkpoint">
|
---|
| 164 | <primary sortas="b-db_checkpoint">db_checkpoint</primary>
|
---|
| 165 | </indexterm></listitem>
|
---|
| 166 | </varlistentry>
|
---|
| 167 |
|
---|
| 168 | <varlistentry id="db_deadlock">
|
---|
| 169 | <term><command>db_deadlock</command></term>
|
---|
| 170 | <listitem><para>is used to abort lock requests when deadlocks are
|
---|
| 171 | detected.</para>
|
---|
| 172 | <indexterm zone="db db_deadlock">
|
---|
| 173 | <primary sortas="b-db_deadlock">db_deadlock</primary>
|
---|
| 174 | </indexterm></listitem>
|
---|
| 175 | </varlistentry>
|
---|
| 176 |
|
---|
| 177 | <varlistentry id="db_dump">
|
---|
| 178 | <term><command>db_dump</command></term>
|
---|
| 179 | <listitem><para>converts database files to a flat file format readable by
|
---|
| 180 | <command>db_load</command>.</para>
|
---|
| 181 | <indexterm zone="db db_dump">
|
---|
| 182 | <primary sortas="b-db_dump">db_dump</primary>
|
---|
| 183 | </indexterm></listitem>
|
---|
| 184 | </varlistentry>
|
---|
| 185 |
|
---|
| 186 | <varlistentry id="db_load">
|
---|
| 187 | <term><command>db_load</command></term>
|
---|
| 188 | <listitem><para>is used to create database files from flat files created with
|
---|
| 189 | <command>db_dump</command>.</para>
|
---|
| 190 | <indexterm zone="db db_load">
|
---|
| 191 | <primary sortas="b-db_load">db_load</primary>
|
---|
| 192 | </indexterm></listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
| 195 | <varlistentry id="db_printlog">
|
---|
| 196 | <term><command>db_printlog</command></term>
|
---|
| 197 | <listitem><para>converts database log files to human readable text.</para>
|
---|
| 198 | <indexterm zone="db db_printlog">
|
---|
| 199 | <primary sortas="b-db_printlog">db_printlog</primary>
|
---|
| 200 | </indexterm></listitem>
|
---|
| 201 | </varlistentry>
|
---|
| 202 |
|
---|
| 203 | <varlistentry id="db_recover">
|
---|
| 204 | <term><command>db_recover</command></term>
|
---|
| 205 | <listitem><para>is used to restore a database to a consistent state after a
|
---|
| 206 | failure.</para>
|
---|
| 207 | <indexterm zone="db db_recover">
|
---|
| 208 | <primary sortas="b-db_recover">db_recover</primary>
|
---|
| 209 | </indexterm></listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
| 212 | <varlistentry id="db_stat">
|
---|
| 213 | <term><command>db_stat</command></term>
|
---|
| 214 | <listitem><para>displays database environment statistics.</para>
|
---|
| 215 | <indexterm zone="db db_stat">
|
---|
| 216 | <primary sortas="b-db_stat">db_stat</primary>
|
---|
| 217 | </indexterm></listitem>
|
---|
| 218 | </varlistentry>
|
---|
| 219 |
|
---|
| 220 | <varlistentry id="db_upgrade">
|
---|
| 221 | <term><command>db_upgrade</command></term>
|
---|
| 222 | <listitem><para>is used to upgrade database files to a newer version of
|
---|
| 223 | <application>Berkeley DB</application>.</para>
|
---|
| 224 | <indexterm zone="db db_upgrade">
|
---|
| 225 | <primary sortas="b-db_upgrade">db_upgrade</primary>
|
---|
| 226 | </indexterm></listitem>
|
---|
| 227 | </varlistentry>
|
---|
| 228 |
|
---|
| 229 | <varlistentry id="db_verify">
|
---|
| 230 | <term><command>db_verify</command></term>
|
---|
| 231 | <listitem><para>is used to run consistency checks on database files.</para>
|
---|
| 232 | <indexterm zone="db db_verify">
|
---|
| 233 | <primary sortas="b-db_verify">db_verify</primary>
|
---|
| 234 | </indexterm></listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 | </variablelist>
|
---|
[08254fc] | 237 |
|
---|
| 238 | </sect2>
|
---|
[f45b1953] | 239 |
|
---|
| 240 | </sect1>
|
---|