-
Notifications
You must be signed in to change notification settings - Fork 26
/
index.html
217 lines (205 loc) · 13.3 KB
/
index.html
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
<!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>Welcome to FDB’s documentation! — FDB 1.4.9 documentation</title>
<link rel="stylesheet" href="_static/fdbtheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.4.9',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="FDB 1.4.9 documentation" href="#" />
<link rel="next" title="Getting Started with FDB" href="getting-started.html" />
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Neuton&subset=latin" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="http://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&subset=latin" type="text/css" media="screen" charset="utf-8" />
<!--[if lte IE 6]>
<link rel="stylesheet" href="_static/ie6.css" type="text/css" media="screen" charset="utf-8" />
<![endif]-->
</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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="getting-started.html" title="Getting Started with FDB"
accesskey="N">next</a> |</li>
<li><a href="#">FDB 1.4.9 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="welcome-to-fdb-s-documentation">
<h1>Welcome to FDB’s documentation!<a class="headerlink" href="#welcome-to-fdb-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>FDB is a <a class="reference external" href="http://python.org">Python</a> library package that
implements <cite>Python Database API 2.0</cite>-compliant support for the open source relational
database <a class="reference external" href="http://www.firebirdsql.org">Firebird®</a>.
In addition to the minimal feature set of the standard Python DB API,
FDB also exposes nearly the entire native client API of the database engine.</p>
<p>FDB is free – covered by a permissive BSD-style <a class="reference external" href="license.html">license</a> that both commercial and noncommercial users should
find agreeable.</p>
<p>This documentation set is not a tutorial on Python, SQL, or Firebird;
rather, it is a topical presentation of FDB’s feature set,
with example code to demonstrate basic usage patterns. For detailed
information about Firebird features, see the <a class="reference external" href="http://www.firebirdsql.org/index.php?op=doc">Firebird documentation</a>, and especially the excellent
<a class="reference external" href="http://www.ibphoenix.com/products/books/firebird_book">The Firebird Book</a>
written by Helen Borrie and published by APress.</p>
<div class="section" id="documentation-contents">
<h2>Documentation Contents:<a class="headerlink" href="#documentation-contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting-started.html">Getting Started with FDB</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting-started.html#quick-start-guide">Quick-start Guide</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage-guide.html">Usage Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#driver-structure">Driver structure</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#databases">Databases</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#executing-sql-statements">Executing SQL Statements</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#data-handling-and-conversions">Data handling and conversions</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#transanction-management">Transanction management</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#database-events">Database Events</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#working-with-services">Working with Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#working-with-database-schema">Working with database schema</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#working-with-user-privileges">Working with user privileges</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage-guide.html#working-with-monitoring-tables">Working with monitoring tables</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="python-db-api-compliance.html">Compliance to Python Database API 2.0</a><ul>
<li class="toctree-l2"><a class="reference internal" href="python-db-api-compliance.html#unsupported-optional-features">Unsupported Optional Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="python-db-api-compliance.html#supported-optional-features">Supported Optional Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="python-db-api-compliance.html#nominally-supported-optional-features">Nominally Supported Optional Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="python-db-api-compliance.html#extensions-and-caveats">Extensions and Caveats</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="differences-from-kdb.html">Differences from KInterbasDB</a><ul>
<li class="toctree-l2"><a class="reference internal" href="differences-from-kdb.html#no-need-for-initialization">No need for initialization</a></li>
<li class="toctree-l2"><a class="reference internal" href="differences-from-kdb.html#distributed-transactions">Distributed transactions</a></li>
<li class="toctree-l2"><a class="reference internal" href="differences-from-kdb.html#stream-blobs">Stream BLOBs</a></li>
<li class="toctree-l2"><a class="reference internal" href="differences-from-kdb.html#services-api">Services API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference.html">FDB Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-globals">Module globals</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#exceptions">Exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#functions">Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-fdb.fbcore">Internally used classes exposed to driver users</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-fdb.services">Services</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-fdb.schema">Database schema</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-fdb.monitor">Monitoring information</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#module-fdb.utils">Utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="reference.html#ctypes-interface-to-firebird-client-library">ctypes interface to Firebird client library</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-9">Version 1.4.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-8">Version 1.4.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-7">Version 1.4.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-6">Version 1.4.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-5">Version 1.4.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-4">Version 1.4.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-3">Version 1.4.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-2">Version 1.4.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4-1">Version 1.4.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-4">Version 1.4</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-3">Version 1.3</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-2">Version 1.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-1-1">Version 1.1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-1">Version 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-1-0">Version 1.0</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-9-9">Version 0.9.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-9-1">Version 0.9.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-9">Version 0.9</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-8-5">Version 0.8.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-8">Version 0.8</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-7-2">Version 0.7.2</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-7-1">Version 0.7.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="changelog.html#version-0-7">Version 0.7</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">LICENSE</a></li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to FDB’s documentation!</a><ul>
<li><a class="reference internal" href="#documentation-contents">Documentation Contents:</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="getting-started.html"
title="next chapter">Getting Started with FDB</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</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"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="getting-started.html" title="Getting Started with FDB"
>next</a> |</li>
<li><a href="#">FDB 1.4.9 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2009-2015, David Rushby, Pavel Cisar.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
</div>
</body>
</html>