# Copyright (C) 2013-2023 the SQLAlchemy authors and contributors
|
# <see AUTHORS file>
|
#
|
# This module is part of SQLAlchemy and is released under
|
# the MIT License: https://www.opensource.org/licenses/mit-license.php
|
from __future__ import annotations
|
|
import datetime as dt
|
from typing import Any
|
from typing import Optional
|
from typing import overload
|
from typing import Type
|
from typing import TYPE_CHECKING
|
from uuid import UUID as _python_UUID
|
|
from ...sql import sqltypes
|
from ...sql import type_api
|
from ...util.typing import Literal
|
|
_DECIMAL_TYPES = (1231, 1700)
|
_FLOAT_TYPES = (700, 701, 1021, 1022)
|
_INT_TYPES = (20, 21, 23, 26, 1005, 1007, 1016)
|
|
|
class PGUuid(sqltypes.UUID[sqltypes._UUID_RETURN]):
|
render_bind_cast = True
|
render_literal_cast = True
|
|
if TYPE_CHECKING:
|
|
@overload
|
def __init__(
|
self: PGUuid[_python_UUID], as_uuid: Literal[True] = ...
|
) -> None:
|
...
|
|
@overload
|
def __init__(self: PGUuid[str], as_uuid: Literal[False] = ...) -> None:
|
...
|
|
def __init__(self, as_uuid: bool = True) -> None:
|
...
|
|
|
class BYTEA(sqltypes.LargeBinary):
|
__visit_name__ = "BYTEA"
|
|
|
class INET(sqltypes.TypeEngine[str]):
|
__visit_name__ = "INET"
|
|
|
PGInet = INET
|
|
|
class CIDR(sqltypes.TypeEngine[str]):
|
__visit_name__ = "CIDR"
|
|
|
PGCidr = CIDR
|
|
|
class MACADDR(sqltypes.TypeEngine[str]):
|
__visit_name__ = "MACADDR"
|
|
|
PGMacAddr = MACADDR
|
|
|
class MACADDR8(sqltypes.TypeEngine[str]):
|
__visit_name__ = "MACADDR8"
|
|
|
PGMacAddr8 = MACADDR8
|
|
|
class MONEY(sqltypes.TypeEngine[str]):
|
r"""Provide the PostgreSQL MONEY type.
|
|
Depending on driver, result rows using this type may return a
|
string value which includes currency symbols.
|
|
For this reason, it may be preferable to provide conversion to a
|
numerically-based currency datatype using :class:`_types.TypeDecorator`::
|
|
import re
|
import decimal
|
from sqlalchemy import Dialect
|
from sqlalchemy import TypeDecorator
|
|
class NumericMoney(TypeDecorator):
|
impl = MONEY
|
|
def process_result_value(
|
self, value: Any, dialect: Dialect
|
) -> None:
|
if value is not None:
|
# adjust this for the currency and numeric
|
m = re.match(r"\$([\d.]+)", value)
|
if m:
|
value = decimal.Decimal(m.group(1))
|
return value
|
|
Alternatively, the conversion may be applied as a CAST using
|
the :meth:`_types.TypeDecorator.column_expression` method as follows::
|
|
import decimal
|
from sqlalchemy import cast
|
from sqlalchemy import TypeDecorator
|
|
class NumericMoney(TypeDecorator):
|
impl = MONEY
|
|
def column_expression(self, column: Any):
|
return cast(column, Numeric())
|
|
.. versionadded:: 1.2
|
|
"""
|
|
__visit_name__ = "MONEY"
|
|
|
class OID(sqltypes.TypeEngine[int]):
|
|
"""Provide the PostgreSQL OID type."""
|
|
__visit_name__ = "OID"
|
|
|
class REGCONFIG(sqltypes.TypeEngine[str]):
|
|
"""Provide the PostgreSQL REGCONFIG type.
|
|
.. versionadded:: 2.0.0rc1
|
|
"""
|
|
__visit_name__ = "REGCONFIG"
|
|
|
class TSQUERY(sqltypes.TypeEngine[str]):
|
|
"""Provide the PostgreSQL TSQUERY type.
|
|
.. versionadded:: 2.0.0rc1
|
|
"""
|
|
__visit_name__ = "TSQUERY"
|
|
|
class REGCLASS(sqltypes.TypeEngine[str]):
|
|
"""Provide the PostgreSQL REGCLASS type.
|
|
.. versionadded:: 1.2.7
|
|
"""
|
|
__visit_name__ = "REGCLASS"
|
|
|
class TIMESTAMP(sqltypes.TIMESTAMP):
|
|
"""Provide the PostgreSQL TIMESTAMP type."""
|
|
__visit_name__ = "TIMESTAMP"
|
|
def __init__(
|
self, timezone: bool = False, precision: Optional[int] = None
|
) -> None:
|
"""Construct a TIMESTAMP.
|
|
:param timezone: boolean value if timezone present, default False
|
:param precision: optional integer precision value
|
|
.. versionadded:: 1.4
|
|
"""
|
super().__init__(timezone=timezone)
|
self.precision = precision
|
|
|
class TIME(sqltypes.TIME):
|
|
"""PostgreSQL TIME type."""
|
|
__visit_name__ = "TIME"
|
|
def __init__(
|
self, timezone: bool = False, precision: Optional[int] = None
|
) -> None:
|
"""Construct a TIME.
|
|
:param timezone: boolean value if timezone present, default False
|
:param precision: optional integer precision value
|
|
.. versionadded:: 1.4
|
|
"""
|
super().__init__(timezone=timezone)
|
self.precision = precision
|
|
|
class INTERVAL(type_api.NativeForEmulated, sqltypes._AbstractInterval):
|
|
"""PostgreSQL INTERVAL type."""
|
|
__visit_name__ = "INTERVAL"
|
native = True
|
|
def __init__(
|
self, precision: Optional[int] = None, fields: Optional[str] = None
|
) -> None:
|
"""Construct an INTERVAL.
|
|
:param precision: optional integer precision value
|
:param fields: string fields specifier. allows storage of fields
|
to be limited, such as ``"YEAR"``, ``"MONTH"``, ``"DAY TO HOUR"``,
|
etc.
|
|
.. versionadded:: 1.2
|
|
"""
|
self.precision = precision
|
self.fields = fields
|
|
@classmethod
|
def adapt_emulated_to_native(
|
cls, interval: sqltypes.Interval, **kw: Any # type: ignore[override]
|
) -> INTERVAL:
|
return INTERVAL(precision=interval.second_precision)
|
|
@property
|
def _type_affinity(self) -> Type[sqltypes.Interval]:
|
return sqltypes.Interval
|
|
def as_generic(self, allow_nulltype: bool = False) -> sqltypes.Interval:
|
return sqltypes.Interval(native=True, second_precision=self.precision)
|
|
@property
|
def python_type(self) -> Type[dt.timedelta]:
|
return dt.timedelta
|
|
|
PGInterval = INTERVAL
|
|
|
class BIT(sqltypes.TypeEngine[int]):
|
__visit_name__ = "BIT"
|
|
def __init__(
|
self, length: Optional[int] = None, varying: bool = False
|
) -> None:
|
if varying:
|
# BIT VARYING can be unlimited-length, so no default
|
self.length = length
|
else:
|
# BIT without VARYING defaults to length 1
|
self.length = length or 1
|
self.varying = varying
|
|
|
PGBit = BIT
|
|
|
class TSVECTOR(sqltypes.TypeEngine[str]):
|
|
"""The :class:`_postgresql.TSVECTOR` type implements the PostgreSQL
|
text search type TSVECTOR.
|
|
It can be used to do full text queries on natural language
|
documents.
|
|
.. seealso::
|
|
:ref:`postgresql_match`
|
|
"""
|
|
__visit_name__ = "TSVECTOR"
|
|
|
class CITEXT(sqltypes.TEXT):
|
|
"""Provide the PostgreSQL CITEXT type.
|
|
.. versionadded:: 2.0.7
|
|
"""
|
|
__visit_name__ = "CITEXT"
|
