1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY db-download-http " ">
|
---|
8 | <!ENTITY db-download-ftp "ftp://sleepycat1.inetu.net/releases/db-&db-version;.tar.gz">
|
---|
9 | <!ENTITY db-md5sum "fcc481d52c3b80e20a328f8c0cb042bd">
|
---|
10 | <!ENTITY db-size "5.7 MB">
|
---|
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)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="db" xreflabel="Berkeley DB-&db-version;">
|
---|
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>
|
---|
61 | <para><xref linkend="tcl"/> and <xref linkend="jdk"/></para>
|
---|
62 |
|
---|
63 | </sect2>
|
---|
64 |
|
---|
65 | <sect2 role="installation">
|
---|
66 | <title>Installation of Berkeley DB</title>
|
---|
67 |
|
---|
68 | <para>If you wish to test <application>Berkeley DB</application> before
|
---|
69 | installing, skip ahead to testing, then return here.</para>
|
---|
70 |
|
---|
71 | <para>Install <application>Berkeley DB</application> by running the
|
---|
72 | following commands:</para>
|
---|
73 |
|
---|
74 | <screen><userinput>cd build_unix &&
|
---|
75 | ../dist/configure --prefix=/usr \
|
---|
76 | --enable-compat185 \
|
---|
77 | --enable-cxx &&
|
---|
78 | make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread"</userinput></screen>
|
---|
79 |
|
---|
80 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
81 |
|
---|
82 | <screen role="root"><userinput>make docdir=/usr/share/doc/db-&db-version; install &&
|
---|
83 | chown root:root /usr/bin/db_* \
|
---|
84 | /usr/lib/libdb* /usr/include/db* &&
|
---|
85 | chown -R root:root /usr/share/doc/db-&db-version;</userinput></screen>
|
---|
86 |
|
---|
87 | </sect2>
|
---|
88 |
|
---|
89 | <sect2 role="testing">
|
---|
90 | <title>Testing Berkeley DB</title>
|
---|
91 |
|
---|
92 | <para>If you have already built <application>Berkeley DB</application>,
|
---|
93 | clean up with the following command:</para>
|
---|
94 |
|
---|
95 | <screen><userinput>make realclean</userinput></screen>
|
---|
96 |
|
---|
97 | <para>Build for the <application>Berkeley DB</application> test by running
|
---|
98 | the following commands:</para>
|
---|
99 |
|
---|
100 | <screen><userinput>cd build_unix &&
|
---|
101 | ../dist/configure --prefix=/usr \
|
---|
102 | --enable-test --enable-tcl --with-tcl=/usr/lib &&
|
---|
103 | make LIBSO_LIBS="-lpthread" LIBXSO_LIBS="-lpthread"</userinput></screen>
|
---|
104 |
|
---|
105 | <para>To test the results, start <command>tclsh</command> and issue the
|
---|
106 | following, replacing the 4 with the number of parallel processes you wish:</para>
|
---|
107 |
|
---|
108 | <screen><userinput>source ../test/test.tcl
|
---|
109 | run_parallel 4 run_std</userinput></screen>
|
---|
110 |
|
---|
111 | <para>Clean up with the following command:</para>
|
---|
112 |
|
---|
113 | <screen><userinput>make realclean</userinput></screen>
|
---|
114 |
|
---|
115 | </sect2>
|
---|
116 |
|
---|
117 | <sect2 role="commands">
|
---|
118 | <title>Command Explanations</title>
|
---|
119 |
|
---|
120 | <para><command>cd build_unix &&
|
---|
121 | ../dist/configure --prefix=/usr...</command>:
|
---|
122 | This replaces the normal <command>./configure</command> command, as
|
---|
123 | <application>Berkeley DB</application> comes with various
|
---|
124 | build directories for different platforms.</para>
|
---|
125 |
|
---|
126 | <para><parameter>--enable-compat185</parameter>: This switch enables
|
---|
127 | building DB 1.85 compatibility API.</para>
|
---|
128 |
|
---|
129 | <para><parameter>--enable-cxx</parameter>: This switch enables building
|
---|
130 | C++ API libraries.</para>
|
---|
131 |
|
---|
132 | <para><parameter>--enable-test</parameter>: Enables building the test suite
|
---|
133 | (requires the two Tcl switches below).</para>
|
---|
134 |
|
---|
135 | <para><parameter>--enable-tcl --with-tcl=/usr/lib</parameter>:
|
---|
136 | Enables <application>Tcl</application> support in DB and creates the
|
---|
137 | <filename class="libraryfile">libdb_tcl</filename> libraries.</para>
|
---|
138 |
|
---|
139 | <para><parameter>--enable-java</parameter>: Enables
|
---|
140 | <application>Java</application> support in DB and creates the
|
---|
141 | <filename class='libraryfile'>libdb_java</filename> libraries.</para>
|
---|
142 |
|
---|
143 | <para><parameter>--enable-rpc</parameter>: Enables building the
|
---|
144 | <application>Berkeley DB</application> RPC server.</para>
|
---|
145 |
|
---|
146 | <para><command>make LIBSO_LIBS="-lpthread"
|
---|
147 | LIBXSO_LIBS="-lpthread"</command>: <command>configure</command>
|
---|
148 | does not correctly handle NPTL. These variables force it to
|
---|
149 | properly link against NPTL.</para>
|
---|
150 |
|
---|
151 | <para><command>make docdir=/usr/share/doc/db-&db-version;
|
---|
152 | install</command>: This installs the documentation in
|
---|
153 | the correct place.</para>
|
---|
154 |
|
---|
155 | </sect2>
|
---|
156 |
|
---|
157 | <sect2 role="content">
|
---|
158 | <title>Contents</title>
|
---|
159 |
|
---|
160 | <segmentedlist>
|
---|
161 | <segtitle>Installed Programs</segtitle>
|
---|
162 | <segtitle>Installed Libraries</segtitle>
|
---|
163 | <segtitle>Installed Directory</segtitle>
|
---|
164 |
|
---|
165 | <seglistitem>
|
---|
166 | <seg>db_archive, db_checkpoint, db_deadlock, db_dump, db_load,
|
---|
167 | db_printlog, db_recover, db_stat, db_upgrade, db_verify and
|
---|
168 | berkeley_db_svc if enabled</seg>
|
---|
169 | <seg>libdb.[so,a], libdb_cxx.[so,a], libdb_java.[so,a] and
|
---|
170 | libdb_tcl.[so,a]</seg>
|
---|
171 | <seg>/usr/share/doc/db-&db-version;</seg>
|
---|
172 | </seglistitem>
|
---|
173 | </segmentedlist>
|
---|
174 |
|
---|
175 | <variablelist>
|
---|
176 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
177 | <?dbfo list-presentation="list"?>
|
---|
178 | <?dbhtml list-presentation="table"?>
|
---|
179 |
|
---|
180 | <varlistentry id="berkeley_db_svc">
|
---|
181 | <term><command>berkeley_db_svc</command></term>
|
---|
182 | <listitem>
|
---|
183 | <para>is the <application>Berkeley DB</application>
|
---|
184 | RPC server.</para>
|
---|
185 | <indexterm zone="db berkeley_db_svc">
|
---|
186 | <primary sortas="b-berkeley_db_svc">berkeley_db_svc</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 |
|
---|
191 | <varlistentry id="db_archive">
|
---|
192 | <term><command>db_archive</command></term>
|
---|
193 | <listitem>
|
---|
194 | <para>prints the pathnames of log files that are no longer in
|
---|
195 | use.</para>
|
---|
196 | <indexterm zone="db db_archive">
|
---|
197 | <primary sortas="b-db_archive">db_archive</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | <varlistentry id="db_checkpoint">
|
---|
203 | <term><command>db_checkpoint</command></term>
|
---|
204 | <listitem>
|
---|
205 | <para>is a daemon process used to monitor and checkpoint database
|
---|
206 | logs.</para>
|
---|
207 | <indexterm zone="db db_checkpoint">
|
---|
208 | <primary sortas="b-db_checkpoint">db_checkpoint</primary>
|
---|
209 | </indexterm>
|
---|
210 | </listitem>
|
---|
211 | </varlistentry>
|
---|
212 |
|
---|
213 | <varlistentry id="db_deadlock">
|
---|
214 | <term><command>db_deadlock</command></term>
|
---|
215 | <listitem>
|
---|
216 | <para>is used to abort lock requests when deadlocks are
|
---|
217 | detected.</para>
|
---|
218 | <indexterm zone="db db_deadlock">
|
---|
219 | <primary sortas="b-db_deadlock">db_deadlock</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | <varlistentry id="db_dump">
|
---|
225 | <term><command>db_dump</command></term>
|
---|
226 | <listitem>
|
---|
227 | <para>converts database files to a flat file format readable by
|
---|
228 | <command>db_load</command>.</para>
|
---|
229 | <indexterm zone="db db_dump">
|
---|
230 | <primary sortas="b-db_dump">db_dump</primary>
|
---|
231 | </indexterm>
|
---|
232 | </listitem>
|
---|
233 | </varlistentry>
|
---|
234 |
|
---|
235 | <varlistentry id="db_load">
|
---|
236 | <term><command>db_load</command></term>
|
---|
237 | <listitem>
|
---|
238 | <para>is used to create database files from flat files created with
|
---|
239 | <command>db_dump</command>.</para>
|
---|
240 | <indexterm zone="db db_load">
|
---|
241 | <primary sortas="b-db_load">db_load</primary>
|
---|
242 | </indexterm>
|
---|
243 | </listitem>
|
---|
244 | </varlistentry>
|
---|
245 |
|
---|
246 | <varlistentry id="db_printlog">
|
---|
247 | <term><command>db_printlog</command></term>
|
---|
248 | <listitem>
|
---|
249 | <para>converts database log files to human readable text.</para>
|
---|
250 | <indexterm zone="db db_printlog">
|
---|
251 | <primary sortas="b-db_printlog">db_printlog</primary>
|
---|
252 | </indexterm>
|
---|
253 | </listitem>
|
---|
254 | </varlistentry>
|
---|
255 |
|
---|
256 | <varlistentry id="db_recover">
|
---|
257 | <term><command>db_recover</command></term>
|
---|
258 | <listitem>
|
---|
259 | <para>is used to restore a database to a consistent state after a
|
---|
260 | failure.</para>
|
---|
261 | <indexterm zone="db db_recover">
|
---|
262 | <primary sortas="b-db_recover">db_recover</primary>
|
---|
263 | </indexterm>
|
---|
264 | </listitem>
|
---|
265 | </varlistentry>
|
---|
266 |
|
---|
267 | <varlistentry id="db_stat">
|
---|
268 | <term><command>db_stat</command></term>
|
---|
269 | <listitem>
|
---|
270 | <para>displays database environment statistics.</para>
|
---|
271 | <indexterm zone="db db_stat">
|
---|
272 | <primary sortas="b-db_stat">db_stat</primary>
|
---|
273 | </indexterm>
|
---|
274 | </listitem>
|
---|
275 | </varlistentry>
|
---|
276 |
|
---|
277 | <varlistentry id="db_upgrade">
|
---|
278 | <term><command>db_upgrade</command></term>
|
---|
279 | <listitem>
|
---|
280 | <para>is used to upgrade database files to a newer version of
|
---|
281 | <application>Berkeley DB</application>.</para>
|
---|
282 | <indexterm zone="db db_upgrade">
|
---|
283 | <primary sortas="b-db_upgrade">db_upgrade</primary>
|
---|
284 | </indexterm>
|
---|
285 | </listitem>
|
---|
286 | </varlistentry>
|
---|
287 |
|
---|
288 | <varlistentry id="db_verify">
|
---|
289 | <term><command>db_verify</command></term>
|
---|
290 | <listitem>
|
---|
291 | <para>is used to run consistency checks on database files.</para>
|
---|
292 | <indexterm zone="db db_verify">
|
---|
293 | <primary sortas="b-db_verify">db_verify</primary>
|
---|
294 | </indexterm>
|
---|
295 | </listitem>
|
---|
296 | </varlistentry>
|
---|
297 |
|
---|
298 | </variablelist>
|
---|
299 |
|
---|
300 | </sect2>
|
---|
301 |
|
---|
302 | </sect1>
|
---|