Skip to content

Commit 1b678bd

Browse files
edit docs (#246)
1 parent 3419101 commit 1b678bd

File tree

2 files changed

+8
-7
lines changed

2 files changed

+8
-7
lines changed

docs/src/pgstac.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ PgSTAC installs everything into the pgstac schema in the database. This schema m
1010

1111

1212
#### PgSTAC Users
13-
The pgstac_admin role is the owner of all the objects within pgstac and should be used when running things such as migrations.
13+
The `pgstac_admin` role is the owner of all the objects within pgstac and should be used when running things such as migrations.
1414

15-
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.
15+
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.
1616

17-
The pgstac_read role has read only access to the items and collections, but will still be able to write to the logging tables.
17+
The `pgstac_read` role has read only access to the items and collections, but will still be able to write to the logging tables.
1818

1919
You can use the roles either directly and adding a password to them or by granting them to a role you are already using.
2020

@@ -85,7 +85,7 @@ Note that when pgstac.readonly is set to TRUE that pgstac is unable to use a cac
8585
8686
Runtime configuration of variables can be made with search by passing in configuration in the search json "conf" item.
8787
88-
Runtime configuration is available for context, context_estimated_count, context_estimated_cost, context_stats_ttl, and nohydrate.
88+
Runtime configuration is available for **context**, **context_estimated_count**, **context_estimated_cost**, **context_stats_ttl**, and **nohydrate**.
8989
9090
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.
9191
```sql

docs/src/pypgstac.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ PgSTAC includes a Python utility for bulk data loading and managing migrations.
44

55
pyPgSTAC is available on PyPI
66
```
7-
pip install pypgstac
7+
python -m pip install pypgstac
88
```
99

1010
By default, pyPgSTAC does not install the `psycopg` dependency. If you want the database driver installed, use:
1111

1212
```
13-
pip install pypgstac[psycopg]
13+
python -m pip install pypgstac[psycopg]
1414
```
1515

1616
Or can be built locally
1717
```
1818
git clone https://github.com/stac-utils/pgstac
1919
cd pgstac/pypgstac
20-
pip install .
20+
python -m pip install .
2121
```
2222

2323
```
@@ -53,6 +53,7 @@ It can also take a DSN database url "postgresql://..." via the **--dsn** flag.
5353
pyPgSTAC has a utility to help apply migrations to an existing PgSTAC instance to bring it up to date.
5454

5555
There are two types of migrations:
56+
5657
- **Base migrations** install PgSTAC into a database with no current PgSTAC installation. These migrations follow the file pattern `"pgstac.[version].sql"`
5758
- **Incremental migrations** are used to move PgSTAC from one version to the next. These migrations follow the file pattern `"pgstac.[version].[fromversion].sql"`
5859

0 commit comments

Comments
 (0)