[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 |
|
---|
[cd2ef4a6] | 7 | <!ENTITY db-download-http "http://downloads.sleepycat.com/db-&db-version;.tar.gz">
|
---|
| 8 | <!ENTITY db-download-ftp "ftp://ftp.sleepycat.com/releases/db-&db-version;.tar.gz">
|
---|
| 9 | <!ENTITY db-md5sum "13585a20ce32f113b8e8cdb57f52e3bb">
|
---|
| 10 | <!ENTITY db-size "5.9 MB">
|
---|
[0635d22] | 11 | <!ENTITY db-buildsize "74 MB (additional 140 MB to run parallel standard testsuite)">
|
---|
| 12 | <!ENTITY db-time "1.0 SBU (additional 80 SBU to run parallel standard testsuite)">
|
---|
[08254fc] | 13 | ]>
|
---|
| 14 |
|
---|
[317034a] | 15 | <sect1 id="db" xreflabel="Berkeley DB-&db-version;">
|
---|
[b742c85] | 16 | <?dbhtml filename="db.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>Berkeley DB-&db-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="db">
|
---|
| 26 | <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to Berkeley DB</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>Berkeley DB</application> package contains programs
|
---|
| 33 | and utilities used by many other applications for database related
|
---|
| 34 | functions.</para>
|
---|
| 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>Download (HTTP): <ulink url="&db-download-http;"/></para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (FTP): <ulink url="&db-download-ftp;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download MD5 sum: &db-md5sum;</para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download size: &db-size;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Estimated disk space required: &db-buildsize;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated build time: &db-time;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | </itemizedlist>
|
---|
| 57 |
|
---|
| 58 | <bridgehead renderas="sect3">Berkeley DB Dependencies</bridgehead>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[472ae882] | 61 | <para><xref linkend="tcl"/>, <xref linkend="jdk"/> and
|
---|
| 62 | <ulink url="http://www.gnu.org/software/sharutils/">sharutils</ulink>
|
---|
| 63 | (for the <command>uudecode</command> command)</para>
|
---|
[b742c85] | 64 |
|
---|
| 65 | </sect2>
|
---|
| 66 |
|
---|
[ac3ee9f8] | 67 | <sect2 role="testing">
|
---|
| 68 | <title>Testing Berkeley DB</title>
|
---|
| 69 |
|
---|
[8d288fe8] | 70 | <para>It is recommended you skip ahead to Installation. The test-suite
|
---|
| 71 | takes more than 80 SBU and has a few bugs causing reports of 'Regression
|
---|
| 72 | Tests Failed'. You must have <application>Tcl</application> to test
|
---|
| 73 | <application>Berkeley DB</application>.</para>
|
---|
[ac3ee9f8] | 74 |
|
---|
| 75 | <para>Build for the <application>Berkeley DB</application> test by running
|
---|
| 76 | the following commands:</para>
|
---|
| 77 |
|
---|
| 78 | <screen><userinput>cd build_unix &&
|
---|
| 79 | ../dist/configure --prefix=/usr \
|
---|
| 80 | --enable-test --enable-tcl --with-tcl=/usr/lib &&
|
---|
[0635d22] | 81 | make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread" &&
|
---|
| 82 | chmod 644 ../test/sijointest.tcl &&
|
---|
| 83 | sed -i 's:puts "[s,S].*::' \
|
---|
| 84 | ../test/sijointest.tcl</userinput></screen>
|
---|
[ac3ee9f8] | 85 |
|
---|
[8d288fe8] | 86 | <para>To test the results, start <command>tclsh</command>:</para>
|
---|
| 87 |
|
---|
| 88 | <screen><userinput>tclsh</userinput></screen>
|
---|
| 89 |
|
---|
| 90 | <para>From the tclsh prompt (%), run:</para>
|
---|
[ac3ee9f8] | 91 |
|
---|
| 92 | <screen><userinput>source ../test/test.tcl
|
---|
[8d288fe8] | 93 | run_parallel 4 run_std
|
---|
| 94 | exit</userinput></screen>
|
---|
[ac3ee9f8] | 95 |
|
---|
| 96 | <para>Clean up with the following command:</para>
|
---|
| 97 |
|
---|
[2c2f849] | 98 | <screen><userinput>make realclean &&
|
---|
[8d288fe8] | 99 | cd ..</userinput></screen>
|
---|
[2c2f849] | 100 |
|
---|
| 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="installation">
|
---|
| 104 | <title>Installation of Berkeley DB</title>
|
---|
| 105 |
|
---|
| 106 | <para>Install <application>Berkeley DB</application> by running the
|
---|
| 107 | following commands:</para>
|
---|
| 108 |
|
---|
| 109 | <screen><userinput>cd build_unix &&
|
---|
| 110 | ../dist/configure --prefix=/usr \
|
---|
| 111 | --enable-compat185 \
|
---|
| 112 | --enable-cxx &&
|
---|
| 113 | make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread"</userinput></screen>
|
---|
| 114 |
|
---|
| 115 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 116 |
|
---|
| 117 | <screen role="root"><userinput>make docdir=/usr/share/doc/db-&db-version; install &&
|
---|
| 118 | chown root:root /usr/bin/db_* \
|
---|
[472ae882] | 119 | /usr/lib/libdb* /usr/include/db* &&
|
---|
[2c2f849] | 120 | chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen>
|
---|
[ac3ee9f8] | 121 |
|
---|
| 122 | </sect2>
|
---|
| 123 |
|
---|
[b742c85] | 124 | <sect2 role="commands">
|
---|
| 125 | <title>Command Explanations</title>
|
---|
| 126 |
|
---|
| 127 | <para><command>cd build_unix &&
|
---|
| 128 | ../dist/configure --prefix=/usr...</command>:
|
---|
| 129 | This replaces the normal <command>./configure</command> command, as
|
---|
| 130 | <application>Berkeley DB</application> comes with various
|
---|
| 131 | build directories for different platforms.</para>
|
---|
| 132 |
|
---|
| 133 | <para><parameter>--enable-compat185</parameter>: This switch enables
|
---|
| 134 | building DB 1.85 compatibility API.</para>
|
---|
| 135 |
|
---|
| 136 | <para><parameter>--enable-cxx</parameter>: This switch enables building
|
---|
| 137 | C++ API libraries.</para>
|
---|
| 138 |
|
---|
[ac3ee9f8] | 139 | <para><parameter>--enable-tcl --with-tcl=/usr/lib</parameter>:
|
---|
[b742c85] | 140 | Enables <application>Tcl</application> support in DB and creates the
|
---|
| 141 | <filename class="libraryfile">libdb_tcl</filename> libraries.</para>
|
---|
| 142 |
|
---|
[ac3ee9f8] | 143 | <para><parameter>--enable-java</parameter>: Enables
|
---|
[b742c85] | 144 | <application>Java</application> support in DB and creates the
|
---|
| 145 | <filename class='libraryfile'>libdb_java</filename> libraries.</para>
|
---|
| 146 |
|
---|
[ac3ee9f8] | 147 | <para><parameter>--enable-rpc</parameter>: Enables building the
|
---|
[b742c85] | 148 | <application>Berkeley DB</application> RPC server.</para>
|
---|
| 149 |
|
---|
[ac3ee9f8] | 150 | <para><command>make LIBSO_LIBS="-lpthread"
|
---|
| 151 | LIBXSO_LIBS="-lpthread"</command>: <command>configure</command>
|
---|
| 152 | does not correctly handle NPTL. These variables force it to
|
---|
| 153 | properly link against NPTL.</para>
|
---|
| 154 |
|
---|
| 155 | <para><command>make docdir=/usr/share/doc/db-&db-version;
|
---|
| 156 | install</command>: This installs the documentation in
|
---|
| 157 | the correct place.</para>
|
---|
| 158 |
|
---|
[0635d22] | 159 | <para><command>sed -i 's:puts "[s,S].*::' ../test/sijointest.tcl</command>:
|
---|
| 160 | This prevents logging two notes that are not recognized by
|
---|
| 161 | <command>run_std</command>.</para>
|
---|
| 162 |
|
---|
[b742c85] | 163 | </sect2>
|
---|
| 164 |
|
---|
| 165 | <sect2 role="content">
|
---|
| 166 | <title>Contents</title>
|
---|
| 167 |
|
---|
| 168 | <segmentedlist>
|
---|
| 169 | <segtitle>Installed Programs</segtitle>
|
---|
| 170 | <segtitle>Installed Libraries</segtitle>
|
---|
| 171 | <segtitle>Installed Directory</segtitle>
|
---|
| 172 |
|
---|
| 173 | <seglistitem>
|
---|
[ac3ee9f8] | 174 | <seg>db_archive, db_checkpoint, db_deadlock, db_dump, db_load,
|
---|
| 175 | db_printlog, db_recover, db_stat, db_upgrade, db_verify and
|
---|
| 176 | berkeley_db_svc if enabled</seg>
|
---|
[b742c85] | 177 | <seg>libdb.[so,a], libdb_cxx.[so,a], libdb_java.[so,a] and
|
---|
| 178 | libdb_tcl.[so,a]</seg>
|
---|
| 179 | <seg>/usr/share/doc/db-&db-version;</seg>
|
---|
| 180 | </seglistitem>
|
---|
| 181 | </segmentedlist>
|
---|
| 182 |
|
---|
| 183 | <variablelist>
|
---|
| 184 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 185 | <?dbfo list-presentation="list"?>
|
---|
| 186 | <?dbhtml list-presentation="table"?>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="berkeley_db_svc">
|
---|
| 189 | <term><command>berkeley_db_svc</command></term>
|
---|
| 190 | <listitem>
|
---|
| 191 | <para>is the <application>Berkeley DB</application>
|
---|
| 192 | RPC server.</para>
|
---|
| 193 | <indexterm zone="db berkeley_db_svc">
|
---|
| 194 | <primary sortas="b-berkeley_db_svc">berkeley_db_svc</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="db_archive">
|
---|
| 200 | <term><command>db_archive</command></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>prints the pathnames of log files that are no longer in
|
---|
| 203 | use.</para>
|
---|
| 204 | <indexterm zone="db db_archive">
|
---|
| 205 | <primary sortas="b-db_archive">db_archive</primary>
|
---|
| 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
| 210 | <varlistentry id="db_checkpoint">
|
---|
| 211 | <term><command>db_checkpoint</command></term>
|
---|
| 212 | <listitem>
|
---|
| 213 | <para>is a daemon process used to monitor and checkpoint database
|
---|
| 214 | logs.</para>
|
---|
| 215 | <indexterm zone="db db_checkpoint">
|
---|
| 216 | <primary sortas="b-db_checkpoint">db_checkpoint</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="db_deadlock">
|
---|
| 222 | <term><command>db_deadlock</command></term>
|
---|
| 223 | <listitem>
|
---|
| 224 | <para>is used to abort lock requests when deadlocks are
|
---|
| 225 | detected.</para>
|
---|
| 226 | <indexterm zone="db db_deadlock">
|
---|
| 227 | <primary sortas="b-db_deadlock">db_deadlock</primary>
|
---|
| 228 | </indexterm>
|
---|
| 229 | </listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="db_dump">
|
---|
| 233 | <term><command>db_dump</command></term>
|
---|
| 234 | <listitem>
|
---|
| 235 | <para>converts database files to a flat file format readable by
|
---|
| 236 | <command>db_load</command>.</para>
|
---|
| 237 | <indexterm zone="db db_dump">
|
---|
| 238 | <primary sortas="b-db_dump">db_dump</primary>
|
---|
| 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
| 242 |
|
---|
| 243 | <varlistentry id="db_load">
|
---|
| 244 | <term><command>db_load</command></term>
|
---|
| 245 | <listitem>
|
---|
| 246 | <para>is used to create database files from flat files created with
|
---|
| 247 | <command>db_dump</command>.</para>
|
---|
| 248 | <indexterm zone="db db_load">
|
---|
| 249 | <primary sortas="b-db_load">db_load</primary>
|
---|
| 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
| 254 | <varlistentry id="db_printlog">
|
---|
| 255 | <term><command>db_printlog</command></term>
|
---|
| 256 | <listitem>
|
---|
| 257 | <para>converts database log files to human readable text.</para>
|
---|
| 258 | <indexterm zone="db db_printlog">
|
---|
| 259 | <primary sortas="b-db_printlog">db_printlog</primary>
|
---|
| 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
| 263 |
|
---|
| 264 | <varlistentry id="db_recover">
|
---|
| 265 | <term><command>db_recover</command></term>
|
---|
| 266 | <listitem>
|
---|
| 267 | <para>is used to restore a database to a consistent state after a
|
---|
| 268 | failure.</para>
|
---|
| 269 | <indexterm zone="db db_recover">
|
---|
| 270 | <primary sortas="b-db_recover">db_recover</primary>
|
---|
| 271 | </indexterm>
|
---|
| 272 | </listitem>
|
---|
| 273 | </varlistentry>
|
---|
| 274 |
|
---|
| 275 | <varlistentry id="db_stat">
|
---|
| 276 | <term><command>db_stat</command></term>
|
---|
| 277 | <listitem>
|
---|
| 278 | <para>displays database environment statistics.</para>
|
---|
| 279 | <indexterm zone="db db_stat">
|
---|
| 280 | <primary sortas="b-db_stat">db_stat</primary>
|
---|
| 281 | </indexterm>
|
---|
| 282 | </listitem>
|
---|
| 283 | </varlistentry>
|
---|
| 284 |
|
---|
| 285 | <varlistentry id="db_upgrade">
|
---|
| 286 | <term><command>db_upgrade</command></term>
|
---|
| 287 | <listitem>
|
---|
| 288 | <para>is used to upgrade database files to a newer version of
|
---|
| 289 | <application>Berkeley DB</application>.</para>
|
---|
| 290 | <indexterm zone="db db_upgrade">
|
---|
| 291 | <primary sortas="b-db_upgrade">db_upgrade</primary>
|
---|
| 292 | </indexterm>
|
---|
| 293 | </listitem>
|
---|
| 294 | </varlistentry>
|
---|
| 295 |
|
---|
| 296 | <varlistentry id="db_verify">
|
---|
| 297 | <term><command>db_verify</command></term>
|
---|
| 298 | <listitem>
|
---|
| 299 | <para>is used to run consistency checks on database files.</para>
|
---|
| 300 | <indexterm zone="db db_verify">
|
---|
| 301 | <primary sortas="b-db_verify">db_verify</primary>
|
---|
| 302 | </indexterm>
|
---|
| 303 | </listitem>
|
---|
| 304 | </varlistentry>
|
---|
| 305 |
|
---|
| 306 | </variablelist>
|
---|
| 307 |
|
---|
| 308 | </sect2>
|
---|
[f45b1953] | 309 |
|
---|
| 310 | </sect1>
|
---|