alembic 1.13.2__tar.gz → 1.13.3__tar.gz

{alembic-1.13.2/alembic.egg-info → alembic-1.13.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alembic
-Version: 1.13.2
+Version: 1.13.3
 Summary: A database migration tool for SQLAlchemy.
 Home-page: https://alembic.sqlalchemy.org
 Author: Mike Bayer

{alembic-1.13.2 → alembic-1.13.3}/alembic/__init__.py

@@ -1,4 +1,4 @@
 from . import context
 from . import op
 
-__version__ = "1.13.2"
+__version__ = "1.13.3"

{alembic-1.13.2 → alembic-1.13.3}/alembic/autogenerate/render.py

@@ -279,6 +279,9 @@ def _add_table(autogen_context: AutogenContext, op: ops.CreateTableOp) -> str:
         prefixes = ", ".join("'%s'" % p for p in table._prefixes)
         text += ",\nprefixes=[%s]" % prefixes
 
+    if op.if_not_exists is not None:
+        text += ",\nif_not_exists=%r" % bool(op.if_not_exists)
+
     text += "\n)"
     return text
 
@@ -291,6 +294,10 @@ def _drop_table(autogen_context: AutogenContext, op: ops.DropTableOp) -> str:
     }
     if op.schema:
         text += ", schema=%r" % _ident(op.schema)
+
+    if op.if_exists is not None:
+        text += ", if_exists=%r" % bool(op.if_exists)
+
     text += ")"
     return text
 
@@ -324,6 +331,8 @@ def _add_index(autogen_context: AutogenContext, op: ops.CreateIndexOp) -> str:
     assert index.table is not None
 
     opts = _render_dialect_kwargs_items(autogen_context, index)
+    if op.if_not_exists is not None:
+        opts.append("if_not_exists=%r" % bool(op.if_not_exists))
     text = tmpl % {
         "prefix": _alembic_autogenerate_prefix(autogen_context),
         "name": _render_gen_name(autogen_context, index.name),
@@ -356,6 +365,8 @@ def _drop_index(autogen_context: AutogenContext, op: ops.DropIndexOp) -> str:
             "table_name=%(table_name)r%(schema)s%(kwargs)s)"
         )
     opts = _render_dialect_kwargs_items(autogen_context, index)
+    if op.if_exists is not None:
+        opts.append("if_exists=%r" % bool(op.if_exists))
     text = tmpl % {
         "prefix": _alembic_autogenerate_prefix(autogen_context),
         "name": _render_gen_name(autogen_context, op.index_name),

{alembic-1.13.2 → alembic-1.13.3}/alembic/ddl/impl.py

@@ -362,11 +362,11 @@ class DefaultImpl(metaclass=ImplMeta):
             base.RenameTable(old_table_name, new_table_name, schema=schema)
         )
 
-    def create_table(self, table: Table) -> None:
+    def create_table(self, table: Table, **kw: Any) -> None:
         table.dispatch.before_create(
             table, self.connection, checkfirst=False, _ddl_runner=self
         )
-        self._exec(schema.CreateTable(table))
+        self._exec(schema.CreateTable(table, **kw))
         table.dispatch.after_create(
             table, self.connection, checkfirst=False, _ddl_runner=self
         )
@@ -385,11 +385,11 @@ class DefaultImpl(metaclass=ImplMeta):
             if comment and with_comment:
                 self.create_column_comment(column)
 
-    def drop_table(self, table: Table) -> None:
+    def drop_table(self, table: Table, **kw: Any) -> None:
         table.dispatch.before_drop(
             table, self.connection, checkfirst=False, _ddl_runner=self
         )
-        self._exec(schema.DropTable(table))
+        self._exec(schema.DropTable(table, **kw))
         table.dispatch.after_drop(
             table, self.connection, checkfirst=False, _ddl_runner=self
         )

{alembic-1.13.2 → alembic-1.13.3}/alembic/op.pyi

