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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<?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>DbEnv::rep_set_view()</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="rep.html" title="Chapter 11. Replication Methods" />
<link rel="prev" href="reptransport.html" title="DbEnv::rep_set_transport()" />
<link rel="next" href="repstart.html" title="DbEnv::rep_start()" />
</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">DbEnv::rep_set_view()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="reptransport.html">Prev</a> </td>
<th width="60%" align="center">Chapter 11.
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="repstart.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="repset_view"></a>DbEnv::rep_set_view()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include <db_cxx.h>
int
DbEnv::rep_set_view(int (*partial_func)(DB_ENV *dbenv,
const char *name, int *result, u_int32_t flags));</pre>
<p>
The <code class="methodname">DbEnv::rep_set_view()</code> method specifies
that this environment is a replication view. A replication view is
a special type of client that can contain a full or partial copy of
the replicated data. A partial view uses a callback to determine
the subset of database files to replicate. A replication view does
not vote in elections, cannot become master, and cannot contribute
to transactional durability.
</p>
<p>
The <code class="methodname">DbEnv::rep_set_view()</code> method
configures operations performed using the specified
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a> handle, not all operations
performed on the underlying database environment.
</p>
<p>
The <code class="methodname">DbEnv::rep_set_view()</code> method must be
called prior to opening the environment. Also the method must be
called every time the environment is used after that point. Once
an environment is configured as a view, it stays that way for the
lifetime of the environment.
</p>
<p>
The <code class="methodname">DbEnv::rep_set_view()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
<p>
Berkeley DB is not re-entrant. The callback function for
this method should not attempt to make library calls (for
example, to release locks or close open handles).
Re-entering Berkeley DB is not guaranteed to work
correctly, and the results are undefined.
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4391480"></a>Parameters</h3>
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4385488"></a>partial_func</h4>
</div>
</div>
</div>
<p>
The <span class="bold"><strong>partial_func</strong></span>
callback function determines whether a particular
database file should be replicated to the local site. If
a NULL callback is specified, all database files will be
replicated. The parameters to
<span class="bold"><strong>partial_func</strong></span> are as follows:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<code class="literal">dbenv</code>
</p>
<p>
The <span class="bold"><strong>dbenv</strong></span>
parameter is the enclosing database environment
handle.
</p>
</li>
<li>
<p>
<code class="literal">name</code>
</p>
<p>
The <span class="bold"><strong>name</strong></span>
parameter is the physical on-disk file name of the
database. In-memory databases are always
replicated and do not invoke this callback.
</p>
</li>
<li>
<p>
<code class="literal">result</code>
</p>
<p>
The <span class="bold"><strong>result</strong></span> parameter is
an output parameter indicating whether the file should be
replicated. Set it to 0 to reject this file or to a
non-zero value to accept this file.
</p>
</li>
<li>
<p>
<code class="literal">flags</code>
</p>
<p>
The <span class="bold"><strong>flags</strong></span>
parameter is currently unused.
</p>
</li>
</ul>
</div>
<p>
The <span class="bold"><strong>partial</strong></span> function must
return 0 on success and non-zero on failure. If the
partial function fails, the environment will panic.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4361856"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DbEnv::rep_set_view()</code>
<span>
<span>
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
exception, encapsulating one of the following non-zero errors, or return one
of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp4392520"></a>EINVAL</h4>
</div>
</div>
</div>
<p>
The method was called after the environment was opened.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4401440"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="env.html" title="Chapter 5. The DbEnv Handle">DbEnv</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp4396992"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="reptransport.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="rep.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="repstart.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbEnv::rep_set_transport() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DbEnv::rep_start()</td>
</tr>
</table>
</div>
</body>
</html>
|
