class documentation

class INTERVAL(sqltypes.NativeForEmulated, sqltypes._AbstractInterval):

Known subclasses: sqlalchemy.dialects.oracle.cx_oracle._OracleInterval

View In Hierarchy

Undocumented

Method __init__ Construct an INTERVAL.
Class Method ​_adapt​_from​_generic​_interval Undocumented
Method as​_generic Return an instance of the generic type corresponding to this type using heuristic rule. The method may be overridden if this heuristic rule is not sufficient.
Method coerce​_compared​_value See .TypeEngine.coerce_compared_value for a description.
Class Variable __visit​_name__ Undocumented
Instance Variable day​_precision Undocumented
Instance Variable second​_precision Undocumented
Property ​_type​_affinity Return a rudimental 'affinity' value expressing the general class of type.

Inherited from NativeForEmulated:

Class Method adapt​_emulated​_to​_native Given an impl, adapt this type's class to the impl assuming "native".
Class Method adapt​_native​_to​_emulated Given an impl, adapt this type's class to the impl assuming "emulated".

Inherited from _AbstractInterval:

Property ​_expression​_adaptations Undocumented

Inherited from _LookupExpressionAdapter (via _AbstractInterval):

Class ​Comparator Undocumented

Inherited from TypeEngine (via _AbstractInterval):

Class ​Comparator Base class for custom comparison operations defined at the type level. See .TypeEngine.comparator_factory.
Method adapt Produce an "adapted" form of this type, given an "impl" class to work with.
Method bind​_expression Given a bind value (i.e. a .BindParameter instance), return a SQL expression in its place.
Method bind​_processor Return a conversion function for processing bind values.
Method column​_expression Given a SELECT column expression, return a wrapping SQL expression.
Method compare​_against​_backend Compare this type against the given backend type.
Method compare​_values Compare two values for equality.
Method compile Produce a string-compiled form of this .TypeEngine.
Method dialect​_impl Return a dialect-specific implementation for this .TypeEngine.
Method evaluates​_none Return a copy of this type which has the .should_evaluate_none flag set to True.
Method get​_dbapi​_type Return the corresponding type object from the underlying DB-API, if any.
Method literal​_processor Return a conversion function for processing literal values that are to be rendered directly without using binds.
Method result​_processor Return a conversion function for processing result row values.
Method with​_variant Produce a new type object that will utilize the given type when applied to the dialect of the given name.
Class Variable hashable Flag, if False, means values from this type aren't hashable.
Class Variable should​_evaluate​_none If True, the Python constant None is considered to be handled explicitly by this type.
Class Variable sort​_key​_function A sorting function that can be passed as the key to sorted.
Static Method ​_to​_instance Undocumented
Method __repr__ Undocumented
Method __str__ Undocumented
Method ​_cached​_bind​_processor Return a dialect-specific bind processor for this type.
Method ​_cached​_custom​_processor Undocumented
Method ​_cached​_literal​_processor Return a dialect-specific literal processor for this type.
Method ​_cached​_result​_processor Return a dialect-specific result processor for this type.
Method ​_compare​_type​_affinity Undocumented
Method ​_default​_dialect Undocumented
Method ​_dialect​_info Return a dialect-specific registry which caches a dialect-specific implementation, bind processing function, and one or more result processing functions.
Method ​_gen​_dialect​_impl Undocumented
Method ​_resolve​_for​_literal adjust this type given a literal Python value that will be stored in a bound parameter.
Method ​_unwrapped​_dialect​_impl Return the 'unwrapped' dialect impl for this type.
Method copy Undocumented
Method copy​_value Undocumented
Class Variable ​_is​_array Undocumented
Class Variable ​_is​_table​_value Undocumented
Class Variable ​_is​_tuple​_type Undocumented
Class Variable ​_is​_type​_decorator Undocumented
Class Variable ​_isnull Undocumented
Class Variable ​_sqla​_type Undocumented
Property ​_generic​_type​_affinity Undocumented
Property ​_has​_bind​_expression memoized boolean, check if bind_expression is implemented.
Property ​_has​_column​_expression memoized boolean, check if column_expression is implemented.
Property ​_static​_cache​_key Undocumented
Property python​_type Return the Python type object expected to be returned by instances of this type, if known.

Inherited from Traversible (via _AbstractInterval, TypeEngine):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented
def __init__(self, day_precision=None, second_precision=None):

Construct an INTERVAL.

Note that only DAY TO SECOND intervals are currently supported. This is due to a lack of support for YEAR TO MONTH intervals within available DBAPIs.

Parameters
day​_precisionthe day precision value. this is the number of digits to store for the day field. Defaults to "2"
second​_precisionthe second precision value. this is the number of digits to store for the fractional seconds field. Defaults to "6".
@classmethod
def _adapt_from_generic_interval(cls, interval):

Undocumented

def as_generic(self, allow_nulltype=False):

Return an instance of the generic type corresponding to this type using heuristic rule. The method may be overridden if this heuristic rule is not sufficient.

>>> from sqlalchemy.dialects.mysql import INTEGER
>>> INTEGER(display_width=4).as_generic()
Integer()
>>> from sqlalchemy.dialects.mysql import NVARCHAR
>>> NVARCHAR(length=100).as_generic()
Unicode(length=100)
New in version 1.4.0b2.

See Also

:ref:`metadata_reflection_dbagnostic_types` - describes the use of _types.TypeEngine.as_generic in conjunction with the _sql.DDLEvents.column_reflect event, which is its intended use.

def coerce_compared_value(self, op, value):
See .TypeEngine.coerce_compared_value for a description.
__visit_name__: str =

Undocumented

day_precision =

Undocumented

second_precision =

Undocumented

@property
_type_affinity =
Return a rudimental 'affinity' value expressing the general class of type.