GraphQL Engine server config reference

Introduction

Every GraphQL engine command is structured as:

$ graphql-engine <server-flags> serve <command-flags>

The flags can be passed as environment variables as well.

graphql-engine command flags / environment variables

For the graphql-engine command these are the available flags and environment variables:

Flag ENV variable Description
--database-url <DB_URL> HASURA_GRAPHQL_DATABASE_URL

Postgres database URL:

postgres://<user>:<password>@<host>:<port>/<db-name>

Example: postgres://admin:mypass@mydomain.com:5432/mydb
--metadata-database-url <METADATA-DATABASE-URL> HASURA_GRAPHQL_METADATA_DATABASE_URL

Postgres database URL that will be used to store the Hasura metadata. By default the database configured using HASURA_GRAPHQL_DATABASE_URL will be used to store the metadata.

postgres://<user>:<password>@<host>:<port>/<db-name>

Example: postgres://admin:mypass@mydomain.com:5432/metadata_db

(Available for versions > v2.0.0)

Or you can specify the following options (only via flags):

    --host                      Postgres server host
-p, --port                      Postgres server port
-u, --user                      Database user name
-p, --password                  Password of the user
-d, --dbname                    Database name to connect to
-o, --pg-connection-options     PostgreSQL connection options

Note

The default configuration of PostgreSQL 11 and older may result in loss of precision when retrieving IEEE 754 style data, such as float4, real or double precision values, from the database. To avoid this, set the extra_float_digits PostgreSQL connection parameter to 3. This can be done by passing '--pg-connection-options=-c extra_float_digits=3' to graphql-engine, or by passing this option as part of the database url:

postgres://admin:mypass@mydomain.com:5432/mydb?options=-c%20extra_float_digits%3D3

serve sub-command flags / environment variables

For the serve sub-command these are the available flags and environment variables:

Flag ENV variable Description
--server-port <PORT> HASURA_GRAPHQL_SERVER_PORT Port on which graphql-engine should be served (default: 8080)
--server-host <HOST> HASURA_GRAPHQL_SERVER_HOST Host on which graphql-engine will listen (default: *)
--enable-console <true|false> HASURA_GRAPHQL_ENABLE_CONSOLE Enable the Hasura Console (served by the server on / and /console) (default: false)
--admin-secret <ADMIN_SECRET_KEY> HASURA_GRAPHQL_ADMIN_SECRET Admin secret key, required to access this instance. This is mandatory when you use webhook or JWT.
--auth-hook <WEBHOOK_URL> HASURA_GRAPHQL_AUTH_HOOK URL of the authorization webhook required to authorize requests. See auth webhooks docs for more details.
--auth-hook-mode <GET|POST> HASURA_GRAPHQL_AUTH_HOOK_MODE HTTP method to use for the authorization webhook (default: GET)
--jwt-secret <JSON_CONFIG> HASURA_GRAPHQL_JWT_SECRET A JSON string containing type and the JWK used for verifying (and other optional details). Example: {"type": "HS256", "key": "3bd561c37d214b4496d09049fadc542c"}. See the JWT docs for more details.
--unauthorized-role <ROLE> HASURA_GRAPHQL_UNAUTHORIZED_ROLE Unauthorized role, used when access-key is not sent in access-key only mode or the Authorization header is absent in JWT mode. Example: anonymous. Now whenever the “authorization” header is absent, the request’s role will default to anonymous.
--cors-domain <DOMAINS> HASURA_GRAPHQL_CORS_DOMAIN CSV of list of domains, incuding scheme (http/https) and port, to allow for CORS. Wildcard domains are allowed. (See Configure CORS)
--disable-cors HASURA_GRAPHQL_DISABLE_CORS Disable CORS. Do not send any CORS headers on any request.
--ws-read-cookie <true|false> HASURA_GRAPHQL_WS_READ_COOKIE Read cookie on WebSocket initial handshake even when CORS is disabled. This can be a potential security flaw! Please make sure you know what you’re doing. This configuration is only applicable when CORS is disabled. (default: false)
--enable-telemetry <true|false> HASURA_GRAPHQL_ENABLE_TELEMETRY Enable anonymous telemetry (default: true)
N/A HASURA_GRAPHQL_EVENTS_HTTP_POOL_SIZE Maximum number of concurrent http workers delivering events at any time (default: 100)
N/A HASURA_GRAPHQL_EVENTS_FETCH_INTERVAL Interval in milliseconds to sleep before trying to fetch events again after a fetch returned no events from postgres
--events-fetch-batch-size HASURA_GRAPHQL_EVENTS_FETCH_BATCH_SIZE

