python-bsddb3-doc 5.2.0-1build1 / usr / share / doc / python-bsddb3 / html / dbsequence.html

This file is indexed.

/usr/share/doc/python-bsddb3/html/dbsequence.html is in python-bsddb3-doc 5.2.0-1build1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
  "http://www.w3.org/TR/html4/loose.dtd">
<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>DBSequence &mdash; PyBSDDB Documentation</title>
    <link rel="stylesheet" href="static/default.css" type="text/css">
    <link rel="stylesheet" href="static/pygments.css" type="text/css">
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:   '',
        VERSION:    '5.2.0'
      };
    </script>
    <script type="text/javascript" src="static/jquery.js"></script>
    <script type="text/javascript" src="static/interface.js"></script>
    <script type="text/javascript" src="static/doctools.js"></script>
    <link rel="contents" title="Global table of contents" href="contents.html">
    <link rel="index" title="Global index" href="genindex.html">
    <link rel="search" title="Search" href="search.html">
    <link rel="top" title="PyBSDDB Documentation" href="index.html">
    <link rel="next" title="DBSite" href="dbsite.html">
    <link rel="prev" title="DBLock" href="dblock.html">
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
        <li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
          <li class="right"><a href="dbsite.html" title="DBSite" accesskey="N">next</a> |</li>
          <li class="right"><a href="dblock.html" title="DBLock" accesskey="P">previous</a> |</li>
        <li><a href="index.html">PyBSDDB v5.2.0 documentation</a> &raquo;</li>
      </ul>
    </div>

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  
  <div class="section">
<h1 id="dbsequence">DBSequence<a class="headerlink" href="#dbsequence" title="Permalink to this headline"></a></h1>
<p>Read <a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/programmer_reference/index.html">Oracle documentation</a>
for better understanding.</p>
<p>Sequences provide an arbitrary number of persistent objects that return
an increasing or decreasing sequence of integers. Opening a sequence
handle associates it with a record in a database. The handle can
maintain a cache of values from the database so that a database update
is not needed as the application allocates a value.</p>
<p><a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seq.html">More info...</a></p>
<div class="section">
<h2 id="dbsequence-methods">DBSequence Methods<a class="headerlink" href="#dbsequence-methods" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="DBSequence">
<!--#DBSequence#--><tt class="descname">DBSequence</tt><big>(</big><em>db</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#DBSequence" title="Permalink to this definition"></a></dt>
<dd>Constructor.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqcreate.html">More info...</a></dd></dl>

<dl class="function">
<dt id="open">
<!--#open#--><tt class="descname">open</tt><big>(</big><em>key</em>, <em>txn=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#open" title="Permalink to this definition"></a></dt>
<dd>Opens the sequence represented by the key.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqopen.html">More info...</a></dd></dl>

<dl class="function">
<dt id="close">
<!--#close#--><tt class="descname">close</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#close" title="Permalink to this definition"></a></dt>
<dd>Close a DBSequence handle.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqclose.html">More info...</a></dd></dl>

<dl class="function">
<dt id="initial_value">
<!--#initial_value#--><tt class="descname">initial_value</tt><big>(</big><em>value</em><big>)</big><a class="headerlink" href="#initial_value" title="Permalink to this definition"></a></dt>
<dd>Set the initial value for a sequence. This call is only effective
when the sequence is being created.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqinitial_value.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get">
<!--#get#--><tt class="descname">get</tt><big>(</big><em>delta=1</em>, <em>txn=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#get" title="Permalink to this definition"></a></dt>
<dd>Returns the next available element in the sequence and changes the
sequence value by delta.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get_dbp">
<!--#get_dbp#--><tt class="descname">get_dbp</tt><big>(</big><big>)</big><a class="headerlink" href="#get_dbp" title="Permalink to this definition"></a></dt>
<dd>Returns the DB object associated to the DBSequence.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget_dbp.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get_key">
<!--#get_key#--><tt class="descname">get_key</tt><big>(</big><big>)</big><a class="headerlink" href="#get_key" title="Permalink to this definition"></a></dt>
<dd>Returns the key for the sequence.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget_key.html">More info...</a></dd></dl>

<dl class="function">
<dt id="remove">
<!--#remove#--><tt class="descname">remove</tt><big>(</big><em>txn=None</em>, <em>flags=0</em><big>)</big><a class="headerlink" href="#remove" title="Permalink to this definition"></a></dt>
<dd>Removes the sequence from the database. This method should not be
called if there are other open handles on this sequence.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqremove.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get_cachesize">
<!--#get_cachesize#--><tt class="descname">get_cachesize</tt><big>(</big><big>)</big><a class="headerlink" href="#get_cachesize" title="Permalink to this definition"></a></dt>
<dd>Returns the current cache size.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget_cachesize.html">More info...</a></dd></dl>

