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
210
211
212
213
214
215
216
217
218
219
220
|
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.
.. _api.types:
.. currentmodule:: pyarrow
Data Types and Schemas
======================
Factory Functions
-----------------
These should be used to create Arrow data types and schemas.
.. autosummary::
:toctree: ../generated/
null
bool_
int8
int16
int32
int64
uint8
uint16
uint32
uint64
float16
float32
float64
time32
time64
timestamp
date32
date64
duration
month_day_nano_interval
binary
string
utf8
large_binary
large_string
large_utf8
binary_view
string_view
decimal128
decimal256
list_
large_list
list_view
large_list_view
map_
struct
dictionary
run_end_encoded
fixed_shape_tensor
union
dense_union
sparse_union
opaque
bool8
uuid
json_
field
schema
from_numpy_dtype
Utility Functions
-----------------
.. autosummary::
:toctree: ../generated/
unify_schemas
.. _api.type_classes:
.. currentmodule:: pyarrow
Type Classes
------------
Do not instantiate these classes directly. Instead, call one of the factory
functions above.
.. autosummary::
:toctree: ../generated/
DataType
DictionaryType
ListType
ListViewType
FixedSizeListType
LargeListType
LargeListViewType
MapType
StructType
UnionType
DenseUnionType
SparseUnionType
TimestampType
Time32Type
Time64Type
DurationType
FixedSizeBinaryType
Decimal32Type
Decimal64Type
Decimal128Type
Decimal256Type
Field
Schema
RunEndEncodedType
Specific classes and functions for extension types.
.. autosummary::
:toctree: ../generated/
BaseExtensionType
ExtensionType
UnknownExtensionType
register_extension_type
unregister_extension_type
:doc:`Canonical extension types <../../format/CanonicalExtensions>`
implemented by PyArrow.
.. autosummary::
:toctree: ../generated/
FixedShapeTensorType
OpaqueType
JsonType
UuidType
Bool8Type
.. _api.types.checking:
.. currentmodule:: pyarrow.types
Type Checking
-------------
These functions are predicates to check whether a :class:`DataType` instance
represents a given data type (such as ``int32``) or general category
(such as "is a signed integer").
.. autosummary::
:toctree: ../generated/
is_boolean
is_integer
is_signed_integer
is_unsigned_integer
is_int8
is_int16
is_int32
is_int64
is_uint8
is_uint16
is_uint32
is_uint64
is_floating
is_float16
is_float32
is_float64
is_decimal
is_decimal128
is_decimal256
is_list
is_large_list
is_fixed_size_list
is_list_view
is_large_list_view
is_struct
is_union
is_nested
is_run_end_encoded
is_temporal
is_timestamp
is_date
is_date32
is_date64
is_time
is_time32
is_time64
is_duration
is_interval
is_null
is_binary
is_unicode
is_string
is_large_binary
is_large_unicode
is_large_string
is_binary_view
is_string_view
is_fixed_size_binary
is_map
is_dictionary
is_primitive
Types enum that can be used for direct type checking.
.. autosummary::
:toctree: ../generated/
TypesEnum
|
