~j5-dev/+junk/sqlalchemy-0.6.1

« back to all changes in this revision

Viewing changes to doc/sqlalchemy_sql_compiler.html

  • Committer: Bazaar Package Importer
  • Author(s): Piotr Ożarowski
  • Date: 2008-01-10 11:25:35 UTC
  • mfrom: (1.1.14 upstream)
  • Revision ID: james.westby@ubuntu.com-20080110112535-hwmmsushfu16bm9v
Tags: 0.4.2p3-1
New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
30
30
 
31
31
<div id="pagecontrol"><a href="index.html">Multiple Pages</a> | <a href="documentation.html">One Page</a></div>
32
32
 
33
 
<div class="versionheader">Version: 0.4.1   Last Updated: 11/18/07 17:50:18</div>
 
33
<div class="versionheader">Version: 0.4.2p3   Last Updated: 01/09/08 16:39:03</div>
34
34
 
35
35
 
36
36
 
97
97
    <h3>module sqlalchemy.sql.compiler</h3>
98
98
    
99
99
    
100
 
    <div class="darkcell"><p>SQL expression compilation routines and DDL implementations.</p>
 
100
    <div class="darkcell"><p>Base SQL and DDL compiler implementations.</p>
 
101
<p>Provides the <a href="sqlalchemy_sql_compiler.html#docstrings_sqlalchemy.sql.compiler_DefaultCompiler">DefaultCompiler</a> class, which is
 
102
responsible for generating all SQL query strings, as well as
 
103
<a href="sqlalchemy_sql_compiler.html#docstrings_sqlalchemy.sql.compiler_SchemaGenerator">SchemaGenerator</a> and <a href="sqlalchemy_sql_compiler.html#docstrings_sqlalchemy.sql.compiler_SchemaDropper">SchemaDropper</a>
 
104
which issue CREATE and DROP DDL for tables, sequences, and indexes.</p>
 
105
<p>The elements in this module are used by public-facing constructs like
 
106
<a href="sqlalchemy_sql_expression.html#docstrings_sqlalchemy.sql.expression_ClauseElement">ClauseElement</a> and <a href="sqlalchemy_engine.html#docstrings_sqlalchemy.engine_Engine">Engine</a>.
 
107
While dialect authors will want to be familiar with this module for the purpose of
 
108
creating database-specific compilers and schema generators, the module
 
109
is otherwise internal to SQLAlchemy.</p>
101
110
</div>
102
111
    
103
112
 
176
185
    <div class="darkcell">
177
186
    
178
187
    <A name=""></a>
179
 
    <b>def apply_function_parens(<i>self</i>, <i>func</i>)</b>
180
 
    <div class="docstring">
181
 
    
182
 
    </div>
183
 
    </div>
184
 
 
185
 
                    
186
 
    <div class="darkcell">
187
 
    
188
 
    <A name=""></a>
189
188
    <b>def bindparam_string(<i>self</i>, <i>name</i>)</b>
190
189
    <div class="docstring">
191
190
    
239
238
    <div class="darkcell">
240
239
    
241
240
    <A name=""></a>
 
241
    <b>def function_argspec(<i>self</i>, <i>func</i>)</b>
 
242
    <div class="docstring">
 
243
    
 
244
    </div>
 
245
    </div>
 
246
 
 
247
                    
 
248
    <div class="darkcell">
 
249
    
 
250
    <A name=""></a>
 
251
    <b>def function_string(<i>self</i>, <i>func</i>)</b>
 
252
    <div class="docstring">
 
253
    
 
254
    </div>
 
255
    </div>
 
256
 
 
257
                    
 
258
    <div class="darkcell">
 
259
    
 
260
    <A name=""></a>
242
261
    <b>def get_select_precolumns(<i>self</i>, <i>select</i>)</b>
243
262
    <div class="docstring">
244
263
    <p>Called when building a <tt class="docutils literal"><span class="pre">SELECT</span></tt> statement, position is just before column list.</p>
274
293
    <div class="darkcell">
275
294
    
276
295
    <A name=""></a>
277
 
    <b>def label_select_column(<i>self</i>, <i>select</i>, <i>column</i>)</b>
 
296
    <b>def label_select_column(<i>self</i>, <i>select</i>, <i>column</i>, <i>asfrom</i>)</b>
