1.. Licensed to the Apache Software Foundation (ASF) under one
2.. or more contributor license agreements.  See the NOTICE file
3.. distributed with this work for additional information
4.. regarding copyright ownership.  The ASF licenses this file
5.. to you under the Apache License, Version 2.0 (the
6.. "License"); you may not use this file except in compliance
7.. with the License.  You may obtain a copy of the License at
8
9..   http://www.apache.org/licenses/LICENSE-2.0
10
11.. Unless required by applicable law or agreed to in writing,
12.. software distributed under the License is distributed on an
13.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14.. KIND, either express or implied.  See the License for the
15.. specific language governing permissions and limitations
16.. under the License.
17
18.. _api.types:
19.. currentmodule:: pyarrow
20
21Data Types and Schemas
22======================
23
24Factory Functions
25-----------------
26
27These should be used to create Arrow data types and schemas.
28
29.. autosummary::
30   :toctree: ../generated/
31
32   null
33   bool_
34   int8
35   int16
36   int32
37   int64
38   uint8
39   uint16
40   uint32
41   uint64
42   float16
43   float32
44   float64
45   time32
46   time64
47   timestamp
48   date32
49   date64
50   binary
51   string
52   utf8
53   large_binary
54   large_string
55   large_utf8
56   decimal128
57   list_
58   large_list
59   map_
60   struct
61   dictionary
62   field
63   schema
64   from_numpy_dtype
65
66.. _api.type_classes:
67.. currentmodule:: pyarrow
68
69Type Classes
70------------
71
72Do not instantiate these classes directly.  Instead, call one of the factory
73functions above.
74
75.. autosummary::
76   :toctree: ../generated/
77
78   DataType
79   DictionaryType
80   ListType
81   MapType
82   StructType
83   UnionType
84   TimestampType
85   Time32Type
86   Time64Type
87   FixedSizeBinaryType
88   Decimal128Type
89   Field
90   Schema
91
92Specific classes and functions for extension types.
93
94.. autosummary::
95   :toctree: ../generated/
96
97   ExtensionType
98   PyExtensionType
99   register_extension_type
100   unregister_extension_type
101
102
103.. _api.types.checking:
104.. currentmodule:: pyarrow.types
105
106Type Checking
107-------------
108
109These functions are predicates to check whether a :class:`DataType` instance
110represents a given data type (such as ``int32``) or general category
111(such as "is a signed integer").
112
113.. autosummary::
114   :toctree: ../generated/
115
116   is_boolean
117   is_integer
118   is_signed_integer
119   is_unsigned_integer
120   is_int8
121   is_int16
122   is_int32
123   is_int64
124   is_uint8
125   is_uint16
126   is_uint32
127   is_uint64
128   is_floating
129   is_float16
130   is_float32
131   is_float64
132   is_decimal
133   is_list
134   is_large_list
135   is_struct
136   is_union
137   is_nested
138   is_temporal
139   is_timestamp
140   is_date
141   is_date32
142   is_date64
143   is_time
144   is_time32
145   is_time64
146   is_null
147   is_binary
148   is_unicode
149   is_string
150   is_large_binary
151   is_large_unicode
152   is_large_string
153   is_fixed_size_binary
154   is_map
155   is_dictionary
156