summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2010-01-23 19:44:06 +0000
committerMike Bayer <mike_mp@zzzcomputing.com>2010-01-23 19:44:06 +0000
commitfc92d14bbe3077ff94df108bf53ec77e0da83dd8 (patch)
treea893a688e404966a1727477580425e95cb7f1236
parent2d15d9b0d0b20190d5aa348edaf4b398263464f7 (diff)
downloadsqlalchemy-fc92d14bbe3077ff94df108bf53ec77e0da83dd8.tar.gz
- types.Binary is renamed to types.LargeBinary, it only
produces BLOB, BYTEA, or a similar "long binary" type. New base BINARY and VARBINARY types have been added to access these MySQL/MS-SQL specific types in an agnostic way [ticket:1664].
-rw-r--r--CHANGES6
-rw-r--r--doc/build/reference/sqlalchemy/types.rst12
-rw-r--r--lib/sqlalchemy/__init__.py1
-rw-r--r--lib/sqlalchemy/dialects/access/base.py4
-rw-r--r--lib/sqlalchemy/dialects/informix/base.py4
-rw-r--r--lib/sqlalchemy/dialects/maxdb/base.py6
-rw-r--r--lib/sqlalchemy/dialects/mssql/base.py32
-rw-r--r--lib/sqlalchemy/dialects/mysql/base.py76
-rw-r--r--lib/sqlalchemy/dialects/oracle/base.py6
-rw-r--r--lib/sqlalchemy/dialects/oracle/cx_oracle.py4
-rw-r--r--lib/sqlalchemy/dialects/postgresql/base.py4
-rw-r--r--lib/sqlalchemy/dialects/sqlite/base.py2
-rw-r--r--lib/sqlalchemy/dialects/sybase/base.py12
-rw-r--r--lib/sqlalchemy/dialects/type_migration_guidelines.txt2
-rw-r--r--lib/sqlalchemy/sql/compiler.py8
-rw-r--r--lib/sqlalchemy/types.py73
-rw-r--r--test/dialect/test_mysql.py7
-rw-r--r--test/engine/test_reflection.py10
-rw-r--r--test/orm/inheritance/test_productspec.py2
-rw-r--r--test/orm/test_unitofwork.py2
-rw-r--r--test/sql/test_types.py12
21 files changed, 125 insertions, 160 deletions
diff --git a/CHANGES b/CHANGES
index 28feff967..326d64b1b 100644
--- a/CHANGES
+++ b/CHANGES
@@ -788,6 +788,12 @@ CHANGES
FLOAT, DECIMAL don't generate any length or scale unless
specified.
+ - types.Binary is renamed to types.LargeBinary, it only
+ produces BLOB, BYTEA, or a similar "long binary" type.
+ New base BINARY and VARBINARY
+ types have been added to access these MySQL/MS-SQL specific
+ types in an agnostic way [ticket:1664].
+
- String/Text/Unicode types now skip the unicode() check
on each result column value if the dialect has
detected the DBAPI as returning Python unicode objects
diff --git a/doc/build/reference/sqlalchemy/types.rst b/doc/build/reference/sqlalchemy/types.rst
index a22cf2ef7..0b26a83c2 100644
--- a/doc/build/reference/sqlalchemy/types.rst
+++ b/doc/build/reference/sqlalchemy/types.rst
@@ -38,9 +38,6 @@ database column type available on the target database when issuing a
type is emitted in ``CREATE TABLE``, such as ``VARCHAR`` see `SQL
Standard Types`_ and the other sections of this chapter.
-.. autoclass:: Binary
- :show-inheritance:
-
.. autoclass:: Boolean
:show-inheritance:
@@ -64,6 +61,9 @@ Standard Types`_ and the other sections of this chapter.
.. autoclass:: Interval
:show-inheritance:
+.. autoclass:: LargeBinary
+ :show-inheritance:
+
.. autoclass:: Numeric
:show-inheritance:
:members:
@@ -101,6 +101,9 @@ The SQL standard types always create database column types of the same
name when ``CREATE TABLE`` is issued. Some types may not be supported
on all databases.
+.. autoclass:: BINARY
+ :show-inheritance:
+
.. autoclass:: BLOB
:show-inheritance:
@@ -149,6 +152,9 @@ on all databases.
.. autoclass:: TIMESTAMP
:show-inheritance:
+.. autoclass:: VARBINARY
+ :show-inheritance:
+
.. autoclass:: VARCHAR
:show-inheritance:
diff --git a/lib/sqlalchemy/__init__.py b/lib/sqlalchemy/__init__.py
index 0fae80997..8aa293a6c 100644
--- a/lib/sqlalchemy/__init__.py
+++ b/lib/sqlalchemy/__init__.py
@@ -67,6 +67,7 @@ from sqlalchemy.types import (
INTEGER,
Integer,
Interval,
+ LargeBinary,
NCHAR,
NVARCHAR,
NUMERIC,
diff --git a/lib/sqlalchemy/dialects/access/base.py b/lib/sqlalchemy/dialects/access/base.py
index d665dbda1..a46ad247a 100644
--- a/lib/sqlalchemy/dialects/access/base.py
+++ b/lib/sqlalchemy/dialects/access/base.py
@@ -95,7 +95,7 @@ class AcChar(types.CHAR):
def get_col_spec(self):
return "TEXT" + (self.length and ("(%d)" % self.length) or "")
-class AcBinary(types.Binary):
+class AcBinary(types.LargeBinary):
def get_col_spec(self):
return "BINARY"
@@ -170,7 +170,7 @@ class AccessDialect(default.DefaultDialect):
types.DateTime : AcDateTime,
types.Date : AcDate,
types.String : AcString,
- types.Binary : AcBinary,
+ types.LargeBinary : AcBinary,
types.Boolean : AcBoolean,
types.Text : AcText,
types.CHAR: AcChar,
diff --git a/lib/sqlalchemy/dialects/informix/base.py b/lib/sqlalchemy/dialects/informix/base.py
index c11917c0f..2802d493a 100644
--- a/lib/sqlalchemy/dialects/informix/base.py
+++ b/lib/sqlalchemy/dialects/informix/base.py
@@ -65,7 +65,7 @@ ischema_names = {
7 : sqltypes.DATE, # DATE
8 : sqltypes.Numeric, # MONEY
10 : sqltypes.DATETIME, # DATETIME
- 11 : sqltypes.Binary, # BYTE
+ 11 : sqltypes.LargeBinary, # BYTE
12 : sqltypes.TEXT, # TEXT
13 : sqltypes.VARCHAR, # VARCHAR
15 : sqltypes.NCHAR, # NCHAR
@@ -85,7 +85,7 @@ class InfoTypeCompiler(compiler.GenericTypeCompiler):
def visit_TIME(self, type_):
return "DATETIME HOUR TO SECOND"
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return "BYTE"
def visit_boolean(self, type_):
diff --git a/lib/sqlalchemy/dialects/maxdb/base.py b/lib/sqlalchemy/dialects/maxdb/base.py
index 891547ac3..2e0b9518b 100644
--- a/lib/sqlalchemy/dialects/maxdb/base.py
+++ b/lib/sqlalchemy/dialects/maxdb/base.py
@@ -263,7 +263,7 @@ class MaxTime(sqltypes.Time):
return process
-class MaxBlob(sqltypes.Binary):
+class MaxBlob(sqltypes.LargeBinary):
def bind_processor(self, dialect):
def process(value):
if value is None:
@@ -306,7 +306,7 @@ class MaxDBTypeCompiler(compiler.GenericTypeCompiler):
def visit_string(self, type_):
return self._string_spec("VARCHAR", type_)
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return "LONG BYTE"
def visit_numeric(self, type_):
@@ -327,7 +327,7 @@ colspecs = {
sqltypes.Time: MaxTime,
sqltypes.String: MaxString,
sqltypes.Unicode:MaxUnicode,
- sqltypes.Binary: MaxBlob,
+ sqltypes.LargeBinary: MaxBlob,
sqltypes.Text: MaxText,
sqltypes.CHAR: MaxChar,
sqltypes.TIMESTAMP: MaxTimestamp,
diff --git a/lib/sqlalchemy/dialects/mssql/base.py b/lib/sqlalchemy/dialects/mssql/base.py
index 8f52c4b12..4e58d64b3 100644
--- a/lib/sqlalchemy/dialects/mssql/base.py
+++ b/lib/sqlalchemy/dialects/mssql/base.py
@@ -235,7 +235,8 @@ from sqlalchemy.engine import default, base, reflection
from sqlalchemy import types as sqltypes
from decimal import Decimal as _python_Decimal
from sqlalchemy.types import INTEGER, BIGINT, SMALLINT, DECIMAL, NUMERIC, \
- FLOAT, TIMESTAMP, DATETIME, DATE
+ FLOAT, TIMESTAMP, DATETIME, DATE, BINARY,\
+ VARBINARY, BLOB
from sqlalchemy.dialects.mssql import information_schema as ischema
@@ -592,13 +593,7 @@ class NCHAR(_StringType, sqltypes.NCHAR):
_StringType.__init__(self, collation)
sqltypes.NCHAR.__init__(self, *args, **kw)
-class BINARY(sqltypes.Binary):
- __visit_name__ = 'BINARY'
-
-class VARBINARY(sqltypes.Binary):
- __visit_name__ = 'VARBINARY'
-
-class IMAGE(sqltypes.Binary):
+class IMAGE(sqltypes.LargeBinary):
__visit_name__ = 'IMAGE'
class BIT(sqltypes.TypeEngine):
@@ -772,27 +767,12 @@ class MSTypeCompiler(compiler.GenericTypeCompiler):
else:
return self.visit_TIME(type_)
- def visit_binary(self, type_):
- if type_.length:
- return self.visit_BINARY(type_)
- else:
- return self.visit_IMAGE(type_)
-
- def visit_BINARY(self, type_):
- if type_.length:
- return "BINARY(%s)" % type_.length
- else:
- return "BINARY"
+ def visit_large_binary(self, type_):
+ return self.visit_IMAGE(type_)
def visit_IMAGE(self, type_):
return "IMAGE"
- def visit_VARBINARY(self, type_):
- if type_.length:
- return "VARBINARY(%s)" % type_.length
- else:
- return "VARBINARY"
-
def visit_boolean(self, type_):
return self.visit_BIT(type_)
@@ -1290,7 +1270,7 @@ class MSDialect(default.DefaultDialect):
coltype = self.ischema_names.get(type, None)
kwargs = {}
- if coltype in (MSString, MSChar, MSNVarchar, MSNChar, MSText, MSNText, MSBinary, MSVarBinary, sqltypes.Binary):
+ if coltype in (MSString, MSChar, MSNVarchar, MSNChar, MSText, MSNText, MSBinary, MSVarBinary, sqltypes.LargeBinary):
kwargs['length'] = charlen
if collation:
kwargs['collation'] = collation
diff --git a/lib/sqlalchemy/dialects/mysql/base.py b/lib/sqlalchemy/dialects/mysql/base.py
index e3235783c..1a85babe4 100644
--- a/lib/sqlalchemy/dialects/mysql/base.py
+++ b/lib/sqlalchemy/dialects/mysql/base.py
@@ -197,7 +197,8 @@ from sqlalchemy.engine import reflection
from sqlalchemy.engine import base as engine_base, default
from sqlalchemy import types as sqltypes
-from sqlalchemy.types import DATE, DATETIME, BOOLEAN, TIME
+from sqlalchemy.types import DATE, DATETIME, BOOLEAN, TIME, \
+ BLOB, BINARY, VARBINARY
RESERVED_WORDS = set(
['accessible', 'add', 'all', 'alter', 'analyze','and', 'as', 'asc',
@@ -305,11 +306,6 @@ class _StringType(sqltypes.String):
', '.join(['%s=%r' % (k, params[k]) for k in params]))
-class _BinaryType(sqltypes.Binary):
- """Base for MySQL binary types."""
-
- pass
-
class NUMERIC(_NumericType, sqltypes.NUMERIC):
"""MySQL NUMERIC type."""
@@ -826,62 +822,18 @@ class NCHAR(_StringType, sqltypes.NCHAR):
-class VARBINARY(_BinaryType):
- """MySQL VARBINARY type, for variable length binary data."""
-
- __visit_name__ = 'VARBINARY'
-
- def __init__(self, length=None, **kw):
- """Construct a VARBINARY. Arguments are:
-
- :param length: Maximum data length, in characters.
-
- """
- super(VARBINARY, self).__init__(length=length, **kw)
-
-class BINARY(_BinaryType):
- """MySQL BINARY type, for fixed length binary data"""
-
- __visit_name__ = 'BINARY'
-
- def __init__(self, length=None, **kw):
- """Construct a BINARY.
-
- This is a fixed length type, and short values will be right-padded
- with a server-version-specific pad value.
-
- :param length: Maximum data length, in bytes.
-
- """
- super(BINARY, self).__init__(length=length, **kw)
-class BLOB(_BinaryType, sqltypes.BLOB):
- """MySQL BLOB type, for binary data up to 2^16 bytes"""
-
- __visit_name__ = 'BLOB'
-
- def __init__(self, length=None, **kw):
- """Construct a BLOB. Arguments are:
-
- :param length: Optional, if provided the server may optimize storage
- by substituting the smallest TEXT type sufficient to store
- ``length`` characters.
-
- """
- super(BLOB, self).__init__(length=length, **kw)
-
-
-class TINYBLOB(_BinaryType):
+class TINYBLOB(sqltypes._Binary):
"""MySQL TINYBLOB type, for binary data up to 2^8 bytes."""
__visit_name__ = 'TINYBLOB'
-class MEDIUMBLOB(_BinaryType):
+class MEDIUMBLOB(sqltypes._Binary):
"""MySQL MEDIUMBLOB type, for binary data up to 2^24 bytes."""
__visit_name__ = 'MEDIUMBLOB'
-class LONGBLOB(_BinaryType):
+class LONGBLOB(sqltypes._Binary):
"""MySQL LONGBLOB type, for binary data up to 2^32 bytes."""
__visit_name__ = 'LONGBLOB'
@@ -1122,7 +1074,6 @@ MSInteger = INTEGER
colspecs = {
sqltypes.Numeric: NUMERIC,
sqltypes.Float: FLOAT,
- sqltypes.Binary: _BinaryType,
sqltypes.Time: _MSTime,
sqltypes.Enum: ENUM,
}
@@ -1217,7 +1168,7 @@ class MySQLCompiler(compiler.SQLCompiler):
return 'CHAR(%s)' % type_.length
else:
return 'CHAR'
- elif isinstance(type_, sqltypes.Binary):
+ elif isinstance(type_, sqltypes._Binary):
return 'BINARY'
elif isinstance(type_, NUMERIC):
return self.dialect.type_compiler.process(type_).replace('NUMERIC', 'DECIMAL')
@@ -1425,7 +1376,7 @@ class MySQLTypeCompiler(compiler.GenericTypeCompiler):
if c is not None])
def _mysql_type(self, type_):
- return isinstance(type_, (_StringType, _NumericType, _BinaryType))
+ return isinstance(type_, (_StringType, _NumericType))
def visit_NUMERIC(self, type_):
if type_.precision is None:
@@ -1564,12 +1515,9 @@ class MySQLTypeCompiler(compiler.GenericTypeCompiler):
return self._extend_string(type_, {'national':True}, "CHAR")
def visit_VARBINARY(self, type_):
- if type_.length:
- return "VARBINARY(%d)" % type_.length
- else:
- return self.visit_BLOB(type_)
+ return "VARBINARY(%d)" % type_.length
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_BLOB(type_)
def visit_enum(self, type_):
@@ -1578,12 +1526,6 @@ class MySQLTypeCompiler(compiler.GenericTypeCompiler):
else:
return self.visit_ENUM(type_)
- def visit_BINARY(self, type_):
- if type_.length:
- return "BINARY(%d)" % type_.length
- else:
- return "BINARY"
-
def visit_BLOB(self, type_):
if type_.length:
return "BLOB(%d)" % type_.length
diff --git a/lib/sqlalchemy/dialects/oracle/base.py b/lib/sqlalchemy/dialects/oracle/base.py
index 882505a40..926796961 100644
--- a/lib/sqlalchemy/dialects/oracle/base.py
+++ b/lib/sqlalchemy/dialects/oracle/base.py
@@ -122,7 +122,7 @@ from sqlalchemy.types import VARCHAR, NVARCHAR, CHAR, DATE, DATETIME, \
RESERVED_WORDS = set('''SHARE RAW DROP BETWEEN FROM DESC OPTION PRIOR LONG THEN DEFAULT ALTER IS INTO MINUS INTEGER NUMBER GRANT IDENTIFIED ALL TO ORDER ON FLOAT DATE HAVING CLUSTER NOWAIT RESOURCE ANY TABLE INDEX FOR UPDATE WHERE CHECK SMALLINT WITH DELETE BY ASC REVOKE LIKE SIZE RENAME NOCOMPRESS NULL GROUP VALUES AS IN VIEW EXCLUSIVE COMPRESS SYNONYM SELECT INSERT EXISTS NOT TRIGGER ELSE CREATE INTERSECT PCTFREE DISTINCT USER CONNECT SET MODE OF UNIQUE VARCHAR2 VARCHAR LOCK OR CHAR DECIMAL UNION PUBLIC AND START UID COMMENT'''.split())
-class RAW(sqltypes.Binary):
+class RAW(sqltypes.LargeBinary):
pass
OracleRaw = RAW
@@ -157,7 +157,7 @@ class DOUBLE_PRECISION(sqltypes.Numeric):
super(DOUBLE_PRECISION, self).__init__(precision=precision, scale=scale, asdecimal=asdecimal)
-class BFILE(sqltypes.Binary):
+class BFILE(sqltypes.LargeBinary):
__visit_name__ = 'BFILE'
class LONG(sqltypes.Text):
@@ -282,7 +282,7 @@ class OracleTypeCompiler(compiler.GenericTypeCompiler):
def visit_unicode_text(self, type_):
return self.visit_NCLOB(type_)
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_BLOB(type_)
def visit_big_integer(self, type_):
diff --git a/lib/sqlalchemy/dialects/oracle/cx_oracle.py b/lib/sqlalchemy/dialects/oracle/cx_oracle.py
index 6b1d7e5b9..d0058e454 100644
--- a/lib/sqlalchemy/dialects/oracle/cx_oracle.py
+++ b/lib/sqlalchemy/dialects/oracle/cx_oracle.py
@@ -160,7 +160,7 @@ class _OracleInteger(sqltypes.Integer):
return val
return to_int
-class _OracleBinary(_LOBMixin, sqltypes.Binary):
+class _OracleBinary(_LOBMixin, sqltypes.LargeBinary):
def get_dbapi_type(self, dbapi):
return dbapi.BLOB
@@ -176,7 +176,7 @@ class _OracleRaw(oracle.RAW):
colspecs = {
sqltypes.Date : _OracleDate,
- sqltypes.Binary : _OracleBinary,
+ sqltypes.LargeBinary : _OracleBinary,
sqltypes.Boolean : oracle._OracleBoolean,
sqltypes.Interval : _OracleInterval,
oracle.INTERVAL : _OracleInterval,
diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py
index bc5459f3a..cfbef69e8 100644
--- a/lib/sqlalchemy/dialects/postgresql/base.py
+++ b/lib/sqlalchemy/dialects/postgresql/base.py
@@ -83,7 +83,7 @@ from sqlalchemy.types import INTEGER, BIGINT, SMALLINT, VARCHAR, \
class REAL(sqltypes.Float):
__visit_name__ = "REAL"
-class BYTEA(sqltypes.Binary):
+class BYTEA(sqltypes.LargeBinary):
__visit_name__ = 'BYTEA'
class DOUBLE_PRECISION(sqltypes.Float):
@@ -476,7 +476,7 @@ class PGTypeCompiler(compiler.GenericTypeCompiler):
def visit_UUID(self, type_):
return "UUID"
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_BYTEA(type_)
def visit_BYTEA(self, type_):
diff --git a/lib/sqlalchemy/dialects/sqlite/base.py b/lib/sqlalchemy/dialects/sqlite/base.py
index 85f1157e0..93e62ec24 100644
--- a/lib/sqlalchemy/dialects/sqlite/base.py
+++ b/lib/sqlalchemy/dialects/sqlite/base.py
@@ -300,7 +300,7 @@ class SQLiteDDLCompiler(compiler.DDLCompiler):
return text
class SQLiteTypeCompiler(compiler.GenericTypeCompiler):
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_BLOB(type_)
class SQLiteIdentifierPreparer(compiler.IdentifierPreparer):
diff --git a/lib/sqlalchemy/dialects/sybase/base.py b/lib/sqlalchemy/dialects/sybase/base.py
index 63e1d01aa..cdbf6138d 100644
--- a/lib/sqlalchemy/dialects/sybase/base.py
+++ b/lib/sqlalchemy/dialects/sybase/base.py
@@ -99,7 +99,7 @@ RESERVED_WORDS = set([
])
-class SybaseImage(sqltypes.Binary):
+class SybaseImage(sqltypes.LargeBinary):
__visit_name__ = 'IMAGE'
class SybaseBit(sqltypes.TypeEngine):
@@ -135,7 +135,7 @@ class SybaseBoolean(sqltypes.Boolean):
return process
class SybaseTypeCompiler(compiler.GenericTypeCompiler):
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_IMAGE(type_)
def visit_boolean(self, type_):
@@ -157,7 +157,7 @@ class SybaseTypeCompiler(compiler.GenericTypeCompiler):
return "UNIQUEIDENTIFIER"
colspecs = {
- sqltypes.Binary : SybaseImage,
+ sqltypes.LargeBinary : SybaseImage,
sqltypes.Boolean : SybaseBoolean,
}
@@ -176,9 +176,9 @@ ischema_names = {
'numeric' : sqltypes.NUMERIC,
'float' : sqltypes.FLOAT,
'double' : sqltypes.Numeric,
- 'binary' : sqltypes.Binary,
- 'long binary' : sqltypes.Binary,
- 'varbinary' : sqltypes.Binary,
+ 'binary' : sqltypes.LargeBinary,
+ 'long binary' : sqltypes.LargeBinary,
+ 'varbinary' : sqltypes.LargeBinary,
'bit': SybaseBit,
'image' : SybaseImage,
'timestamp': sqltypes.TIMESTAMP,
diff --git a/lib/sqlalchemy/dialects/type_migration_guidelines.txt b/lib/sqlalchemy/dialects/type_migration_guidelines.txt
index 8ed1a1797..c26b65e08 100644
--- a/lib/sqlalchemy/dialects/type_migration_guidelines.txt
+++ b/lib/sqlalchemy/dialects/type_migration_guidelines.txt
@@ -139,7 +139,7 @@ a subclass of compiler.GenericTypeCompiler.
arguments and flags to those types.
d. the visit_lowercase methods are overridden to provide an interpretation of a generic
- type. E.g. visit_binary() might be overridden to say "return self.visit_BIT(type_)".
+ type. E.g. visit_large_binary() might be overridden to say "return self.visit_BIT(type_)".
e. visit_lowercase methods should *never* render strings directly - it should always
be via calling a visit_UPPERCASE() method.
diff --git a/lib/sqlalchemy/sql/compiler.py b/lib/sqlalchemy/sql/compiler.py
index 2d099e9d5..e635e20e1 100644
--- a/lib/sqlalchemy/sql/compiler.py
+++ b/lib/sqlalchemy/sql/compiler.py
@@ -1217,6 +1217,12 @@ class GenericTypeCompiler(engine.TypeCompiler):
def visit_BLOB(self, type_):
return "BLOB"
+
+ def visit_BINARY(self, type_):
+ return "BINARY" + (type_.length and "(%d)" % type_.length or "")
+
+ def visit_VARBINARY(self, type_):
+ return "VARBINARY" + (type_.length and "(%d)" % type_.length or "")
def visit_BOOLEAN(self, type_):
return "BOOLEAN"
@@ -1224,7 +1230,7 @@ class GenericTypeCompiler(engine.TypeCompiler):
def visit_TEXT(self, type_):
return "TEXT"
- def visit_binary(self, type_):
+ def visit_large_binary(self, type_):
return self.visit_BLOB(type_)
def visit_boolean(self, type_):
diff --git a/lib/sqlalchemy/types.py b/lib/sqlalchemy/types.py
index 5ed631a86..b4e9ba0cd 100644
--- a/lib/sqlalchemy/types.py
+++ b/lib/sqlalchemy/types.py
@@ -16,7 +16,7 @@ __all__ = [ 'TypeEngine', 'TypeDecorator', 'AbstractType', 'UserDefinedType',
'FLOAT', 'NUMERIC', 'DECIMAL', 'TIMESTAMP', 'DATETIME', 'CLOB',
'BLOB', 'BOOLEAN', 'SMALLINT', 'INTEGER', 'DATE', 'TIME',
'String', 'Integer', 'SmallInteger', 'BigInteger', 'Numeric',
- 'Float', 'DateTime', 'Date', 'Time', 'Binary', 'Boolean',
+ 'Float', 'DateTime', 'Date', 'Time', 'LargeBinary', 'Binary', 'Boolean',
'Unicode', 'MutableType', 'Concatenable', 'UnicodeText',
'PickleType', 'Interval', 'type_map', 'Enum' ]
@@ -845,29 +845,10 @@ class Time(TypeEngine):
def get_dbapi_type(self, dbapi):
return dbapi.DATETIME
-
-class Binary(TypeEngine):
- """A type for 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.
-
- """
-
- __visit_name__ = 'binary'
+class _Binary(TypeEngine):
+ """Define base behavior for binary types."""
def __init__(self, length=None):
- """
- Construct a Binary type.
-
- :param length: optional, a length for the column for use in
- DDL statements. 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.
-
- """
self.length = length
# Python 3 - sqlite3 doesn't need the `Binary` conversion
@@ -908,6 +889,40 @@ class Binary(TypeEngine):
def get_dbapi_type(self, dbapi):
return dbapi.BINARY
+
+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.
+
+ """
+
+ __visit_name__ = 'large_binary'
+
+ def __init__(self, length=None):
+ """
+ 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.
+
+ """
+ _Binary.__init__(self, length=length)
+
+class Binary(LargeBinary):
+ """Deprecated. Renamed to LargeBinary."""
+
+ def __init__(self, *arg, **kw):
+ util.warn_deprecated("The Binary type has been renamed to LargeBinary.")
+ LargeBinary.__init__(self, *arg, **kw)
class SchemaType(object):
"""Mark a type as possibly requiring schema-level DDL for usage.
@@ -1100,7 +1115,7 @@ class PickleType(MutableType, TypeDecorator):
"""
- impl = Binary
+ impl = LargeBinary
def __init__(self, protocol=pickle.HIGHEST_PROTOCOL, pickler=None, mutable=True, comparator=None):
"""
@@ -1398,11 +1413,21 @@ class NCHAR(Unicode):
__visit_name__ = 'NCHAR'
-class BLOB(Binary):
+class BLOB(LargeBinary):
"""The SQL BLOB type."""
__visit_name__ = 'BLOB'
+class BINARY(_Binary):
+ """The SQL BINARY type."""
+
+ __visit_name__ = 'BINARY'
+
+class VARBINARY(_Binary):
+ """The SQL VARBINARY type."""
+
+ __visit_name__ = 'VARBINARY'
+
class BOOLEAN(Boolean):
"""The SQL BOOLEAN type."""
diff --git a/test/dialect/test_mysql.py b/test/dialect/test_mysql.py
index 4a4197725..09213cf95 100644
--- a/test/dialect/test_mysql.py
+++ b/test/dialect/test_mysql.py
@@ -817,11 +817,10 @@ class ReflectionTest(TestBase, AssertsExecutionResults):
( mysql.MSSmallInteger(4), mysql.MSSmallInteger(4), ),
( mysql.MSMediumInteger(), mysql.MSMediumInteger(), ),
( mysql.MSMediumInteger(8), mysql.MSMediumInteger(8), ),
- ( Binary(3), mysql.TINYBLOB(), ),
- ( Binary(), mysql.BLOB() ),
+ ( LargeBinary(3), mysql.TINYBLOB(), ),
+ ( LargeBinary(), mysql.BLOB() ),
( mysql.MSBinary(3), mysql.MSBinary(3), ),
( mysql.MSVarBinary(3),),
- ( mysql.MSVarBinary(), mysql.MSBlob()),
( mysql.MSTinyBlob(),),
( mysql.MSBlob(),),
( mysql.MSBlob(1234), mysql.MSBlob()),
@@ -1081,7 +1080,7 @@ class SQLTest(TestBase, AssertsCompiledSQL):
(m.MSNChar, "CAST(t.col AS CHAR)"),
(m.MSNVarChar, "CAST(t.col AS CHAR)"),
- (Binary, "CAST(t.col AS BINARY)"),
+ (LargeBinary, "CAST(t.col AS BINARY)"),
(BLOB, "CAST(t.col AS BINARY)"),
(m.MSBlob, "CAST(t.col AS BINARY)"),
(m.MSBlob(32), "CAST(t.col AS BINARY)"),
diff --git a/test/engine/test_reflection.py b/test/engine/test_reflection.py
index bc2c896ab..95f985db3 100644
--- a/test/engine/test_reflection.py
+++ b/test/engine/test_reflection.py
@@ -32,9 +32,9 @@ class ReflectionTest(TestBase, ComparesTables):
sa.ForeignKey('engine_users.user_id')),
Column('test6', sa.Date, nullable=False),
Column('test7', sa.Text),
- Column('test8', sa.Binary),
+ Column('test8', sa.LargeBinary),
Column('test_passivedefault2', sa.Integer, server_default='5'),
- Column('test9', sa.Binary(100)),
+ Column('test9', sa.LargeBinary(100)),
Column('test10', sa.Numeric(10, 2)),
test_needs_fk=True,
)
@@ -951,9 +951,9 @@ def createTables(meta, schema=None):
parent_user_id,
Column('test6', sa.Date, nullable=False),
Column('test7', sa.Text),
- Column('test8', sa.Binary),
+ Column('test8', sa.LargeBinary),
Column('test_passivedefault2', sa.Integer, server_default='5'),
- Column('test9', sa.Binary(100)),
+ Column('test9', sa.LargeBinary(100)),
Column('test10', sa.Numeric(10, 2)),
schema=schema,
test_needs_fk=True,
@@ -1083,7 +1083,7 @@ class ComponentReflectionTest(TestBase):
).intersection(ctype_def.__mro__)
.intersection([sql_types.Integer, sql_types.Numeric,
sql_types.DateTime, sql_types.Date, sql_types.Time,
- sql_types.String, sql_types.Binary])
+ sql_types.String, sql_types._Binary])
) > 0
,("%s(%s), %s(%s)" % (col.name, col.type, cols[i]['name'],
ctype)))
diff --git a/test/orm/inheritance/test_productspec.py b/test/orm/inheritance/test_productspec.py
index 4c593e2a3..deb7564a8 100644
--- a/test/orm/inheritance/test_productspec.py
+++ b/test/orm/inheritance/test_productspec.py
@@ -37,7 +37,7 @@ class InheritTest(_base.MappedTest):
Column('last_updated', DateTime, default=lambda:datetime.now(),
onupdate=lambda:datetime.now()),
Column('name', String(128)),
- Column('data', Binary),
+ Column('data', LargeBinary),
Column('size', Integer, default=0),
)
diff --git a/test/orm/test_unitofwork.py b/test/orm/test_unitofwork.py
index 85a0eae82..265ce3fc0 100644
--- a/test/orm/test_unitofwork.py
+++ b/test/orm/test_unitofwork.py
@@ -337,7 +337,7 @@ class BinaryHistTest(_base.MappedTest, testing.AssertsExecutionResults):
def define_tables(cls, metadata):
Table('t1', metadata,
Column('id', sa.Integer, primary_key=True, test_needs_autoincrement=True),
- Column('data', sa.Binary),
+ Column('data', sa.LargeBinary),
)
@classmethod
diff --git a/test/sql/test_types.py b/test/sql/test_types.py
index b31015d85..4b7cba73c 100644
--- a/test/sql/test_types.py
+++ b/test/sql/test_types.py
@@ -63,9 +63,9 @@ class TypeAffinityTest(TestBase):
(Integer(), Integer(), True),
(Text(), String(), True),
(Text(), Unicode(), True),
- (Binary(), Integer(), False),
- (Binary(), PickleType(), True),
- (PickleType(), Binary(), True),
+ (LargeBinary(), Integer(), False),
+ (LargeBinary(), PickleType(), True),
+ (PickleType(), LargeBinary(), True),
(PickleType(), PickleType(), True),
]:
eq_(t1._compare_type_affinity(t2), comp, "%s %s" % (t1, t2))
@@ -466,8 +466,8 @@ class BinaryTest(TestBase, AssertsExecutionResults):
binary_table = Table('binary_table', MetaData(testing.db),
Column('primary_id', Integer, Sequence('binary_id_seq', optional=True), primary_key=True),
- Column('data', Binary),
- Column('data_slice', Binary(100)),
+ Column('data', LargeBinary),
+ Column('data_slice', LargeBinary(100)),
Column('misc', String(30)),
# construct PickleType with non-native pickle module, since cPickle uses relative module
# loading and confuses this test's parent package 'sql' with the 'sqlalchemy.sql' package relative
@@ -516,7 +516,7 @@ class BinaryTest(TestBase, AssertsExecutionResults):
binary_table.select(order_by=binary_table.c.primary_id),
text(
"select * from binary_table order by binary_table.primary_id",
- typemap={'pickled':PickleType, 'mypickle':MyPickleType, 'data':Binary, 'data_slice':Binary},
+ typemap={'pickled':PickleType, 'mypickle':MyPickleType, 'data':LargeBinary, 'data_slice':LargeBinary},
bind=testing.db)
):
l = stmt.execute().fetchall()