]> 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:20:08 +0000 (16:20 -0500)
create confusion for inherited classes such as BYTEA, fixes

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

index e158cacbff215b5dcb380a84f8d7ddbaf8ef6c26..616924685e6997e432e3c441572242713aaa3e5f 100644 (file)
@@ -44,9 +44,7 @@ construction arguments, are as follows:
 .. autoclass:: BYTEA
     :members: __init__
 
-
 .. autoclass:: CIDR
-    :members: __init__
 
 
 .. autoclass:: DOUBLE_PRECISION
index 62f163893b93629c80446331a9a9450c5966393c..84bfca0261c61bd7d97ff4805738ccc9c65152ea 100644 (file)
@@ -909,9 +909,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.
 
     """
 
@@ -922,13 +922,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 *lengthed* 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)