summaryrefslogtreecommitdiff
path: root/doc/build/dialects/postgresql.rst
blob: f2b401e9a57176695a8640fd71e86080fab1cd24 (plain)
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
.. _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, MACADDR, NUMERIC, REAL, SMALLINT, TEXT, TIME, \
        TIMESTAMP, UUID, VARCHAR, INT4RANGE, INT8RANGE, NUMRANGE, \
        DATERANGE, TSRANGE, TSTZRANGE

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
    :show-inheritance:

.. autoclass:: Any

.. autoclass:: All

.. autoclass:: BIT
    :members: __init__
    :show-inheritance:

.. autoclass:: BYTEA
    :members: __init__
    :show-inheritance:

.. autoclass:: CIDR
    :members: __init__
    :show-inheritance:

.. autoclass:: DOUBLE_PRECISION
    :members: __init__
    :show-inheritance:

.. autoclass:: ENUM
    :members: __init__, create, drop
    :show-inheritance:

.. autoclass:: HSTORE
    :members:
    :show-inheritance:

.. autoclass:: hstore
    :members:
    :show-inheritance:

.. autoclass:: INET
    :members: __init__
    :show-inheritance:

.. autoclass:: INTERVAL
    :members: __init__
    :show-inheritance:

.. autoclass:: MACADDR
    :members: __init__
    :show-inheritance:

.. autoclass:: REAL
    :members: __init__
    :show-inheritance:

.. autoclass:: UUID
    :members: __init__
    :show-inheritance:

.. autoclass:: sqlalchemy.dialects.postgresql.ranges.RangeOperators
    :members:

.. autoclass:: INT4RANGE
   :show-inheritance:

.. autoclass:: INT8RANGE
   :show-inheritance:

.. autoclass:: NUMRANGE
   :show-inheritance:

.. autoclass:: DATERANGE
   :show-inheritance:

.. autoclass:: TSRANGE
   :show-inheritance:

.. autoclass:: TSTZRANGE
   :show-inheritance:


PostgreSQL Constraint Types
---------------------------

SQLAlchemy supports Postgresql EXCLUDE constraints via the
:class:`ExcludeConstraint` class:

.. autoclass:: ExcludeConstraint
   :show-inheritance:
   :members: __init__

For example::

  from sqlalchemy.dialects.postgresql import (
      ExcludeConstraint,
      TSRANGE as Range,
      )

  class RoomBookings(Base):

      room = Column(Integer(), primary_key=True)
      during = Column(TSRANGE())

      __table_args__ = (
          ExcludeConstraint(('room', '='), ('during', '&&')),
      )

psycopg2
--------------

.. automodule:: sqlalchemy.dialects.postgresql.psycopg2

py-postgresql
--------------------

.. automodule:: sqlalchemy.dialects.postgresql.pypostgresql

pg8000
--------------

.. automodule:: sqlalchemy.dialects.postgresql.pg8000

zxjdbc
--------------

.. automodule:: sqlalchemy.dialects.postgresql.zxjdbc