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>Chapter 10. Db_base_iterator</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++ Standard Template Library API Reference" />
|
|
|
|
|
|
<link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
|
|
|
|
|
|
<link rel="prev" href="dbstl_iterators.html" title="Chapter 9. Dbstl Iterator Classes" />
|
|
|
|
|
|
<link rel="next" href="stldb_base_iteratorclose_cursor.html" title="close_cursor" />
|
|
|
|
|
|
</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">Chapter 10.
|
|
|
|
|
|
Db_base_iterator </th>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="20%" align="left"><a accesskey="p" href="dbstl_iterators.html">Prev</a> </td>
|
|
|
|
|
|
<th width="60%" align="center"> </th>
|
|
|
|
|
|
<td width="20%" align="right"> <a accesskey="n" href="stldb_base_iteratorclose_cursor.html">Next</a></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="chapter" lang="en" xml:lang="en">
|
|
|
|
|
|
<div class="titlepage">
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<h2 class="title"><a id="db_base_iterator"></a>Chapter 10.
|
|
|
|
|
|
Db_base_iterator </h2>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
2011-12-20 00:07:10 +00:00
|
|
|
|
<h4><a id="id3607657"></a> Public Members </h4>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
<div class="informaltable">
|
|
|
|
|
|
<table border="1" width="80%">
|
|
|
|
|
|
<colgroup>
|
|
|
|
|
|
<col />
|
|
|
|
|
|
<col />
|
|
|
|
|
|
</colgroup>
|
|
|
|
|
|
<thead>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<th>Member</th>
|
|
|
|
|
|
<th>Description</th>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</thead>
|
|
|
|
|
|
<tbody>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="db_base_iterator.html#stldb_base_iteratorrefresh" title="refresh">refresh</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Read data from underlying database via its cursor, and update its cached value. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratorclose_cursor.html" title="close_cursor">close_cursor</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Close its cursor. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratorset_bulk_buffer.html" title="set_bulk_buffer">
|
|
|
|
|
|
set_bulk_buffer
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Call this function to modify bulk buffer size. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratorget_bulk_bufsize.html" title="get_bulk_bufsize">get_bulk_bufsize</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Return current bulk buffer size. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratordb_base_iterator.html" title="db_base_iterator">
|
|
|
|
|
|
db_base_iterator
|
|
|
|
|
|
</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Default constructor. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratoroperator_assign.html" title="operator=">operator=</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Iterator assignment operator. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratordstr_db_base_iterator.html" title="~db_base_iterator">~db_base_iterator</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Destructor. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratorget_bulk_retrieval.html" title="get_bulk_retrieval">get_bulk_retrieval</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Get bulk buffer size. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratoris_rmw.html" title="is_rmw">is_rmw</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Get DB_RMW setting. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<a class="xref" href="stldb_base_iteratoris_directdb_get.html" title="is_directdb_get">is_directdb_get</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td>
|
|
|
|
|
|
<p>Get direct database get setting. </p> </td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</tbody>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</div>
|
2011-12-20 00:07:10 +00:00
|
|
|
|
<h4><a id="id3607638"></a>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
Group</h4>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<a class="xref" href="dbstl_iterators.html" title="Chapter 9. Dbstl Iterator Classes">
|
|
|
|
|
|
Dbstl Iterator Classes </a>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
<div class="sect1" lang="en" xml:lang="en">
|
|
|
|
|
|
<div class="titlepage">
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<h2 class="title" style="clear: both"><a id="stldb_base_iteratorrefresh"></a>refresh</h2>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|
|
|
|
|
<div class="titlepage">
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<h3 class="title"><a id="stldb_base_iteratorrefresh_details"></a>Function Details</h3>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<pre class="programlisting">
|
|
|
|
|
|
int refresh(bool from_db=true)
|
|
|
|
|
|
</pre>
|
|
|
|
|
|
<p>Read data from underlying database via its cursor, and update its cached value. </p>
|
|
|
|
|
|
<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="id3608142"></a>Parameters</h4>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="sect4" lang="en" xml:lang="en">
|
|
|
|
|
|
<div class="titlepage">
|
|
|
|
|
|
<div>
|
|
|
|
|
|
<div>
|
2011-12-20 00:07:10 +00:00
|
|
|
|
<h5 class="title"><a id="id3607896"></a>from_db </h5>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>Whether retrieve data from database rather than using the cached data in this iterator. </p>
|
|
|
|
|
|
</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="id3608213"></a>Return Value</h4>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>0 if succeeded. Otherwise an <a class="link" href="DbstlException.html" title="Chapter 30. DbstlException">DbstlException</a>
|
|
|
|
|
|
exception will be thrown. </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="id3608226"></a>Class</h3>
|
2011-09-13 17:44:24 +00:00
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<p>
|
|
|
|
|
|
<a class="link" href="db_base_iterator.html" title="Chapter 10. Db_base_iterator">db_base_iterator</a>
|
|
|
|
|
|
</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="navfooter">
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
<table width="100%" summary="Navigation footer">
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="40%" align="left"><a accesskey="p" href="dbstl_iterators.html">Prev</a> </td>
|
|
|
|
|
|
<td width="20%" align="center"> </td>
|
|
|
|
|
|
<td width="40%" align="right"> <a accesskey="n" href="stldb_base_iteratorclose_cursor.html">Next</a></td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
<tr>
|
|
|
|
|
|
<td width="40%" align="left" valign="top">Chapter 9.
|
|
|
|
|
|
Dbstl Iterator Classes </td>
|
|
|
|
|
|
<td width="20%" align="center">
|
|
|
|
|
|
<a accesskey="h" href="index.html">Home</a>
|
|
|
|
|
|
</td>
|
|
|
|
|
|
<td width="40%" align="right" valign="top"> close_cursor</td>
|
|
|
|
|
|
</tr>
|
|
|
|
|
|
</table>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</body>
|
|
|
|
|
|
</html>
|
