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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: Xapian::Auto Namespace Reference</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="doxygen.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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">xapian-core
 <span id="projectnumber">1.4.18</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceXapian.html">Xapian</a></li><li class="navelem"><a class="el" href="namespaceXapian_1_1Auto.html">Auto</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Xapian::Auto Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions which determine the database type automatically.
<a href="namespaceXapian_1_1Auto.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a061dd41e3c877bf094251d25975fe3ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#a061dd41e3c877bf094251d25975fe3ee">open_stub</a> (const std::string &file)</td></tr>
<tr class="memdesc:a061dd41e3c877bf094251d25975fe3ee"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for a stub database file. <a href="namespaceXapian_1_1Auto.html#a061dd41e3c877bf094251d25975fe3ee">More...</a><br /></td></tr>
<tr class="separator:a061dd41e3c877bf094251d25975fe3ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a299894005d7f0996d113d87da285ea8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#a299894005d7f0996d113d87da285ea8c">open_stub</a> (const std::string &file, int action)</td></tr>
<tr class="memdesc:a299894005d7f0996d113d87da285ea8c"><td class="mdescLeft"> </td><td class="mdescRight">Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for a stub database file. <a href="namespaceXapian_1_1Auto.html#a299894005d7f0996d113d87da285ea8c">More...</a><br /></td></tr>
<tr class="separator:a299894005d7f0996d113d87da285ea8c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> factory functions which determine the database type automatically. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a061dd41e3c877bf094251d25975fe3ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a061dd41e3c877bf094251d25975fe3ee">◆ </a></span>open_stub() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1Database.html">Database</a> Xapian::Auto::open_stub </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>file</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1Database.html" title="This class is used to access a database, or a group of databases.">Database</a> object for a stub database file. </p>
<p>The stub database file contains serialised parameters for one or more databases.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>pathname of the stub database file. </td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="namespaceXapian.html#a5299fb3122d20bcb29f697fdcb2fea22">Xapian::DB_BACKEND_STUB</a>.</p>
</div>
</div>
<a id="a299894005d7f0996d113d87da285ea8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a299894005d7f0996d113d87da285ea8c">◆ </a></span>open_stub() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a> Xapian::Auto::open_stub </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>action</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a <a class="el" href="classXapian_1_1WritableDatabase.html" title="This class provides read/write access to a database.">WritableDatabase</a> object for a stub database file. </p>
<p>The stub database file must contain serialised parameters for exactly one database.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>pathname of the stub database file. </td></tr>
<tr><td class="paramname">action</td><td>determines handling of existing/non-existing database:<ul>
<li><a class="el" href="namespaceXapian.html#a1236aaa6a3d7a37a4c6b95439e449f7a" title="Create a new database.">Xapian::DB_CREATE</a> fail if database already exist, otherwise create new database.</li>
<li><a class="el" href="namespaceXapian.html#a3d32111900603ce02b8c8467b9c5bacb" title="Create database if it doesn't already exist.">Xapian::DB_CREATE_OR_OPEN</a> open existing database, or create new database if none exists.</li>
<li><a class="el" href="namespaceXapian.html#afbc13e6712a12dcfd0c048242fc313ed" title="Create database if it doesn't already exist, or overwrite if it does.">Xapian::DB_CREATE_OR_OVERWRITE</a> overwrite existing database, or create new database if none exists.</li>
<li><a class="el" href="namespaceXapian.html#a54521467b649894bdc411f4c35e56ac3" title="Open an existing database.">Xapian::DB_OPEN</a> open existing database, failing if none exists. </li>
</ul>
</td></tr>
</table>
</dd>
</dl>
<p class="reference">References <a class="el" href="namespaceXapian.html#a5299fb3122d20bcb29f697fdcb2fea22">Xapian::DB_BACKEND_STUB</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.1</a>
</small></address>
</body>
</html>
|
