From: Randall Smith <randall@tnr.cc>
Date: Mon, 2 Mar 2009 05:59:01 +0000 (+0000)
Subject: added reflection methods
X-Git-Tag: rel_0_6_6~270
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f53a0b85ceefaacaac35b1da6e980b795304d338;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

added reflection methods
---

diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py
index 5225b6d4b7..81e95c1c83 100644
--- a/lib/sqlalchemy/engine/base.py
+++ b/lib/sqlalchemy/engine/base.py
@@ -177,6 +177,112 @@ class Dialect(object):
 
         raise NotImplementedError()
 
+    def get_columns(self, connection, table_name, schema=None, info_cache=None):
+        """Return information about columns in `table_name`.
+
+        Given a [sqlalchemy.engine#Connection], a string `table_name`, and an
+        optional string `schema`, return column information as a list of dicts
+        with these keys:
+
+        name
+          the column's name
+
+        type
+          [sqlalchemy.types#TypeEngine]
+
+        nullable
+          boolean
+
+        default
+          the column's default value
+
+        attrs
+          dict containing optional column attributes
+        """
+
+        raise NotImplementedError()
+
+    def get_primary_keys(self, connection, table_name, schema=None,
+                         info_cache=None):
+        """Return information about primary keys in `table_name`.
+
+        Given a [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_foreign_keys(self, connection, table_name, schema=None,
+                         info_cache=None):
+        """Return information about foreign_keys in `table_name`.
+
+        Given a [sqlalchemy.engine#Connection], a string `table_name`, and an
+        optional string `schema`, return foreign key information as a list of
+        dicts with these keys:
+
+        name
+          the constraint's name
+
+        constrained_columns
+          a list of column names that make up the foreign key
+
+        referred_schema
+          the name of the referred schema
+
+        referred_table
+          the name of the referred table
+
+        referred_columns
+          a list of column names in the referred table that correspond to
+          constrained_columns
+        """
+
+        raise NotImplementedError()
+
+    def get_view_names(self, connection, schema=None, info_cache=None):
+        """Return a list of all view names available in the database.
+
+        schema:
+          Optional, retrieve names from a non-default schema.
+
+        """
+
+        raise NotImplementedError()
+
+    def get_view_definition(self, connection, view_name, schema=None,
+                            info_cache=None):
+        """Return view definition.
+
+        Given a [sqlalchemy.engine#Connection], a string `view_name`, and an
+        optional string `schema`, return the view definition.
+
+        """
+
+        raise NotImplementedError()
+
+    def get_indexes(self, connection, table_name, schema=None, info_cache=None):
+        """Return information about indexes in `table_name`.
+
+        Given a [sqlalchemy.engine#Connection], a string `table_name` and an 
+        optional string `schema`, return index information as a list of dicts 
+        with these keys:
+
+        name
+          the index's name
+
+        column_names
+          list of column names in order
+
+        unique
+          boolean
+
+        """
+
+        raise NotImplementedError()
+
+
     def has_table(self, connection, table_name, schema=None):
         """Check the existence of a particular table in the database.