Maximum number of events to be fetched from the DB in a single batch (default: 100)

(Available for versions > v2.0.0)
--async-actions-fetch-interval HASURA_GRAPHQL_ASYNC_ACTIONS_FETCH_INTERVAL

Interval in milliseconds to sleep before trying to fetch async actions again after a fetch returned no async actions from metadata storage. Value 0 implies completely disable fetching async actions from the storage.

(Available for versions > v2.0.0)
-s, --stripes <NO_OF_STRIPES> HASURA_GRAPHQL_PG_STRIPES Number of stripes (distinct sub-pools) to maintain with Postgres (default: 1). New connections will be taken from a particular stripe pseudo-randomly.
-c, --connections <NO_OF_CONNS> HASURA_GRAPHQL_PG_CONNECTIONS

Maximum number of Postgres connections that can be opened per stripe (default: 50). When the maximum is reached we will block until a new connection becomes available, even if there is capacity in other stripes.

(Deprecated in versions > v2.0.0. See details)
--timeout <SECONDS> HASURA_GRAPHQL_PG_TIMEOUT

Each connection’s idle time before it is closed (default: 180 sec)

(Deprecated in versions > v2.0.0. See details)
--use-prepared-statements <true|false> HASURA_GRAPHQL_USE_PREPARED_STATEMENTS

Use prepared statements for queries (default: true)

(Deprecated in versions > v2.0.0. See details)
-i, --tx-iso <TXISO> HASURA_GRAPHQL_TX_ISOLATION

Transaction isolation. read-committed / repeatable-read / serializable (default: read-committed)

(Deprecated in versions > v2.0.0. See details)
--retries <NO_OF_RETRIES> HASURA_GRAPHQL_NO_OF_RETRIES

Number of retries if Postgres connection error occurs (default: 1)

(Deprecated in versions > v2.0.0. See details)
--conn-lifetime <SECONDS> HASURA_GRAPHQL_PG_CONN_LIFETIME

Time from connection creation after which the connection should be destroyed and a new one created. A value of 0 indicates we should never destroy an active connection. If 0 is passed, memory from large query results may not be reclaimed. (default: 600 sec)

(Deprecated in versions > v2.0.0. See details)
--stringify-numeric-types HASURA_GRAPHQL_STRINGIFY_NUMERIC_TYPES Stringify certain Postgres numeric types, specifically bigint, numeric, decimal and double precision as they don’t fit into the IEEE-754 spec for JSON encoding-decoding. (default: false)
--enabled-apis <APIS> HASURA_GRAPHQL_ENABLED_APIS Comma separated list of APIs (options: metadata, graphql, pgdump, config) to be enabled. (default: metadata,graphql,pgdump,config)
--live-queries-multiplexed-refetch-interval HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_REFETCH_INTERVAL Updated results (if any) will be sent at most once in this interval (in milliseconds) for live queries which can be multiplexed. Default: 1000 (1sec)
--live-queries-multiplexed-batch-size HASURA_GRAPHQL_LIVE_QUERIES_MULTIPLEXED_BATCH_SIZE Multiplexed live queries are split into batches of the specified size. Default: 100
--enable-allowlist HASURA_GRAPHQL_ENABLE_ALLOWLIST Restrict queries allowed to be executed by the GraphQL engine to those that are part of the configured allow-list. Default: false
--console-assets-dir HASURA_GRAPHQL_CONSOLE_ASSETS_DIR Set the value to /srv/console-assets for the console to load assets from the server itself instead of CDN
--enabled-log-types HASURA_GRAPHQL_ENABLED_LOG_TYPES Set the enabled log types. This is a comma-separated list of log-types to enable. Default: startup, http-log, webhook-log, websocket-log. See log types for more details.
--log-level HASURA_GRAPHQL_LOG_LEVEL Set the logging level. Default: info. Options: debug, info, warn, error.
--dev-mode HASURA_GRAPHQL_DEV_MODE

