source: server/databases/db.xml@ ab7b9fc

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY db-download-http "http://download-east.oracle.com/berkeley-db/db-&db-version;.tar.gz">
  <!ENTITY db-download-ftp  " ">
  <!ENTITY db-md5sum        "76fcbfeebfcd09ba0b4d96bfdf8d884d">
  <!ENTITY db-size          "30 MB">
  <!ENTITY db-buildsize     "267 MB (additional 170 MB to run parallel standard test suite with all bindings)">
  <!ENTITY db-time          "2.1 SBU (builds all bindings, add an additional 160 SBU to run parallel standard test suite)">
]>

<sect1 id="db" xreflabel="Berkeley DB-&db-version;">
  <?dbhtml filename="db.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Berkeley DB-&db-version;</title>

  <indexterm zone="db">
    <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Berkeley DB</title>

    <!-- <para>The <application>Berkeley DB</application> package contains programs
    and utilities used by many other applications for database related
    functions. This package is also installed during LFS and may already exist
    on your system. It is listed here in BLFS as well because you may need to
    reinstall it if you need the additional language bindings or the RPC
    server. If you do reinstall <application>Berkeley DB</application>, ensure
    you use the &lfs-bdb-version; version used in the LFS book.</para> -->

    <para>The <application>Berkeley DB</application> package contains programs
    and utilities used by many other applications for database related
    functions.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&db-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&db-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &db-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &db-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &db-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &db-time;</para>
      </listitem>
    </itemizedlist>

    <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="http://www.oracle.com/technology/products/berkeley-db/db/update/&db-version;/patch.&db-version;.1"/></para>
      </listitem>
      <listitem>
        <para>Required patch: <ulink
        url="http://www.oracle.com/technology/products/berkeley-db/db/update/&db-version;/patch.&db-version;.2"/></para>
      </listitem>
    </itemizedlist> -->

    <bridgehead renderas="sect3">Berkeley DB Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="tcl"/>, and
    <xref linkend="icedtea6"/> or <xref linkend="jdk"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/db"/></para>

  </sect2>

  <sect2 role="testing">
    <title>Testing Berkeley DB</title>

    <para>You may want to skip ahead to <xref linkend="bdb-installation"/>. The
    test suite can take up to 150 SBUs and has a few bugs causing a report of
    <quote>Regression tests failed</quote>. However, running the test suite is
    a very exhaustive test of your hardware, perhaps pushing your machine
    harder (especially disk I/O) than it will ever see during production use.
    Note that you must have <application>Tcl</application> installed to run the
    test suite.</para>

    <para>Build for the <application>Berkeley DB</application> test suite by
    running the following commands (add <parameter>--enable-java</parameter> if
    you wish to test the java bindings):</para>

<screen><userinput>cd build_unix &amp;&amp;
uudecode="no" ../dist/configure --prefix=/usr \
                  --enable-test \
                  --enable-tcl  \
                  --enable-sql  \
                  --with-tcl=/usr/lib &amp;&amp;
make</userinput></screen>

    <para>To test <application>Berkeley DB</application>, issue the following
    command:</para>

<screen><userinput>echo "source ../test/tcl/test.tcl; run_parallel 5 run_std; exit;" | tclsh</userinput></screen>

    <para>Clean up the source tree with the following command:</para>

<screen><userinput>make realclean &amp;&amp;
cd ..</userinput></screen>

  </sect2>

  <sect2 role="installation" id="bdb-installation">
    <title>Installation of Berkeley DB</title>

    <!-- <para>The installation commands below are identical to the commands used
    in the LFS book. If you installed <application>Berkeley DB</application>
    in LFS, and you don't add anything to the <command>configure</command>
    script, you'll end up with exactly what you already have. The additional
    parameters you can use are listed in the Command Explanations section
    below.</para> 

    <note>
      <para>If you plan on installing <application>Berkeley DB</application>
      with Java support, you should check the system for certain versions
      of <xref linkend="jdk"/> and <xref linkend="gmime"/>. Specifically, if
      <application>JDK</application>-6 Update X and the
      <command>uudecode</command> program from the
      <application>GMime</application> program is on the system, the build will
      fail (unless you run the modified <command>./configure</command> command
      shown below). You can run two commands (<command>javac -version</command>
      and <command>uudecode - -version</command>) to determine what versions are
      installed. You can also download and run a shell script from
      <ulink url="&files-anduin;/jdk-uudecode-check.sh"/> that will alert
      you to a non-working condition. If the identified programs exist on the
      system, you must modify the
      <command>./configure</command> command as shown below.</para> 

