![GeoParquet parakeets gathered around a map](geoparquet.jpg)

[![npm](https://img.shields.io/npm/v/geoparquet)](https://www.npmjs.com/package/geoparquet)
[![minzipped](https://img.shields.io/bundlephobia/minzip/geoparquet)](https://www.npmjs.com/package/geoparquet)
[![workflow status](https://github.com/hyparam/geoparquet/actions/workflows/ci.yml/badge.svg)](https://github.com/hyparam/geoparquet/actions)
[![mit license](https://img.shields.io/badge/License-MIT-orange.svg)](https://opensource.org/licenses/MIT)
![coverage](https://img.shields.io/badge/Coverage-95-darkred)
[![dependencies](https://img.shields.io/badge/Dependencies-1-blueviolet)](https://www.npmjs.com/package/geoparquet?activeTab=dependencies)

# GeoParquet is DEPRECATED

This GeoParquet JS library has been deprecated in favor of native support for GeoParquet in [hyparquet](https://github.com/hyparam/hyparquet).

We recommend using hyparquet directly for reading GeoParquet files:

```javascript
const { asyncBufferFromUrl, parquetReadObjects } = await import('hyparquet')

const file = await asyncBufferFromUrl({ url: 'example.parquet' })
const data = await parquetReadObjects({ file })
const geojson = {
  type: 'FeatureCollection',
  features: data.map(({ geometry, ...properties }) => ({
    type: 'Feature',
    geometry,
    properties,
  }))
}
```

# GeoParquet

**GeoParquet** provides a pure JavaScript workflow to read and convert [GeoParquet](https://github.com/opengeospatial/geoparquet) files into [GeoJSON](https://datatracker.ietf.org/doc/html/rfc7946). Under the hood, it uses the [hyparquet](https://github.com/hyparam/hyparquet) library for efficient in-browser parquet parsing, enabling minimal overhead and fast loading.

## Why GeoParquet?

**GeoParquet** is an emerging standard for storing geospatial vector data in the columnar [Parquet](https://parquet.apache.org/) format. By leveraging Parquet’s columnar storage, GeoParquet files can be significantly more compact and faster to query than their GeoJSON equivalents, especially for large datasets. This can result in:

- **Smaller file sizes:** A GeoParquet file plus this lightweight library can often be much smaller than the equivalent GeoJSON, reducing bandwidth costs and improving load times.
- **Faster loading:** Pure JavaScript parsing of Parquet files in the browser, with tiny package size means fast page load times.
- **Seamless integration:** GeoParquet is based on well-established standards (GeoJSON, Parquet), ensuring broad compatibility and extensibility.

## Demo

Check out the [live demo](https://hyparam.github.io/geoparquet/) to see GeoParquet in action.

## Parquet Compression Formats

By default, geoparquet.js supports the most common parquet compression formats: uncompressed and snappy compression.
To enable support for other compression codecs, such as gzip, brotli, zstd, etc you can use the `compressors` option.
The `hyparquet-compressors` package adds support for all parquet compression codecs:

```javascript
import { asyncBufferFromFile, toGeoJson } from 'geoparquet'
import { compressors } from 'hyparquet-compressors'

const file = asyncBufferFromFile('example.zstd.parquet')
const geoJson = toGeoJson({ file, compressors })
```

## References

 - https://geoparquet.org/
 - https://github.com/opengeospatial/geoparquet
 - https://geojson.org/
 - https://datatracker.ietf.org/doc/html/rfc7946
 - https://github.com/hyparam/hyparquet
 - https://github.com/hyparam/hyparquet-compressors
 - https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry