File: env_set_lg_max.html

package info (click to toggle)
db4.4 4.4.20-8
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 39,948 kB
  • ctags: 26,257
  • sloc: ansic: 124,258; tcl: 46,590; java: 28,006; perl: 13,009; sh: 11,611; cpp: 9,192; makefile: 1,972; awk: 1,339; cs: 457; xml: 112; php: 22; asm: 14
file content (109 lines) | stat: -rw-r--r-- 5,052 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!--$Id: env_set_lg_max.so,v 10.45 2004/09/28 15:04:21 bostic Exp $-->
<!--Copyright 1997-2005 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<!--See the file LICENSE for redistribution information.-->
<html>
<head>
<title>Berkeley DB: DB_ENV-&gt;set_lg_max</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
<h3>DB_ENV-&gt;set_lg_max</h3>
</td>
<td align=right>
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a>
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
#include &lt;db.h&gt;
<p>
int
DB_ENV-&gt;set_lg_max(DB_ENV *dbenv, u_int32_t lg_max);
<p>
int
DB_ENV-&gt;get_lg_max(DB_ENV *dbenv, u_int32_t *lg_maxp);
</pre></h3>
<hr size=1 noshade>
<h3>Description: DB_ENV-&gt;set_lg_max</h3>
<p>Set the maximum size of a single file in the log, in bytes.  Because
<a href="../api_c/lsn_class.html">DB_LSN</a> file offsets are unsigned four-byte values, the set
value may not be larger than the maximum unsigned four-byte value.</p>
<p>When the logging subsystem is configured for on-disk logging, the
default size of a log file is 10MB.</p>
<p>When the logging subsystem is configured for in-memory logging, the
default size of a log file is 256KB.  In addition, the configured log
buffer size must be larger than the log file size.  (The logging
subsystem divides memory configured for in-memory log records into
"files", as database environments configured for in-memory log records
may exchange log records with other members of a replication group, and
those members may be configured to store log records on-disk.)  When
choosing log buffer and file sizes for in-memory logs, applications
should ensure the in-memory log buffer size is large enough that no
transaction will ever span the entire buffer, and avoid a state where
the in-memory buffer is full and no space can be freed because a
transaction that started in the first log "file" is still active.</p>
<p>See <a href="../ref/log/limits.html">Log File Limits</a> for more
information.</p>
<p>The database environment's log file size may also be configured using the
environment's <b>DB_CONFIG</b> file.  The syntax of the entry in that
file is a single line with the string "set_lg_max", one or more whitespace
characters, and the size in bytes.
Because the <b>DB_CONFIG</b> file is read when the database
environment is opened, it will silently overrule configuration done
before that time.</p>
<p>The DB_ENV-&gt;set_lg_max method configures a database environment, not only operations
performed using the specified <a href="../api_c/env_class.html">DB_ENV</a> handle.</p>
<p>The DB_ENV-&gt;set_lg_max method may be called at any time during the life of the
application.</p>
If no size is specified by the application, the size last specified for
the database region will be used, or if no database region previously
existed, the default will be used.
<p>The DB_ENV-&gt;set_lg_max method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>lg_max</b><dd>The <b>lg_max</b> parameter is the size of a single log file, in bytes.
</dl>
<h3>Errors</h3>
<p>The DB_ENV-&gt;set_lg_max method
may fail and return one of the following non-zero errors:</p>
<dl compact>
<dt>EINVAL<dd>If the method was called after <a href="../api_c/env_open.html">DB_ENV-&gt;open</a> was called;
the size of the log file is less than four times the size of the in-memory
log buffer;
The specified log file size was too large; or if an
invalid flag value or parameter was specified.
</dl>
<hr size=1 noshade>
<h3>Description: DB_ENV-&gt;get_lg_max</h3>
<p>The DB_ENV-&gt;get_lg_max method returns the maximum log file size.</p>
<p>The DB_ENV-&gt;get_lg_max method may be called at any time during the life of the
application.</p>
<p>The DB_ENV-&gt;get_lg_max method
returns a non-zero error value on failure
and 0 on success.
</p>
<h3>Parameters</h3>
<dl compact>
<dt><b>lg_maxp</b><dd>The DB_ENV-&gt;get_lg_max method returns  the
maximum log file size in <b>lg_maxp</b>.
</dl>
<hr size=1 noshade>
<h3>Class</h3>
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/logc_class.html">DB_LOGC</a>, <a href="../api_c/lsn_class.html">DB_LSN</a>
<h3>See Also</h3>
<a href="../api_c/log_list.html">Logging Subsystem and Related Methods</a>
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
</td></tr></table>
<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2005</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font>
</body>
</html>