278
297
    <div class="docstring">
279
 
    <p>convert a column from a select's &quot;columns&quot; clause.</p>
280
 
<p>given a select() and a column element from its inner_columns collection, return a
281
 
Label object if this column should be labeled in the columns clause.  Otherwise,
282
 
return None and the column will be used as-is.</p>
283
 
<p>The calling method will traverse the returned label to acquire its string
284
 
representation.</p>
 
298
    <p>label columns present in a select().</p>
285
299
 
286
300
    </div>
287
301
    </div>
350
364
    <div class="darkcell">
351
365
    
352
366
    <A name=""></a>
353
 
    <b>def visit_binary(<i>self</i>, <i>binary</i>, <i>typemap=None</i>, <i>**kwargs</i>)</b>
 
367
    <b>def visit_binary(<i>self</i>, <i>binary</i>, <i>**kwargs</i>)</b>
354
368
    <div class="docstring">
355
369
    
356
370
    </div>
380
394
    <div class="darkcell">
381
395
    
382
396
    <A name=""></a>
383
 
    <b>def visit_cast(<i>self</i>, <i>cast</i>, <i>typemap=None</i>, <i>**kwargs</i>)</b>
 
397
    <b>def visit_cast(<i>self</i>, <i>cast</i>, <i>**kwargs</i>)</b>
384
398
    <div class="docstring">
385
399
    
386
400
    </div>
400
414
    <div class="darkcell">
401
415
    
402
416
    <A name=""></a>
403
 
    <b>def visit_column(<i>self</i>, <i>column</i>, <i>typemap=None</i>, <i>column_labels=None</i>, <i>**kwargs</i>)</b>
 
417
    <b>def visit_column(<i>self</i>, <i>column</i>, <i>result_map=None</i>, <i>**kwargs</i>)</b>
404
418
    <div class="docstring">
405
419
    
406
420
    </div>
440
454
    <div class="darkcell">
441
455
    
442
456
    <A name=""></a>
443
 
    <b>def visit_function(<i>self</i>, <i>func</i>, <i>typemap=None</i>, <i>**kwargs</i>)</b>
 
457
    <b>def visit_function(<i>self</i>, <i>func</i>, <i>result_map=None</i>, <i>**kwargs</i>)</b>
444
458
    <div class="docstring">
445
459
    
446
460
    </div>
490
504
    <div class="darkcell">
491
505
    
492
506
    <A name=""></a>
493
 
    <b>def visit_label(<i>self</i>, <i>label</i>, <i>typemap=None</i>, <i>column_labels=None</i>)</b>
 
507
    <b>def visit_label(<i>self</i>, <i>label</i>, <i>result_map=None</i>)</b>
494
508
    <div class="docstring">
495
509
    
496
510
    </div>
667
681
    <b>def format_column(<i>self</i>, <i>column</i>, <i>use_table=False</i>, <i>name=None</i>, <i>table_name=None</i>)</b>
668
682
    <div class="docstring">
669
683
    <p>Prepare a quoted column name.</p>
670
 
 
671
 
    </div>
672
 
    </div>
673
 
 
674
 
                    
675
 
    <div class="darkcell">
676
 
    
677
 
    <A name=""></a>
678
 
    <b>def format_column_with_table(<i>self</i>, <i>column</i>, <i>column_name=None</i>, <i>table_name=None</i>)</b>
679
 
    <div class="docstring">
680
 
    <p>Prepare a quoted column name with table name.</p>
 
684
<p>deprecated.  use preparer.quote(col, column.name) or combine with format_table()</p>
681
685
 
682
686
    </div>
683
687
    </div>
758
762
    <div class="darkcell">
759
763
    
760
764
    <A name=""></a>
 
765
    <b>def quote(<i>self</i>, <i>obj</i>, <i>ident</i>)</b>
 
766
    <div class="docstring">
 
767
    
 
768
    </div>
 
769
    </div>
 
770
 
 
771
                    
 
772
    <div class="darkcell">
 
773
    
 
774
    <A name=""></a>
761
775
    <b>def quote_identifier(<i>self</i>, <i>value</i>)</b>
762
776
    <div class="docstring">
763
777
    <p>Quote an identifier.</p>