OS Manuals

/usr/bin/peerdb-server

PeerDB SQL gateway (nexus) - Postgres-wire compatible frontend for PeerDB

From peerdb-server 0.37.15-r1 (enterprise-packages), captured 2026-11-08 by running peerdb-server --help (exit 0). permalink

Arguments for the nexus server

Usage: peerdb-server [OPTIONS]

Options:
      --host <HOST>
          Host to bind to, defaults to localhost

          [env: PEERDB_HOST=]
          [default: 0.0.0.0]

  -p, --port <PORT>
          Port of the server, defaults to `9900`

          [env: PEERDB_PORT=]
          [default: 9900]

      --catalog-host <CATALOG_HOST>
          Catalog postgres server host. Defaults to `localhost`

          [env: PEERDB_CATALOG_HOST=]
          [default: localhost]

      --catalog-port <CATALOG_PORT>
          Catalog postgres server port. Defaults to `5432`

          [env: PEERDB_CATALOG_PORT=]
          [default: 5432]

      --catalog-user <CATALOG_USER>
          Catalog postgres server user. Defaults to `postgres`

          [env: PEERDB_CATALOG_USER=]
          [default: postgres]

      --catalog-password <CATALOG_PASSWORD>
          Catalog postgres server password. Defaults to `postgres`

          [env: PEERDB_CATALOG_PASSWORD=]
          [default: postgres]

      --catalog-database <CATALOG_DATABASE>
          Catalog postgres server database. Defaults to `postgres`

          [env: PEERDB_CATALOG_DATABASE=]
          [default: postgres]

      --tls-cert <TLS_CERT>
          Path to the TLS certificate file

          [env: PEERDB_TLS_CERT=]

      --tls-key <TLS_KEY>
          Path to the TLS private key file

          [env: PEERDB_TLS_KEY=]

  -l, --log-dir <LOG_DIR>
          Path to the directory where peerdb logs will be written to

          [env: PEERDB_LOG_DIR=]

      --peerdb-password <PEERDB_PASSWORD>
          Password for the  postgres interface.

          Defaults to `peerdb`.

          [env: PEERDB_PASSWORD=]
          [default: peerdb]

      --flow-api-url <FLOW_API_URL>
          Points to the URL for the Flow API server.

          This is an optional parameter. If not provided, the MIRROR commands will not be supported.

          [env: PEERDB_FLOW_SERVER_ADDRESS=]

      --peerdb-fdw-mode
          [env: PEERDB_FDW_MODE=]

      --kms-key-id <KMS_KEY_ID>
          KMS Key ID for decrypting the catalog password

          [env: PEERDB_KMS_KEY_ID=]

      --kms-provider <KMS_PROVIDER>
          KMS provider: "aws" (default) or "gcp"

          [env: PEERDB_KMS_PROVIDER=]
          [default: aws]

  -h, --help
          Print help (see a summary with '-h')
Options (16)
OptionDescriptionSource
--host HOSTHost to bind to, defaults to localhosthelp
-p, --port PORTPort of the server, defaults to `9900`help
--catalog-host CATALOG_HOSTCatalog postgres server host.help
--catalog-port CATALOG_PORTCatalog postgres server port.help
--catalog-user CATALOG_USERCatalog postgres server user.help
--catalog-password CATALOG_PASSWORDCatalog postgres server password.help
--catalog-database CATALOG_DATABASECatalog postgres server database.help
--tls-cert TLS_CERTPath to the TLS certificate filehelp
--tls-key TLS_KEYPath to the TLS private key filehelp
-l, --log-dir LOG_DIRPath to the directory where peerdb logs will be written tohelp
--peerdb-password PEERDB_PASSWORDPassword for the postgres interface.help
--flow-api-url FLOW_API_URLPoints to the URL for the Flow API server.help
--peerdb-fdw-mode[env: PEERDB_FDW_MODE=]help
--kms-key-id KMS_KEY_IDKMS Key ID for decrypting the catalog passwordhelp
--kms-provider KMS_PROVIDERKMS provider: "aws" (default) or "gcp"help
-h, --helpPrint help (see a summary with '-h')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.