summaryrefslogtreecommitdiff
path: root/docs/api_reference/C/envlog_get_config.html
blob: 2268e8474557eeb2b01db36172a4f8a781f2537e (plain)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>DB_ENV-&gt;log_get_config()</title>
    <link rel="stylesheet" href="apiReference.css" type="text/css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
    <link rel="start" href="index.html" title="Berkeley DB C API Reference" />
    <link rel="up" href="lsn.html" title="Chapter 7.  The DB_LSN Handle" />
    <link rel="prev" href="logflush.html" title="DB_ENV-&gt;log_flush()" />
    <link rel="next" href="logprintf.html" title="DB_ENV-&gt;log_printf()" />
  </head>
  <body>
    <div xmlns="" class="navheader">
      <div class="libver">
        <p>Library Version 12.1.6.1</p>
      </div>
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">DB_ENV-&gt;log_get_config()</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="logflush.html">Prev</a> </td>
          <th width="60%" align="center">Chapter 7. 
                The DB_LSN Handle
        </th>
          <td width="20%" align="right"> <a accesskey="n" href="logprintf.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="sect1" lang="en" xml:lang="en">
      <div class="titlepage">
        <div>
          <div>
            <h2 class="title" style="clear: both"><a id="envlog_get_config"></a>DB_ENV-&gt;log_get_config()</h2>
          </div>
        </div>
      </div>
      <pre class="programlisting">#include &lt;db.h&gt;

int
DB_ENV-&gt;log_get_config(DB_ENV *dbenv, u_int32_t which, int *onoffp);  </pre>
      <p>
         The <code class="methodname">DB_ENV-&gt;log_get_config()</code> method returns whether the specified
         <span class="bold"><strong>which</strong></span> parameter is currently set or
         not. You can manage this value using the
         <a class="xref" href="envlog_set_config.html" title="DB_ENV-&gt;log_set_config()">DB_ENV-&gt;log_set_config()</a>
         method.
    </p>
      <p>
         The <code class="methodname">DB_ENV-&gt;log_get_config()</code> method may be called at any time during
         the life of the application.
    </p>
      <p>
         The <code class="methodname">DB_ENV-&gt;log_get_config()</code> <span>
            <span>
                  method returns a non-zero error value on failure and 0 on success.
            </span>
            
        </span>
    </p>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp2529736"></a>Parameters</h3>
            </div>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp2507392"></a>which</h4>
              </div>
            </div>
          </div>
          <p>
                  The <span class="bold"><strong>which</strong></span> parameter is
                  the message value for which configuration is being
                  checked. Must be set to one of the following values:
             </p>
          <div class="itemizedlist">
            <ul type="disc">
              <li>
                <p><a id="log_get_config_DB_LOG_BLOB"></a>
                        <code class="literal">DB_LOG_BLOB</code>
                    </p>
                <p>
                        Enables full logging of 
                        <a class="link" href="blob.html" title="Chapter 13.  Binary Large Objects">BLOB</a> data.
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_DIRECT"></a>
                        <code class="literal">DB_LOG_DIRECT</code>
                    </p>
                <p>
                        System buffering is turned off for Berkeley DB log
                        files to avoid double caching.
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_DSYNC"></a>
                        <code class="literal">DB_LOG_DSYNC</code>
                    </p>
                <p>
                         Berkeley DB is configured to flush log writes to the backing disk before
                         returning from the write system call, rather than flushing log writes
                         explicitly in a separate system call, as necessary.  
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_AUTO_REMOVE"></a>
                        <code class="literal">DB_LOG_AUTO_REMOVE</code>
                    </p>
                <p>
                        Berkeley DB automatically removes log files that
                        are no longer needed.
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_IN_MEMORY"></a>
                          <code class="literal">DB_LOG_IN_MEMORY</code>
                    </p>
                <p>
                         Transaction logs are maintained in memory rather than on disk.  This
                         means that transactions exhibit the ACI (atomicity, consistency, and
                         isolation) properties, but not D (durability).
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_NOSYNC"></a>
                        <code class="literal">DB_LOG_NOSYNC</code>
                    </p>
                <p>
                        The transaction log is not flushed from from the operating system cache to
                        stable storage when the logging system switches log files or a durable
                        transaction commits.  This means that transactions exhibit the ACI
                        (atomicity, consistency, and isolation) properties, but only partially
                        support D (durability); that is, database integrity will be maintained if
                        the application fails and the environment is recovered, but not if the
                        system fails.  All database files must be verified and/or restored from a
                        replication group master or archival backup after system failure.
                    </p>
              </li>
              <li>
                <p><a id="log_get_config_DB_LOG_ZERO"></a>
                        <code class="literal">DB_LOG_ZERO</code>
                    </p>
                <p>
                         All pages of a log file are zeroed when that log file is created. 
                    </p>
              </li>
            </ul>
          </div>
        </div>
        <div class="sect3" lang="en" xml:lang="en">
          <div class="titlepage">
            <div>
              <div>
                <h4 class="title"><a id="idp2551832"></a>onoffp</h4>
              </div>
            </div>
          </div>
          <p>
                The <span class="bold"><strong>onoffp</strong></span> parameter
                references memory into which  the configuration of the
                specified <span class="bold"><strong>which</strong></span> parameter
                is copied.
            </p>
          <p>
                If the returned <span class="bold"><strong>onoff</strong></span>
                value is zero, the parameter is off; otherwise, on.
            </p>
        </div>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp2552048"></a>Class</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="link" href="env.html" title="Chapter 5.  The DB_ENV Handle">DB_ENV</a>  
        </p>
      </div>
      <div class="sect2" lang="en" xml:lang="en">
        <div class="titlepage">
          <div>
            <div>
              <h3 class="title"><a id="idp2553776"></a>See Also</h3>
            </div>
          </div>
        </div>
        <p>
            <a class="xref" href="lsn.html#loglist" title="Logging Subsystem and Related Methods">Logging Subsystem and Related Methods</a>, 
            <a class="xref" href="envlog_set_config.html" title="DB_ENV-&gt;log_set_config()">DB_ENV-&gt;log_set_config()</a>
        </p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="logflush.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="lsn.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="logprintf.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">DB_ENV-&gt;log_flush() </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> DB_ENV-&gt;log_printf()</td>
        </tr>
      </table>
    </div>
  </body>
</html>