From 466f64c62214757954ec251df018704e6de4555f Mon Sep 17 00:00:00 2001 From: zeeeeb Date: Sat, 25 Jun 2022 19:15:26 -0600 Subject: [PATCH] fixing docs --- doc/build/changelog/unreleased_20/7156.rst | 4 +++- doc/build/dialects/postgresql.rst | 8 ++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/build/changelog/unreleased_20/7156.rst b/doc/build/changelog/unreleased_20/7156.rst index 15f5207d3a..aa6b235600 100644 --- a/doc/build/changelog/unreleased_20/7156.rst +++ b/doc/build/changelog/unreleased_20/7156.rst @@ -3,4 +3,6 @@ :tickets: 7156 Adds support for PostgreSQL MultiRange types, introduced - in PostgreSQL 14. + in PostgreSQL 14. Note that this feature currently only + tested with `psycopg` and the `psycopg.types.multirange` + type. \ No newline at end of file diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst index 852a9cdba2..2380b9b23a 100644 --- a/doc/build/dialects/postgresql.rst +++ b/doc/build/dialects/postgresql.rst @@ -187,7 +187,10 @@ mixin: .. warning:: The multirange type DDL support should work with any PostgreSQL DBAPI - driver, however the data types returned may vary. + driver, however the data types returned may vary. The feature is + currently developed against the psycopg driver, and is known to + work with the range types specific to the `psycopg.types.range` + extension module. When instantiating models that use these column types, you should pass whatever data type is expected by the DBAPI driver you're using for @@ -196,7 +199,8 @@ the column type. For example: .. code-block:: python - + # Note: Multirange type currently only tested against the psycopg + # driver, hence the use here. from psycopg.types.range import Range from pscyopg.types.multirange import Multirange from sqlalchemy.dialects.postgresql import TSMULTIRANGE -- 2.47.3