[08254fc] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[08254fc] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[0aeb696] | 6 |
|
---|
[a9e1d249] | 7 | <!ENTITY db-download-http
|
---|
| 8 | "http://download.oracle.com/berkeley-db/db-&db-version;.tar.gz">
|
---|
| 9 | <!ENTITY db-download-ftp " ">
|
---|
[8082e46] | 10 | <!ENTITY db-md5sum "33491b4756cb44b91c3318b727e71023">
|
---|
| 11 | <!ENTITY db-size "43 MB">
|
---|
| 12 | <!ENTITY db-buildsize "236 MB">
|
---|
[db6b3391] | 13 | <!ENTITY db-time "0.7 SBU">
|
---|
[08254fc] | 14 | ]>
|
---|
| 15 |
|
---|
[317034a] | 16 | <sect1 id="db" xreflabel="Berkeley DB-&db-version;">
|
---|
[b742c85] | 17 | <?dbhtml filename="db.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
| 23 |
|
---|
| 24 | <title>Berkeley DB-&db-version;</title>
|
---|
| 25 |
|
---|
| 26 | <indexterm zone="db">
|
---|
| 27 | <primary sortas="a-Berkeley-DB">Berkeley DB</primary>
|
---|
| 28 | </indexterm>
|
---|
| 29 |
|
---|
| 30 | <sect2 role="package">
|
---|
| 31 | <title>Introduction to Berkeley DB</title>
|
---|
| 32 |
|
---|
[1ea160c0] | 33 | <para>
|
---|
| 34 | The <application>Berkeley DB</application> package contains programs and
|
---|
| 35 | utilities used by many other applications for database related functions.
|
---|
| 36 | </para>
|
---|
[b742c85] | 37 |
|
---|
[baa6857] | 38 | &lfs82_checked;
|
---|
[d8069d7] | 39 |
|
---|
[b742c85] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[1ea160c0] | 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&db-download-http;"/>
|
---|
| 45 | </para>
|
---|
[b742c85] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[1ea160c0] | 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&db-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
[b742c85] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[1ea160c0] | 53 | <para>
|
---|
| 54 | Download MD5 sum: &db-md5sum;
|
---|
| 55 | </para>
|
---|
[b742c85] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[1ea160c0] | 58 | <para>
|
---|
| 59 | Download size: &db-size;
|
---|
| 60 | </para>
|
---|
[b742c85] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[1ea160c0] | 63 | <para>
|
---|
| 64 | Estimated disk space required: &db-buildsize;
|
---|
| 65 | </para>
|
---|
[b742c85] | 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
[1ea160c0] | 68 | <para>
|
---|
| 69 | Estimated build time: &db-time;
|
---|
| 70 | </para>
|
---|
[b742c85] | 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Berkeley DB Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[d8069d7] | 77 | <para role="optional">
|
---|
[d335260] | 78 | <xref linkend="tcl"/><!--,
|
---|
[233a4949] | 79 | <xref linkend="openjdk"/> or <xref linkend="java"/>, and
|
---|
[d335260] | 80 | - - This is currently broken, removed for now. - -
|
---|
[ca8bcae9] | 81 | <xref linkend="sharutils"/> (for the <command>uudecode</command> command
|
---|
[d335260] | 82 | - Java bindings are required) -->
|
---|
[d8069d7] | 83 | </para>
|
---|
[b742c85] | 84 |
|
---|
[1ea160c0] | 85 | <para condition="html" role="usernotes">
|
---|
| 86 | User Notes: <ulink url="&blfs-wiki;/db"/>
|
---|
| 87 | </para>
|
---|
[b742c85] | 88 | </sect2>
|
---|
| 89 |
|
---|
[a9e1d249] | 90 | <!-- <sect2 role="testing">
|
---|
[ac3ee9f8] | 91 | <title>Testing Berkeley DB</title>
|
---|
| 92 |
|
---|
[1ea160c0] | 93 | <para>
|
---|
| 94 | If you can't wait 12 hours or so you may want to skip ahead to
|
---|
| 95 | <xref linkend="bdb-installation"/>. The test suite can take a long time
|
---|
| 96 | and has a few bugs causing a report of <quote>Regression tests
|
---|
| 97 | failed</quote>. However, running the test suite is a very exhaustive test
|
---|
| 98 | of your hardware, perhaps pushing your machine harder (especially disk
|
---|
| 99 | I/O) than it will ever see during production use. Note that you must have
|
---|
| 100 | <application>Tcl</application> installed to run the test suite.
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <para>
|
---|
| 104 | Build for the <application>Berkeley DB</application> test by running the
|
---|
| 105 | following commands:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput>cd build_unix &&
|
---|
[a9e1d249] | 109 | ../dist/configure --prefix=/usr \
|
---|
| 110 | --enable-test \
|
---|
| 111 | --enable-tcl \
|
---|
| 112 | --enable-dbm \
|
---|
| 113 | --with-tcl=/usr/lib &&
|
---|
[2a038b2] | 114 | make</userinput></screen>
|
---|
[ac3ee9f8] | 115 |
|
---|
[1ea160c0] | 116 | <para>
|
---|
| 117 | To test the results, start <command>tclsh</command>:
|
---|
| 118 | </para>
|
---|
[bccbdaea] | 119 |
|
---|
[8f9c757e] | 120 | <screen><userinput>tclsh</userinput></screen>
|
---|
| 121 |
|
---|
[1ea160c0] | 122 | <para>
|
---|
| 123 | From the <command>tclsh</command> prompt (<prompt>% </prompt>), run:
|
---|
| 124 | </para>
|
---|
[8f9c757e] | 125 |
|
---|
[d8069d7] | 126 | <screen><userinput>source ../test/tcl/test.tcl
|
---|
[8f9c757e] | 127 | run_parallel 5 run_std
|
---|
| 128 | exit</userinput></screen>
|
---|
[ac3ee9f8] | 129 |
|
---|
[1ea160c0] | 130 | <para>
|
---|
| 131 | Clean up the source tree with the following command:
|
---|
| 132 | </para>
|
---|
[ac3ee9f8] | 133 |
|
---|
[2c2f849] | 134 | <screen><userinput>make realclean &&
|
---|
[8d288fe8] | 135 | cd ..</userinput></screen>
|
---|
[2c2f849] | 136 |
|
---|
[1ea160c0] | 137 | <note><para>
|
---|
| 138 | Test127.f and Repmgr026.c are known to fail.
|
---|
| 139 | </para></note>
|
---|
[d8069d7] | 140 |
|
---|
[1ea160c0] | 141 | <para>
|
---|
| 142 | There are additional testing suites in the
|
---|
| 143 | <filename class="directory">test/c</filename> and
|
---|
| 144 | <filename class="directory">test/cxx</filename> directories. See the
|
---|
| 145 | <filename>README</filename> in each directory for instructions on how to
|
---|
| 146 | run the tests.
|
---|
| 147 | </para>
|
---|
[a9e1d249] | 148 | </sect2> -->
|
---|
[2c2f849] | 149 |
|
---|
[2a038b2] | 150 | <sect2 role="installation" id="bdb-installation">
|
---|
[2c2f849] | 151 | <title>Installation of Berkeley DB</title>
|
---|
| 152 |
|
---|
[1ea160c0] | 153 | <para>
|
---|
| 154 | Install <application>Berkeley DB</application> by running the following
|
---|
| 155 | commands:
|
---|
| 156 | </para>
|
---|
[2c2f849] | 157 |
|
---|
[1ea160c0] | 158 | <screen><userinput>cd build_unix &&
|
---|
| 159 | ../dist/configure --prefix=/usr \
|
---|
[2a038b2] | 160 | --enable-compat185 \
|
---|
[1ea160c0] | 161 | --enable-dbm \
|
---|
| 162 | --disable-static \
|
---|
| 163 | --enable-cxx &&
|
---|
[2a038b2] | 164 | make</userinput></screen>
|
---|
[2c2f849] | 165 |
|
---|
[1ea160c0] | 166 | <para>
|
---|
| 167 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 168 | </para>
|
---|
[2c2f849] | 169 |
|
---|
| 170 | <screen role="root"><userinput>make docdir=/usr/share/doc/db-&db-version; install &&
|
---|
[aed3e6ec] | 171 |
|
---|
[1ea160c0] | 172 | chown -v -R root:root \
|
---|
| 173 | /usr/bin/db_* \
|
---|
| 174 | /usr/include/db{,_185,_cxx}.h \
|
---|
| 175 | /usr/lib/libdb*.{so,la} \
|
---|
[35a18d26] | 176 | /usr/share/doc/db-&db-version;</userinput></screen>
|
---|
[ac3ee9f8] | 177 | </sect2>
|
---|
| 178 |
|
---|
[b742c85] | 179 | <sect2 role="commands">
|
---|
| 180 | <title>Command Explanations</title>
|
---|
| 181 |
|
---|
[1ea160c0] | 182 | <para>
|
---|
| 183 | <command>cd build_unix && ../dist/configure
|
---|
| 184 | --prefix=/usr...</command>: This replaces the normal
|
---|
| 185 | <command>./configure</command> command, as
|
---|
| 186 | <application>Berkeley DB</application> comes with various build
|
---|
| 187 | directories for different platforms.
|
---|
| 188 | </para>
|
---|
[b742c85] | 189 |
|
---|
[1ea160c0] | 190 | <para>
|
---|
[b412c90f] | 191 | <parameter>--enable-compat185</parameter>: This switch enables building
|
---|
[1ea160c0] | 192 | the DB-1.85 compatibility API.
|
---|
| 193 | </para>
|
---|
[b742c85] | 194 |
|
---|
[1ea160c0] | 195 | <para>
|
---|
[b412c90f] | 196 | <parameter>--enable-cxx</parameter>: This switch enables building C++ API
|
---|
[1ea160c0] | 197 | libraries.
|
---|
| 198 | </para>
|
---|
[b742c85] | 199 |
|
---|
[1ea160c0] | 200 | <para>
|
---|
[b412c90f] | 201 | <parameter>--enable-dbm</parameter>: Enables legacy interface support
|
---|
[1ea160c0] | 202 | needed by some older packages.
|
---|
| 203 | </para>
|
---|
[b742c85] | 204 |
|
---|
[1ea160c0] | 205 | <para>
|
---|
| 206 | <command>make docdir=/usr/share/doc/db-&db-version; install</command>:
|
---|
| 207 | This installs the documentation in the standard location instead of
|
---|
| 208 | <filename class="directory">/usr/docs</filename>.
|
---|
| 209 | </para>
|
---|
[0635d22] | 210 |
|
---|
[1ea160c0] | 211 | <para>
|
---|
| 212 | <command>chown -v -R root:root ...</command>:This command changes the
|
---|
| 213 | ownership of various installed files from the uid:gid of the builder to
|
---|
| 214 | root:root.
|
---|
| 215 | </para>
|
---|
[a9e1d249] | 216 |
|
---|
| 217 | <para>
|
---|
| 218 | <option>--enable-tcl --with-tcl=/usr/lib</option>: Enables
|
---|
| 219 | <application>Tcl</application> support in DB and creates the
|
---|
| 220 | <filename class="libraryfile">libdb_tcl</filename> libraries.
|
---|
| 221 | </para>
|
---|
| 222 |
|
---|
| 223 | <para>
|
---|
[ca8bcae9] | 224 | <option>--enable-java</option>: Enables <application>Java</application>
|
---|
| 225 | support in DB and creates the
|
---|
[a9e1d249] | 226 | <filename class="libraryfile">libdb_java</filename> libraries.
|
---|
[d335260] | 227 | <!-- Remove at next version -->
|
---|
| 228 | Support is currently broken with Java-9.x.
|
---|
[a9e1d249] | 229 | </para>
|
---|
[b742c85] | 230 | </sect2>
|
---|
| 231 |
|
---|
| 232 | <sect2 role="content">
|
---|
| 233 | <title>Contents</title>
|
---|
| 234 |
|
---|
| 235 | <segmentedlist>
|
---|
[de7f20e] | 236 | <segtitle>Installed Programs</segtitle>
|
---|
[b742c85] | 237 | <segtitle>Installed Libraries</segtitle>
|
---|
| 238 | <segtitle>Installed Directory</segtitle>
|
---|
| 239 |
|
---|
| 240 | <seglistitem>
|
---|
[1ea160c0] | 241 | <seg>
|
---|
[a9e1d249] | 242 | db_archive,
|
---|
| 243 | db_checkpoint,
|
---|
| 244 | db_deadlock,
|
---|
| 245 | db_dump,
|
---|
| 246 | db_hotbackup,
|
---|
| 247 | db_load,
|
---|
| 248 | db_log_verify,
|
---|
| 249 | db_printlog,
|
---|
| 250 | db_recover,
|
---|
| 251 | db_replicate,
|
---|
| 252 | db_stat,
|
---|
| 253 | db_tuner,
|
---|
[f12d3487] | 254 | db_upgrade, and
|
---|
[233a4949] | 255 | db_verify
|
---|
[1ea160c0] | 256 | </seg>
|
---|
| 257 | <seg>
|
---|
[491df213] | 258 | libdb.so,
|
---|
| 259 | libdb_cxx.so,
|
---|
| 260 | libdb_java.so, and
|
---|
| 261 | libdb_tcl.so
|
---|
[1ea160c0] | 262 | </seg>
|
---|
[b742c85] | 263 | <seg>/usr/share/doc/db-&db-version;</seg>
|
---|
| 264 | </seglistitem>
|
---|
| 265 | </segmentedlist>
|
---|
| 266 |
|
---|
| 267 | <variablelist>
|
---|
| 268 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 269 | <?dbfo list-presentation="list"?>
|
---|
| 270 | <?dbhtml list-presentation="table"?>
|
---|
| 271 |
|
---|
| 272 | <varlistentry id="db_archive">
|
---|
| 273 | <term><command>db_archive</command></term>
|
---|
| 274 | <listitem>
|
---|
[1ea160c0] | 275 | <para>
|
---|
| 276 | prints the pathnames of log files that are no longer in use.
|
---|
| 277 | </para>
|
---|
[b742c85] | 278 | <indexterm zone="db db_archive">
|
---|
| 279 | <primary sortas="b-db_archive">db_archive</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | <varlistentry id="db_checkpoint">
|
---|
| 285 | <term><command>db_checkpoint</command></term>
|
---|
| 286 | <listitem>
|
---|
[1ea160c0] | 287 | <para>
|
---|
| 288 | is a daemon process used to monitor and checkpoint database logs.
|
---|
| 289 | </para>
|
---|
[b742c85] | 290 | <indexterm zone="db db_checkpoint">
|
---|
| 291 | <primary sortas="b-db_checkpoint">db_checkpoint</primary>
|
---|
| 292 | </indexterm>
|
---|
| 293 | </listitem>
|
---|
| 294 | </varlistentry>
|
---|
| 295 |
|
---|
| 296 | <varlistentry id="db_deadlock">
|
---|
| 297 | <term><command>db_deadlock</command></term>
|
---|
| 298 | <listitem>
|
---|
[1ea160c0] | 299 | <para>
|
---|
| 300 | is used to abort lock requests when deadlocks are detected.
|
---|
| 301 | </para>
|
---|
[b742c85] | 302 | <indexterm zone="db db_deadlock">
|
---|
| 303 | <primary sortas="b-db_deadlock">db_deadlock</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
| 307 |
|
---|
| 308 | <varlistentry id="db_dump">
|
---|
| 309 | <term><command>db_dump</command></term>
|
---|
| 310 | <listitem>
|
---|
[1ea160c0] | 311 | <para>
|
---|
| 312 | converts database files to a flat file format readable by
|
---|
| 313 | <command>db_load</command>.
|
---|
| 314 | </para>
|
---|
[b742c85] | 315 | <indexterm zone="db db_dump">
|
---|
| 316 | <primary sortas="b-db_dump">db_dump</primary>
|
---|
| 317 | </indexterm>
|
---|
| 318 | </listitem>
|
---|
| 319 | </varlistentry>
|
---|
| 320 |
|
---|
[1ea160c0] | 321 | <varlistentry id="db_hotbackup">
|
---|
| 322 | <term><command>db_hotbackup</command></term>
|
---|
| 323 | <listitem>
|
---|
| 324 | <para>
|
---|
| 325 | creates "hot backup" or "hot failover" snapshots of Berkeley DB
|
---|
| 326 | databases.
|
---|
| 327 | </para>
|
---|
| 328 | <indexterm zone="db db_hotbackup">
|
---|
| 329 | <primary sortas="b-db_hotbackup">db_hotbackup</primary>
|
---|
| 330 | </indexterm>
|
---|
| 331 | </listitem>
|
---|
| 332 | </varlistentry>
|
---|
| 333 |
|
---|
[b742c85] | 334 | <varlistentry id="db_load">
|
---|
| 335 | <term><command>db_load</command></term>
|
---|
| 336 | <listitem>
|
---|
[1ea160c0] | 337 | <para>
|
---|
| 338 | is used to create database files from flat files created with
|
---|
| 339 | <command>db_dump</command>.
|
---|
| 340 | </para>
|
---|
[b742c85] | 341 | <indexterm zone="db db_load">
|
---|
| 342 | <primary sortas="b-db_load">db_load</primary>
|
---|
| 343 | </indexterm>
|
---|
| 344 | </listitem>
|
---|
| 345 | </varlistentry>
|
---|
| 346 |
|
---|
[1ea160c0] | 347 | <varlistentry id="db_log_verify">
|
---|
| 348 | <term><command>db_log_verify</command></term>
|
---|
| 349 | <listitem>
|
---|
| 350 | <para>verifies the log files of a database.</para>
|
---|
| 351 | <indexterm zone="db db_log_verify">
|
---|
| 352 | <primary sortas="b-db_log_verify">db_log_verify</primary>
|
---|
| 353 | </indexterm>
|
---|
| 354 | </listitem>
|
---|
| 355 | </varlistentry>
|
---|
| 356 |
|
---|
[b742c85] | 357 | <varlistentry id="db_printlog">
|
---|
| 358 | <term><command>db_printlog</command></term>
|
---|
| 359 | <listitem>
|
---|
| 360 | <para>converts database log files to human readable text.</para>
|
---|
| 361 | <indexterm zone="db db_printlog">
|
---|
| 362 | <primary sortas="b-db_printlog">db_printlog</primary>
|
---|
| 363 | </indexterm>
|
---|
| 364 | </listitem>
|
---|
| 365 | </varlistentry>
|
---|
| 366 |
|
---|
| 367 | <varlistentry id="db_recover">
|
---|
| 368 | <term><command>db_recover</command></term>
|
---|
| 369 | <listitem>
|
---|
[1ea160c0] | 370 | <para>
|
---|
| 371 | is used to restore a database to a consistent state after a failure.
|
---|
| 372 | </para>
|
---|
[b742c85] | 373 | <indexterm zone="db db_recover">
|
---|
| 374 | <primary sortas="b-db_recover">db_recover</primary>
|
---|
| 375 | </indexterm>
|
---|
| 376 | </listitem>
|
---|
| 377 | </varlistentry>
|
---|
| 378 |
|
---|
[1ea160c0] | 379 | <varlistentry id="db_replicate">
|
---|
| 380 | <term><command>db_replicate</command></term>
|
---|
| 381 | <listitem>
|
---|
| 382 | <para>
|
---|
| 383 | is a daemon process that provides replication/HA services on a
|
---|
| 384 | transactional environment.
|
---|
| 385 | </para>
|
---|
| 386 | <indexterm zone="db db_replicate">
|
---|
| 387 | <primary sortas="b-db_replicate">db_replicate</primary>
|
---|
| 388 | </indexterm>
|
---|
| 389 | </listitem>
|
---|
| 390 | </varlistentry>
|
---|
| 391 |
|
---|
[b742c85] | 392 | <varlistentry id="db_stat">
|
---|
| 393 | <term><command>db_stat</command></term>
|
---|
| 394 | <listitem>
|
---|
| 395 | <para>displays database environment statistics.</para>
|
---|
| 396 | <indexterm zone="db db_stat">
|
---|
| 397 | <primary sortas="b-db_stat">db_stat</primary>
|
---|
| 398 | </indexterm>
|
---|
| 399 | </listitem>
|
---|
| 400 | </varlistentry>
|
---|
| 401 |
|
---|
[1ea160c0] | 402 | <varlistentry id="db_tuner">
|
---|
| 403 | <term><command>db_tuner</command></term>
|
---|
| 404 | <listitem>
|
---|
| 405 | <para>
|
---|
| 406 | analyzes the data in a btree database, and suggests a page size that
|
---|
| 407 | is likely to deliver optimal operation.
|
---|
| 408 | </para>
|
---|
| 409 | <indexterm zone="db db_tuner">
|
---|
| 410 | <primary sortas="b-db_tuner">db_tuner</primary>
|
---|
| 411 | </indexterm>
|
---|
| 412 | </listitem>
|
---|
| 413 | </varlistentry>
|
---|
| 414 |
|
---|
[b742c85] | 415 | <varlistentry id="db_upgrade">
|
---|
| 416 | <term><command>db_upgrade</command></term>
|
---|
| 417 | <listitem>
|
---|
[1ea160c0] | 418 | <para>
|
---|
| 419 | is used to upgrade database files to a newer version of
|
---|
| 420 | <application>Berkeley DB</application>.
|
---|
| 421 | </para>
|
---|
[b742c85] | 422 | <indexterm zone="db db_upgrade">
|
---|
| 423 | <primary sortas="b-db_upgrade">db_upgrade</primary>
|
---|
| 424 | </indexterm>
|
---|
| 425 | </listitem>
|
---|
| 426 | </varlistentry>
|
---|
| 427 |
|
---|
| 428 | <varlistentry id="db_verify">
|
---|
| 429 | <term><command>db_verify</command></term>
|
---|
| 430 | <listitem>
|
---|
| 431 | <para>is used to run consistency checks on database files.</para>
|
---|
| 432 | <indexterm zone="db db_verify">
|
---|
| 433 | <primary sortas="b-db_verify">db_verify</primary>
|
---|
| 434 | </indexterm>
|
---|
| 435 | </listitem>
|
---|
| 436 | </varlistentry>
|
---|
| 437 | </variablelist>
|
---|
| 438 | </sect2>
|
---|
[f45b1953] | 439 | </sect1>
|
---|