xdapy.github.com/index.html at master · xdapy/xdapy.github.com · GitHub

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


<!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>xdapy &mdash; xdapy 0.9.0 documentation</title>

    <link rel="stylesheet" href="_static/haiku.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/print.css" type="text/css" />

    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.9.0',
        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>
    <script type="text/javascript" src="_static/theme_extras.js"></script>
    <link rel="top" title="xdapy 0.9.0 documentation" href="#" />
    <link rel="next" title="Introduction" href="intro.html" />
  </head>
  <body>
      <div class="header"><h1 class="heading"><a href="#">
          <span>xdapy 0.9.0 documentation</span></a></h1>
        <h2 class="heading"><span>xdapy</span></h2>
      </div>
      <div class="topnav">

        <p>
        <a class="uplink" href="#">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="intro.html">Introduction</a>&#160;&#160;»
        </p>

      </div>
      <div class="content">


  <div class="section" id="xdapy">
<h1>xdapy<a class="headerlink" href="#xdapy" title="Permalink to this headline">¶</a></h1>
<p>Xdapy is the intermediate layer between application and database.
On the one hand Xdapy knows about the database structure and where the database is located.
It manages a Python framework for object storage
&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8212;&#8211;</p>
<p>Fork on github: <a class="reference external" href="https://github.com/xdapy/xdapy">https://github.com/xdapy/xdapy</a></p>
<p>Contents:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#setup-step-1">Setup Step 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#basic-test">Basic Test</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#setup-step-2">Setup Step 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#test-with-postresql">Test with PostreSQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="install.html#setup-step-3">Setup Step 3</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="datamodel.html">Data Model</a><ul>
<li class="toctree-l2"><a class="reference internal" href="datamodel.html#zoo-example">Zoo example</a></li>
<li class="toctree-l2"><a class="reference internal" href="datamodel.html#science-example">Science example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#opening-a-connection">Opening a connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#define-and-create-an-object">Define and create an object</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#build-an-object-hierarchy">Build an object hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#attach-entities">Attach entities</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#adding-data">Adding data</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#load-objects-from-the-database">Load objects from the database</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#query-the-database">Query the database</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tables.html">Database Tables</a></li>
<li class="toctree-l1"><a class="reference internal" href="api/index.html">Python API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api/init.html">Init</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/connection.html">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/mapper.html">Mapper</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/data.html">Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/errors.html">Errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/io.html">I/O</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/operators.html">Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/parameters.html">Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/structures.html">Structures</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="io_formats.html">I/O formats</a><ul>
<li class="toctree-l2"><a class="reference internal" href="io_formats.html#xml">XML</a></li>
<li class="toctree-l2"><a class="reference internal" href="io_formats.html#json">JSON</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="migration.html#possible-issues">Possible issues</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="migration.html#rebranding-entities">Rebranding Entities</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Developer Information</a><ul>
<li class="toctree-l2"><a class="reference internal" href="development.html#publishing-the-documentation">Publishing the documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="development.html#commit-markers">Commit Markers</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<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 class="bottomnav">

        <p>
        <a class="uplink" href="#">Contents</a>
        &#160;&#160;::&#160;&#160;
        <a href="intro.html">Introduction</a>&#160;&#160;»
        </p>

      </div>

    <div class="footer">
        &copy; Copyright 2012, Hannah Dold, Rike-Benjamin Schuppner.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
    </div>
  </body>
</html>