diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2016-01-20 16:20:08 -0500 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2016-01-20 16:20:08 -0500 |
commit | 47d8858c54401cdf10285b7935049faf87432f55 (patch) | |
tree | fbd17c997fa58896a2fe0d9738ae95a17be465fe | |
parent | 24dba714cb56e1f5a4dca5453cc5f442e6ee08ab (diff) | |
download | sqlalchemy-47d8858c54401cdf10285b7935049faf87432f55.tar.gz |
- generalize the verbiage on LargeBinary so that it doesn't
create confusion for inherited classes such as BYTEA, fixes
-rw-r--r-- | doc/build/dialects/postgresql.rst | 2 | ||||
-rw-r--r-- | lib/sqlalchemy/sql/sqltypes.py | 15 |
2 files changed, 5 insertions, 12 deletions
diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst index e158cacbf..616924685 100644 --- a/doc/build/dialects/postgresql.rst +++ b/doc/build/dialects/postgresql.rst @@ -44,9 +44,7 @@ construction arguments, are as follows: .. autoclass:: BYTEA :members: __init__ - .. autoclass:: CIDR - :members: __init__ .. autoclass:: DOUBLE_PRECISION diff --git a/lib/sqlalchemy/sql/sqltypes.py b/lib/sqlalchemy/sql/sqltypes.py index 62f163893..84bfca026 100644 --- a/lib/sqlalchemy/sql/sqltypes.py +++ b/lib/sqlalchemy/sql/sqltypes.py @@ -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) |