Set dev mode for GraphQL requests; include the internal key in the errors extensions of the response (if required).

(Available for versions > v1.2.0)
--admin-internal-errors HASURA_GRAPHQL_ADMIN_INTERNAL_ERRORS

Include the internal key in the errors extensions of the response for GraphQL requests with the admin role (if required).

(Available for versions > v1.2.0)
--enable-remote-schema-permissions HASURA_GRAPHQL_ENABLE_REMOTE_SCHEMA_PERMISSIONS

Enable remote schema permissions (default: false)

(Available for versions > v2.0.0)
--infer-function-permissions HASURA_GRAPHQL_INFER_FUNCTION_PERMISSIONS

When the --infer-function-permissions flag is set to false, a function f, stable, immutable or volatile is only exposed for a role r if there is a permission defined on the function f for the role r, creating a function permission will only be allowed if there is a select permission on the table type.

When the --infer-function-permissions flag is set to true or the flag is omitted (defaults to true), the permission of the function is inferred from the select permissions from the target table of the function, only for stable/immutable functions. Volatile functions are not exposed to any of the roles in this case.

(Available for versions > v2.0.0)
--schema-sync-poll-interval HASURA_GRAPHQL_SCHEMA_SYNC_POLL_INTERVAL

Interval to poll metadata storage for updates in milliseconds - Default 1000 (1s) - Set to 0 to disable.

(Available for versions > v2.0.0)
--experimental-features HASURA_GRAPHQL_EXPERIMENTAL_FEATURES

List of experimental features to be enabled. A comma separated value is expected. Options: inherited_roles.

(Available for versions > v2.0.0)
--graceful-shutdown-timeout HASURA_GRAPHQL_GRACEFUL_SHUTDOWN_TIMEOUT

Timeout (in seconds) to wait for the in-flight events (event triggers and scheduled triggers) and async actions to complete before the server shuts down completely (default: 60 seconds). If the in-flight events are not completed within the timeout, those events are marked as pending.

(Available for versions > v2.0.0)
--enable-maintenance-mode HASURA_GRAPHQL_ENABLE_MAINTENANCE_MODE

Disable updating of metadata on the server (default: false)

(Available for versions > v2.0.0)
--websocket-compression HASURA_GRAPHQL_CONNECTION_COMPRESSION

Enable WebSocket permessage-deflate compression (default: false)

(Available for versions > v2.0.0)
--websocket-keepalive <SECONDS> HASURA_GRAPHQL_WEBSOCKET_KEEPALIVE

Used to set the Keep Alive delay for client that use the subscription-transport-ws (Apollo) protocol. For graphql-ws clients the graphql-engine sends PING messages instead.

(default: 5)

(Available for versions > v2.0.0)
--websocket-connection-init-timeout <SECONDS> HASURA_GRAPHQL_WEBSOCKET_CONNECTION_INIT_TIMEOUT

Used to set the connection initialisation timeout for graphql-ws clients. This is ignored for subscription-transport-ws (Apollo) clients.

(default: 3)

Note

When the equivalent flags for environment variables are used, the flags will take precedence.

« previous | next »
Want to contribute or report missing content?

Powered by Sphinx. | Copyright © 2021 Hasura.