File: api.rst

package info (click to toggle)
fdb 5.20.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 89,268 kB
  • sloc: cpp: 40,830; python: 5,079; sh: 4,996; makefile: 32; ansic: 8
file content (62 lines) | stat: -rw-r--r-- 1,557 bytes parent folder | download
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

API
===========
The ``PyFDB`` API provides a Pythonic interface to the ``FDB``.
It is designed to give Python users direct access to core ``FDB`` concepts
such as databases, archives, keys, and retrieval operations, while preserving
the performance characteristics of the native implementation. The API closely
mirrors the ``FDB`` data model, making it familiar to existing ``FDB`` users and
straightforward to integrate into Python-based workflows. This section
documents the main classes and functions available in ``PyFDB`` and explains how
they map to the underlying ``FDB`` components.

FDB
---
.. autoapiclass:: pyfdb.pyfdb.FDB  
   :members:

FDB - Auxiliary Objects
-----------------------
.. autoapiclass:: pyfdb.pyfdb.URI 
   :members:

.. autoapiclass:: pyfdb.pyfdb.DataHandle 
   :members:

.. autoapiclass:: pyfdb.pyfdb.MarsSelection 
   :members:

.. autoapiclass:: pyfdb.pyfdb.SelectionMapper
   :members:

.. autoapiclass:: pyfdb.pyfdb.ControlAction 
   :members:

.. autoapiclass:: pyfdb.pyfdb.ControlIdentifier 
   :members:

FDB - Iterator Objects
----------------------
.. autoapiclass:: pyfdb.pyfdb.ControlElement
    :members:

.. autoapiclass:: pyfdb.pyfdb.IndexAxis
    :members:

.. autoapiclass:: pyfdb.pyfdb.ListElement
    :members:
   
.. autoapiclass:: pyfdb.pyfdb.MoveElement
    :members:

.. autoapiclass:: pyfdb.pyfdb.PurgeElement
    :members:
   
.. autoapiclass:: pyfdb.pyfdb.StatsElement
    :members:

.. autoapiclass:: pyfdb.pyfdb.StatusElement
    :members:

.. autoapiclass:: pyfdb.pyfdb.WipeElement
    :members: