diff options
| -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_)}) |