<screen><userinput>uudecode="no" ../dist/configure - -(use the parameters shown below)</userinput></screen>
    </note> -->

    <para>Install <application>Berkeley DB</application> by running the
    following commands:</para>

<screen><userinput>cd build_unix &amp;&amp;
uudecode="no" ../dist/configure --prefix=/usr \
                  --enable-compat185 \
                  --enable-cxx \
                  --enable-sql &amp;&amp;
make</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make docdir=/usr/share/doc/db-&db-version; install &amp;&amp;
touch /usr/include/sqlite.h
chown -v -R root:root \
      /usr/bin/db_* \
      /usr/bin/dbsql \
      /usr/include/db{,_185,_cxx,sql}.h \
      /usr/lib/libdb{,_cxx,_sql}{.a,.so,-5.so,-5.1.{a,la,so}} \
      /usr/share/doc/db-&db-version;</userinput></screen>

    <para>If you compiled <application>Berkeley DB</application> with
    <application>TCL</application> support, complete the
    <application>TCL</application> installation with the following commands
    while still the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>chown -v root:root \
      /usr/lib/libdb_tcl{.a,.so,-5.so,-5.1.{a,la,so}}</userinput></screen>

    <para>If you compiled <application>Berkeley DB</application> with
    <application>Java</application> support, complete the
    <application>Java</application> installation with the following commands
    while still the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>chown -v root:root \
      /usr/lib/libdb_java{.so,-5.so,-5.1{.a,.la,.so,_g.so}} \
      /usr/lib/db.jar</userinput></screen>

    <para>Finaly, if you've configured <application>Berkeley DB</application>
    with the <parameter>--enable-sql_compat</parameter> parameter to provide
    <application>SQLite3</application> compatibility, complete the installation
    with the following commands while still the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>touch /usr/include/sqlite3.h &amp;&amp;
