OS Manuals

/usr/bin/graphql-engine

Hasura GraphQL Engine v2 - instant GraphQL APIs on PostgreSQL

From graphql-engine-2.51 2.51.4-r0 (enterprise-packages), captured 2026-11-08 by running graphql-engine --help (exit 1). permalink

Also provided by 9 other package versions
Hasura GraphQL Engine: Blazing fast, instant realtime GraphQL APIs on your DB
with fine grained access control, also trigger webhooks on database events.

Usage: graphql-engine [--retries NO OF RETRIES]
                      [--database-url <DATABASE-URL> | [--host <HOST>]
                        [-p|--port <PORT>] [-u|--user <USER>]
                        [--password <PASSWORD>] [-d|--dbname <DBNAME>]
                        [-o|--pg-connection-options <DATABASE-OPTIONS>]]
                      [--metadata-database-url <METADATA-DATABASE-URL>] COMMAND

Available options:
  -h,--help                Show this help text
  --retries NO OF RETRIES  No.of retries if Postgres connection error occurs
                           (default: 1)
  --database-url <DATABASE-URL>
                           Postgres database URL. Example
                           postgres://foo:bar@example.com:2345/database
  --host <HOST>            Postgres server host
  -p,--port <PORT>         Postgres server port
  -u,--user <USER>         Database user name
  --password <PASSWORD>    Password of the user
  -d,--dbname <DBNAME>     Database name to connect to
  -o,--pg-connection-options <DATABASE-OPTIONS>
                           PostgreSQL options
  --metadata-database-url <METADATA-DATABASE-URL>
                           Postgres database URL for Metadata storage. Example
                           postgres://foo:bar@example.com:2345/database This can
                           also be a URI of the form
                           graphql-engine: Uncaught exception ghc-internal:GHC.Internal.IO.Exception.IOException:

<stdout>: commitBuffer: invalid argument (cannot encode character '\8216')

HasCallStack backtrace:
  ioException, called at libraries/ghc-internal/src/GHC/Internal/IO/Encoding/Failure.hs:218:24 in ghc-internal:GHC.Internal.IO.Encoding.Failure
Options (10)
OptionDescriptionSource
-h, --helpShow this help texthelp
--retries NONo.of retries if Postgres connection error occurs (default: 1)help
--database-url DATABASE-URLPostgres database URL.help
--host HOSTPostgres server hosthelp
-p, --port PORTPostgres server porthelp
-u, --user USERDatabase user namehelp
--password PASSWORDPassword of the userhelp
-d, --dbname DBNAMEDatabase name to connect tohelp
-o, --pg-connection-options DATABASE-OPTIONSPostgreSQL optionshelp
--metadata-database-url METADATA-DATABASE-URLPostgres database URL for Metadata storage.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.