Skip to content

Commit 98d326e

Browse files
authored
add notification about PG_SCHEMA for restoring postgres from an archive (#1087)
1 parent 57dafa3 commit 98d326e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

content/docs/en/resources/archive/stacks-api.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ There are two ways to restore a Stacks Blockchain API using the Hiro Archive. Th
2121

2222
This is the quickest and most direct method, and it is suitable for most scenarios. It consists of a backup of the API's Postgres database taken using `pg_dump`. We generally recommend starting with this method before attempting the method below if this one does not work for any reason.
2323

24+
:::callout
25+
type: info
26+
### Postgres Schema
27+
You will need to set the API `PG_SCHEMA` environment variable to: `PG_SCHEMA=stacks_blockchain_api` when restoring from an archive.
28+
:::
29+
2430
**Restore via tab-separated-values (TSV) file**
2531

2632
This method is several times slower than restoring from a Postgres dump. The API TSV file contains the raw unprocessed events from a Stacks blockchain node. The API can ingest this file to process events into a Postgres database.

0 commit comments

Comments
 (0)