]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Tidy range types docs and add warning about the return type support offered by differ...
authorChris Withers <chris@simplistix.co.uk>
Wed, 26 Jun 2013 06:29:48 +0000 (07:29 +0100)
committerChris Withers <chris@simplistix.co.uk>
Wed, 26 Jun 2013 06:29:48 +0000 (07:29 +0100)
doc/build/dialects/postgresql.rst

index d401eef5b9287bd49dfac5e0e380966ad92059a4..3c151483f9c6a818c4dc581ebb040afbd18835ca 100644 (file)
@@ -82,8 +82,11 @@ construction arguments, are as follows:
     :members: __init__
     :show-inheritance:
 
-.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
-    :members:
+Range Types
+~~~~~~~~~~~
+
+The new range column types founds in PostgreSQL 9.2 onwards are
+catered for by the following types:
 
 .. autoclass:: INT4RANGE
    :show-inheritance:
@@ -103,6 +106,19 @@ construction arguments, are as follows:
 .. autoclass:: TSTZRANGE
    :show-inheritance:
 
+The types above get most of their functionality from the following
+mixin:
+
+.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
+    :members:
+
+.. warning::
+
+  The range type DDL support should work with any Postgres DBAPI
+  driver, however the data types returned may vary. If you are using
+  ``psycopg2``, it's recommended to upgrade to version 2.5 or later
+  before using these column types.
+
 
 PostgreSQL Constraint Types
 ---------------------------