-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathgroup__wt__ext.html
242 lines (233 loc) · 18.7 KB
/
group__wt__ext.html
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
242
<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>WiredTiger: WiredTiger Extension API</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="wiredtiger.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><a href="http://wiredtiger.com/"><img alt="Logo" src="LogoFinal-header.png" alt="WiredTiger" /></a></td>
<td style="padding-left: 0.5em;">
<div id="projectname">
 <span id="projectnumber">Version 2.0.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="banner">
<a href="https://github.com/wiredtiger/wiredtiger">Fork me on GitHub</a>
<a class="last" href="http://groups.google.com/group/wiredtiger-users">Join my user group</a>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li><a href="community.html"><span>Community</span></a></li>
<li><a href="license.html"><span>License</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__wt__ext.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#define-members">Macros</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">WiredTiger Extension API</div> </div>
</div><!--header-->
<div class="contents">
<p>The functions and interfaces applications use to customize and extend the behavior of WiredTiger.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___c_o_l_l_a_t_o_r.html">WT_COLLATOR</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The interface implemented by applications to provide custom ordering of records. <a href="struct_w_t___c_o_l_l_a_t_o_r.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___c_o_m_p_r_e_s_s_o_r.html">WT_COMPRESSOR</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The interface implemented by applications to provide custom compression. <a href="struct_w_t___c_o_m_p_r_e_s_s_o_r.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___d_a_t_a___s_o_u_r_c_e.html">WT_DATA_SOURCE</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Applications can extend WiredTiger by providing new implementations of the <a class="el" href="struct_w_t___d_a_t_a___s_o_u_r_c_e.html" title="Applications can extend WiredTiger by providing new implementations of the WT_DATA_SOURCE class...">WT_DATA_SOURCE</a> class. <a href="struct_w_t___d_a_t_a___s_o_u_r_c_e.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___e_x_t_r_a_c_t_o_r.html">WT_EXTRACTOR</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The interface implemented by applications to provide custom extraction of index keys or column group values. <a href="struct_w_t___e_x_t_r_a_c_t_o_r.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct____wt__txn__notify.html">WT_TXN_NOTIFY</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Snapshot isolation level, returned by <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a52c99b55eb7e4459ebdc69d224f33b30" title="Return the current transaction's isolation level; returns one of WT_TXN_ISO_READ_COMMITTED, WT_TXN_ISO_READ_UNCOMMITTED, or WT_TXN_ISO_SNAPSHOT.">WT_EXTENSION_API::transaction_isolation_level</a>. <a href="struct____wt__txn__notify.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html">WT_EXTENSION_API</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Table of WiredTiger extension methods. <a href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_w_t___c_o_n_f_i_g___i_t_e_m.html">WT_CONFIG_ITEM</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The configuration information returned by the WiredTiger extension function <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a1f23ff3b17d86decfe92ba232f988fd6" title="Return the value of a configuration string.">WT_EXTENSION_API::config_get</a>. <a href="struct_w_t___c_o_n_f_i_g___i_t_e_m.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga84ae45d6803da8dab05bb72c2e69aa0f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga84ae45d6803da8dab05bb72c2e69aa0f"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga84ae45d6803da8dab05bb72c2e69aa0f">WT_TXN_ISO_READ_COMMITTED</a></td></tr>
<tr class="memdesc:ga84ae45d6803da8dab05bb72c2e69aa0f"><td class="mdescLeft"> </td><td class="mdescRight">Read-committed isolation level, returned by <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a52c99b55eb7e4459ebdc69d224f33b30" title="Return the current transaction's isolation level; returns one of WT_TXN_ISO_READ_COMMITTED, WT_TXN_ISO_READ_UNCOMMITTED, or WT_TXN_ISO_SNAPSHOT.">WT_EXTENSION_API::transaction_isolation_level</a>. <br/></td></tr>
<tr class="separator:ga84ae45d6803da8dab05bb72c2e69aa0f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga604e4478bcef2026786b0826e34f5262"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga604e4478bcef2026786b0826e34f5262"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga604e4478bcef2026786b0826e34f5262">WT_TXN_ISO_READ_UNCOMMITTED</a></td></tr>
<tr class="memdesc:ga604e4478bcef2026786b0826e34f5262"><td class="mdescLeft"> </td><td class="mdescRight">Read-uncommitted isolation level, returned by <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a52c99b55eb7e4459ebdc69d224f33b30" title="Return the current transaction's isolation level; returns one of WT_TXN_ISO_READ_COMMITTED, WT_TXN_ISO_READ_UNCOMMITTED, or WT_TXN_ISO_SNAPSHOT.">WT_EXTENSION_API::transaction_isolation_level</a>. <br/></td></tr>
<tr class="separator:ga604e4478bcef2026786b0826e34f5262"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga36207e3a80d960f7e0c822e8ab483014"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga36207e3a80d960f7e0c822e8ab483014"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga36207e3a80d960f7e0c822e8ab483014">WT_TXN_ISO_SNAPSHOT</a></td></tr>
<tr class="memdesc:ga36207e3a80d960f7e0c822e8ab483014"><td class="mdescLeft"> </td><td class="mdescRight">Snapshot isolation level, returned by <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a52c99b55eb7e4459ebdc69d224f33b30" title="Return the current transaction's isolation level; returns one of WT_TXN_ISO_READ_COMMITTED, WT_TXN_ISO_READ_UNCOMMITTED, or WT_TXN_ISO_SNAPSHOT.">WT_EXTENSION_API::transaction_isolation_level</a>. <br/></td></tr>
<tr class="separator:ga36207e3a80d960f7e0c822e8ab483014"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga6fa5797cf581d18dc843e07333a497e4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__wt__ext.html#ga6fa5797cf581d18dc843e07333a497e4">WT_CONFIG_ARG</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga6fa5797cf581d18dc843e07333a497e4">WT_CONFIG_ARG</a></td></tr>
<tr class="memdesc:ga6fa5797cf581d18dc843e07333a497e4"><td class="mdescLeft"> </td><td class="mdescRight">A configuration object passed to some extension interfaces. <a href="#ga6fa5797cf581d18dc843e07333a497e4">More...</a><br/></td></tr>
<tr class="separator:ga6fa5797cf581d18dc843e07333a497e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabfbec7a59e49e7c8f89b71e31748fa7a"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="group__wt__ext.html#gabfbec7a59e49e7c8f89b71e31748fa7a">WT_CONFIG_SCAN</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#gabfbec7a59e49e7c8f89b71e31748fa7a">WT_CONFIG_SCAN</a></td></tr>
<tr class="memdesc:gabfbec7a59e49e7c8f89b71e31748fa7a"><td class="mdescLeft"> </td><td class="mdescRight">A handle for a scan through a configuration string. <a href="#gabfbec7a59e49e7c8f89b71e31748fa7a">More...</a><br/></td></tr>
<tr class="separator:gabfbec7a59e49e7c8f89b71e31748fa7a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5ed14c916d5dcfe0e81aea9d9ccb7fe3"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga5ed14c916d5dcfe0e81aea9d9ccb7fe3">wiredtiger_extension_init</a> (<a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html">WT_CONNECTION</a> *connection, <a class="el" href="group__wt__ext.html#ga6fa5797cf581d18dc843e07333a497e4">WT_CONFIG_ARG</a> *config)</td></tr>
<tr class="memdesc:ga5ed14c916d5dcfe0e81aea9d9ccb7fe3"><td class="mdescLeft"> </td><td class="mdescRight">Entry point to an extension, called when the extension is loaded. <a href="#ga5ed14c916d5dcfe0e81aea9d9ccb7fe3">More...</a><br/></td></tr>
<tr class="separator:ga5ed14c916d5dcfe0e81aea9d9ccb7fe3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3b904ac0bedaa0d1d59d04baaf915f7f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__wt__ext.html#ga3b904ac0bedaa0d1d59d04baaf915f7f">wiredtiger_extension_terminate</a> (<a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html">WT_CONNECTION</a> *connection)</td></tr>
<tr class="memdesc:ga3b904ac0bedaa0d1d59d04baaf915f7f"><td class="mdescLeft"> </td><td class="mdescRight">Optional cleanup function for an extension, called during <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#af535c517df851eeac8ebf3594d40b545" title="Close a connection.">WT_CONNECTION::close</a>. <a href="#ga3b904ac0bedaa0d1d59d04baaf915f7f">More...</a><br/></td></tr>
<tr class="separator:ga3b904ac0bedaa0d1d59d04baaf915f7f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>The functions and interfaces applications use to customize and extend the behavior of WiredTiger. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga6fa5797cf581d18dc843e07333a497e4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__wt__ext.html#ga6fa5797cf581d18dc843e07333a497e4">WT_CONFIG_ARG</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A configuration object passed to some extension interfaces. </p>
<p>This is an opaque type: configuration values can be queried using <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a1f23ff3b17d86decfe92ba232f988fd6" title="Return the value of a configuration string.">WT_EXTENSION_API::config_get</a>. </p>
</div>
</div>
<a class="anchor" id="gabfbec7a59e49e7c8f89b71e31748fa7a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__wt__ext.html#gabfbec7a59e49e7c8f89b71e31748fa7a">WT_CONFIG_SCAN</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>A handle for a scan through a configuration string. </p>
<p>This is an opaque type returned by <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#ac071d945745773aea0cbb7d231f78206" title="Return the list entries of a configuration string value.">WT_EXTENSION_API::config_scan_begin</a>. Configuration values can be queried using <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a9a07710dc77a2771c83e0b42beda1a3e" title="Return the next key/value pair from a config string scan.">WT_EXTENSION_API::config_scan_next</a>. Call <a class="el" href="struct_w_t___e_x_t_e_n_s_i_o_n___a_p_i.html#a14b3e055d1e61781f0f6e784e3439cd7" title="Release any resources allocated by WT_EXTENSION_API::config_scan_begin.">WT_EXTENSION_API::config_scan_end</a> when finished to release resources. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga5ed14c916d5dcfe0e81aea9d9ccb7fe3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wiredtiger_extension_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html">WT_CONNECTION</a> * </td>
<td class="paramname"><em>connection</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__wt__ext.html#ga6fa5797cf581d18dc843e07333a497e4">WT_CONFIG_ARG</a> * </td>
<td class="paramname"><em>config</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Entry point to an extension, called when the extension is loaded. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connection</td><td>the connection handle </td></tr>
<tr><td class="paramname">config</td><td>the config information passed to <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#ab6a56facfd217e5ff687aa4c012e8d68" title="Load an extension.">WT_CONNECTION::load_extension</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
<a class="anchor" id="ga3b904ac0bedaa0d1d59d04baaf915f7f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int wiredtiger_extension_terminate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html">WT_CONNECTION</a> * </td>
<td class="paramname"><em>connection</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Optional cleanup function for an extension, called during <a class="el" href="struct_w_t___c_o_n_n_e_c_t_i_o_n.html#af535c517df851eeac8ebf3594d40b545" title="Close a connection.">WT_CONNECTION::close</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">connection</td><td>the connection handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>zero on success and a non-zero error code on failure. See <a class="el" href="group__wt.html#error_returns">Error Returns</a> for details. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Copyright (c) 2008-2013 WiredTiger, Inc. All rights reserved. Contact <a href="mailto:[email protected]">[email protected]</a> for more information.</li>
</ul>
</div>
</body>
</html>