1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
.. _postgresql_toplevel:
PostgreSQL
==========
.. automodule:: sqlalchemy.dialects.postgresql.base
PostgreSQL Data Types
------------------------
As with all SQLAlchemy dialects, all UPPERCASE types that are known to be
valid with Postgresql are importable from the top level dialect, whether
they originate from :mod:`sqlalchemy.types` or from the local dialect::
from sqlalchemy.dialects.postgresql import \
ARRAY, BIGINT, BIT, BOOLEAN, BYTEA, CHAR, CIDR, DATE, \
DOUBLE_PRECISION, ENUM, FLOAT, HSTORE, INET, INTEGER, \
INTERVAL, JSON, JSONB, MACADDR, NUMERIC, OID, REAL, SMALLINT, TEXT, \
TIME, TIMESTAMP, UUID, VARCHAR, INT4RANGE, INT8RANGE, NUMRANGE, \
DATERANGE, TSRANGE, TSTZRANGE, TSVECTOR
Types which are specific to PostgreSQL, or have PostgreSQL-specific
construction arguments, are as follows:
.. currentmodule:: sqlalchemy.dialects.postgresql
.. autoclass:: array
.. autoclass:: ARRAY
:members: __init__, Comparator
.. autoclass:: Any
.. autoclass:: All
.. autoclass:: BIT
:members: __init__
.. autoclass:: BYTEA
:members: __init__
.. autoclass:: CIDR
.. autoclass:: DOUBLE_PRECISION
:members: __init__
.. autoclass:: ENUM
:members: __init__, create, drop
.. autoclass:: HSTORE
:members:
.. autoclass:: hstore
:members:
.. autoclass:: INET
:members: __init__
.. autoclass:: INTERVAL
:members: __init__
.. autoclass:: JSON
:members:
.. autoclass:: JSONB
:members:
.. autoclass:: JSONElement
:members:
.. autoclass:: MACADDR
:members: __init__
.. autoclass:: OID
:members: __init__
.. autoclass:: REAL
:members: __init__
.. autoclass:: TSVECTOR
:members: __init__
.. autoclass:: UUID
:members: __init__
Range Types
~~~~~~~~~~~
The new range column types found in PostgreSQL 9.2 onwards are
catered for by the following types:
.. autoclass:: INT4RANGE
.. autoclass:: INT8RANGE
.. autoclass:: NUMRANGE
.. autoclass:: DATERANGE
.. autoclass:: TSRANGE
.. autoclass:: TSTZRANGE
The types above get most of their functionality from the following
mixin:
.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
:members:
.. warning::
The range type DDL support should work with any Postgres DBAPI
driver, however the data types returned may vary. If you are using
``psycopg2``, it's recommended to upgrade to version 2.5 or later
before using these column types.
When instantiating models that use these column types, you should pass
whatever data type is expected by the DBAPI driver you're using for
the column type. For :mod:`psycopg2` these are
:class:`~psycopg2.extras.NumericRange`,
:class:`~psycopg2.extras.DateRange`,
:class:`~psycopg2.extras.DateTimeRange` and
:class:`~psycopg2.extras.DateTimeTZRange` or the class you've
registered with :func:`~psycopg2.extras.register_range`.
For example:
.. code-block:: python
from psycopg2.extras import DateTimeRange
from sqlalchemy.dialects.postgresql import TSRANGE
class RoomBooking(Base):
__tablename__ = 'room_booking'
room = Column(Integer(), primary_key=True)
during = Column(TSRANGE())
booking = RoomBooking(
room=101,
during=DateTimeRange(datetime(2013, 3, 23), None)
)
PostgreSQL Constraint Types
---------------------------
SQLAlchemy supports Postgresql EXCLUDE constraints via the
:class:`ExcludeConstraint` class:
.. autoclass:: ExcludeConstraint
:members: __init__
For example::
from sqlalchemy.dialects.postgresql import ExcludeConstraint, TSRANGE
class RoomBooking(Base):
__tablename__ = 'room_booking'
room = Column(Integer(), primary_key=True)
during = Column(TSRANGE())
__table_args__ = (
ExcludeConstraint(('room', '='), ('during', '&&')),
)
psycopg2
--------------
.. automodule:: sqlalchemy.dialects.postgresql.psycopg2
pg8000
--------------
.. automodule:: sqlalchemy.dialects.postgresql.pg8000
psycopg2cffi
--------------
.. automodule:: sqlalchemy.dialects.postgresql.psycopg2cffi
py-postgresql
--------------------
.. automodule:: sqlalchemy.dialects.postgresql.pypostgresql
zxjdbc
--------------
.. automodule:: sqlalchemy.dialects.postgresql.zxjdbc
|
