diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2023-01-03 09:48:06 -0500 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2023-01-03 09:48:28 -0500 |
| commit | 90457077c23a45e505b65224e2ca30704a7e95dd (patch) | |
| tree | 382dde618942b314cd8c4e294d488d6d6a2e0a99 | |
| parent | 77dfbe96db345a6f001a43fdb078ed1f0ecfe261 (diff) | |
| download | sqlalchemy-90457077c23a45e505b65224e2ca30704a7e95dd.tar.gz | |
link to with_variant() narrative from API doc
Change-Id: I5d8e4d7cb7871bedebe0fe89758be441e64b94c6
(cherry picked from commit 7f86be997eea27bc994b25c4fb65d72b3d4567f9)
| -rw-r--r-- | doc/build/core/type_basics.rst | 2 | ||||
| -rw-r--r-- | lib/sqlalchemy/sql/type_api.py | 5 |
2 files changed, 7 insertions, 0 deletions
diff --git a/doc/build/core/type_basics.rst b/doc/build/core/type_basics.rst index 62d941e66..ed4d928e6 100644 --- a/doc/build/core/type_basics.rst +++ b/doc/build/core/type_basics.rst @@ -127,6 +127,8 @@ API documentation for backend-specific types are in the dialect-specific documentation, listed at :ref:`dialect_toplevel`. +.. _types_with_variant: + Using "UPPERCASE" and Backend-specific types for multiple backends ------------------------------------------------------------------ diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py index 30fc4189b..8c786968e 100644 --- a/lib/sqlalchemy/sql/type_api.py +++ b/lib/sqlalchemy/sql/type_api.py @@ -543,6 +543,11 @@ class TypeEngine(Traversible): :param dialect_name: base name of the dialect which uses this type. (i.e. ``'postgresql'``, ``'mysql'``, etc.) + .. seealso:: + + :ref:`types_with_variant` - illustrates the use of + :meth:`_types.TypeEngine.with_variant`. + """ return Variant(self, {dialect_name: to_instance(type_)}) |