Skip to content

Commit 7721ab8

Browse files
authored
Update Python IO docs (#853)
1 parent 49fd4cb commit 7721ab8

File tree

14 files changed

+581
-72
lines changed

14 files changed

+581
-72
lines changed

python/docs/api/io/arrow_ipc.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Arrow IPC
2+
3+
It's possible to read and write GeoArrow data to the [Arrow IPC format](https://arrow.apache.org/docs/python/ipc.html).
4+
5+
The Arrow IPC format is able to fully represent GeoArrow data. Loading such files back into memory will identically reproduce the prior data.
6+
7+
Arrow IPC generically supports GeoArrow data without any extra behavior, so the functionality to read and write Arrow IPC files lives in [`arro3`](https://github.com/kylebarron/arro3).
8+
9+
Refer to:
10+
11+
- [`arro3.io.read_ipc`][]
12+
- [`arro3.io.read_ipc_stream`][]
13+
- [`arro3.io.write_ipc`][]
14+
- [`arro3.io.write_ipc_stream`][]
15+
16+
When saved without any internal compression, the Arrow IPC format can also be memory-mapped, enabling faster reading.

python/docs/api/io/csv.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# CSV
2+
3+
Read and write CSV files with a geometry column encoded as Well-Known Text.
4+
5+
::: geoarrow.rust.io.read_csv
6+
::: geoarrow.rust.io.write_csv

python/docs/api/io/enums.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

python/docs/api/io/flatgeobuf.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# FlatGeobuf
2+
3+
Read and write [FlatGeobuf](https://flatgeobuf.org/) files.
4+
5+
::: geoarrow.rust.io.read_flatgeobuf
6+
::: geoarrow.rust.io.read_flatgeobuf_async
7+
::: geoarrow.rust.io.write_flatgeobuf

python/docs/api/io/functions.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

python/docs/api/io/gdal.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# GDAL
2+
3+
GDAL natively supports reading data from any vector driver as GeoArrow data, and natively supports writing data to any vector driver from GeoArrow data.
4+
5+
For reading and writing you have two options:
6+
7+
- You can use [`pyogrio`'s Arrow integration](https://pyogrio.readthedocs.io/en/latest/api.html#arrow-integration) directly
8+
- You can use the [`geoarrow.rust.core.read_pyogrio`][] wrapper.
9+
10+
This calls `pyogrio` under the hood (and requires that `pyogrio` is installed). The wrapper lives in `geoarrow.rust.core` because it has no dependency on any Rust IO code.

python/docs/api/io/geojson.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# GeoJSON
2+
3+
Read and write GeoJSON and newline-delimited GeoJSON files.
4+
5+
::: geoarrow.rust.io.read_geojson
6+
::: geoarrow.rust.io.read_geojson_lines
7+
::: geoarrow.rust.io.write_geojson
8+
::: geoarrow.rust.io.write_geojson_lines

python/docs/api/io/geoparquet.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# GeoParquet
2+
3+
Read and write [GeoParquet](https://geoparquet.org/) files.
4+
5+
::: geoarrow.rust.io.read_parquet
6+
::: geoarrow.rust.io.read_parquet_async
7+
::: geoarrow.rust.io.write_parquet
8+
::: geoarrow.rust.io.ParquetDataset
9+
::: geoarrow.rust.io.ParquetFile
10+
::: geoarrow.rust.io.ParquetWriter
11+
::: geoarrow.rust.io.types.BboxCovering
12+
::: geoarrow.rust.io.enums.GeoParquetEncoding
13+
::: geoarrow.rust.io.types.GeoParquetEncodingT

python/docs/api/io/postgis.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# PostGIS
2+
3+
Read from a PostGIS database.
4+
5+
::: geoarrow.rust.io.read_postgis
6+
::: geoarrow.rust.io.read_postgis_async

python/docs/api/io/types.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)