From: Mike Bayer <mike_mp@zzzcomputing.com>
Date: Sun, 5 Jan 2014 02:12:31 +0000 (-0500)
Subject: - The :paramref:`.Table.extend_existing` and :paramref:`.Table.autoload_replace`
X-Git-Tag: rel_0_9_1~6^2~4
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=ecb3865615082301c2e5ab7f8e8a40bfbb99b05c;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

- The :paramref:`.Table.extend_existing` and :paramref:`.Table.autoload_replace`
parameters are now available on the :meth:`.MetaData.reflect`
method.
- starting to use paramref and need newer paramlinks version.
---

diff --git a/doc/build/changelog/changelog_09.rst b/doc/build/changelog/changelog_09.rst
index c72d853d9a..2dbb9702da 100644
--- a/doc/build/changelog/changelog_09.rst
+++ b/doc/build/changelog/changelog_09.rst
@@ -14,6 +14,13 @@
 .. changelog::
     :version: 0.9.1
 
+    .. change::
+        :tags: feature, core
+
+        The :paramref:`.Table.extend_existing` and :paramref:`.Table.autoload_replace`
+        parameters are now available on the :meth:`.MetaData.reflect`
+        method.
+
     .. change::
         :tags: bug, orm, declarative
 
diff --git a/doc/build/requirements.txt b/doc/build/requirements.txt
index 52f594ca59..a5b32f735b 100644
--- a/doc/build/requirements.txt
+++ b/doc/build/requirements.txt
@@ -1,3 +1,3 @@
 mako
 changelog>=0.3.2
-sphinx-paramlinks>=0.1.8
+sphinx-paramlinks>=0.1.9
diff --git a/lib/sqlalchemy/sql/schema.py b/lib/sqlalchemy/sql/schema.py
index 6205ada34a..97c160bf5b 100644
--- a/lib/sqlalchemy/sql/schema.py
+++ b/lib/sqlalchemy/sql/schema.py
@@ -2894,7 +2894,9 @@ class MetaData(SchemaItem):
         """
         return ddl.sort_tables(self.tables.values())
 
-    def reflect(self, bind=None, schema=None, views=False, only=None):
+    def reflect(self, bind=None, schema=None, views=False, only=None,
+                                extend_existing=False,
+                                autoload_replace=True):
         """Load all available table definitions from the database.
 
         Automatically creates ``Table`` entries in this ``MetaData`` for any
@@ -2929,6 +2931,17 @@ class MetaData(SchemaItem):
           with a table name and this ``MetaData`` instance as positional
           arguments and should return a true value for any table to reflect.
 
+        :param extend_existing: Passed along to each :class:`.Table` as
+          :paramref:`.Table.extend_existing`.
+
+          .. versionadded:: 0.9.1
+
+        :param autoload_replace: Passed along to each :class:`.Table` as
+          :paramref:`.Table.autoload_replace`.
+
+          .. versionadded:: 0.9.1
+
+
         """
         if bind is None:
             bind = _bind_or_error(self)
@@ -2937,7 +2950,9 @@ class MetaData(SchemaItem):
 
             reflect_opts = {
                 'autoload': True,
-                'autoload_with': conn
+                'autoload_with': conn,
+                'extend_existing': extend_existing,
+                'autoload_replace': autoload_replace
             }
 
             if schema is None:
@@ -2963,12 +2978,13 @@ class MetaData(SchemaItem):
 
             if only is None:
                 load = [name for name, schname in
-                            zip(available, available_w_schema)
-                            if schname not in current]
+                        zip(available, available_w_schema)
+                        if extend_existing or schname not in current]
             elif util.callable(only):
                 load = [name for name, schname in
                             zip(available, available_w_schema)
-                            if schname not in current and only(name, self)]
+                            if (extend_existing or schname not in current)
+                            and only(name, self)]
             else:
                 missing = [name for name in only if name not in available]
                 if missing:
@@ -2977,7 +2993,8 @@ class MetaData(SchemaItem):
                         'Could not reflect: requested table(s) not available '
                         'in %s%s: (%s)' %
                         (bind.engine.url, s, ', '.join(missing)))
-                load = [name for name in only if name not in current]
+                load = [name for name in only if extend_existing or
+                                                    name not in current]
 
             for name in load:
                 Table(name, self, **reflect_opts)
diff --git a/test/engine/test_reflection.py b/test/engine/test_reflection.py
index a3b0ecdb52..bd065103ee 100644
--- a/test/engine/test_reflection.py
+++ b/test/engine/test_reflection.py
@@ -823,6 +823,7 @@ class ReflectionTest(fixtures.TestBase, ComparesTables):
     def test_reflect_uses_bind_engine_reflect(self):
         self._test_reflect_uses_bind(lambda e: MetaData().reflect(e))
 
+
     @testing.provide_metadata
     def test_reflect_all(self):
         existing = testing.db.table_names()
@@ -878,6 +879,18 @@ class ReflectionTest(fixtures.TestBase, ComparesTables):
             m8.reflect
         )
 
+        m8_e1 = MetaData(testing.db)
+        rt_c = Table('rt_c', m8_e1)
+        m8_e1.reflect(extend_existing=True)
+        eq_(set(m8_e1.tables.keys()), set(names))
+        eq_(rt_c.c.keys(), ['id'])
+
+        m8_e2 = MetaData(testing.db)
+        rt_c = Table('rt_c', m8_e2)
+        m8_e2.reflect(extend_existing=True, only=['rt_a', 'rt_c'])
+        eq_(set(m8_e2.tables.keys()), set(['rt_a', 'rt_c']))
+        eq_(rt_c.c.keys(), ['id'])
+
         if existing:
             print("Other tables present in database, skipping some checks.")
         else: