• Home
  • History
  • Annotate
  • Line#
  • Navigate
  • Raw
  • Download
  • only in /asuswrt-rt-n18u-9.0.0.4.380.2695/release/src-rt/router/db-4.8.30/docs/java/com/sleepycat/db/
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0_03) on Mon Apr 12 16:25:45 EDT 2010 -->
6<TITLE>
7CompactConfig (Oracle - Berkeley DB Java API)
8</TITLE>
9
10<META NAME="date" CONTENT="2010-04-12">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="CompactConfig (Oracle - Berkeley DB Java API)";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CompactConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
48  </TR>
49</TABLE>
50</TD>
51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
52<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
53</TD>
54</TR>
55
56<TR>
57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
58&nbsp;<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../com/sleepycat/db/CompactStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../index.html?com/sleepycat/db/CompactConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="CompactConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<SCRIPT type="text/javascript">
64  <!--
65  if(window==top) {
66    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
67  }
68  //-->
69</SCRIPT>
70<NOSCRIPT>
71  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
72</NOSCRIPT>
73
74
75</FONT></TD>
76</TR>
77<TR>
78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
82</TR>
83</TABLE>
84<A NAME="skip-navbar_top"></A>
85<!-- ========= END OF TOP NAVBAR ========= -->
86
87<HR>
88<!-- ======== START OF CLASS DATA ======== -->
89<H2>
90<FONT SIZE="-1">
91com.sleepycat.db</FONT>
92<BR>
93Class CompactConfig</H2>
94<PRE>
95<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.CompactConfig</B>
97</PRE>
98<DL>
99<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD>
100</DL>
101<HR>
102<DL>
103<DT><PRE>public class <B>CompactConfig</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A><DT>implements <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL>
104</PRE>
105
106<P>
107Configuration for <A HREF="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)"><CODE>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</CODE></A> operations.
108<P>
109
110<P>
111<HR>
112
113<P>
114<!-- =========== FIELD SUMMARY =========== -->
115
116<A NAME="field_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
120<B>Field Summary</B></FONT></TH>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124<CODE>static&nbsp;<A HREF="../../../com/sleepycat/db/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</A></CODE></FONT></TD>
125<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#DEFAULT">DEFAULT</A></B></CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default configuration used if null is passed to methods that create a
129    cursor.</TD>
130</TR>
131</TABLE>
132&nbsp;
133<!-- ======== CONSTRUCTOR SUMMARY ======== -->
134
135<A NAME="constructor_summary"><!-- --></A>
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Constructor Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#CompactConfig()">CompactConfig</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct a default configuration object for compact operations.</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ========== METHOD SUMMARY =========== -->
150
151<A NAME="method_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
155<B>Method Summary</B></FONT></TH>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;int</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getFillPercent()">getFillPercent</A></B>()</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the the desired fill percentage.</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;boolean</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getFreeListOnly()">getFreeListOnly</A></B>()</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the whether to skip page compaction.</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;boolean</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getFreeSpace()">getFreeSpace</A></B>()</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return true if the whether to return pages to the filesystem.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;int</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getMaxPages()">getMaxPages</A></B>()</CODE>
185
186<BR>
187&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the the maximum number of pages to free.</TD>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
191<CODE>&nbsp;int</CODE></FONT></TD>
192<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getTimeout()">getTimeout</A></B>()</CODE>
193
194<BR>
195&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the the lock timeout set for implicit transactions, in microseconds.</TD>
196</TR>
197<TR BGCOLOR="white" CLASS="TableRowColor">
198<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
199<CODE>&nbsp;void</CODE></FONT></TD>
200<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#setFillPercent(int)">setFillPercent</A></B>(int&nbsp;fillpercent)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the desired fill percentage.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#setFreeListOnly(boolean)">setFreeListOnly</A></B>(boolean&nbsp;freeListOnly)</CODE>
209
210<BR>
211&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configure whether to skip page compaction, only returning pages
212    to the filesystem that are already free and at the end of the file.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#setFreeSpace(boolean)">setFreeSpace</A></B>(boolean&nbsp;freeSpace)</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return pages to the filesystem if possible.</TD>
221</TR>
222<TR BGCOLOR="white" CLASS="TableRowColor">
223<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224<CODE>&nbsp;void</CODE></FONT></TD>
225<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#setMaxPages(int)">setMaxPages</A></B>(int&nbsp;maxPages)</CODE>
226
227<BR>
228&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the maximum number of pages to free.</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;void</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#setTimeout(int)">setTimeout</A></B>(int&nbsp;timeout)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the lock timeout for implicit transactions.</TD>
237</TR>
238</TABLE>
239&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
240<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
241<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
242<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
246</TR>
247</TABLE>
248&nbsp;
249<P>
250
251<!-- ============ FIELD DETAIL =========== -->
252
253<A NAME="field_detail"><!-- --></A>
254<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
255<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
256<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
257<B>Field Detail</B></FONT></TH>
258</TR>
259</TABLE>
260
261<A NAME="DEFAULT"><!-- --></A><H3>
262DEFAULT</H3>
263<PRE>
264public static final <A HREF="../../../com/sleepycat/db/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</A> <B>DEFAULT</B></PRE>
265<DL>
266<DD>Default configuration used if null is passed to methods that create a
267    cursor.
268<P>
269<DL>
270</DL>
271</DL>
272
273<!-- ========= CONSTRUCTOR DETAIL ======== -->
274
275<A NAME="constructor_detail"><!-- --></A>
276<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
278<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
279<B>Constructor Detail</B></FONT></TH>
280</TR>
281</TABLE>
282
283<A NAME="CompactConfig()"><!-- --></A><H3>
284CompactConfig</H3>
285<PRE>
286public <B>CompactConfig</B>()</PRE>
287<DL>
288<DD>Construct a default configuration object for compact operations.
289<P>
290</DL>
291
292<!-- ============ METHOD DETAIL ========== -->
293
294<A NAME="method_detail"><!-- --></A>
295<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
297<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
298<B>Method Detail</B></FONT></TH>
299</TR>
300</TABLE>
301
302<A NAME="setFillPercent(int)"><!-- --></A><H3>
303setFillPercent</H3>
304<PRE>
305public void <B>setFillPercent</B>(int&nbsp;fillpercent)</PRE>
306<DL>
307<DD>Set the desired fill percentage.
308    If non-zero, the goal for filling pages, specified as a percentage
309    between 1 and 100.  Any page in a Btree or Recno databases not at or
310    above this percentage full will be considered for compaction.  The
311    default behavior is to consider every page for compaction, regardless
312    of its page fill percentage.
313<P>
314<DD><DL>
315</DL>
316</DD>
317<DD><DL>
318<DT><B>Parameters:</B><DD><CODE>fillpercent</CODE> - The desired fill percentage.</DL>
319</DD>
320</DL>
321<HR>
322
323<A NAME="getFillPercent()"><!-- --></A><H3>
324getFillPercent</H3>
325<PRE>
326public int <B>getFillPercent</B>()</PRE>
327<DL>
328<DD>Return the the desired fill percentage.
329<p>
330This method may be called at any time during the life of the application.
331<p>
332<P>
333<DD><DL>
334</DL>
335</DD>
336<DD><DL>
337
338<DT><B>Returns:</B><DD>The the desired fill percentage.</DL>
339</DD>
340</DL>
341<HR>
342
343<A NAME="setFreeListOnly(boolean)"><!-- --></A><H3>
344setFreeListOnly</H3>
345<PRE>
346public void <B>setFreeListOnly</B>(boolean&nbsp;freeListOnly)</PRE>
347<DL>
348<DD>Configure whether to skip page compaction, only returning pages
349    to the filesystem that are already free and at the end of the file.
350    This flag must be set if the database is a Hash access method database.
351<P>
352<DD><DL>
353</DL>
354</DD>
355<DD><DL>
356<DT><B>Parameters:</B><DD><CODE>freeListOnly</CODE> - Whether to skip page compaction</DL>
357</DD>
358</DL>
359<HR>
360
361<A NAME="getFreeListOnly()"><!-- --></A><H3>
362getFreeListOnly</H3>
363<PRE>
364public boolean <B>getFreeListOnly</B>()</PRE>
365<DL>
366<DD>Return true if the whether to skip page compaction.
367<p>
368This method may be called at any time during the life of the application.
369<p>
370<P>
371<DD><DL>
372</DL>
373</DD>
374<DD><DL>
375
376<DT><B>Returns:</B><DD>True if the whether to skip page compaction.</DL>
377</DD>
378</DL>
379<HR>
380
381<A NAME="setFreeSpace(boolean)"><!-- --></A><H3>
382setFreeSpace</H3>
383<PRE>
384public void <B>setFreeSpace</B>(boolean&nbsp;freeSpace)</PRE>
385<DL>
386<DD>Return pages to the filesystem if possible.  If this flag is not
387    specified, pages emptied as a result of compaction will be placed on the
388    free list for re-use, but not returned to the filesystem.
389    Note that only pages at the end of the file may be returned.  Given the one
390    pass nature of the algorithm if a page near the end of the file is
391    logically near the begining of the btree it will inhibit returning pages to
392    the file system.
393    A second call to the method with a low fillfactor can be used to return
394    pages in such a situation.
395<P>
396<DD><DL>
397</DL>
398</DD>
399<DD><DL>
400<DT><B>Parameters:</B><DD><CODE>freeSpace</CODE> - Whether to return pages to the filesystem</DL>
401</DD>
402</DL>
403<HR>
404
405<A NAME="getFreeSpace()"><!-- --></A><H3>
406getFreeSpace</H3>
407<PRE>
408public boolean <B>getFreeSpace</B>()</PRE>
409<DL>
410<DD>Return true if the whether to return pages to the filesystem.
411<p>
412This method may be called at any time during the life of the application.
413<p>
414<P>
415<DD><DL>
416</DL>
417</DD>
418<DD><DL>
419
420<DT><B>Returns:</B><DD>True if the whether to return pages to the filesystem.</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="setMaxPages(int)"><!-- --></A><H3>
426setMaxPages</H3>
427<PRE>
428public void <B>setMaxPages</B>(int&nbsp;maxPages)</PRE>
429<DL>
430<DD>Set the maximum number of pages to free.
431<P>
432<DD><DL>
433</DL>
434</DD>
435<DD><DL>
436<DT><B>Parameters:</B><DD><CODE>maxPages</CODE> - If non-zero, the call will return after that number of pages have been
437    freed.</DL>
438</DD>
439</DL>
440<HR>
441
442<A NAME="getMaxPages()"><!-- --></A><H3>
443getMaxPages</H3>
444<PRE>
445public int <B>getMaxPages</B>()</PRE>
446<DL>
447<DD>Return the the maximum number of pages to free.
448<p>
449This method may be called at any time during the life of the application.
450<p>
451<P>
452<DD><DL>
453</DL>
454</DD>
455<DD><DL>
456
457<DT><B>Returns:</B><DD>The the maximum number of pages to free.</DL>
458</DD>
459</DL>
460<HR>
461
462<A NAME="setTimeout(int)"><!-- --></A><H3>
463setTimeout</H3>
464<PRE>
465public void <B>setTimeout</B>(int&nbsp;timeout)</PRE>
466<DL>
467<DD>Set the lock timeout for implicit transactions.
468    If non-zero, and no transaction parameter was specified to
469    <A HREF="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)"><CODE>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</CODE></A>, the lock timeout set for implicit
470    transactions, in microseconds.
471<P>
472<DD><DL>
473</DL>
474</DD>
475<DD><DL>
476<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the lock timeout set for implicit transactions, in microseconds.</DL>
477</DD>
478</DL>
479<HR>
480
481<A NAME="getTimeout()"><!-- --></A><H3>
482getTimeout</H3>
483<PRE>
484public int <B>getTimeout</B>()</PRE>
485<DL>
486<DD>Return the the lock timeout set for implicit transactions, in microseconds.
487<p>
488This method may be called at any time during the life of the application.
489<p>
490<P>
491<DD><DL>
492</DL>
493</DD>
494<DD><DL>
495
496<DT><B>Returns:</B><DD>The the lock timeout set for implicit transactions, in microseconds.</DL>
497</DD>
498</DL>
499<!-- ========= END OF CLASS DATA ========= -->
500<HR>
501
502
503<!-- ======= START OF BOTTOM NAVBAR ====== -->
504<A NAME="navbar_bottom"><!-- --></A>
505<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
506<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
507<TR>
508<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
509<A NAME="navbar_bottom_firstrow"><!-- --></A>
510<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
511  <TR ALIGN="center" VALIGN="top">
512  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
513  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
514  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
515  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/CompactConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
516  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
517  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
518  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
519  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
520  </TR>
521</TABLE>
522</TD>
523<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
524<b>Berkeley DB</b><br><font size="-1"> version 4.8.30</font></EM>
525</TD>
526</TR>
527
528<TR>
529<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
530&nbsp;<A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>&nbsp;
531&nbsp;<A HREF="../../../com/sleepycat/db/CompactStats.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
532<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
533  <A HREF="../../../index.html?com/sleepycat/db/CompactConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;
534&nbsp;<A HREF="CompactConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
535&nbsp;<SCRIPT type="text/javascript">
536  <!--
537  if(window==top) {
538    document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
539  }
540  //-->
541</SCRIPT>
542<NOSCRIPT>
543  <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
544</NOSCRIPT>
545
546
547</FONT></TD>
548</TR>
549<TR>
550<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
551  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
552<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
553DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
554</TR>
555</TABLE>
556<A NAME="skip-navbar_bottom"></A>
557<!-- ======== END OF BOTTOM NAVBAR ======= -->
558
559<HR>
560<font size=1>Copyright (c) 1996-2009 Oracle.  All rights reserved.</font>
561</BODY>
562</HTML>
563