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
|
<!--$Id: db_sync.so,v 10.20 2000/09/08 15:20:28 bostic Exp $-->
<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.-->
<!--All rights reserved.-->
<html>
<head>
<title>Berkeley DB: DB->sync</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
</head>
<body bgcolor=white>
<a name="2"><!--meow--></a>
<table><tr valign=top>
<td>
<h1>DB->sync</h1>
</td>
<td width="1%">
<a href="../api_c/c_index.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 <db.h>
<p>
int
DB->sync(DB *db, u_int32_t flags);
</pre></h3>
<h1>Description</h1>
<p>The DB->sync function flushes any cached information to disk.
<p>If the database is in memory only, the DB->sync function has no effect and
will always succeed.
<p>The <b>flags</b> parameter is currently unused, and must be set to 0.
<p>See <a href="../api_c/db_close.html">DB->close</a> for a discussion of Berkeley DB and cached data.
<p>The DB->sync function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if the underlying database still has
dirty pages in the cache. (The only reason to return
<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> is if another thread of control was writing pages
in the underlying database file at the same time as the
DB->sync function was being called. For this reason, a return of
<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> can normally be ignored, or, in cases where it is
a possible return value, there may be no reason to call
DB->sync.)
<h1>Errors</h1>
<p>The DB->sync function may fail and return a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
</dl>
<p>The DB->sync function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB->sync function may fail and return
<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail
in the same way.
<h1>See Also</h1>
<a href="../api_c/db_create.html">db_create</a>,
<a href="../api_c/db_close.html">DB->close</a>,
<a href="../api_c/db_cursor.html">DB->cursor</a>,
<a href="../api_c/db_del.html">DB->del</a>,
<a href="../api_c/db_err.html">DB->err</a>,
<a href="../api_c/db_fd.html">DB->fd</a>,
<a href="../api_c/db_get.html">DB->get</a>,
<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>,
<a href="../api_c/db_get_type.html">DB->get_type</a>,
<a href="../api_c/db_join.html">DB->join</a>,
<a href="../api_c/db_key_range.html">DB->key_range</a>,
<a href="../api_c/db_open.html">DB->open</a>,
<a href="../api_c/db_put.html">DB->put</a>,
<a href="../api_c/db_remove.html">DB->remove</a>,
<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>,
<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>,
<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>,
<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>,
<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>,
<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>,
<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>,
<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>,
<a href="../api_c/db_set_flags.html">DB->set_flags</a>,
<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>,
<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>,
<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>,
<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>,
<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>,
<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>,
<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>,
<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>,
<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>,
<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>,
<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>,
<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>,
<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>,
<a href="../api_c/db_stat.html">DB->stat</a>,
<a href="../api_c/db_sync.html">DB->sync</a>,
<a href="../api_c/db_upgrade.html">DB->upgrade</a>
and
<a href="../api_c/db_verify.html">DB->verify</a>.
</tt>
<table><tr><td><br></td><td width="1%">
<a href="../api_c/c_index.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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
</body>
</html>
|
