Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .spi.yml

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 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.

version: 1
Comment thread
DivineDominion marked this conversation as resolved.
builder:
configs:
- documentation_targets: [Arrow]
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ TODO: We should update this after we register this package to Swift Package Inde

## Getting Started

TODO: We should refer auto generated documentation on Swift Package Index after we register this package to Swift Package Index.
For API documentation and usage examples, see the [documentation on Swift Package Index](https://swiftpackageindex.com/apache/arrow-swift/documentation).

@DivineDominion DivineDominion Jan 19, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That link will start to work after the merge (when SPI picks up the changes)


## Getting involved

Expand Down
68 changes: 68 additions & 0 deletions Sources/Arrow/Arrow.docc/Arrow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<!--
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.
-->

# ``Arrow``

Apache Arrow: Columnar format for fast data interchange and in-memory analytics.

## Overview

Arrow provides a universal columnar data format optimized for efficient analytic operations. This Swift implementation enables you to:

- Read and write Arrow IPC file and streaming formats
- Build columnar data structures with typed arrays
- Work with record batches and tables
- Encode and decode Swift types to Arrow format
- Interoperate with other Arrow implementations via the C Data Interface

## Topics

### Reading and Writing Data

- ``ArrowReader``
- ``ArrowWriter``

### Core Data Structures

- ``ArrowTable``
- ``RecordBatch``
- ``ArrowColumn``
- ``ChunkedArray``

### Arrays

- ``ArrowArray``
- ``ArrowArrayBuilder``
- ``ArrowArrayHolder``

### Schema and Types

- ``ArrowSchema``
- ``ArrowField``
- ``ArrowType``

### Encoding and Decoding

- ``ArrowEncoder``
- ``ArrowDecoder``

### C Data Interface

- ``ArrowCExporter``
- ``ArrowCImporter``