libdb/docs/api_reference/CXX/dbget_partition_keys.html

147 lines
5.5 KiB
HTML
Raw Normal View History

2011-09-13 17:44:24 +00:00
<?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::get_partition_keys()</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="db.html" title="Chapter 2.  The Db Handle" />
<link rel="prev" href="dbget_partition_dirs.html" title="Db::get_partition_dirs()" />
<link rel="next" href="dbget_pagesize.html" title="Db::get_pagesize()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 11.2.5.2</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Db::get_partition_keys()</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbget_partition_dirs.html">Prev</a> </td>
<th width="60%" align="center">Chapter 2. 
The Db Handle
</th>
<td width="20%" align="right"> <a accesskey="n" href="dbget_pagesize.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="dbget_partition_keys"></a>Db::get_partition_keys()</h2>
</div>
</div>
</div>
<pre class="programlisting">#include &lt;db_cxx.h&gt;
int
Db::get_partition_keys(u_int32_t *partsp, DBT *keysp);</pre>
<p>
The <code class="methodname">Db::get_partition_keys()</code> method returns the partitioning information as
set by the <a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a> method.
</p>
<p>
The <code class="methodname">Db::get_partition_keys()</code> method may be called at any time during the life
of the application.
</p>
<p>
The <code class="methodname">Db::get_partition_keys()</code> <span>
<span>
method either returns a non-zero error value or throws an
exception that encapsulates a non-zero error value on
failure, and returns 0 on success.
</span>
</span>
</p>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3565508"></a>Parameters</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3566117"></a>partsp</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
The
<code class="methodname">Db::get_partition_keys()</code>
method returns number of partitions in the
<span class="bold"><strong>partsp</strong></span>
parameter.
</p>
</div>
<div class="sect3" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h4 class="title"><a id="id3565568"></a>keysp</h4>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
The <span class="bold"><strong>keysp</strong></span> parameter will be set to the array of partitioning keys.
</p>
</div>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3566047"></a>Class</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="link" href="db.html" title="Chapter 2.  The Db Handle">Db</a>
</p>
</div>
<div class="sect2" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
2011-12-20 00:07:10 +00:00
<h3 class="title"><a id="id3565716"></a>See Also</h3>
2011-09-13 17:44:24 +00:00
</div>
</div>
</div>
<p>
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>,
<a class="xref" href="dbset_partition.html" title="Db::set_partition()">Db::set_partition()</a>
</p>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbget_partition_dirs.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="dbget_pagesize.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Db::get_partition_dirs() </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> Db::get_pagesize()</td>
</tr>
</table>
</div>
</body>
</html>