]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- generalize the verbiage on LargeBinary so that it doesn't
authorMike Bayer <mike_mp@zzzcomputing.com>
Wed, 20 Jan 2016 21:20:08 +0000 (16:20 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Wed, 20 Jan 2016 21:21:31 +0000 (16:21 -0500)
create confusion for inherited classes such as BYTEA, fixes

(cherry picked from commit 47d8858c54401cdf10285b7935049faf87432f55)

doc/build/dialects/postgresql.rst
lib/sqlalchemy/sql/sqltypes.py

index e1a96493e08e44767299009249d7d3ed2ea1e625..7ebf28c3ed91ef29c841e833f320e840c417f509 100644 (file)
@@ -41,9 +41,7 @@ construction arguments, are as follows:
 .. autoclass:: BYTEA
     :members: __init__
 
-
 .. autoclass:: CIDR
-    :members: __init__
 
 
 .. autoclass:: DOUBLE_PRECISION
index fbf3f613ebde0772a47155dac6e6da51644c0185..4c4947d09ae428972423bb6c0b439e68c3914a44 100644 (file)
@@ -873,9 +873,9 @@ class LargeBinary(_Binary):
 
     """A type for large binary byte data.
 
-    The Binary type generates BLOB or BYTEA when tables are created,
-    and also converts incoming values using the ``Binary`` callable
-    provided by each DB-API.
+    The :class:`.LargeBinary` type corresponds to a large and/or unlengthed
+    binary type for the target platform, such as BLOB on MySQL and BYTEA for
+    Postgresql.  It also handles the necessary conversions for the DBAPI.
 
     """
 
@@ -886,13 +886,8 @@ class LargeBinary(_Binary):
         Construct a LargeBinary type.
 
         :param length: optional, a length for the column for use in
-          DDL statements, for those BLOB types that accept a length
-          (i.e. MySQL).  It does *not* produce a small BINARY/VARBINARY
-          type - use the BINARY/VARBINARY types specifically for those.
-          May be safely omitted if no ``CREATE
-          TABLE`` will be issued.  Certain databases may require a
-          *length* for use in DDL, and will raise an exception when
-          the ``CREATE TABLE`` DDL is issued.
+          DDL statements, for those binary types that accept a length,
+          such as the MySQL BLOB type.
 
         """
         _Binary.__init__(self, length=length)