Files
cpython-source-deps/docs/gsg/CXX/CoreDBAdmin.html
2017-09-04 13:40:25 -05:00

148 lines
5.1 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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/html; charset=UTF-8" />
<title>Administrative Methods</title>
<link rel="stylesheet" href="gettingStarted.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.62.4" />
<link rel="home" href="index.html" title="Getting Started with Berkeley DB" />
<link rel="up" href="DB.html" title="Chapter 2. Databases" />
<link rel="previous" href="DBOpenFlags.html" title="Database Open Flags" />
<link rel="next" href="dbErrorReporting.html" title="Error Reporting Functions" />
</head>
<body>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Administrative Methods</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="DBOpenFlags.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. Databases</th>
<td width="20%" align="right"> <a accesskey="n" href="dbErrorReporting.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="CoreDBAdmin"></a>Administrative Methods</h2>
</div>
</div>
<div></div>
</div>
<p>
The following
<tt class="classname">Db</tt>
methods may be useful to you when managing DB databases:
</p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<tt class="methodname">Db::get_open_flags()</tt>
</p>
<p>
Returns the current open flags. It is an error to use this method on
an unopened database.
</p>
<a id="cxx_db5"></a>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
...
Db db(NULL, 0);
u_int32_t open_flags;
// Database open and subsequent operations omitted for clarity
db.get_open_flags(&amp;open_flags); </pre>
</li>
<li>
<p>
<tt class="methodname">Db::remove()</tt>
</p>
<p>
Removes the specified database. If no value is given for the
<i class="parameter"><tt>database</tt></i> parameter, then the entire file
referenced by this method is removed.
</p>
<p>
Never remove a database that has handles opened for it. Never remove a file that
contains databases with opened handles.
</p>
<a id="cxx_db6"></a>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
...
Db db(NULL, 0);
// Database handle creation omitted for clarity
db.remove("mydb.db", // Database file to remove
NULL, // Database to remove. This is
// NULL so the entire file is
// removed.
0); // Flags. None used.</pre>
</li>
<li>
<p>
<tt class="methodname">Db::rename()</tt>
</p>
<p>
Renames the specified database. If no value is given for the
<i class="parameter"><tt>database</tt></i> parameter, then the entire file
referenced by this method is renamed.
</p>
<p>
Never rename a database that has handles opened for it. Never rename a file that
contains databases with opened handles.
</p>
<a id="cxx_db7"></a>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
...
Db db(NULL, 0);
// Database handle creation omitted for clarity
db.rename("mydb.db", // Database file to rename
NULL, // Database to rename. This is
// NULL so the entire file is
// renamed.
"newdb.db", // New database file name
0); // Flags. None used.</pre>
</li>
</ul>
</div>
<span>
</span>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="DBOpenFlags.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="DB.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbErrorReporting.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Database Open Flags </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Error Reporting Functions</td>
</tr>
</table>
</div>
</body>
</html>