diff --git a/docs/src/pgstac.md b/docs/src/pgstac.md index 4e53a584..8cb2c10e 100644 --- a/docs/src/pgstac.md +++ b/docs/src/pgstac.md @@ -10,11 +10,11 @@ PgSTAC installs everything into the pgstac schema in the database. This schema m #### PgSTAC Users -The pgstac_admin role is the owner of all the objects within pgstac and should be used when running things such as migrations. +The `pgstac_admin` role is the owner of all the objects within pgstac and should be used when running things such as migrations. -The pgstac_ingest role has read/write privileges on all tables and should be used for data ingest or if using the transactions extension with stac-fastapi-pgstac. +The `pgstac_ingest` role has read/write privileges on all tables and should be used for data ingest or if using the transactions extension with stac-fastapi-pgstac. -The pgstac_read role has read only access to the items and collections, but will still be able to write to the logging tables. +The `pgstac_read` role has read only access to the items and collections, but will still be able to write to the logging tables. You can use the roles either directly and adding a password to them or by granting them to a role you are already using. @@ -85,7 +85,7 @@ Note that when pgstac.readonly is set to TRUE that pgstac is unable to use a cac Runtime configuration of variables can be made with search by passing in configuration in the search json "conf" item. -Runtime configuration is available for context, context_estimated_count, context_estimated_cost, context_stats_ttl, and nohydrate. +Runtime configuration is available for **context**, **context_estimated_count**, **context_estimated_cost**, **context_stats_ttl**, and **nohydrate**. The nohydrate conf item returns an unhydrated item bypassing the CPU intensive step of rehydrating data with data from the collection metadata. When using the nohydrate conf, the only fields that are respected in the fields extension are geometry and bbox. ```sql diff --git a/docs/src/pypgstac.md b/docs/src/pypgstac.md index 25654904..ad14c4f1 100644 --- a/docs/src/pypgstac.md +++ b/docs/src/pypgstac.md @@ -4,20 +4,20 @@ PgSTAC includes a Python utility for bulk data loading and managing migrations. pyPgSTAC is available on PyPI ``` -pip install pypgstac +python -m pip install pypgstac ``` By default, pyPgSTAC does not install the `psycopg` dependency. If you want the database driver installed, use: ``` -pip install pypgstac[psycopg] +python -m pip install pypgstac[psycopg] ``` Or can be built locally ``` git clone https://github.com/stac-utils/pgstac cd pgstac/pypgstac -pip install . +python -m pip install . ``` ``` @@ -53,6 +53,7 @@ It can also take a DSN database url "postgresql://..." via the **--dsn** flag. pyPgSTAC has a utility to help apply migrations to an existing PgSTAC instance to bring it up to date. There are two types of migrations: + - **Base migrations** install PgSTAC into a database with no current PgSTAC installation. These migrations follow the file pattern `"pgstac.[version].sql"` - **Incremental migrations** are used to move PgSTAC from one version to the next. These migrations follow the file pattern `"pgstac.[version].[fromversion].sql"`