summaryrefslogtreecommitdiffstats
path: root/src/arrow/docs/source/status.rst
blob: 8e3e998dfb9c28ad5399dd7f0e68b432afbf7c05 (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
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
.. 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.

=====================
Implementation Status
=====================

The following tables summarize the features available in the various official
Arrow libraries.  Unless otherwise stated, the Python, R, Ruby and C/GLib
libraries follow the C++ Arrow library.

Data Types
==========

+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Data type         | C++   | Java  | Go    | JavaScript | C#    | Rust  | Julia |
| (primitive)       |       |       |       |            |       |       |       |
+===================+=======+=======+=======+============+=======+=======+=======+
| Null              | ✓     | ✓     | ✓     |            |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Boolean           | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Int8/16/32/64     | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| UInt8/16/32/64    | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Float16           |       |       | ✓     |            |       |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Float32/64        | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Decimal128        | ✓     | ✓     | ✓     |            |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Decimal256        | ✓     | ✓     |       |            |  ✓    |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Date32/64         | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Time32/64         | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Timestamp         | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Duration          | ✓     | ✓     | ✓     |            |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Interval          | ✓     | ✓     | ✓     |            |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Fixed Size Binary | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Binary            | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Large Binary      | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Utf8              | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Large Utf8        | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+

+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Data type         | C++   | Java  | Go    | JavaScript | C#    | Rust  | Julia |
| (nested)          |       |       |       |            |       |       |       |
+===================+=======+=======+=======+============+=======+=======+=======+
| Fixed Size List   | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| List              | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Large List        | ✓     | ✓     |       |            |       |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Struct            | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Map               | ✓     | ✓     | ✓     | ✓          |       |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Dense Union       | ✓     | ✓     |       |            |       |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Sparse Union      | ✓     | ✓     |       |            |       |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+

+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Data type         | C++   | Java  | Go    | JavaScript | C#    | Rust  | Julia |
| (special)         |       |       |       |            |       |       |       |
+===================+=======+=======+=======+============+=======+=======+=======+
| Dictionary        | ✓     | ✓ (1) |       | ✓ (1)      |       | ✓ (1) | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+
| Extension         | ✓     | ✓     | ✓     |            |       |       | ✓     |
+-------------------+-------+-------+-------+------------+-------+-------+-------+

Notes:

* \(1) Nested dictionaries not supported

.. seealso::
   The :ref:`format_columnar` specification.


IPC Format
==========

+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| IPC Feature                 | C++   | Java  | Go    | JavaScript | C#    | Rust  | Julia |
|                             |       |       |       |            |       |       |       |
+=============================+=======+=======+=======+============+=======+=======+=======+
| Arrow stream format         | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Arrow file format           | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Record batches              | ✓     | ✓     | ✓     | ✓          |  ✓    |  ✓    | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Dictionaries                | ✓     | ✓     | ✓     | ✓          |       |  ✓    | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Replacement dictionaries    | ✓     | ✓     |       |            |       |       | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Delta dictionaries          | ✓ (1) |       |       |            |       |       | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Tensors                     | ✓     |       |       |            |       |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Sparse tensors              | ✓     |       |       |            |       |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Buffer compression          | ✓     | ✓ (3) | ✓     |            |       |       | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Endianness conversion       | ✓ (2) |       |       |            |       |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Custom schema metadata      | ✓     | ✓     | ✓     |            |       |  ✓    | ✓     |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+

Notes:

* \(1) Delta dictionaries not supported on nested dictionaries

* \(2) Data with non-native endianness can be byte-swapped automatically when reading.

* \(3) LZ4 Codec currently is quite inefficient. ARROW-11901 tracks improving performance.

.. seealso::
   The :ref:`format-ipc` specification.


Flight RPC
==========

+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Flight RPC Feature          | C++   | Java  | Go    | JavaScript | C#    | Rust  | Julia |
|                             |       |       |       |            |       |       |       |
+=============================+=======+=======+=======+============+=======+=======+=======+
| gRPC transport              | ✓     | ✓     | ✓     |            | ✓ (1) |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| gRPC + TLS transport        | ✓     | ✓     | ✓     |            | ✓     |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| RPC error codes             | ✓     | ✓     | ✓     |            | ✓     |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Authentication handlers     | ✓     | ✓     | ✓     |            | ✓ (2) |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Custom client middleware    | ✓     | ✓     | ✓     |            |       |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+
| Custom server middleware    | ✓     | ✓     | ✓     |            |       |       |       |
+-----------------------------+-------+-------+-------+------------+-------+-------+-------+

Notes:

* \(1) No support for handshake or DoExchange.
* \(2) Support using AspNetCore authentication handlers.

.. seealso::
   The :ref:`flight-rpc` specification.


C Data Interface
================

+-----------------------------+-----+--------+---+------+----+------+--------+------+
| Feature                     | C++ | Python | R | Rust | Go | Java | C/GLib | Ruby |
|                             |     |        |   |      |    |      |        |      |
+=============================+=====+========+===+======+====+======+========+======+
| Schema export               | ✓   | ✓      | ✓ | ✓    | ✓  | ✓    | ✓      | ✓    |
+-----------------------------+-----+--------+---+------+----+------+--------+------+
| Array export                | ✓   | ✓      | ✓ | ✓    | ✓  | ✓    | ✓      | ✓    |
+-----------------------------+-----+--------+---+------+----+------+--------+------+
| Schema import               | ✓   | ✓      | ✓ | ✓    | ✓  | ✓    | ✓      | ✓    |
+-----------------------------+-----+--------+---+------+----+------+--------+------+
| Array import                | ✓   | ✓      | ✓ | ✓    | ✓  | ✓    | ✓      | ✓    |
+-----------------------------+-----+--------+---+------+----+------+--------+------+

.. seealso::
   The :ref:`C Data Interface <c-data-interface>` specification.


C Stream Interface (experimental)
=================================

+-----------------------------+-----+--------+----+--------+------+
| Feature                     | C++ | Python | Go | C/GLib | Ruby |
|                             |     |        |    |        |      |
+=============================+=====+========+====+========+======+
| Stream export               | ✓   | ✓      |    | ✓      | ✓    |
+-----------------------------+-----+--------+----+--------+------+
| Stream import               | ✓   | ✓      | ✓  | ✓      | ✓    |
+-----------------------------+-----+--------+----+--------+------+

.. seealso::
   The :ref:`C Stream Interface <c-stream-interface>` specification.


Third-Party Data Formats
========================

+-----------------------------+---------+---------+-------+------------+-------+---------+-------+
| Format                      | C++     | Java    | Go    | JavaScript | C#    | Rust    | Julia |
|                             |         |         |       |            |       |         |       |
+=============================+=========+=========+=======+============+=======+=========+=======+
| Avro                        |         | R       |       |            |       |         |       |
+-----------------------------+---------+---------+-------+------------+-------+---------+-------+
| CSV                         | R       |         | R/W   |            |       | R/W     | R/W   |
+-----------------------------+---------+---------+-------+------------+-------+---------+-------+
| ORC                         | R/W     | R (2)   |       |            |       |         |       |
+-----------------------------+---------+---------+-------+------------+-------+---------+-------+
| Parquet                     | R/W     | R (3)   |       |            |       | R/W (1) |       |
+-----------------------------+---------+---------+-------+------------+-------+---------+-------+

Notes:

* *R* = Read supported

* *W* = Write supported

* \(1) Nested read/write not supported.

* \(2) Through JNI bindings. (Provided by ``org.apache.arrow.orc:arrow-orc``)

* \(3) Through JNI bindings to Arrow C++ Datasets. (Provided by ``org.apache.arrow:arrow-dataset``)