pgstac
Schema, functions and a python library for storing and accessing STAC collections and items in PostgreSQL
File Explorer
Download Latest Version (.zip)- devcontainer.json
- migrations.instructions.md
- scripts.instructions.md
- sql-source.instructions.md
- add-sql-function.prompt.md
- stage-version.prompt.md
- continuous-integration.yml
- deploy_mkdocs.yml
- release.yml
- copilot-instructions.md
- dependabot.yml
- pgstac.sh
- Dockerfile
- Dockerfile
- benchmark.json
- contributing.md
- index.md
- item_size_analysis.ipynb
- pgstac-rs.md
- pgstac.md
- promoted-fields.md
- pypgstac.md
- release-notes.md
- mkdocs.yml
- format
- initpgstac
- loadsampledata
- makemigration
- pgstac_restore
- resetpgstac
- stageversion
- test
- cibuild
- console
- format
- loadsampledata
- makemigration
- migrate
- pgstac-rs-test-db
- pgstac-rs-test-rich-db
- pgstacenv
- runinpypgstac
- server
- setup
- stageversion
- test
- update
- pgstac--0.1.9--0.2.3.sql
- pgstac--0.1.9.sql
- pgstac--0.2.3--0.2.4.sql
- pgstac--0.2.3.sql
- pgstac--0.2.4--0.2.5.sql
- pgstac--0.2.4--0.2.7.sql
- pgstac--0.2.4.sql
- pgstac--0.2.5--0.2.7.sql
- pgstac--0.2.5.sql
- pgstac--0.2.7--0.2.8.sql
- pgstac--0.2.7.sql
- pgstac--0.2.8--0.2.9.sql
- pgstac--0.2.8.sql
- pgstac--0.2.9--0.3.0.sql
- pgstac--0.2.9.sql
- pgstac--0.3.0--0.3.1.sql
- pgstac--0.3.0.sql
- pgstac--0.3.1--0.3.2.sql
- pgstac--0.3.1.sql
- pgstac--0.3.2--0.3.3.sql
- pgstac--0.3.2.sql
- pgstac--0.3.3--0.3.4.sql
- pgstac--0.3.3.sql
- pgstac--0.3.4--0.3.5.sql
- pgstac--0.3.4.sql
- pgstac--0.3.5--0.3.6.sql
- pgstac--0.3.5.sql
- pgstac--0.3.6--0.4.0.sql
- pgstac--0.3.6.sql
- pgstac--0.4.0--0.4.1.sql
- pgstac--0.4.0.sql
- pgstac--0.4.1--0.4.2.sql
- pgstac--0.4.1.sql
- pgstac--0.4.2--0.4.3.sql
- pgstac--0.4.2.sql
- pgstac--0.4.3--0.4.4.sql
- pgstac--0.4.3.sql
- pgstac--0.4.4--0.4.5.sql
- pgstac--0.4.4.sql
- pgstac--0.4.5--0.5.0.sql
- pgstac--0.4.5.sql
- pgstac--0.5.0--0.5.1.sql
- pgstac--0.5.0.sql
- pgstac--0.5.1--0.6.0.sql
- pgstac--0.5.1.sql
- pgstac--0.6.0--0.6.1.sql
- pgstac--0.6.0.sql
- pgstac--0.6.1--0.6.2.sql
- pgstac--0.6.1.sql
- pgstac--0.6.10--0.6.11.sql
- pgstac--0.6.10.sql
- pgstac--0.6.11--0.6.12.sql
- pgstac--0.6.11.sql
- pgstac--0.6.12--0.6.13.sql
- pgstac--0.6.12.sql
- pgstac--0.6.13--0.7.0.sql
- pgstac--0.6.13--0.7.3.sql
- pgstac--0.6.13.sql
- pgstac--0.6.2--0.6.3.sql
- pgstac--0.6.2.sql
- pgstac--0.6.3--0.6.4.sql
- pgstac--0.6.3.sql
- pgstac--0.6.4--0.6.5.sql
- pgstac--0.6.4.sql
- pgstac--0.6.5--0.6.6.sql
- pgstac--0.6.5.sql
- pgstac--0.6.6--0.6.7.sql
- pgstac--0.6.6.sql
- pgstac--0.6.7--0.6.8.sql
- pgstac--0.6.7.sql
- pgstac--0.6.8--0.6.9.sql
- pgstac--0.6.8.sql
- pgstac--0.6.9--0.6.10.sql
- pgstac--0.6.9.sql
- pgstac--0.7.0--0.7.1.sql
- pgstac--0.7.0.sql
- pgstac--0.7.1--0.7.2.sql
- pgstac--0.7.1.sql
- pgstac--0.7.10--0.8.0.sql
- pgstac--0.7.10.sql
- pgstac--0.7.2--0.7.3.sql
- pgstac--0.7.2.sql
- pgstac--0.7.3--0.7.4.sql
- pgstac--0.7.3.sql
- pgstac--0.7.4--0.7.5.sql
- pgstac--0.7.4.sql
- pgstac--0.7.5--0.7.6.sql
- pgstac--0.7.5.sql
- pgstac--0.7.6--0.7.7.sql
- pgstac--0.7.6.sql
- pgstac--0.7.7--0.7.8.sql
- pgstac--0.7.7.sql
- pgstac--0.7.8--0.7.9.sql
- pgstac--0.7.8.sql
- pgstac--0.7.9--0.7.10.sql
- pgstac--0.7.9.sql
- pgstac--0.8.0--0.8.1.sql
- pgstac--0.8.0.sql
- pgstac--0.8.1--0.8.2.sql
- pgstac--0.8.1.sql
- pgstac--0.8.2--0.8.3.sql
- pgstac--0.8.2.sql
- pgstac--0.8.3--0.8.4.sql
- pgstac--0.8.3.sql
- pgstac--0.8.4--0.8.5.sql
- pgstac--0.8.4.sql
- pgstac--0.8.5--0.9.0.sql
- pgstac--0.8.5.sql
- pgstac--0.8.6--0.9.0.sql
- pgstac--0.8.6--0.9.10.sql
- pgstac--0.8.6.sql
- pgstac--0.9.0--0.9.1.sql
- pgstac--0.9.0.sql
- pgstac--0.9.1--0.9.2.sql
- pgstac--0.9.1.sql
- pgstac--0.9.10--0.9.11.sql
- pgstac--0.9.10.sql
- pgstac--0.9.11--unreleased.sql
- pgstac--0.9.11.sql
- pgstac--0.9.2--0.9.3.sql
- pgstac--0.9.2.sql
- pgstac--0.9.3--0.9.4.sql
- pgstac--0.9.3.sql
- pgstac--0.9.4--0.9.5.sql
- pgstac--0.9.4.sql
- pgstac--0.9.5--0.9.6.sql
- pgstac--0.9.5.sql
- pgstac--0.9.6--0.9.7.sql
- pgstac--0.9.6.sql
- pgstac--0.9.7--0.9.8.sql
- pgstac--0.9.7.sql
- pgstac--0.9.8--0.9.9.sql
- pgstac--0.9.8.sql
- pgstac--0.9.9--0.9.10.sql
- pgstac--0.9.9.sql
- pgstac--unreleased.sql
- 000_idempotent_pre.sql
- 001_core.sql
- 001a_jsonutils.sql
- 001s_stacutils.sql
- 002_collections.sql
- 002a_queryables.sql
- 002b_cql.sql
- 002c_envelope.sql
- 002d_keyset.sql
- 003a_items.sql
- 003b_partitions.sql
- 003c_ingest.sql
- 004_search.sql
- 004a_collectionsearch.sql
- 005_tileutils.sql
- 006_tilesearch.sql
- 997_maintenance.sql
- 998_idempotent_post.sql
- 999_version.sql
- collection_searches.sql
- collection_searches.sql.out
- cql2_searches.sql
- cql2_searches.sql.out
- cql_searches.sql
- cql_searches.sql.out
- crud_functions.sql
- crud_functions.sql.out
- free_text.sql
- free_text.sql.out
- hydration.sql
- hydration.sql.out
- partitions.sql
- partitions.sql.out
- search_path.sql
- search_path.sql.out
- xyz_searches.sql
- xyz_searches.sql.out
- 000_privileges.sql
- 001_core.sql
- 001a_jsonutils.sql
- 001b_cursorutils.sql
- 001s_stacutils.sql
- 002_collections.sql
- 002a_queryables.sql
- 002c_envelope.sql
- 003_items.sql
- 004_search.sql
- 004a_collectionsearch.sql
- 005_tileutils.sql
- 006_tilesearch.sql
- 9999_readonly.sql
- 999_version.sql
- collection.json
- items.ndjson
- collection.json
- items.ndjson
- collection.json
- items.ndjson
- .gitkeep
- fixture-summary.json
- collections.ndjson
- collections.json
- collections.ndjson
- items.ndjson
- items.pgcopy
- items_duplicate_ids.ndjson
- items_for_delsert.ndjson
- items_private.ndjson
- pgtap.sql
- plpgsql_check.sql
- pgstac.sql
- pyproject.toml
- build_artifact.py
- __init__.py
- api.py
- build.py
- cli.py
- compat.py
- version_source.py
- test_api.py
- test_cli.py
- test_parity.py
- test_version_source.py
- pyproject.toml
- README.md
- uv.lock
- mod.rs
- stac_api.rs
- pgstac.rs
- call.rs
- client.rs
- connect.rs
- mod.rs
- pool.rs
- tls.rs
- budget.rs
- format.rs
- manifest.rs
- metadata.rs
- mod.rs
- parallel.rs
- plan.rs
- planner.rs
- sink.rs
- canonical.rs
- geom.rs
- mod.rs
- rawjson.rs
- temporal.rs
- dehydrate.rs
- extensions.rs
- field_registry.rs
- fragment.rs
- ingest.rs
- mod.rs
- parquet_decode.rs
- pool_ingest.rs
- queryables.rs
- mod.rs
- collections.rs
- feature.rs
- fields.rs
- hydrate.rs
- keyset.rs
- mod.rs
- page.rs
- search.rs
- source.rs
- stream.rs
- lib.rs
- stream_collection.rs
- canonical_parity.rs
- cli.rs
- client.rs
- collections.rs
- concurrency.rs
- dehydrate_parity.rs
- dump_e2e.rs
- dump_followups.rs
- extensions.rs
- fragment_parity.rs
- hydrate_parity.rs
- ingest_copy.rs
- ingest_load.rs
- pool_ingest.rs
- profile_search.rs
- queryables.rs
- search_dimensions.rs
- search_page.rs
- stream.rs
- .gitignore
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- pyproject.toml
- README.md
- .dockerignore
- .editorconfig
- .env.example
- .gitignore
- .pre-commit-config.yaml
- AGENTS.md
- CHANGELOG.md
- CLAUDE.md
- CONTRIBUTING.md
- docker-compose.yml
- LICENSE
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/stac-utils/pgstac
Downloads the entire project code from GitHub to your computer.
cd pgstac
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up -d --build
Builds and starts all defined containers (server, database, etc.) at once, in the background.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. Python
EasyPrerequisites
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install .
Installs the package published on PyPI directly β no need to clone the source.
jupyter notebook
Launches Jupyter in your browser so you can open and run the notebook (.ipynb) files.
If it runs without errors and prints output in the terminal, it worked.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
β οΈ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd src/pgstac-rs
This project's files live in a subfolder, so move into it first.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation
Was this content helpful?
(0 ratings)