summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2006-11-26 02:36:27 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2006-11-26 02:36:27 +0000
commitb6b0130646b677e507d2fb461829ed5d72658000 (patch)
treefe0acf9855ba4053cc7594e8e5b465721aad66c6 /lib/sqlalchemy
parentd9f3b2a06370a88676afa91ff3cd73722ad38543 (diff)
downloadsqlalchemy-b6b0130646b677e507d2fb461829ed5d72658000.tar.gz
- made kwargs parsing to Table strict; removed various obsoluete "redefine=True" kw's from the unit tests
- documented instance variables in ANSICompiler - fixed [ticket:120], adds "inline_params" set to ANSICompiler which DefaultDialect picks up on when determining defaults. added unittests to query.py - additionally fixed up the behavior of the "values" parameter on _Insert/_Update - more cleanup to sql/Select - more succinct organization of FROM clauses, removed silly _process_from_dict methods and JoinMarker object
Diffstat (limited to 'lib/sqlalchemy')
-rw-r--r--lib/sqlalchemy/ansisql.py121
-rw-r--r--lib/sqlalchemy/databases/__init__.py2
-rw-r--r--lib/sqlalchemy/engine/default.py27
-rw-r--r--lib/sqlalchemy/schema.py18
-rw-r--r--lib/sqlalchemy/sql.py80
5 files changed, 147 insertions, 101 deletions
diff --git a/lib/sqlalchemy/ansisql.py b/lib/sqlalchemy/ansisql.py
index 2e0fe6e34..e470a2101 100644
--- a/lib/sqlalchemy/ansisql.py
+++ b/lib/sqlalchemy/ansisql.py
@@ -70,20 +70,64 @@ class ANSICompiler(sql.Compiled):
actual compilation, as in the case of an INSERT where the actual columns
inserted will correspond to the keys present in the parameters."""
sql.Compiled.__init__(self, dialect, statement, parameters, **kwargs)
+
+ # a dictionary of bind parameter keys to _BindParamClause instances.
self.binds = {}
+
+ # a dictionary which stores the string representation for every ClauseElement
+ # processed by this compiler.
+ self.strings = {}
+
+ # a dictionary which stores the string representation for ClauseElements
+ # processed by this compiler, which are to be used in the FROM clause
+ # of a select. items are often placed in "froms" as well as "strings"
+ # and sometimes with different representations.
self.froms = {}
+
+ # slightly hacky. maps FROM clauses to WHERE clauses, and used in select
+ # generation to modify the WHERE clause of the select. currently a hack
+ # used by the oracle module.
self.wheres = {}
- self.strings = {}
+
+ # when the compiler visits a SELECT statement, the clause object is appended
+ # to this stack. various visit operations will check this stack to determine
+ # additional choices (TODO: it seems to be all typemap stuff. shouldnt this only
+ # apply to the topmost-level SELECT statement ?)
self.select_stack = []
+
+ # a dictionary of result-set column names (strings) to TypeEngine instances,
+ # which will be passed to a ResultProxy and used for resultset-level value conversion
self.typemap = {}
+
+ # True if this compiled represents an INSERT
self.isinsert = False
+
+ # True if this compiled represents an UPDATE
self.isupdate = False
+
+ # default formatting style for bind parameters
self.bindtemplate = ":%s"
+
+ # paramstyle from the dialect (comes from DBAPI)
self.paramstyle = dialect.paramstyle
+
+ # true if the paramstyle is positional
self.positional = dialect.positional
+
+ # a list of the compiled's bind parameter names, used to help
+ # formulate a positional argument list
self.positiontup = []
+
+ # an ANSIIdentifierPreparer that formats the quoting of identifiers
self.preparer = dialect.identifier_preparer
+ # for UPDATE and INSERT statements, a set of columns whos values are being set
+ # from a SQL expression (i.e., not one of the bind parameter values). if present,
+ # default-value logic in the Dialect knows not to fire off column defaults
+ # and also knows postfetching will be needed to get the values represented by these
+ # parameters.
+ self.inline_params = None
+
def after_compile(self):
# this re will search for params like :param
# it has a negative lookbehind for an extra ':' so that it doesnt match
@@ -295,13 +339,10 @@ class ANSICompiler(sql.Compiled):
def visit_select(self, select):
# the actual list of columns to print in the SELECT column list.
- # its an ordered dictionary to insure that the actual labeled column name
- # is unique.
inner_columns = util.OrderedDict()
self.select_stack.append(select)
for c in select._raw_columns:
- # TODO: make this polymorphic?
if isinstance(c, sql.Select) and c.is_scalar:
c.accept_visitor(self)
inner_columns[self.get_str(c)] = c
@@ -431,7 +472,6 @@ class ANSICompiler(sql.Compiled):
self.strings[table] = ""
def visit_join(self, join):
- # TODO: ppl are going to want RIGHT, FULL OUTER and NATURAL joins.
righttext = self.get_from_text(join.right)
if join.right._group_parenthesized():
righttext = "(" + righttext + ")"
@@ -488,13 +528,15 @@ class ANSICompiler(sql.Compiled):
self.isinsert = True
colparams = self._get_colparams(insert_stmt, default_params)
- def create_param(p):
+ self.inline_params = util.Set()
+ def create_param(col, p):
if isinstance(p, sql._BindParamClause):
self.binds[p.key] = p
if p.shortname is not None:
self.binds[p.shortname] = p
return self.bindparam_string(p.key)
else:
+ self.inline_params.add(col)
p.accept_visitor(self)
if isinstance(p, sql.ClauseElement) and not isinstance(p, sql.ColumnElement):
return "(" + self.get_str(p) + ")"
@@ -502,7 +544,7 @@ class ANSICompiler(sql.Compiled):
return self.get_str(p)
text = ("INSERT INTO " + self.preparer.format_table(insert_stmt.table) + " (" + string.join([self.preparer.format_column(c[0]) for c in colparams], ', ') + ")" +
- " VALUES (" + string.join([create_param(c[1]) for c in colparams], ', ') + ")")
+ " VALUES (" + string.join([create_param(*c) for c in colparams], ', ') + ")")
self.strings[insert_stmt] = text
@@ -520,19 +562,22 @@ class ANSICompiler(sql.Compiled):
self.isupdate = True
colparams = self._get_colparams(update_stmt, default_params)
- def create_param(p):
+
+ self.inline_params = util.Set()
+ def create_param(col, p):
if isinstance(p, sql._BindParamClause):
self.binds[p.key] = p
self.binds[p.shortname] = p
return self.bindparam_string(p.key)
else:
p.accept_visitor(self)
+ self.inline_params.add(col)
if isinstance(p, sql.ClauseElement) and not isinstance(p, sql.ColumnElement):
return "(" + self.get_str(p) + ")"
else:
return self.get_str(p)
- text = "UPDATE " + self.preparer.format_table(update_stmt.table) + " SET " + string.join(["%s=%s" % (self.preparer.format_column(c[0]), create_param(c[1])) for c in colparams], ', ')
+ text = "UPDATE " + self.preparer.format_table(update_stmt.table) + " SET " + string.join(["%s=%s" % (self.preparer.format_column(c[0]), create_param(*c)) for c in colparams], ', ')
if update_stmt.whereclause:
text += " WHERE " + self.get_str(update_stmt.whereclause)
@@ -541,55 +586,51 @@ class ANSICompiler(sql.Compiled):
def _get_colparams(self, stmt, default_params):
- """determines the VALUES or SET clause for an INSERT or UPDATE
- clause based on the arguments specified to this ANSICompiler object
- (i.e., the execute() or compile() method clause object):
-
- insert(mytable).execute(col1='foo', col2='bar')
- mytable.update().execute(col2='foo', col3='bar')
-
- in the above examples, the insert() and update() methods have no "values" sent to them
- at all, so compiling them with no arguments would yield an insert for all table columns,
- or an update with no SET clauses. but the parameters sent indicate a set of per-compilation
- arguments that result in a differently compiled INSERT or UPDATE object compared to the
- original. The "values" parameter to the insert/update is figured as well if present,
- but the incoming "parameters" sent here take precedence.
+ """organize UPDATE/INSERT SET/VALUES parameters into a list of tuples,
+ each tuple containing the Column and a ClauseElement representing the
+ value to be set (usually a _BindParamClause, but could also be other
+ SQL expressions.)
+
+ the list of tuples will determine the columns that are actually rendered
+ into the SET/VALUES clause of the rendered UPDATE/INSERT statement. It will
+ also determine how to generate the list/dictionary of bind parameters at
+ execution time (i.e. get_params()).
+
+ this list takes into account the "values" keyword specified to the statement,
+ the parameters sent to this Compiled instance, and the default bind parameter
+ values corresponding to the dialect's behavior for otherwise unspecified
+ primary key columns.
"""
- # case one: no parameters in the statement, no parameters in the
- # compiled params - just return binds for all the table columns
+ # no parameters in the statement, no parameters in the
+ # compiled params - return binds for all columns
if self.parameters is None and stmt.parameters is None:
return [(c, sql.bindparam(c.key, type=c.type)) for c in stmt.table.columns]
+ def to_col(key):
+ if not isinstance(key, sql._ColumnClause):
+ return stmt.table.columns.get(str(key), key)
+ else:
+ return key
+
# if we have statement parameters - set defaults in the
# compiled params
if self.parameters is None:
parameters = {}
else:
- parameters = self.parameters.copy()
+ parameters = dict([(to_col(k), v) for k, v in self.parameters.iteritems()])
if stmt.parameters is not None:
for k, v in stmt.parameters.iteritems():
- parameters.setdefault(k, v)
+ parameters.setdefault(to_col(k), v)
for k, v in default_params.iteritems():
- parameters.setdefault(k, v)
-
- # now go thru compiled params, get the Column object for each key
- d = {}
- for key, value in parameters.iteritems():
- if isinstance(key, sql._ColumnClause):
- d[key] = value
- else:
- try:
- d[stmt.table.columns[str(key)]] = value
- except KeyError:
- pass
+ parameters.setdefault(to_col(k), v)
# create a list of column assignment clauses as tuples
values = []
for c in stmt.table.columns:
- if d.has_key(c):
- value = d[c]
+ if parameters.has_key(c):
+ value = parameters[c]
if sql._is_literal(value):
value = sql.bindparam(c.key, value, type=c.type)
values.append((c, value))
diff --git a/lib/sqlalchemy/databases/__init__.py b/lib/sqlalchemy/databases/__init__.py
index f009034c7..45d6e2cbc 100644
--- a/lib/sqlalchemy/databases/__init__.py
+++ b/lib/sqlalchemy/databases/__init__.py
@@ -5,4 +5,4 @@
# the MIT License: http://www.opensource.org/licenses/mit-license.php
-__all__ = ['oracle', 'postgres', 'sqlite', 'mysql', 'mssql']
+__all__ = ['oracle', 'postgres', 'sqlite', 'mysql', 'mssql', 'firebird']
diff --git a/lib/sqlalchemy/engine/default.py b/lib/sqlalchemy/engine/default.py
index 4af539e78..d5cb0cc9f 100644
--- a/lib/sqlalchemy/engine/default.py
+++ b/lib/sqlalchemy/engine/default.py
@@ -175,6 +175,7 @@ class DefaultExecutionContext(base.ExecutionContext):
visit_update methods that add the appropriate column clauses to the statement when its
being compiled, so that these parameters can be bound to the statement."""
if compiled is None: return
+
if getattr(compiled, "isinsert", False):
if isinstance(parameters, list):
plist = parameters
@@ -185,8 +186,20 @@ class DefaultExecutionContext(base.ExecutionContext):
for param in plist:
last_inserted_ids = []
need_lastrowid=False
+ # check the "default" status of each column in the table
for c in compiled.statement.table.c:
- if not param.has_key(c.key) or param[c.key] is None:
+ # check if it will be populated by a SQL clause - we'll need that
+ # after execution.
+ if c in compiled.inline_params:
+ self._lastrow_has_defaults = True
+ if c.primary_key:
+ need_lastrowid = True
+ # check if its not present at all. see if theres a default
+ # and fire it off, and add to bind parameters. if
+ # its a pk, add the value to our last_inserted_ids list,
+ # or, if its a SQL-side default, dont do any of that, but we'll need
+ # the SQL-generated value after execution.
+ elif not param.has_key(c.key) or param[c.key] is None:
if isinstance(c.default, schema.PassiveDefault):
self._lastrow_has_defaults = True
newid = drunner.get_column_default(c)
@@ -196,13 +209,14 @@ class DefaultExecutionContext(base.ExecutionContext):
last_inserted_ids.append(param[c.key])
elif c.primary_key:
need_lastrowid = True
+ # its an explicitly passed pk value - add it to
+ # our last_inserted_ids list.
elif c.primary_key:
last_inserted_ids.append(param[c.key])
if need_lastrowid:
self._last_inserted_ids = None
else:
self._last_inserted_ids = last_inserted_ids
- #print "LAST INSERTED PARAMS", param
self._last_inserted_params = param
elif getattr(compiled, 'isupdate', False):
if isinstance(parameters, list):
@@ -212,8 +226,15 @@ class DefaultExecutionContext(base.ExecutionContext):
drunner = self.dialect.defaultrunner(engine, proxy)
self._lastrow_has_defaults = False
for param in plist:
+ # check the "onupdate" status of each column in the table
for c in compiled.statement.table.c:
- if c.onupdate is not None and (not param.has_key(c.key) or param[c.key] is None):
+ # it will be populated by a SQL clause - we'll need that
+ # after execution.
+ if c in compiled.inline_params:
+ pass
+ # its not in the bind parameters, and theres an "onupdate" defined for the column;
+ # execute it and add to bind params
+ elif c.onupdate is not None and (not param.has_key(c.key) or param[c.key] is None):
value = drunner.get_column_onupdate(c)
if value is not None:
param[c.key] = value
diff --git a/lib/sqlalchemy/schema.py b/lib/sqlalchemy/schema.py
index d9a7684e7..8ebeaea27 100644
--- a/lib/sqlalchemy/schema.py
+++ b/lib/sqlalchemy/schema.py
@@ -14,7 +14,7 @@ structure with its own clause-specific objects as well as the visitor interface,
the schema package "plugs in" to the SQL package.
"""
-from sqlalchemy import sql, types, exceptions,util
+from sqlalchemy import sql, types, exceptions,util, databases
import sqlalchemy
import copy, re, string
@@ -125,7 +125,7 @@ class _TableSingleton(type):
table = metadata.tables[key]
if len(args):
if not useexisting:
- raise exceptions.ArgumentError("Table '%s.%s' is already defined for this MetaData instance." % (schema, name))
+ raise exceptions.ArgumentError("Table '%s' is already defined for this MetaData instance." % key)
return table
except KeyError:
if mustexist:
@@ -183,8 +183,7 @@ class Table(SchemaItem, sql.TableClause):
else an exception is raised.
useexisting=False : indicates that if this Table was already defined elsewhere in the application, disregard
- the rest of the constructor arguments. If this flag and the "redefine" flag are not set, constructing
- the same table twice will result in an exception.
+ the rest of the constructor arguments.
owner=None : optional owning user of this table. useful for databases such as Oracle to aid in table
reflection.
@@ -207,8 +206,8 @@ class Table(SchemaItem, sql.TableClause):
self.indexes = util.Set()
self.constraints = util.Set()
self.primary_key = PrimaryKeyConstraint()
- self.quote = kwargs.get('quote', False)
- self.quote_schema = kwargs.get('quote_schema', False)
+ self.quote = kwargs.pop('quote', False)
+ self.quote_schema = kwargs.pop('quote_schema', False)
if self.schema is not None:
self.fullname = "%s.%s" % (self.schema, self.name)
else:
@@ -217,8 +216,13 @@ class Table(SchemaItem, sql.TableClause):
self._set_casing_strategy(name, kwargs)
self._set_casing_strategy(self.schema or '', kwargs, keyname='case_sensitive_schema')
+
+ if len([k for k in kwargs if not re.match(r'^(?:%s)_' % '|'.join(databases.__all__), k)]):
+ raise TypeError("Invalid argument(s) for Table: %s" % repr(kwargs.keys()))
+
+ # store extra kwargs, which should only contain db-specific options
self.kwargs = kwargs
-
+
def _get_case_sensitive_schema(self):
try:
return getattr(self, '_case_sensitive_schema')
diff --git a/lib/sqlalchemy/sql.py b/lib/sqlalchemy/sql.py
index 8605d5c0c..b3d61dc7e 100644
--- a/lib/sqlalchemy/sql.py
+++ b/lib/sqlalchemy/sql.py
@@ -423,14 +423,9 @@ class ClauseElement(object):
FROM list of a query, when this ClauseElement is placed in the column clause of a Select
statement."""
raise NotImplementedError(repr(self))
- def _process_from_dict(self, data, asfrom):
- """given a dictionary attached to a Select object, places the appropriate
- FROM objects in the dictionary corresponding to this ClauseElement,
- and possibly removes or modifies others."""
- for f in self._get_from_objects():
- data.setdefault(f, f)
- if asfrom:
- data[self] = self
+ def _hide_froms(self):
+ """return a list of FROM clause elements which this ClauseElement replaces."""
+ return []
def compare(self, other):
"""compare this ClauseElement to the given ClauseElement.
@@ -832,8 +827,9 @@ class _BindParamClause(ClauseElement, _CompareMixin):
return isinstance(other, _BindParamClause) and other.type.__class__ == self.type.__class__
def _make_proxy(self, selectable, name = None):
return self
-# return self.obj._make_proxy(selectable, name=self.name)
-
+ def __repr__(self):
+ return "_BindParamClause(%s, %s, type=%s)" % (repr(self.key), repr(self.value), repr(self.type))
+
class _TypeClause(ClauseElement):
"""handles a type keyword in a SQL statement. used by the Case statement."""
def __init__(self, type):
@@ -966,11 +962,6 @@ class _CalculatedClause(ClauseList, ColumnElement):
self._engine = kwargs.get('engine', None)
ClauseList.__init__(self, *clauses)
key = property(lambda self:self.name or "_calc_")
- def _process_from_dict(self, data, asfrom):
- super(_CalculatedClause, self)._process_from_dict(data, asfrom)
- # this helps a Select object get the engine from us
- if asfrom:
- data.setdefault(self, self)
def copy_container(self):
clauses = [clause.copy_container() for clause in self.clauses]
return _CalculatedClause(type=self.type, engine=self._engine, *clauses)
@@ -1156,25 +1147,13 @@ class Join(FromClause):
engine = property(lambda s:s.left.engine or s.right.engine)
- class JoinMarker(FromClause):
- def __init__(self, join):
- FromClause.__init__(self)
- self.join = join
- def _exportable_columns(self):
- return []
-
def alias(self, name=None):
"""creates a Select out of this Join clause and returns an Alias of it. The Select is not correlating."""
return self.select(use_labels=True, correlate=False).alias(name)
- def _process_from_dict(self, data, asfrom):
- for f in self.onclause._get_from_objects():
- data[f] = f
- for f in self.left._get_from_objects() + self.right._get_from_objects():
- # mark the object as a "blank" "from" that wont be printed
- data[f] = Join.JoinMarker(self)
- # a JOIN always impacts the final FROM list of a select statement
- data[self] = self
-
+
+ def _hide_froms(self):
+ return self.left._get_from_objects() + self.right._get_from_objects()
+
def _get_from_objects(self):
return [self] + self.onclause._get_from_objects() + self.left._get_from_objects() + self.right._get_from_objects()
@@ -1323,11 +1302,6 @@ class TableClause(FromClause):
raise NotImplementedError()
def _group_parenthesized(self):
return False
- def _process_from_dict(self, data, asfrom):
- for f in self._get_from_objects():
- data.setdefault(f, f)
- if asfrom:
- data[self] = self
def count(self, whereclause=None, **params):
if len(self.primary_key):
col = list(self.primary_key)[0]
@@ -1443,7 +1417,8 @@ class Select(_SelectBaseMixin, FromClause):
the ability to execute itself and return a result set."""
def __init__(self, columns=None, whereclause = None, from_obj = [], order_by = None, group_by=None, having=None, use_labels = False, distinct=False, for_update=False, engine=None, limit=None, offset=None, scalar=False, correlate=True):
_SelectBaseMixin.__init__(self)
- self.__froms = util.OrderedDict()
+ self.__froms = util.OrderedSet()
+ self.__hide_froms = util.Set([self])
self.use_labels = use_labels
self.whereclause = None
self.having = None
@@ -1526,7 +1501,7 @@ class Select(_SelectBaseMixin, FromClause):
# visit the FROM objects of the column looking for more Selects
for f in column._get_from_objects():
f.accept_visitor(self.__correlator)
- column._process_from_dict(self.__froms, False)
+ self._process_froms(column, False)
def _exportable_columns(self):
return self._raw_columns
@@ -1535,6 +1510,15 @@ class Select(_SelectBaseMixin, FromClause):
return column._make_proxy(self, name=column._label)
else:
return column._make_proxy(self, name=column.name)
+
+ def _process_froms(self, elem, asfrom):
+ for f in elem._get_from_objects():
+ self.__froms.add(f)
+ if asfrom:
+ self.__froms.add(elem)
+ for f in elem._hide_froms():
+ self.__hide_froms.add(f)
+
def append_whereclause(self, whereclause):
self._append_condition('whereclause', whereclause)
def append_having(self, having):
@@ -1543,7 +1527,7 @@ class Select(_SelectBaseMixin, FromClause):
if type(condition) == str:
condition = _TextClause(condition)
condition.accept_visitor(self.__wherecorrelator)
- condition._process_from_dict(self.__froms, False)
+ self._process_froms(condition, False)
if getattr(self, attribute) is not None:
setattr(self, attribute, and_(getattr(self, attribute), condition))
else:
@@ -1560,9 +1544,10 @@ class Select(_SelectBaseMixin, FromClause):
if type(fromclause) == str:
fromclause = _TextClause(fromclause)
fromclause.accept_visitor(self.__correlator)
- fromclause._process_from_dict(self.__froms, True)
+ self._process_froms(fromclause, True)
+
def _locate_oid_column(self):
- for f in self.__froms.values():
+ for f in self.__froms:
if f is self:
# we might be in our own _froms list if a column with us as the parent is attached,
# which includes textual columns.
@@ -1572,16 +1557,11 @@ class Select(_SelectBaseMixin, FromClause):
return oid
else:
return None
- def _get_froms(self):
- return [f for f in self.__froms.values() if f is not self and (f not in self.__correlated)]
- froms = property(lambda s: s._get_froms(), doc="""a list containing all elements of the FROM clause""")
+
+ froms = property(lambda self: self.__froms.difference(self.__hide_froms).difference(self.__correlated), doc="""a collection containing all elements of the FROM clause""")
def accept_visitor(self, visitor):
- # TODO: add contextual visit_ methods
- # visit_select_whereclause, visit_select_froms, visit_select_orderby, etc.
- # which will allow the compiler to set contextual flags before traversing
- # into each thing.
- for f in self._get_froms():
+ for f in self.froms:
f.accept_visitor(visitor)
if self.whereclause is not None:
self.whereclause.accept_visitor(visitor)
@@ -1601,7 +1581,7 @@ class Select(_SelectBaseMixin, FromClause):
if self._engine is not None:
return self._engine
- for f in self.__froms.values():
+ for f in self.__froms:
if f is self:
continue
e = f.engine