/usr/include/xapian/dbfactory.h is in libxapian-dev 1.2.16-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 | /** \file dbfactory.h
* \brief Factory functions for constructing Database and WritableDatabase objects
*/
/* Copyright (C) 2005,2006,2007,2008,2009 Olly Betts
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
* USA
*/
#ifndef XAPIAN_INCLUDED_DBFACTORY_H
#define XAPIAN_INCLUDED_DBFACTORY_H
#include <string>
#include <xapian/types.h>
#include <xapian/version.h>
#include <xapian/visibility.h>
namespace Xapian {
class Database;
class WritableDatabase;
/// Database factory functions which determine the database type automatically.
namespace Auto {
/** Construct a Database object for a stub database file.
*
* The stub database file contains serialised parameters for one
* or more databases.
*
* @param file pathname of the stub database file.
*/
XAPIAN_VISIBILITY_DEFAULT
Database open_stub(const std::string &file);
/** Construct a WritableDatabase object for a stub database file.
*
* The stub database file must contain serialised parameters for exactly one
* database.
*
* @param file pathname of the stub database file.
* @param action determines handling of existing/non-existing database:
* - Xapian::DB_CREATE fail if database already exist,
* otherwise create new database.
* - Xapian::DB_CREATE_OR_OPEN open existing database, or create new
* database if none exists.
* - Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
* new database if none exists.
* - Xapian::DB_OPEN open existing database, failing if none
* exists.
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase open_stub(const std::string &file, int action);
}
#ifdef XAPIAN_HAS_INMEMORY_BACKEND
/// Database factory functions for the inmemory backend.
namespace InMemory {
/** Construct a WritableDatabase object for a new, empty InMemory database.
*
* Only a writable InMemory database can be created, since a read-only one
* would always remain empty.
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase open();
}
#endif
#ifdef XAPIAN_HAS_BRASS_BACKEND
/// Database factory functions for the brass backend.
namespace Brass {
/** Construct a Database object for read-only access to a Brass database.
*
* @param dir pathname of the directory containing the database.
*/
XAPIAN_VISIBILITY_DEFAULT
Database open(const std::string &dir);
/** Construct a Database object for update access to a Brass database.
*
* @param dir pathname of the directory containing the database.
* @param action determines handling of existing/non-existing database:
* - Xapian::DB_CREATE fail if database already exist,
* otherwise create new database.
* - Xapian::DB_CREATE_OR_OPEN open existing database, or create new
* database if none exists.
* - Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
* new database if none exists.
* - Xapian::DB_OPEN open existing database, failing if none
* exists.
* @param block_size the Btree blocksize to use (in bytes), which must be a
* power of two between 2048 and 65536 (inclusive). The
* default (also used if an invalid value if passed) is
* 8192 bytes. This parameter is ignored when opening an
* existing database.
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase
open(const std::string &dir, int action, int block_size = 8192);
}
#endif
#ifdef XAPIAN_HAS_CHERT_BACKEND
/// Database factory functions for the chert backend.
namespace Chert {
/** Construct a Database object for read-only access to a Chert database.
*
* @param dir pathname of the directory containing the database.
*/
XAPIAN_VISIBILITY_DEFAULT
Database open(const std::string &dir);
/** Construct a Database object for update access to a Chert database.
*
* @param dir pathname of the directory containing the database.
* @param action determines handling of existing/non-existing database:
* - Xapian::DB_CREATE fail if database already exist,
* otherwise create new database.
* - Xapian::DB_CREATE_OR_OPEN open existing database, or create new
* database if none exists.
* - Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
* new database if none exists.
* - Xapian::DB_OPEN open existing database, failing if none
* exists.
* @param block_size the Btree blocksize to use (in bytes), which must be a
* power of two between 2048 and 65536 (inclusive). The
* default (also used if an invalid value if passed) is
* 8192 bytes. This parameter is ignored when opening an
* existing database.
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase
open(const std::string &dir, int action, int block_size = 8192);
}
#endif
#ifdef XAPIAN_HAS_FLINT_BACKEND
/// Database factory functions for the flint backend.
namespace Flint {
/** Construct a Database object for read-only access to a Flint database.
*
* @param dir pathname of the directory containing the database.
*/
XAPIAN_VISIBILITY_DEFAULT
Database open(const std::string &dir);
/** Construct a Database object for update access to a Flint database.
*
* @param dir pathname of the directory containing the database.
* @param action determines handling of existing/non-existing database:
* - Xapian::DB_CREATE fail if database already exist,
* otherwise create new database.
* - Xapian::DB_CREATE_OR_OPEN open existing database, or create new
* database if none exists.
* - Xapian::DB_CREATE_OR_OVERWRITE overwrite existing database, or create
* new database if none exists.
* - Xapian::DB_OPEN open existing database, failing if none
* exists.
* @param block_size the Btree blocksize to use (in bytes), which must be a
* power of two between 2048 and 65536 (inclusive). The
* default (also used if an invalid value if passed) is
* 8192 bytes. This parameter is ignored when opening an
* existing database.
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase
open(const std::string &dir, int action, int block_size = 8192);
}
#endif
#ifdef XAPIAN_HAS_REMOTE_BACKEND
/// Database factory functions for the remote backend.
namespace Remote {
/** Construct a Database object for read-only access to a remote database
* accessed via a TCP connection.
*
* Access to the remote database is via a TCP connection to the specified
* host and port.
*
* @param host hostname to connect to.
* @param port port number to connect to.
* @param timeout timeout in milliseconds. If this timeout is exceeded
* for any individual operation on the remote database
* then Xapian::NetworkTimeoutError is thrown. A timeout
* of 0 means don't timeout. (Default is 10000ms, which
* is 10 seconds).
* @param connect_timeout timeout to use when connecting to the server.
* If this timeout is exceeded then
* Xapian::NetworkTimeoutError is thrown. A
* timeout of 0 means don't timeout. (Default is
* 10000ms, which is 10 seconds).
*/
XAPIAN_VISIBILITY_DEFAULT
Database open(const std::string &host, unsigned int port, Xapian::timeout timeout = 10000, Xapian::timeout connect_timeout = 10000);
/** Construct a WritableDatabase object for update access to a remote database
* accessed via a TCP connection.
*
* Access to the remote database is via a TCP connection to the specified
* host and port.
*
* @param host hostname to connect to.
* @param port port number to connect to.
* @param timeout timeout in milliseconds. If this timeout is exceeded
* for any individual operation on the remote database
* then Xapian::NetworkTimeoutError is thrown. (Default
* is 0, which means don't timeout).
* @param connect_timeout timeout to use when connecting to the server.
* If this timeout is exceeded then
* Xapian::NetworkTimeoutError is thrown. A
* timeout of 0 means don't timeout. (Default is
* 10000ms, which is 10 seconds).
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase open_writable(const std::string &host, unsigned int port, Xapian::timeout timeout = 0, Xapian::timeout connect_timeout = 10000);
/** Construct a Database object for read-only access to a remote database
* accessed via a program.
*
* Access to the remote database is done by running an external program and
* communicating with it on stdin/stdout.
*
* @param program the external program to run.
* @param args space-separated list of arguments to pass to program.
* @param timeout timeout in milliseconds. If this timeout is exceeded
* for any individual operation on the remote database
* then Xapian::NetworkTimeoutError is thrown. A timeout
* of 0 means don't timeout. (Default is 10000ms, which
* is 10 seconds).
*/
XAPIAN_VISIBILITY_DEFAULT
Database open(const std::string &program, const std::string &args, Xapian::timeout timeout = 10000);
/** Construct a WritableDatabase object for update access to a remote database
* accessed via a program.
*
* Access to the remote database is done by running an external program and
* communicating with it on stdin/stdout.
*
* @param program the external program to run.
* @param args space-separated list of arguments to pass to program.
* @param timeout timeout in milliseconds. If this timeout is exceeded
* for any individual operation on the remote database
* then Xapian::NetworkTimeoutError is thrown. (Default
* is 0, which means don't timeout).
*/
XAPIAN_VISIBILITY_DEFAULT
WritableDatabase open_writable(const std::string &program, const std::string &args, Xapian::timeout timeout = 0);
}
#endif
}
#endif /* XAPIAN_INCLUDED_DBFACTORY_H */
|