<dl class="function">
<dt id="set_cachesize">
<!--#set_cachesize#--><tt class="descname">set_cachesize</tt><big>(</big><em>size</em><big>)</big><a class="headerlink" href="#set_cachesize" title="Permalink to this definition"></a></dt>
<dd>Configure the number of elements cached by a sequence handle.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqset_cachesize.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get_flags">
<!--#get_flags#--><tt class="descname">get_flags</tt><big>(</big><big>)</big><a class="headerlink" href="#get_flags" title="Permalink to this definition"></a></dt>
<dd>Returns the current flags.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget_flags.html">More info...</a></dd></dl>

<dl class="function">
<dt id="set_flags">
<!--#set_flags#--><tt class="descname">set_flags</tt><big>(</big><em>flags</em><big>)</big><a class="headerlink" href="#set_flags" title="Permalink to this definition"></a></dt>
<dd>Configure a sequence.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqset_flags.html">More info...</a></dd></dl>

<dl class="function">
<dt id="stat">
<!--#stat#--><tt class="descname">stat</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#stat" title="Permalink to this definition"></a></dt>
<dd><p>Returns a dictionary of sequence statistics with the following keys:</p>
<blockquote>
<table border="1" class="docutils">
<colgroup>
<col width="21%" />
<col width="79%" />
</colgroup>
<tbody valign="top">
<tr><td>wait</td>
<td>The number of times a thread of control was
forced to wait on the handle mutex.</td>
</tr>
<tr><td>nowait</td>
<td>The number of times that a thread
of control was able to obtain handle mutex
without waiting.</td>
</tr>
<tr><td>current</td>
<td>The current value of the sequence
in the database.</td>
</tr>
<tr><td>value</td>
<td>The current cached value of the sequence.</td>
</tr>
<tr><td>last_value</td>
<td>The last cached value of the sequence.</td>
</tr>
<tr><td>min</td>
<td>The minimum permitted value of the sequence.</td>
</tr>
<tr><td>max</td>
<td>The maximum permitted value of the sequence.</td>
</tr>
<tr><td>cache_size</td>
<td>The number of values that will be cached in
this handle.</td>
</tr>
<tr><td>flags</td>
<td>The flags value for the sequence.</td>
</tr>
</tbody>
</table>
</blockquote>
<p><a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqstat.html">More info...</a></p>
</dd></dl>

<dl class="function">
<dt id="stat_print">
<!--#stat_print#--><tt class="descname">stat_print</tt><big>(</big><em>flags=0</em><big>)</big><a class="headerlink" href="#stat_print" title="Permalink to this definition"></a></dt>
<dd>Prints diagnostic information.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqstat_print.html">More info...</a></dd></dl>

<dl class="function">
<dt id="get_range">
<!--#get_range#--><tt class="descname">get_range</tt><big>(</big><big>)</big><a class="headerlink" href="#get_range" title="Permalink to this definition"></a></dt>
<dd>Returns a tuple representing the range of values in the sequence.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqget_range.html">More info...</a></dd></dl>

<dl class="function">
<dt id="set_range">
<!--#set_range#--><tt class="descname">set_range</tt><big>(</big><em>(min</em>, <em>max)</em><big>)</big><a class="headerlink" href="#set_range" title="Permalink to this definition"></a></dt>
<dd>Configure a sequence range.
<a class="reference" href="http://download.oracle.com/docs/cd/E17076_02/html/api_reference/C/seqset_range.html">More info...</a></dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sidebar">
        <div class="sidebarwrapper">
          
            <h3>Table Of Contents</h3>
            <ul>
<li><a class="reference" href="">DBSequence</a><ul>
<li><a class="reference" href="#dbsequence-methods">DBSequence Methods</a></li>
</ul>
</li>
</ul>

          
            <h4>Previous topic</h4>
            <p class="topless"><a href="dblock.html" title="previous chapter">DBLock</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="dbsite.html" title="next chapter">DBSite</a></p>
          
          
          
        </div>
      </div>
      <div class="clearer"></div>
    </div>

    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px"><a href="genindex.html" title="General Index" accesskey="I">index</a></li>
        <li class="right"><a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
          <li class="right"><a href="dbsite.html" title="DBSite" accesskey="N">next</a> |</li>
          <li class="right"><a href="dblock.html" title="DBLock" accesskey="P">previous</a> |</li>
        <li><a href="index.html">PyBSDDB v5.2.0 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2008-2011 Jesus Cea Avion.
      Last updated on Jul 12, 2011.
    </div>
  </body>
</html>

APT Browse - Built by Thomas Orozco.