<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Xapian: API Documentation: xapian-core: Xapian::Quartz Namespace Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head> <body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.5.2 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li class="current"><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="classes.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="namespaces.html"><span>Namespace List</span></a></li> <li><a href="namespacemembers.html"><span>Namespace Members</span></a></li> </ul> </div> <div class="nav"> <a class="el" href="namespaceXapian.html">Xapian</a>::<a class="el" href="namespaceXapian_1_1Quartz.html">Quartz</a></div> <h1>Xapian::Quartz Namespace Reference</h1><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 quartz backend. <a href="#_details">More...</a> <p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap 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_1Quartz.html#ffaccda52f4e04a6813c3a1aa8cea619">open</a> (const std::string &dir)</td></tr> <tr><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 read-only access to a <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> database. <a href="#ffaccda52f4e04a6813c3a1aa8cea619"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceXapian_1_1Quartz.html#3e65fd27b47759db3f37241c5c04349c">WritableDatabaseopen</a> (const std::string &dir, int action, int block_size=8192)</td></tr> <tr><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 update access to a <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> database. <a href="#3e65fd27b47759db3f37241c5c04349c"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <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 quartz backend. <hr><h2>Function Documentation</h2> <a class="anchor" name="ffaccda52f4e04a6813c3a1aa8cea619"></a><!-- doxytag: member="Xapian::Quartz::open" ref="ffaccda52f4e04a6813c3a1aa8cea619" args="(const std::string &dir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classXapian_1_1Database.html">Database</a> Xapian::Quartz::open </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>dir</em> </td> <td> ) </td> <td width="100%"></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 read-only access to a <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> database. <p> The <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> backend is deprecated - use the <a class="el" href="namespaceXapian_1_1Flint.html" title="Database factory functions for the flint backend.">Flint</a> backend instead.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>dir</em> </td><td>pathname of the directory containing the database. </td></tr> </table> </dl> </div> </div><p> <a class="anchor" name="3e65fd27b47759db3f37241c5c04349c"></a><!-- doxytag: member="Xapian::Quartz::WritableDatabaseopen" ref="3e65fd27b47759db3f37241c5c04349c" args="(const std::string &dir, int action, int block_size=8192)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Xapian::Quartz::WritableDatabaseopen </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>dir</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 class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>block_size</em> = <code>8192</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td width="100%"></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 update access to a <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> database. <p> The <a class="el" href="namespaceXapian_1_1Quartz.html" title="Database factory functions for the quartz backend.">Quartz</a> backend is deprecated - use the <a class="el" href="namespaceXapian_1_1Flint.html" title="Database factory functions for the flint backend.">Flint</a> backend instead.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>dir</em> </td><td>pathname of the directory containing the database. </td></tr> <tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>determines handling of existing/non-existing database:<ul> <li><a class="el" href="namespaceXapian.html#d01f62a9f2bd0310f8bab1025b084dce" title="Create a new database; fail if db exists.">Xapian::DB_CREATE</a> fail if database already exist, otherwise create new database.</li><li><a class="el" href="namespaceXapian.html#03b7f9f4a58459ca435b11b563e58ad1" title="Open for read/write; create if no db exists.">Xapian::DB_CREATE_OR_OPEN</a> open existing database, or create new database if none exists.</li><li><a class="el" href="namespaceXapian.html#3c05f09a4d634681eebc456f0a6544ab" title="Overwrite existing db; create if none exists.">Xapian::DB_CREATE_OR_OVERWRITE</a> overwrite existing database, or create new database if none exists.</li><li><a class="el" href="namespaceXapian.html#ab6b9a465af84f701de4cb59dd9a4767" title="Open for read/write; fail if no db exists.">Xapian::DB_OPEN</a> open existing database, failing if none exists. </li></ul> </td></tr> <tr><td valign="top"></td><td valign="top"><em>block_size</em> </td><td>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. </td></tr> </table> </dl> </div> </div><p> <hr> <address><small> Documentation for Xapian (version 1.0.21).<br> Generated on 18 Jun 2010 by <a href="http://www.doxygen.org/">Doxygen 1.5.2</a>. </small></address> </body> </html>