chown -v root:root \
      /usr/bin/sqlite3 \
      /usr/include/sqlite3.h \
      /usr/lib/libsqlite3.{a,la,so}</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>cd build_unix &amp;&amp;
    uudecode="no" ../dist/configure --prefix=/usr...</command>:
    This replaces the normal <command>./configure</command> command, as
    <application>Berkeley DB</application> comes with various
    build directories for different platforms.  The additional
    <envar>uudecode="no"</envar> environment variable ensures that
    the build will complete if <xref linkend="gmime"/> is intsalled.</para>

    <para><parameter>--enable-compat185</parameter>: This switch enables
    building the DB-1.85 compatibility API.</para>

    <para><parameter>--enable-cxx</parameter>: This switch enables building
    C++ API libraries.</para>

    <para><parameter>--enable-tcl --with-tcl=/usr/lib</parameter>:
    Enables <application>Tcl</application> support in DB and creates the
    <filename class="libraryfile">libdb_tcl</filename> libraries.</para>

    <para><parameter>--enable-java</parameter>: Enables
    <application>Java</application> support in DB and creates the
    <filename class='libraryfile'>libdb_java</filename> libraries.</para>

    <para><parameter>--enable-sql</parameter>: Enables SQL support in
    DB and creates the <filename class='libraryfile'>libdb_sql</filename>
    libraries.</para>

    <para><parameter>--enable-sql_compat</parameter>: enables building of the
    <application>SQLite3</application> compatible binaries and libs.</para>

    <para><command>make docdir=/usr/share/doc/db-&db-version;
    install</command>: This installs the documentation in
    the standard location instead of
    <filename class='directory'>/usr/docs</filename>.</para>

    <para><command>chown -v -R root:root ...</command>:These commands change
    the ownership of various installed files from the uid:gid of the
    builder to root:root.</para>

    <para><command>touch /usr/include/sqlite3.h</command>: This command updates
    the timestamp of the installed sqlite3 header.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <!-- <para>Only the program and libraries not installed in LFS are listed here,
    the others can be found at <ulink
    url="&lfs-root;/chapter06/db.html#contents-db"/> as they were initially
    installed during the building of LFS.</para> -->

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>db_archive, db_checkpoint, db_deadlock, db_dump,
        db_load, db_printlog, db_recover, db_stat, db_upgrade, db_verify, 
        dbsql, sqlite3</seg>
        <seg>libdb.{so,a}, libdb_cxx.{so,a}, libdb_java{_g.so,.{so,a},
        libdb_tcl.{so,a}, libdb_sql.{so.a} and db.jar</seg>
        <seg>/usr/share/doc/db-&db-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="db_archive">
        <term><command>db_archive</command></term>
        <listitem>
          <para>prints the pathnames of log files that are no longer in
          use.</para>
          <indexterm zone="db db_archive">
            <primary sortas="b-db_archive">db_archive</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_checkpoint">
        <term><command>db_checkpoint</command></term>
        <listitem>
          <para>is a daemon process used to monitor and checkpoint database
          logs.</para>
          <indexterm zone="db db_checkpoint">
            <primary sortas="b-db_checkpoint">db_checkpoint</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_deadlock">
        <term><command>db_deadlock</command></term>
        <listitem>
          <para>is used to abort lock requests when deadlocks are
          detected.</para>
          <indexterm zone="db db_deadlock">
            <primary sortas="b-db_deadlock">db_deadlock</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_dump">
        <term><command>db_dump</command></term>
        <listitem>
          <para>converts database files to a flat file format readable by
          <command>db_load</command>.</para>
          <indexterm zone="db db_dump">
            <primary sortas="b-db_dump">db_dump</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_load">
        <term><command>db_load</command></term>
        <listitem>
          <para>is used to create database files from flat files created with
          <command>db_dump</command>.</para>
          <indexterm zone="db db_load">
            <primary sortas="b-db_load">db_load</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_printlog">
        <term><command>db_printlog</command></term>
        <listitem>
          <para>converts database log files to human readable text.</para>
          <indexterm zone="db db_printlog">
            <primary sortas="b-db_printlog">db_printlog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_recover">
        <term><command>db_recover</command></term>
        <listitem>
          <para>is used to restore a database to a consistent state after a
          failure.</para>
          <indexterm zone="db db_recover">
            <primary sortas="b-db_recover">db_recover</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_stat">
        <term><command>db_stat</command></term>
        <listitem>
          <para>displays database environment statistics.</para>
          <indexterm zone="db db_stat">
            <primary sortas="b-db_stat">db_stat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_upgrade">
        <term><command>db_upgrade</command></term>
        <listitem>
          <para>is used to upgrade database files to a newer version of
          <application>Berkeley DB</application>.</para>
          <indexterm zone="db db_upgrade">
            <primary sortas="b-db_upgrade">db_upgrade</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_verify">
        <term><command>db_verify</command></term>
        <listitem>
          <para>is used to run consistency checks on database files.</para>
          <indexterm zone="db db_verify">
            <primary sortas="b-db_verify">db_verify</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dbsql">
        <term><command>dbsql</command></term>
        <listitem>
          <para>is a terminal-based front-end to the dbsql library that can
          evaluate queries interactively and display the results.</para>
          <indexterm zone="db dbsql">
            <primary sortas="b-dbsql">dbsql</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="db_sqlite3">
        <term><command>sqlite3</command></term>
        <listitem>
          <para>is a SQLite3 compatable inteface for dbsql.</para>
          <indexterm zone="db sqlite3">
            <primary sortas="b-sqlite3">sqlite3</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>