libdb/docs/api_reference/C/dbsite_remove.html
2012-11-14 16:35:20 -05:00

141 lines
5.1 KiB
HTML
Raw 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>DB_SITE-&gt;remove()</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C API Reference" />
<link rel="up" href="rep.html" title="Chapter 10.  Replication Methods" />
<link rel="prev" href="dbsite_get_eid.html" title="DB_SITE-&gt;get_eid()" />
<link rel="next" href="dbsite_set_config.html" title="DB_SITE-&gt;set_config()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.3</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">DB_SITE-&gt;remove()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbsite_get_eid.html">Prev</a> </td>
<th width="60%" align="center">Chapter 10. 
Replication Methods
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbsite_set_config.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="dbsite_remove"></a>DB_SITE-&gt;remove()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db.h&gt;
int
DB_SITE-&gt;remove(DB_SITE *site); </pre>
<p>
The <code class="methodname">DB_SITE-&gt;remove()</code> method removes the
site from the replication group. If called at the master site,
repmgr updates the membership database directly. If called from a
client, this method causes a request to be sent to the master to
perform the operation. The method then awaits confirmation.
</p>
<p>
The DB_SITE handle must not be accessed again after this
method is called, regardless of the return value.
</p>
<p>
The <code class="methodname">DB_SITE-&gt;remove()</code> <span>
<span>
method returns a non-zero error value on failure and 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61897464"></a>Errors</h3>
</div>
</div>
</div>
<p>
The <code class="methodname">DB_SITE-&gt;remove()</code> <span>
<span>
method may fail and return one of the following non-zero errors:
</span>
</span>
</p>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h4 class="title"><a id="idp61889392"></a>DB_REP_UNAVAIL</h4>
</div>
</div>
</div>
<p>
The master updated the database but did not receive enough
acknowledgements from clients sufficient to meet the
current ack policy or there was an attempt to remove the
current master site from the replication group.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61900088"></a>Class</h3>
</div>
</div>
</div>
<p>
<a class="link" href="db_site.html" title="The DB_SITE Handle">DB_SITE</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h3 class="title"><a id="idp61891488"></a>See Also</h3>
</div>
</div>
</div>
<p>
<a class="xref" href="rep.html#replist" title="Replication and Related Methods">Replication and Related Methods</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbsite_get_eid.html">Prev</a> </td>
<td width="20%" align="center">
<a accesskey="u" href="rep.html">Up</a>
</td>
<td width="40%" align="right"> <a accesskey="n" href="dbsite_set_config.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DB_SITE-&gt;get_eid() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> DB_SITE-&gt;set_config()</td>
</tr>
</table>
</div>
</body>
</html>