@@ -747,7 +747,12 @@ def create_primary_key(
 
     """
 
-def create_table(table_name: str, *columns: SchemaItem, **kw: Any) -> Table:
+def create_table(
+    table_name: str,
+    *columns: SchemaItem,
+    if_not_exists: Optional[bool] = None,
+    **kw: Any,
+) -> Table:
     r"""Issue a "create table" instruction using the current migration
     context.
 
@@ -818,6 +823,10 @@ def create_table(table_name: str, *columns: SchemaItem, **kw: Any) -> Table:
      quoting of the schema outside of the default behavior, use
      the SQLAlchemy construct
      :class:`~sqlalchemy.sql.elements.quoted_name`.
+    :param if_not_exists: If True, adds IF NOT EXISTS operator when
+     creating the new table.
+
+     .. versionadded:: 1.13.3
     :param \**kw: Other keyword arguments are passed to the underlying
      :class:`sqlalchemy.schema.Table` object created for the command.
 
@@ -998,7 +1007,11 @@ def drop_index(
     """
 
 def drop_table(
-    table_name: str, *, schema: Optional[str] = None, **kw: Any
+    table_name: str,
+    *,
+    schema: Optional[str] = None,
+    if_exists: Optional[bool] = None,
+    **kw: Any,
 ) -> None:
     r"""Issue a "drop table" instruction using the current
     migration context.
@@ -1013,6 +1026,10 @@ def drop_table(
      quoting of the schema outside of the default behavior, use
      the SQLAlchemy construct
      :class:`~sqlalchemy.sql.elements.quoted_name`.
+    :param if_exists: If True, adds IF EXISTS operator when
+     dropping the table.
+
+     .. versionadded:: 1.13.3
     :param \**kw: Other keyword arguments are passed to the underlying
      :class:`sqlalchemy.schema.Table` object created for the command.
 

{alembic-1.13.2 → alembic-1.13.3}/alembic/operations/base.py

@@ -1175,7 +1175,11 @@ class Operations(AbstractOperations):
             ...
 
         def create_table(
-            self, table_name: str, *columns: SchemaItem, **kw: Any
+            self,
+            table_name: str,
+            *columns: SchemaItem,
+            if_not_exists: Optional[bool] = None,
+            **kw: Any,
         ) -> Table:
             r"""Issue a "create table" instruction using the current migration
             context.
@@ -1247,6 +1251,10 @@ class Operations(AbstractOperations):
              quoting of the schema outside of the default behavior, use
              the SQLAlchemy construct
              :class:`~sqlalchemy.sql.elements.quoted_name`.
+            :param if_not_exists: If True, adds IF NOT EXISTS operator when
+             creating the new table.
+
+             .. versionadded:: 1.13.3
             :param \**kw: Other keyword arguments are passed to the underlying
              :class:`sqlalchemy.schema.Table` object created for the command.
 
@@ -1438,7 +1446,12 @@ class Operations(AbstractOperations):
             ...
 
         def drop_table(
-            self, table_name: str, *, schema: Optional[str] = None, **kw: Any
+            self,
+            table_name: str,
+            *,
+            schema: Optional[str] = None,
+            if_exists: Optional[bool] = None,
+            **kw: Any,
         ) -> None:
             r"""Issue a "drop table" instruction using the current
             migration context.
@@ -1453,6 +1466,10 @@ class Operations(AbstractOperations):
              quoting of the schema outside of the default behavior, use
              the SQLAlchemy construct
              :class:`~sqlalchemy.sql.elements.quoted_name`.
+            :param if_exists: If True, adds IF EXISTS operator when
+             dropping the table.
+
+             .. versionadded:: 1.13.3
             :param \**kw: Other keyword arguments are passed to the underlying
              :class:`sqlalchemy.schema.Table` object created for the command.
 

{alembic-1.13.2 → alembic-1.13.3}/alembic/operations/ops.py

@@ -1159,6 +1159,7 @@ class CreateTableOp(MigrateOperation):
         columns: Sequence[SchemaItem],
         *,
         schema: Optional[str] = None,
+        if_not_exists: Optional[bool] = None,
         _namespace_metadata: Optional[MetaData] = None,
         _constraints_included: bool = False,
         **kw: Any,
@@ -1166,6 +1167,7 @@ class CreateTableOp(MigrateOperation):
         self.table_name = table_name
         self.columns = columns
         self.schema = schema
+        self.if_not_exists = if_not_exists
         self.info = kw.pop("info", {})
         self.comment = kw.pop("comment", None)
         self.prefixes = kw.pop("prefixes", None)
@@ -1228,6 +1230,7 @@ class CreateTableOp(MigrateOperation):
         operations: Operations,
         table_name: str,
         *columns: SchemaItem,
+        if_not_exists: Optional[bool] = None,
         **kw: Any,
     ) -> Table:
         r"""Issue a "create table" instruction using the current migration
@@ -1300,6 +1303,10 @@ class CreateTableOp(MigrateOperation):
          quoting of the schema outside of the default behavior, use
          the SQLAlchemy construct
          :class:`~sqlalchemy.sql.elements.quoted_name`.
+        :param if_not_exists: If True, adds IF NOT EXISTS operator when
+         creating the new table.
+
+         .. versionadded:: 1.13.3
         :param \**kw: Other keyword arguments are passed to the underlying
          :class:`sqlalchemy.schema.Table` object created for the command.
 
@@ -1307,7 +1314,7 @@ class CreateTableOp(MigrateOperation):
          to the parameters given.
 
         """
-        op = cls(table_name, columns, **kw)
+        op = cls(table_name, columns, if_not_exists=if_not_exists, **kw)
         return operations.invoke(op)
 
 
@@ -1320,11 +1327,13 @@ class DropTableOp(MigrateOperation):
         table_name: str,
         *,
         schema: Optional[str] = None,
+        if_exists: Optional[bool] = None,
         table_kw: Optional[MutableMapping[Any, Any]] = None,
         _reverse: Optional[CreateTableOp] = None,
     ) -> None:
         self.table_name = table_name
         self.schema = schema
+        self.if_exists = if_exists
         self.table_kw = table_kw or {}
         self.comment = self.table_kw.pop("comment", None)
         self.info = self.table_kw.pop("info", None)
@@ -1385,6 +1394,7 @@ class DropTableOp(MigrateOperation):
         table_name: str,
         *,
         schema: Optional[str] = None,
+        if_exists: Optional[bool] = None,
         **kw: Any,
     ) -> None:
         r"""Issue a "drop table" instruction using the current
@@ -1400,11 +1410,15 @@ class DropTableOp(MigrateOperation):
          quoting of the schema outside of the default behavior, use
          the SQLAlchemy construct
          :class:`~sqlalchemy.sql.elements.quoted_name`.
+        :param if_exists: If True, adds IF EXISTS operator when
+         dropping the table.
+
+         .. versionadded:: 1.13.3
         :param \**kw: Other keyword arguments are passed to the underlying
          :class:`sqlalchemy.schema.Table` object created for the command.
 
         """
