File: dbfactory_8h.html

package info (click to toggle)
xapian-core 1.4.29-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 22,840 kB
  • sloc: cpp: 92,356; ansic: 9,948; sh: 5,026; perl: 850; makefile: 509; javascript: 360; tcl: 319; python: 40
file content (113 lines) | stat: -rw-r--r-- 14,941 bytes parent folder | download
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
<!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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Xapian: API Documentation: xapian/dbfactory.h File 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
   &#160;<span id="projectnumber">1.4.29</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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="dir_f63502d618711192f85ccb772536c6ae.html">xapian</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">dbfactory.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Factory functions for constructing Database and WritableDatabase objects.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceXapian" id="r_namespaceXapian"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian.html">Xapian</a></td></tr>
<tr class="memdesc:namespaceXapian"><td class="mdescLeft">&#160;</td><td class="mdescRight">The <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> namespace contains public interfaces for the <a class="el" href="namespaceXapian.html" title="The Xapian namespace contains public interfaces for the Xapian library.">Xapian</a> library. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceXapian_1_1Auto" id="r_namespaceXapian_1_1Auto"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html">Xapian::Auto</a></td></tr>
<tr class="memdesc:namespaceXapian_1_1Auto"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceXapian_1_1InMemory" id="r_namespaceXapian_1_1InMemory"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1InMemory.html">Xapian::InMemory</a></td></tr>
<tr class="memdesc:namespaceXapian_1_1InMemory"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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 for the inmemory backend. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceXapian_1_1Chert" id="r_namespaceXapian_1_1Chert"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Chert.html">Xapian::Chert</a></td></tr>
<tr class="memdesc:namespaceXapian_1_1Chert"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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 for the chert backend. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceXapian_1_1Remote" id="r_namespaceXapian_1_1Remote"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html">Xapian::Remote</a></td></tr>
<tr class="memdesc:namespaceXapian_1_1Remote"><td class="mdescLeft">&#160;</td><td class="mdescRight"><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 for the remote backend. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a061dd41e3c877bf094251d25975fe3ee" id="r_a061dd41e3c877bf094251d25975fe3ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#a061dd41e3c877bf094251d25975fe3ee">Xapian::Auto::open_stub</a> (const std::string &amp;file)</td></tr>
<tr class="memdesc:a061dd41e3c877bf094251d25975fe3ee"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
<tr class="separator:a061dd41e3c877bf094251d25975fe3ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a299894005d7f0996d113d87da285ea8c" id="r_a299894005d7f0996d113d87da285ea8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Auto.html#a299894005d7f0996d113d87da285ea8c">Xapian::Auto::open_stub</a> (const std::string &amp;file, int action)</td></tr>
<tr class="memdesc:a299894005d7f0996d113d87da285ea8c"><td class="mdescLeft">&#160;</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.  <br /></td></tr>
<tr class="separator:a299894005d7f0996d113d87da285ea8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4b5fcea687b7b2eb81c5ecc58673d72" id="r_ab4b5fcea687b7b2eb81c5ecc58673d72"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1InMemory.html#ab4b5fcea687b7b2eb81c5ecc58673d72">Xapian::InMemory::open</a> ()</td></tr>
<tr class="memdesc:ab4b5fcea687b7b2eb81c5ecc58673d72"><td class="mdescLeft">&#160;</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 new, empty <a class="el" href="namespaceXapian_1_1InMemory.html" title="Database factory functions for the inmemory backend.">InMemory</a> database.  <br /></td></tr>
<tr class="separator:ab4b5fcea687b7b2eb81c5ecc58673d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad38a58329e60fcddf57e1c2ebf33696e" id="r_ad38a58329e60fcddf57e1c2ebf33696e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Chert.html#ad38a58329e60fcddf57e1c2ebf33696e">Xapian::Chert::open</a> (const std::string &amp;dir)</td></tr>
<tr class="memdesc:ad38a58329e60fcddf57e1c2ebf33696e"><td class="mdescLeft">&#160;</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 read-only access to a <a class="el" href="namespaceXapian_1_1Chert.html" title="Database factory functions for the chert backend.">Chert</a> database.  <br /></td></tr>
<tr class="separator:ad38a58329e60fcddf57e1c2ebf33696e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad328887e1b0e513dff7f50f62a645a40" id="r_ad328887e1b0e513dff7f50f62a645a40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Chert.html#ad328887e1b0e513dff7f50f62a645a40">Xapian::Chert::open</a> (const std::string &amp;dir, int action, int block_size=0)</td></tr>
<tr class="memdesc:ad328887e1b0e513dff7f50f62a645a40"><td class="mdescLeft">&#160;</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 update access to a <a class="el" href="namespaceXapian_1_1Chert.html" title="Database factory functions for the chert backend.">Chert</a> database.  <br /></td></tr>
<tr class="separator:ad328887e1b0e513dff7f50f62a645a40"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca6d4535825bbe637bc64b06ba6d0911" id="r_aca6d4535825bbe637bc64b06ba6d0911"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#aca6d4535825bbe637bc64b06ba6d0911">Xapian::Remote::open</a> (const std::string &amp;host, unsigned int port, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=10000, useconds_t connect_timeout=10000)</td></tr>
<tr class="memdesc:aca6d4535825bbe637bc64b06ba6d0911"><td class="mdescLeft">&#160;</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 read-only access to a remote database accessed via a TCP connection.  <br /></td></tr>
<tr class="separator:aca6d4535825bbe637bc64b06ba6d0911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84deed0508be12e092e63c0e5beb90d3" id="r_a84deed0508be12e092e63c0e5beb90d3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#a84deed0508be12e092e63c0e5beb90d3">Xapian::Remote::open_writable</a> (const std::string &amp;host, unsigned int port, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=0, useconds_t connect_timeout=10000, int flags=0)</td></tr>
<tr class="memdesc:a84deed0508be12e092e63c0e5beb90d3"><td class="mdescLeft">&#160;</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 update access to a remote database accessed via a TCP connection.  <br /></td></tr>
<tr class="separator:a84deed0508be12e092e63c0e5beb90d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11e2bf6e836693906f7137d6981f1d9d" id="r_a11e2bf6e836693906f7137d6981f1d9d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1Database.html">Database</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#a11e2bf6e836693906f7137d6981f1d9d">Xapian::Remote::open</a> (const std::string &amp;program, const std::string &amp;args, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=10000)</td></tr>
<tr class="memdesc:a11e2bf6e836693906f7137d6981f1d9d"><td class="mdescLeft">&#160;</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 read-only access to a remote database accessed via a program.  <br /></td></tr>
<tr class="separator:a11e2bf6e836693906f7137d6981f1d9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc7fd4a5c6b738dc83097347f0d760e9" id="r_adc7fd4a5c6b738dc83097347f0d760e9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classXapian_1_1WritableDatabase.html">WritableDatabase</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Remote.html#adc7fd4a5c6b738dc83097347f0d760e9">Xapian::Remote::open_writable</a> (const std::string &amp;program, const std::string &amp;args, useconds_t <a class="el" href="namespaceXapian.html#ada10bc23c3467246f078179fce2d762d">timeout</a>=0, int flags=0)</td></tr>
<tr class="memdesc:adc7fd4a5c6b738dc83097347f0d760e9"><td class="mdescLeft">&#160;</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 update access to a remote database accessed via a program.  <br /></td></tr>
<tr class="separator:adc7fd4a5c6b738dc83097347f0d760e9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Factory functions for constructing Database and WritableDatabase objects. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/">Doxygen 1.9.8</a>
</small></address>
</body>
</html>