← Back to branch summary

~ubuntu-branches/debian/sid/sqlalchemy/sid

« back to all changes in this revision

Viewing changes to doc/orm/extensions/automap.html

  • Committer: Package Import Robot
  • Author(s): Piotr Ożarowski
  • Date: 2014-06-27 20:17:13 UTC
  • mfrom: (1.4.28)
  • Revision ID: package-import@ubuntu.com-20140627201713-g6p1kq8q1qenztrv
Tags: 0.9.6-1
http://bugs.debian.org/747852
http://bugs.debian.org/752145
* New upstream release
* Remove Python 3.X build tag files, thanks to Matthias Urlichs for the
  patch (closes: #747852)
* python-fdb isn't in the Debian archive yet so default dialect for firebird://
  URLs is changed to obsolete kinterbasdb, thanks to Russell Stuart for the
  patch (closes: #752145)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/orm/extensions/automap.html
32
32
    <script type="text/javascript">
33
33
      var DOCUMENTATION_OPTIONS = {
34
34
          URL_ROOT:    '../../',
35
 
          VERSION:     '0.9.4',
 
35
          VERSION:     '0.9.6',
36
36
          COLLAPSE_MODINDEX: false,
37
37
          FILE_SUFFIX: '.html'
38
38
      };
44
44
        <script type="text/javascript" src="../../_static/doctools.js"></script>
45
45
    <!-- end iterate through sphinx environment script_files -->
46
46
 
 
47
    <script type="text/javascript" src="../../_static/detectmobile.js"></script>
47
48
    <script type="text/javascript" src="../../_static/init.js"></script>
48
49
    <link rel="index" title="Index" href="../../genindex.html" />
49
50
    <link rel="search" title="Search" href="../../search.html" />
50
51
        <link rel="copyright" title="Copyright" href="../../copyright.html" />
51
52
    <link rel="top" title="SQLAlchemy 0.9 Documentation" href="../../index.html" />
 
53
        <link rel="up" title="ORM Extensions" href="index.html" />
 
54
        <link rel="next" title="Declarative" href="declarative.html" />
 
55
        <link rel="prev" title="Association Proxy" href="associationproxy.html" />
52
56
    <!-- end layout.mako headers -->
53
57
 
54
58
 
66
70
 
67
71
 
68
72
 
 
73
 
69
74
<div id="docs-container">
70
75
 
71
76
 
72
77
 
73
78
 
 
79
 
 
80
<div id="docs-top-navigation-container" class="body-background">
74
81
<div id="docs-header">
 
82
    <div id="docs-version-header">
 
83
        Release: <span class="version-num">0.9.6</span> | Release Date: June 23, 2014
 
84
    </div>
 
85
 
75
86
    <h1>SQLAlchemy 0.9 Documentation</h1>
76
87
 
77
 
    <div id="docs-search">
78
 
    Search:
79
 
    <form class="search" action="../../search.html" method="get">
80
 
      <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
81
 
      <input type="hidden" name="check_keywords" value="yes" />
82
 
      <input type="hidden" name="area" value="default" />
83
 
    </form>
84
 
    </div>
85
 
 
86
 
    <div id="docs-version-header">
87
 
        Release: <span class="version-num">0.9.4</span> | Release Date: March 28, 2014
88
 
 
89
 
 
90
 
    </div>
91
 
 
92
 
</div>
93
 
 
94
 
<div id="docs-top-navigation">
95
 
    <div id="docs-top-page-control" class="docs-navigation-links">
 
88
</div>
 
89
</div>
 
90
 
 
91
<div id="docs-body-container">
 
92
 
 
93
    <div id="fixed-sidebar" class="withsidebar">
 
94
 
 
95
 
 
96
        <div id="docs-sidebar-popout">
 
97
            <h3><a href="../../index.html">SQLAlchemy 0.9 Documentation</a></h3>
 
98
 
 
99
            <p id="sidebar-paginate">
 
100
                    <a href="index.html" title="ORM Extensions">Up</a> |
 
101
 
 
102
                    <a href="associationproxy.html" title="Association Proxy">Prev</a> |
 
103
                    <a href="declarative.html" title="Declarative">Next</a>
 
104
            </p>
 
105
 
 
106
            <p id="sidebar-topnav">
 
107
                <a href="../../index.html">Contents</a> |
 
108
                <a href="../../genindex.html">Index</a>
 
109
            </p>
 
110
 
 
111
            <div id="sidebar-search">
 
112
                <form class="search" action="../../search.html" method="get">
 
113
                  <input type="text" name="q" size="12" /> <input type="submit" value="Search" />
 
114
                  <input type="hidden" name="check_keywords" value="yes" />
 
115
                  <input type="hidden" name="area" value="default" />
 
116
                </form>
 
117
            </div>
 
118
 
 
119
        </div>
 
120
 
 
121
        <div id="docs-sidebar">
 
122
 
 
123
        <h3><a href="#">            
 
124
                Automap
 
125
            
 
126
        </a></h3>
96
127
        <ul>
97
 
 
98
 
        <li>
99
 
            <a href="../../contents.html">Table of Contents</a> |
100
 
            <a href="../../genindex.html">Index</a>
101
 
            | <a href="../../_sources/orm/extensions/automap.txt">view source
102
 
        </li>
103
 
        </ul>
104
 
    </div>
105
 
 
106
 
    <div id="docs-navigation-banner">
107
 
        <a href="../../index.html">SQLAlchemy 0.9 Documentation</a>
108
 
        » 
109
 
                Automap
110
 
            
111
 
 
112
 
        <h2>
113
 
            
114
 
                Automap
115
 
            
116
 
        </h2>
117
 
    </div>
118
 
 
119
 
</div>
120
 
 
121
 
<div id="docs-body-container">
122
 
 
123
 
    <div id="docs-sidebar">
124
 
    <h3><a href="../../index.html">Table of Contents</a></h3>
125
 
    <ul>
126
128
<li><a class="reference internal" href="#">Automap</a><ul>
127
129
<li><a class="reference internal" href="#basic-use">Basic Use</a></li>
128
130
<li><a class="reference internal" href="#generating-mappings-from-an-existing-metadata">Generating Mappings from an Existing MetaData</a></li>
143
145
 
144
146
 
145
147
 
146
 
    <h4>Quick Search</h4>
147
 
    <p>
148
 
    <form class="search" action="../../search.html" method="get">
149
 
      <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
150
 
      <input type="hidden" name="check_keywords" value="yes" />
151
 
      <input type="hidden" name="area" value="default" />
152
 
    </form>
153
 
    </p>
 
148
        </div>
154
149
 
155
150
    </div>
156
151
 
 
152
    
 
153
 
157
154
    <div id="docs-body" class="withsidebar" >
158
155
        
159
156
<div class="section" id="module-sqlalchemy.ext.automap">
373
370
<li>From each <a class="reference internal" href="../../core/constraints.html#sqlalchemy.schema.ForeignKeyConstraint" title="sqlalchemy.schema.ForeignKeyConstraint"><tt class="xref py py-class docutils literal"><span class="pre">ForeignKeyConstraint</span></tt></a>, the remote <a class="reference internal" href="../../core/metadata.html#sqlalchemy.schema.Table" title="sqlalchemy.schema.Table"><tt class="xref py py-class docutils literal"><span class="pre">Table</span></tt></a>
374
371
object present is matched up to the class to which it is to be mapped,
375
372
if any, else it is skipped.</li>
376
 
<li>As the <a class="reference internal" href="../../core/constraints.html#sqlalchemy.schema.ForeignKeyConstraint" title="sqlalchemy.schema.ForeignKeyConstraint"><tt class="xref py py-class docutils literal"><span class="pre">ForeignKeyConstraint</span></tt></a> we are examining correponds to a reference
 
373
<li>As the <a class="reference internal" href="../../core/constraints.html#sqlalchemy.schema.ForeignKeyConstraint" title="sqlalchemy.schema.ForeignKeyConstraint"><tt class="xref py py-class docutils literal"><span class="pre">ForeignKeyConstraint</span></tt></a> we are examining corresponds to a reference
377
374
from the immediate mapped class,
378
375
the relationship will be set up as a many-to-one referring to the referred class;
379
376
a corresponding one-to-many backref will be created on the referred class referring
611
608
 
612
609
<dl class="classmethod">
613
610
<dt id="sqlalchemy.ext.automap.AutomapBase.prepare">
614
 
<em class="property">classmethod </em><tt class="descname">prepare</tt><big>(</big><em>engine=None</em>, <em>reflect=False</em>, <em>classname_for_table=&lt;function classname_for_table at 0x10fbac398&gt;</em>, <em>collection_class=&lt;type 'list'&gt;</em>, <em>name_for_scalar_relationship=&lt;function name_for_scalar_relationship at 0x10fbac758&gt;</em>, <em>name_for_collection_relationship=&lt;function name_for_collection_relationship at 0x10fbac7d0&gt;</em>, <em>generate_relationship=&lt;function generate_relationship at 0x10fbac848&gt;</em><big>)</big><a class="headerlink" href="#sqlalchemy.ext.automap.AutomapBase.prepare" title="Permalink to this definition">¶</a></dt>
 
611
<em class="property">classmethod </em><tt class="descname">prepare</tt><big>(</big><em>engine=None</em>, <em>reflect=False</em>, <em>classname_for_table=&lt;function classname_for_table at 0x1103f9320&gt;</em>, <em>collection_class=&lt;type 'list'&gt;</em>, <em>name_for_scalar_relationship=&lt;function name_for_scalar_relationship at 0x1103f96e0&gt;</em>, <em>name_for_collection_relationship=&lt;function name_for_collection_relationship at 0x1103f9758&gt;</em>, <em>generate_relationship=&lt;function generate_relationship at 0x1103f97d0&gt;</em><big>)</big><a class="headerlink" href="#sqlalchemy.ext.automap.AutomapBase.prepare" title="Permalink to this definition">¶</a></dt>
615
612
<dd><p>Extract mapped classes and relationships from the <a class="reference internal" href="../../core/metadata.html#sqlalchemy.schema.MetaData" title="sqlalchemy.schema.MetaData"><tt class="xref py py-class docutils literal"><span class="pre">MetaData</span></tt></a> and
616
613
perform mappings.</p>
617
614
<table class="docutils field-list" frame="void" rules="none">
806
803
</div>
807
804
 
808
805
<div id="docs-bottom-navigation" class="docs-navigation-links">
 
806
        Previous:
 
807
        <a href="associationproxy.html" title="previous chapter">Association Proxy</a>
 
808
        Next:
 
809
        <a href="declarative.html" title="next chapter">Declarative</a>
809
810
 
810
811
    <div id="docs-copyright">
811
812
        &copy; <a href="../../copyright.html">Copyright</a> 2007-2014, the SQLAlchemy authors and contributors.