summaryrefslogtreecommitdiff
path: root/lib/sqlalchemy/engine
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-04-15 19:05:41 -0400
committerMike Bayer <mike_mp@zzzcomputing.com>2010-04-15 19:05:41 -0400
commit82d194c9a65b09fef8d52318cbe38e2c84dfd2ca (patch)
tree626464a0f56c7220923299abbf052538f61cc9fb /lib/sqlalchemy/engine
parent7cfd33d4ef9c00bcc2114469960590bdf22f8ac2 (diff)
downloadsqlalchemy-82d194c9a65b09fef8d52318cbe38e2c84dfd2ca.tar.gz
- Added get_pk_constraint() to reflection.Inspector, similar
to get_primary_keys() except returns a dict that includes the name of the constraint, for supported backends (PG so far). [ticket:1769] - Postgresql reflects the name of primary key constraints, if one exists. [ticket:1769]
Diffstat (limited to 'lib/sqlalchemy/engine')
-rw-r--r--lib/sqlalchemy/engine/base.py15
-rw-r--r--lib/sqlalchemy/engine/default.py11
-rw-r--r--lib/sqlalchemy/engine/reflection.py37
3 files changed, 57 insertions, 6 deletions
diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 4c5a6a82b..d35796063 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -260,8 +260,23 @@ class Dialect(object):
Given a :class:`~sqlalchemy.engine.Connection`, a string
`table_name`, and an optional string `schema`, return primary
key information as a list of column names.
+
"""
+ raise NotImplementedError()
+
+ def get_pk_constraint(self, table_name, schema=None, **kw):
+ """Return information about the primary key constraint on `table_name`.
+ Given a string `table_name`, and an optional string `schema`, return
+ primary key information as a dictionary with these keys:
+
+ constrained_columns
+ a list of column names that make up the primary key
+
+ name
+ optional name of the primary key constraint.
+
+ """
raise NotImplementedError()
def get_foreign_keys(self, connection, table_name, schema=None, **kw):
diff --git a/lib/sqlalchemy/engine/default.py b/lib/sqlalchemy/engine/default.py
index 6fb0a14a5..fc49c62fa 100644
--- a/lib/sqlalchemy/engine/default.py
+++ b/lib/sqlalchemy/engine/default.py
@@ -205,6 +205,17 @@ class DefaultDialect(base.Dialect):
insp = reflection.Inspector.from_engine(connection)
return insp.reflecttable(table, include_columns)
+ def get_pk_constraint(self, conn, table_name, schema=None, **kw):
+ """Compatiblity method, adapts the result of get_primary_keys()
+ for those dialects which don't implement get_pk_constraint().
+
+ """
+ return {
+ 'constrained_columns':
+ self.get_primary_keys(conn, table_name,
+ schema=schema, **kw)
+ }
+
def validate_identifier(self, ident):
if len(ident) > self.max_identifier_length:
raise exc.IdentifierError(
diff --git a/lib/sqlalchemy/engine/reflection.py b/lib/sqlalchemy/engine/reflection.py
index 57f2205c1..56b9eafd8 100644
--- a/lib/sqlalchemy/engine/reflection.py
+++ b/lib/sqlalchemy/engine/reflection.py
@@ -189,6 +189,26 @@ class Inspector(object):
return pkeys
+ def get_pk_constraint(self, table_name, schema=None, **kw):
+ """Return information about primary key constraint on `table_name`.
+
+ Given a string `table_name`, and an optional string `schema`, return
+ primary key information as a dictionary with these keys:
+
+ constrained_columns
+ a list of column names that make up the primary key
+
+ name
+ optional name of the primary key constraint.
+
+ """
+ pkeys = self.dialect.get_pk_constraint(self.conn, table_name, schema,
+ info_cache=self.info_cache,
+ **kw)
+
+ return pkeys
+
+
def get_foreign_keys(self, table_name, schema=None, **kw):
"""Return information about foreign_keys in `table_name`.
@@ -208,6 +228,9 @@ class Inspector(object):
a list of column names in the referred table that correspond to
constrained_columns
+ name
+ optional name of the foreign key constraint.
+
\**kw
other options passed to the dialect's get_foreign_keys() method.
@@ -318,12 +341,14 @@ class Inspector(object):
raise exc.NoSuchTableError(table.name)
# Primary keys
- primary_key_constraint = sa_schema.PrimaryKeyConstraint(*[
- table.c[pk] for pk in self.get_primary_keys(table_name, schema, **tblkw)
- if pk in table.c
- ])
-
- table.append_constraint(primary_key_constraint)
+ pk_cons = self.get_pk_constraint(table_name, schema, **tblkw)
+ if pk_cons:
+ primary_key_constraint = sa_schema.PrimaryKeyConstraint(*[
+ table.c[pk] for pk in pk_cons['constrained_columns']
+ if pk in table.c
+ ], name=pk_cons.get('name'))
+
+ table.append_constraint(primary_key_constraint)
# Foreign keys
fkeys = self.get_foreign_keys(table_name, schema, **tblkw)