From: Mike Bayer Date: Fri, 18 Oct 2019 01:29:51 +0000 (-0400) Subject: Ensure SQL Server default schema name not interpreted as dot-separated tokens X-Git-Tag: rel_1_3_11~29^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8bb2b06436074bb8a4b9d76173df165e421f447f;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git Ensure SQL Server default schema name not interpreted as dot-separated tokens Fixed an issue in the :meth:`.Engine.table_names` method where it would feed the dialect's default schema name back into the dialect level table function, which in the case of SQL Server would interpret it as a dot-tokenized schema name as viewed by the mssql dialect, which would cause the method to fail in the case where the database username actually had a dot inside of it. In 1.3, this method is still used by the :meth:`.MetaData.reflect` function so is a prominent codepath. In 1.4, which is the current master development branch, this issue doesn't exist, both because :meth:`.MetaData.reflect` isn't using this method nor does the method pass the default schema name explicitly. The fix nonetheless guards against the default server name value returned by the dialect from being interpreted as dot-tokenized name under any circumstances by wrapping it in quoted_name(). Fixes: #4923 Change-Id: I821bd38ed89b767eaca0bdffee7f8ba3baf82560 (cherry picked from commit f50c6a04067acf2cd2fc5e42d5acaa9206d9a078) --- diff --git a/doc/build/changelog/unreleased_13/4923.rst b/doc/build/changelog/unreleased_13/4923.rst new file mode 100644 index 0000000000..e5318f51fa --- /dev/null +++ b/doc/build/changelog/unreleased_13/4923.rst @@ -0,0 +1,17 @@ +.. change:: + :tags: bug, mssql + :tickets: 4923 + + Fixed an issue in the :meth:`.Engine.table_names` method where it would + feed the dialect's default schema name back into the dialect level table + function, which in the case of SQL Server would interpret it as a + dot-tokenized schema name as viewed by the mssql dialect, which would + cause the method to fail in the case where the database username actually + had a dot inside of it. In 1.3, this method is still used by the + :meth:`.MetaData.reflect` function so is a prominent codepath. In 1.4, + which is the current master development branch, this issue doesn't exist, + both because :meth:`.MetaData.reflect` isn't using this method nor does the + method pass the default schema name explicitly. The fix nonetheless + guards against the default server name value returned by the dialect from + being interpreted as dot-tokenized name under any circumstances by + wrapping it in quoted_name(). diff --git a/lib/sqlalchemy/dialects/mssql/base.py b/lib/sqlalchemy/dialects/mssql/base.py index d01acab125..e4f1d205d1 100644 --- a/lib/sqlalchemy/dialects/mssql/base.py +++ b/lib/sqlalchemy/dialects/mssql/base.py @@ -2399,7 +2399,9 @@ class MSDialect(default.DefaultDialect): query = sql.text("SELECT schema_name()") default_schema_name = connection.scalar(query) if default_schema_name is not None: - return util.text_type(default_schema_name) + # guard against the case where the default_schema_name is being + # fed back into a table reflection function. + return quoted_name(default_schema_name, quote=True) else: return self.schema_name diff --git a/lib/sqlalchemy/engine/base.py b/lib/sqlalchemy/engine/base.py index 7d2715fd11..53bb1857c4 100644 --- a/lib/sqlalchemy/engine/base.py +++ b/lib/sqlalchemy/engine/base.py @@ -2254,8 +2254,6 @@ class Engine(Connectable, log.Identified): """ with self._optional_conn_ctx_manager(connection) as conn: - if not schema: - schema = self.dialect.default_schema_name return self.dialect.get_table_names(conn, schema) def has_table(self, table_name, schema=None): diff --git a/test/dialect/mssql/test_reflection.py b/test/dialect/mssql/test_reflection.py index 789fe6526a..347adbbd6f 100644 --- a/test/dialect/mssql/test_reflection.py +++ b/test/dialect/mssql/test_reflection.py @@ -421,6 +421,18 @@ class ReflectHugeViewTest(fixtures.TestBase): class OwnerPlusDBTest(fixtures.TestBase): + def test_default_schema_name_not_interpreted_as_tokenized(self): + dialect = mssql.dialect() + dialect.server_version_info = base.MS_2014_VERSION + + mock_connection = mock.Mock(scalar=lambda sql: "Jonah.The.Whale") + schema_name = dialect._get_default_schema_name(mock_connection) + eq_(schema_name, "Jonah.The.Whale") + eq_( + base._owner_plus_db(dialect, schema_name), + (None, "Jonah.The.Whale"), + ) + def test_owner_database_pairs_dont_use_for_same_db(self): dialect = mssql.dialect()