-        op = cls(table_name, schema=schema, table_kw=kw)
+        op = cls(table_name, schema=schema, if_exists=if_exists, table_kw=kw)
         operations.invoke(op)
 
 

{alembic-1.13.2 → alembic-1.13.3}/alembic/operations/toimpl.py

@@ -79,8 +79,14 @@ def alter_column(
 
 @Operations.implementation_for(ops.DropTableOp)
 def drop_table(operations: "Operations", operation: "ops.DropTableOp") -> None:
+    kw = {}
+    if operation.if_exists is not None:
+        if not sqla_14:
+            raise NotImplementedError("SQLAlchemy 1.4+ required")
+
+        kw["if_exists"] = operation.if_exists
     operations.impl.drop_table(
-        operation.to_table(operations.migration_context)
+        operation.to_table(operations.migration_context), **kw
     )
 
 
@@ -127,8 +133,14 @@ def drop_index(operations: "Operations", operation: "ops.DropIndexOp") -> None:
 def create_table(
     operations: "Operations", operation: "ops.CreateTableOp"
 ) -> "Table":
+    kw = {}
+    if operation.if_not_exists is not None:
+        if not sqla_14:
+            raise NotImplementedError("SQLAlchemy 1.4+ required")
+
+        kw["if_not_exists"] = operation.if_not_exists
     table = operation.to_table(operations.migration_context)
-    operations.impl.create_table(table)
+    operations.impl.create_table(table, **kw)
     return table
 
 

{alembic-1.13.2 → alembic-1.13.3}/alembic/script/base.py

@@ -187,6 +187,7 @@ class ScriptDirectory:
             split_on_path = {
                 None: None,
                 "space": " ",
+                "newline": "\n",
                 "os": os.pathsep,
                 ":": ":",
                 ";": ";",
@@ -200,7 +201,8 @@ class ScriptDirectory:
                 raise ValueError(
                     "'%s' is not a valid value for "
                     "version_path_separator; "
-                    "expected 'space', 'os', ':', ';'" % version_path_separator
+                    "expected 'space', 'newline', 'os', ':', ';'"
+                    % version_path_separator
                 ) from ke
             else:
                 if split_char is None:
@@ -210,7 +212,9 @@ class ScriptDirectory:
                     )
                 else:
                     version_locations = [
-                        x for x in version_locations_str.split(split_char) if x
+                        x.strip()
+                        for x in version_locations_str.split(split_char)
+                        if x
                     ]
         else:
             version_locations = None

{alembic-1.13.2 → alembic-1.13.3}/alembic/templates/async/alembic.ini.mako

@@ -47,6 +47,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

{alembic-1.13.2 → alembic-1.13.3}/alembic/templates/generic/alembic.ini.mako

@@ -49,6 +49,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

{alembic-1.13.2 → alembic-1.13.3}/alembic/templates/multidb/alembic.ini.mako

@@ -49,6 +49,7 @@ prepend_sys_path = .
 # version_path_separator = :
 # version_path_separator = ;
 # version_path_separator = space
+# version_path_separator = newline
 version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
 # set to 'true' to search source files recursively

{alembic-1.13.2 → alembic-1.13.3}/alembic/testing/assertions.py

@@ -74,7 +74,9 @@ class _ErrorContainer:
 
 
 @contextlib.contextmanager
-def _expect_raises(except_cls, msg=None, check_context=False):
+def _expect_raises(
+    except_cls, msg=None, check_context=False, text_exact=False
+):
     ec = _ErrorContainer()
     if check_context:
         are_we_already_in_a_traceback = sys.exc_info()[0]
@@ -85,7 +87,10 @@ def _expect_raises(except_cls, msg=None, check_context=False):
         ec.error = err
         success = True
         if msg is not None:
-            assert re.search(msg, str(err), re.UNICODE), f"{msg} !~ {err}"
+            if text_exact:
+                assert str(err) == msg, f"{msg} != {err}"
+            else:
+                assert re.search(msg, str(err), re.UNICODE), f"{msg} !~ {err}"
         if check_context and not are_we_already_in_a_traceback:
             _assert_proper_exception_context(err)
         print(str(err).encode("utf-8"))
@@ -98,8 +103,12 @@ def expect_raises(except_cls, check_context=True):
     return _expect_raises(except_cls, check_context=check_context)
 
 
-def expect_raises_message(except_cls, msg, check_context=True):
-    return _expect_raises(except_cls, msg=msg, check_context=check_context)
+def expect_raises_message(
+    except_cls, msg, check_context=True, text_exact=False
+):
+    return _expect_raises(
+        except_cls, msg=msg, check_context=check_context, text_exact=text_exact
+    )
 
 
 def eq_ignore_whitespace(a, b, msg=None):

{alembic-1.13.2 → alembic-1.13.3}/alembic/util/sqla_compat.py

@@ -527,7 +527,7 @@ class _textual_index_element(sql.ColumnElement):
         self.fake_column = schema.Column(self.text.text, sqltypes.NULLTYPE)
         table.append_column(self.fake_column)
 
-    def get_children(self):
+    def get_children(self, **kw):
         return [self.fake_column]
 
 

{alembic-1.13.2 → alembic-1.13.3/alembic.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: alembic
-Version: 1.13.2
+Version: 1.13.3
 Summary: A database migration tool for SQLAlchemy.
 Home-page: https://alembic.sqlalchemy.org
 Author: Mike Bayer

{alembic-1.13.2 → alembic-1.13.3}/alembic.egg-info/SOURCES.txt

@@ -107,26 +107,26 @@ docs/search.html
 docs/searchindex.js
 docs/tutorial.html
 docs/_images/api_overview.png
-docs/_sources/autogenerate.rst.txt
-docs/_sources/batch.rst.txt
-docs/_sources/branches.rst.txt
-docs/_sources/changelog.rst.txt
-docs/_sources/cookbook.rst.txt
-docs/_sources/front.rst.txt
-docs/_sources/index.rst.txt
-docs/_sources/naming.rst.txt
-docs/_sources/offline.rst.txt
-docs/_sources/ops.rst.txt
-docs/_sources/tutorial.rst.txt
-docs/_sources/api/autogenerate.rst.txt
-docs/_sources/api/commands.rst.txt
-docs/_sources/api/config.rst.txt
-docs/_sources/api/ddl.rst.txt
-docs/_sources/api/index.rst.txt
-docs/_sources/api/operations.rst.txt
-docs/_sources/api/overview.rst.txt
-docs/_sources/api/runtime.rst.txt
-docs/_sources/api/script.rst.txt
+docs/_sources/autogenerate.rst
+docs/_sources/batch.rst
+docs/_sources/branches.rst
+docs/_sources/changelog.rst
+docs/_sources/cookbook.rst
+docs/_sources/front.rst
+docs/_sources/index.rst
+docs/_sources/naming.rst
+docs/_sources/offline.rst
+docs/_sources/ops.rst
+docs/_sources/tutorial.rst
+docs/_sources/api/autogenerate.rst
+docs/_sources/api/commands.rst
+docs/_sources/api/config.rst
+docs/_sources/api/ddl.rst
+docs/_sources/api/index.rst
+docs/_sources/api/operations.rst
+docs/_sources/api/overview.rst
+docs/_sources/api/runtime.rst
+docs/_sources/api/script.rst
 docs/_static/basic.css
 docs/_static/changelog.css
 docs/_static/clipboard.min.js
@@ -138,14 +138,28 @@ docs/_static/documentation_options.js
 docs/_static/file.png
 docs/_static/language_data.js
 docs/_static/minus.png
-docs/_static/nature.css
 docs/_static/nature_override.css
 docs/_static/plus.png
 docs/_static/pygments.css
+docs/_static/sbt-webpack-macros.html
 docs/_static/searchtools.js
 docs/_static/site_custom_css.css
 docs/_static/sphinx_highlight.js
 docs/_static/sphinx_paramlinks.css
+docs/_static/webpack-macros.html
+docs/_static/images/logo_colab.png
+docs/_static/scripts/bootstrap.js
+docs/_static/scripts/bootstrap.js.LICENSE.txt
+docs/_static/scripts/pydata-sphinx-theme.js
+docs/_static/scripts/sphinx-book-theme.js
+docs/_static/styles/bootstrap.css
+docs/_static/styles/pydata-sphinx-theme.css
+docs/_static/styles/sphinx-book-theme.css
+docs/_static/styles/theme.css
+docs/_static/vendor/fontawesome/6.5.2/LICENSE.txt
+docs/_static/vendor/fontawesome/6.5.2/css/all.min.css
+docs/_static/vendor/fontawesome/6.5.2/js/all.min.js
+docs/_static/vendor/fontawesome/6.5.2/js/all.min.js.LICENSE.txt
 docs/api/autogenerate.html
 docs/api/commands.html
 docs/api/config.html

{alembic-1.13.2/docs/build → alembic-1.13.3/docs/_sources}/changelog.rst

@@ -3,6 +3,53 @@
 Changelog
 ==========
 
+.. changelog::
+    :version: 1.13.3
+    :released: September 23, 2024
+
+    .. change::
+        :tags: usecase, autogenerate
+
+        Render ``if_exists`` and ``if_not_exists`` parameters in
+        :class:`.CreateTableOp`, :class:`.CreateIndexOp`, :class:`.DropTableOp` and
+        :class:`.DropIndexOp` in an autogenerate context.  While Alembic does not
+        set these parameters during an autogenerate run, they can be enabled using
+        a custom :class:`.Rewriter` in the ``env.py`` file, where they will now be
+        part of the rendered Python code in revision files.  Pull request courtesy
+        of Louis-Amaury Chaib (@lachaib).
+
+    .. change::
+        :tags: usecase, environment
+        :tickets: 1509
+
+        Enhance ``version_locations`` parsing to handle paths containing newlines.
+
+    .. change::
+        :tags: usecase, operations
+        :tickets: 1520
+
+        Added support for :paramref:`.Operations.create_table.if_not_exists` and
+        :paramref:`.Operations.drop_table.if_exists`, adding similar functionality
+        to render IF [NOT] EXISTS for table operations in a similar way as with
+        indexes. Pull request courtesy Aaron Griffin.
+
+
+    .. change::
+        :tags: change, general
+
+        The pin for ``setuptools<69.3`` in ``pyproject.toml`` has been removed.
+        This pin was to prevent a sudden change to :pep:`625` in setuptools from
+        taking place which changes the file name of SQLAlchemy's source
+        distribution on pypi to be an all lower case name, and the change was
+        extended to all SQLAlchemy projects to prevent any further surprises.
+        However, the presence of this pin is now holding back environments that
+        otherwise want to use a newer setuptools, so we've decided to move forward
+        with this change, with the assumption that build environments will have
+        largely accommodated the setuptools change by now.
+
+
+
+
 .. changelog::
     :version: 1.13.2
     :released: June 26, 2024

{alembic-1.13.2/docs/build → alembic-1.13.3/docs/_sources}/cookbook.rst

@@ -776,8 +776,8 @@ recreated again within the downgrade for this migration::
 
 .. _cookbook_postgresql_multi_tenancy:
 
-Rudimental Schema-Level Multi Tenancy for PostgreSQL Databases
-==============================================================
+Rudimental Schema-Level Multi Tenancy for PostgreSQL, MySQL, Other Databases
+============================================================================
 
 **Multi tenancy** refers to an application that accommodates for many
 clients simultaneously.   Within the scope of a database migrations tool,
@@ -789,9 +789,19 @@ the approach must involve running Alembic multiple times against different
 database URLs.
 
 One common approach to multi-tenancy, particularly on the PostgreSQL database,
-is to install tenants within **individual PostgreSQL schemas**.  When using
-PostgreSQL's schemas, a special variable ``search_path`` is offered that is
-intended to assist with targeting of different schemas.
+is to install tenants within **individual PostgreSQL schemas**; similarly
+when using MySQL/MariaDB, **individual MySQL/MariaDB databases** are addressed
+in the same way as "schemas" on PostgreSQL.
+
+When using PostgreSQL's schemas, a special variable ``search_path`` is offered
+that is intended to assist with targeting of different schemas.  When using
+MySQL or MariaDB databases, a similar command is available at the SQL level
+called the ``USE`` command.  This command may be used in a similar fashion as
+that of PostgreSQL's ``search_path`` variable to achieve a similar effect.
+
+Overall, this recipe can be used on **any database that supports runtime
+modification of the current "tenant" via SQL commands on a particular
+connection**.
 
 .. note::  SQLAlchemy includes a system of directing a common set of
    ``Table`` metadata to many schemas called `schema_translate_map <https://docs.sqlalchemy.org/core/connections.html#translation-of-schema-names>`_.   Alembic at the time
@@ -801,7 +811,7 @@ intended to assist with targeting of different schemas.
 
 The recipe below can be altered for flexibility.  The primary purpose of this
 recipe is to illustrate how to point the Alembic process towards one PostgreSQL
-schema or another.
+or MySQL/MariaDB schema or another.
 
 1. The model metadata used as the target for autogenerate must not include any
    schema name for tables; the schema must be non-present or set to ``None``.
@@ -841,12 +851,20 @@ schema or another.
             current_tenant = context.get_x_argument(as_dictionary=True).get("tenant")
             with connectable.connect() as connection:
 
-                # set search path on the connection, which ensures that
-                # PostgreSQL will emit all CREATE / ALTER / DROP statements
-                # in terms of this schema by default
-                connection.execute(text('set search_path to "%s"' % current_tenant))
-                # in SQLAlchemy v2+ the search path change needs to be committed
-                connection.commit()
+                if connection.dialect.name == "postgresql":
+                    # set search path on the connection, which ensures that
+                    # PostgreSQL will emit all CREATE / ALTER / DROP statements
+                    # in terms of this schema by default
+
+                    connection.execute(text('set search_path to "%s"' % current_tenant))
+                    # in SQLAlchemy v2+ the search path change needs to be committed
+                    connection.commit()
+                elif connection.dialect.name in ("mysql", "mariadb"):
+                    # set "USE" on the connection, which ensures that
+                    # MySQL/MariaDB will emit all CREATE / ALTER / DROP statements
+                    # in terms of this schema by default
+
+                    connection.execute(text('USE %s' % current_tenant))
 
                 # make use of non-supported SQLAlchemy attribute to ensure
                 # the dialect reflects tables in terms of the current tenant name
@@ -860,17 +878,18 @@ schema or another.
                 with context.begin_transaction():
                     context.run_migrations()
 
-   The current tenant is set using the PostgreSQL ``search_path`` variable on
-   the connection.  Note above we must employ a **non-supported SQLAlchemy
-   workaround** at the moment which is to hardcode the SQLAlchemy dialect's
-   default schema name to our target schema.
+   The current tenant is set using the PostgreSQL ``search_path`` variable, or
+   the MySQL/MariaDB ``USE`` statement, on the connection.  Note above we must
+   employ a **non-supported SQLAlchemy workaround** at the moment which is to
+   hardcode the SQLAlchemy dialect's default schema name to our target schema.
 
    It is also important to note that the above changes **remain on the connection
    permanently unless reversed explicitly**.  If the alembic application simply
    exits above, there is no issue.  However if the application attempts to
    continue using the above connection for other purposes, it may be necessary
    to reset these variables back to the default, which for PostgreSQL is usually
-   the name "public" however may be different based on configuration.
+   the name "public" however may be different based on configuration, and
+   for MySQL/MariaDB is typically the "database" portion of the database URL.
 
 
 4. Alembic operations will now proceed in terms of whichever schema we pass

{alembic-1.13.2/docs/build → alembic-1.13.3/docs/_sources}/tutorial.rst

@@ -174,6 +174,7 @@ The file generated with the "generic" configuration looks like::
     # version_path_separator = :
     # version_path_separator = ;
     # version_path_separator = space
+    # version_path_separator = newline
     version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
 
     # set to 'true' to search source files recursively

{alembic-1.13.2 → alembic-1.13.3}/docs/_static/basic.css

@@ -55,7 +55,7 @@ div.sphinxsidebarwrapper {
 
 div.sphinxsidebar {
     float: left;
-    width: 230px;
+    width: 270px;
     margin-left: -100%;
     font-size: 90%;
     word-wrap: break-word;