Package 'cozip'

Write a cozip archive in one call

Description

Wraps stage_metadata() + arrow::write_parquet() + stage_create(). For GeoParquet or custom write options, use the staging functions directly.

Usage

create(out_path, table, temp_dir = NULL)

write(out_path, table, temp_dir = NULL)

Arguments

out_path	Destination archive path.
table	arrow::Table with name and path.
temp_dir	Directory for the temp metadata parquet (defaults to tempdir()).

Value

Absolute path of the created archive.

---

Read the manifest of a FLAT-profile cozip archive

Description

Reads the byte-0 index natively, fetches only the ⁠__metadata__⁠ Parquet manifest, and decodes it with DuckDB, which loads no extension. name, offset, size (and cozip:location when location = TRUE) are always included; use columns to bring extras, NULL brings all. Archives using any profile other than Flat (profile = 1), including TACO (profile = 2), are rejected.

Usage

read(source, columns = NULL, location = TRUE)

Arguments

source	Local path or http(s)/s3/gcs/azure/hf URL to the .zip.
columns	Character vector of extra columns. NULL returns every column.
location	Include the cozip:location column.

Value

A tibble.

---

Pack a cozip archive from sources and a user-written parquet

Description

The metadata parquet is embedded verbatim, so any GeoParquet or schema metadata you wrote is preserved.

Usage

stage_create(out_path, paths, metadata_parquet, validate = TRUE)

Arguments

out_path	Destination archive path.
paths	data.frame with name and path in the same row order as metadata_parquet.
metadata_parquet	Path to a parquet with name, offset, size columns and no path column.
validate	If TRUE, re-runs the plan and checks that the parquet matches.

Value

Absolute path of the created archive.

---

Plan a cozip FLAT archive

Description

Computes offsets and sizes for the user entries and returns the canonical metadata table plus a row-aligned paths data.frame. The function checks each source and reads its file size; it does not read payload contents.

Usage

stage_metadata(table)

Arguments

table

arrow::Table with name and path. Extras are preserved in the metadata.

Details

If you reorder metadata before writing it, reorder paths the same way or stage_create() will reject the mismatch.

Value

List with metadata (arrow::Table) and paths (data.frame).

---