hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-14 17:02:49 +03:00
Code Issues Projects Releases Wiki Activity

docs: add admin secret header

Browse Source 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/9323
GitOrigin-RevId: c4b08adcd75d0cc67551615c9e71c1dd7ab2ee05
This commit is contained in:
Rob Dominguez 2023-05-30 06:02:27 -05:00 committed by hasura-bot
parent 5b449909eb
commit 372b5b54c1
1 changed files with 17 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/docs/api-reference/pgdump.mdx
View File

@ -13,13 +13,11 @@ keywords:
## Introduction ## Introduction
The PG Dump API is an admin-only endpoint that can be used to execute The PG Dump API is an **admin-only** endpoint that can be used to execute `pg_dump` on the Postgres instance that Hasura
`pg_dump` on the Postgres instance that Hasura is configured with. is configured with.
The primary motive of this API is to provide convenience methods to The primary motive of this API is to provide convenience methods to initialize Migrations from an existing Hasura
initialize Migrations from an existing Hasura instance. But the instance. But the functionality can be later expanded to do other things such as taking a data dump, etc.
functionality can be later expanded to do other things such as taking a
data dump etc.
## Endpoint ## Endpoint
@ -33,6 +31,7 @@ All requests are `POST` requests to the `/v1alpha1/pg_dump` endpoint.
POST /v1alpha1/pg_dump HTTP/1.1 POST /v1alpha1/pg_dump HTTP/1.1
Content-Type: application/json Content-Type: application/json
X-Hasura-Role: admin X-Hasura-Role: admin
X-Hasura-Admin-Secret: <admin-secret>
{ {
"opts": ["-O", "-x", "--schema-only", "--schema", "public"], "opts": ["-O", "-x", "--schema-only", "--schema", "public"],
@ -41,15 +40,15 @@ X-Hasura-Role: admin
} }
``` ```
- `opts`: Arguments to be passed to the `pg_dump` tool. Represented as - `opts`: Arguments to be passed to the `pg_dump` tool. Represented as array of strings. The underlying command that is
array of strings. The underlying command that is executed is: executed is:
```bash ```bash
pg_dump $DATABASE_URL $OPTS -f $FILENAME pg_dump $DATABASE_URL $OPTS -f $FILENAME
``` ```
- `clean_output`: When this optional argument is set to `true`, the - `clean_output`: When this optional argument is set to `true`, the output SQL from the command is cleaned to remove the
output SQL from the command is cleaned to remove the following: following:
- SQL front matter, like SET statements. - SQL front matter, like SET statements.
- `CREATE SCHEMA public`. - `CREATE SCHEMA public`.
@ -57,8 +56,7 @@ X-Hasura-Role: admin
- Comments (`--`) and empty newlines. - Comments (`--`) and empty newlines.
- Postgres triggers created by Hasura for Event Triggers. - Postgres triggers created by Hasura for Event Triggers.
- `source`: the name of the connected database on which to run - `source`: the name of the connected database on which to run `pg_dump` on. If skipped, it is set to `default`
`pg_dump` on. If skipped, it is set to `default`
### Sample response ### Sample response
@ -84,13 +82,12 @@ ALTER TABLE ONLY public.author ALTER COLUMN id SET DEFAULT nextval('public.autho
## Disabling PG Dump API ## Disabling PG Dump API
Since this API can be used to dump all the Postgres data and schema, it Since this API can be used to dump all the Postgres data and schema, it can be disabled, especially in production
can be disabled, especially in production deployments. deployments.
The `enabled-apis` flag or the `HASURA_GRAPHQL_ENABLED_APIS` env var can The `enabled-apis` flag or the `HASURA_GRAPHQL_ENABLED_APIS` env var can be used to enable/disable this API. By default,
be used to enable/disable this API. By default, The PG DumpAPI is The PG DumpAPI is enabled. To disable it, you need to explicitly state that this API is not enabled. i.e. remove it from
enabled. To disable it, you need to explicitly state that this API is the list of enabled APIs.
not enabled. i.e. remove it from the list of enabled APIs.
```bash ```bash
# enable only graphql & Metadata apis, disable pgdump # enable only graphql & Metadata apis, disable pgdump
@ -98,4 +95,5 @@ not enabled. i.e. remove it from the list of enabled APIs.
HASURA_GRAPHQL_ENABLED_APIS="graphql,metadata" HASURA_GRAPHQL_ENABLED_APIS="graphql,metadata"
``` ```
See [GraphQL Engine server config reference](/deployment/graphql-engine-flags/reference.mdx) for info on setting the above flag/env var. See [GraphQL Engine server config reference](/deployment/graphql-engine-flags/reference.mdx) for info on setting the
above flag/env var.