Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cantonfoundation-generated-hydration-fix.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

./scribe.jar pipeline parameters

ParameterDescription
--config filePath to configuration overrides via an external HOCON file (optional)
• Environment variable: SCRIBE_CONFIG
• System property: config
--pipeline-datasource enumLedger API service to use as data source (default: TransactionStream)
• Environment variable: SCRIBE_PIPELINE_DATASOURCE
• System property: pipeline.datasource
• Enumeration values: TransactionStream, TransactionTreeStream
--pipeline-oauth-clientid stringClient’s identifier (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTID
• System property: pipeline.oauth.clientId
--pipeline-oauth-accesstoken stringAccess token (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_ACCESSTOKEN
• System property: pipeline.oauth.accessToken
--pipeline-oauth-scope [enum | string]Token scope (default: Default)
• Environment variable: SCRIBE_PIPELINE_OAUTH_SCOPE
• System property: pipeline.oauth.scope
• Enumeration values: Default, None
--pipeline-oauth-parameters mapCustom parameters
• Environment variable: SCRIBE_PIPELINE_OAUTH_PARAMETERS
• System property: pipeline.oauth.parameters
--pipeline-oauth-preemptexpiry stringThe duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)
• Environment variable: SCRIBE_PIPELINE_OAUTH_PREEMPTEXPIRY
• System property: pipeline.oauth.preemptExpiry
--pipeline-oauth-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_CAFILE
• System property: pipeline.oauth.cafile
--pipeline-oauth-endpoint uriToken endpoint URL (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_ENDPOINT
• System property: pipeline.oauth.endpoint
--pipeline-oauth-issuer uriOIDC-compliant issuer URL (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_ISSUER
• System property: pipeline.oauth.issuer
--pipeline-oauth-clientsecret stringClient’s secret (optional)
• Environment variable: SCRIBE_PIPELINE_OAUTH_CLIENTSECRET
• System property: pipeline.oauth.clientSecret
--pipeline-filter-parties stringFilter expression determining Daml party identifiers to filter on (default: *)
• Environment variable: SCRIBE_PIPELINE_FILTER_PARTIES
• System property: pipeline.filter.parties
--pipeline-filter-metadata stringFilter expression determining which templates and interfaces to capture metadata for (default: !*)
• Environment variable: SCRIBE_PIPELINE_FILTER_METADATA
• System property: pipeline.filter.metadata
--pipeline-filter-contracts stringFilter expression determining which templates and interfaces to include (default: *)
• Environment variable: SCRIBE_PIPELINE_FILTER_CONTRACTS
• System property: pipeline.filter.contracts
--pipeline-ledger-start [enum | string]Start offset (default: Latest)
• Environment variable: SCRIBE_PIPELINE_LEDGER_START
• System property: pipeline.ledger.start
• Enumeration values: Genesis, Oldest, Latest
--pipeline-ledger-stop [enum | string]Stop offset (default: Never)
• Environment variable: SCRIBE_PIPELINE_LEDGER_STOP
• System property: pipeline.ledger.stop
• Enumeration values: Latest, Never
--retry-backoff-base stringBase time (ISO 8601) for backoff retry strategy (default: PT1S)
• Environment variable: SCRIBE_RETRY_BACKOFF_BASE
• System property: retry.backoff.base
--retry-backoff-cap stringMax duration (ISO 8601) between attempts (default: PT1M)
• Environment variable: SCRIBE_RETRY_BACKOFF_CAP
• System property: retry.backoff.cap
--retry-backoff-factor doubleFactor for backoff retry strategy (default: 2.0)
• Environment variable: SCRIBE_RETRY_BACKOFF_FACTOR
• System property: retry.backoff.factor
--retry-counter-attempts intMax attempts before giving up (optional)
• Environment variable: SCRIBE_RETRY_COUNTER_ATTEMPTS
• System property: retry.counter.attempts
--retry-counter-reset stringReset retry counters after period (ISO 8601) of stability (default: PT10M)
• Environment variable: SCRIBE_RETRY_COUNTER_RESET
• System property: retry.counter.reset
--retry-counter-duration stringTime limit (ISO 8601) before giving up (optional)
• Environment variable: SCRIBE_RETRY_COUNTER_DURATION
• System property: retry.counter.duration
--health-address stringHostname or IP to bind HTTP health info service to (default: 127.0.0.1)
• Environment variable: SCRIBE_HEALTH_ADDRESS
• System property: health.address
--health-port intHTTP port to use to expose application health info (default: 8080)
• Environment variable: SCRIBE_HEALTH_PORT
• System property: health.port
--logger-level enumLog level (default: Info)
• Environment variable: SCRIBE_LOGGER_LEVEL
• System property: logger.level
• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None
--logger-mappings mapCustom mappings for log levels
• Environment variable: SCRIBE_LOGGER_MAPPINGS
• System property: logger.mappings
--logger-format enumLog output format (default: Plain)
• Environment variable: SCRIBE_LOGGER_FORMAT
• System property: logger.format
• Enumeration values: Plain, Json
--logger-pattern [enum | string]Log pattern (default: Plain)
• Environment variable: SCRIBE_LOGGER_PATTERN
• System property: logger.pattern
• Enumeration values: Plain, Standard, Structured
--target-postgres-host stringPostgres host (default: localhost)
• Environment variable: SCRIBE_TARGET_POSTGRES_HOST
• System property: target.postgres.host
--target-postgres-appname stringApplication name for Postgres connections (default: scribe)
• Environment variable: SCRIBE_TARGET_POSTGRES_APPNAME
• System property: target.postgres.appName
--target-postgres-buffersize intBuffer size for transactions processing (default: 128)
• Environment variable: SCRIBE_TARGET_POSTGRES_BUFFERSIZE
• System property: target.postgres.bufferSize
--target-postgres-tls-mode enumSSL mode required for Postgres connectivity (default: Disable)
• Environment variable: SCRIBE_TARGET_POSTGRES_TLS_MODE
• System property: target.postgres.tls.mode
• Enumeration values: Disable, Require, VerifyCA, VerifyFull
--target-postgres-tls-cert fileClient’s certificate (optional)
• Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CERT
• System property: target.postgres.tls.cert
--target-postgres-tls-key fileClient’s private key (optional)
• Environment variable: SCRIBE_TARGET_POSTGRES_TLS_KEY
• System property: target.postgres.tls.key
--target-postgres-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_TARGET_POSTGRES_TLS_CAFILE
• System property: target.postgres.tls.cafile
--target-postgres-keepalive booleanEnable/disable TCP keep-alive probe (default: true)
• Environment variable: SCRIBE_TARGET_POSTGRES_KEEPALIVE
• System property: target.postgres.keepAlive
--target-postgres-maxconnections intMaximum number of JDBC connections (default: 16)
• Environment variable: SCRIBE_TARGET_POSTGRES_MAXCONNECTIONS
• System property: target.postgres.maxConnections
--target-postgres-password stringPostgres user password (default: ********)
• Environment variable: SCRIBE_TARGET_POSTGRES_PASSWORD
• System property: target.postgres.password
--target-postgres-username stringPostgres user name (default: postgres)
• Environment variable: SCRIBE_TARGET_POSTGRES_USERNAME
• System property: target.postgres.username
--target-postgres-database stringPostgres database (default: postgres)
• Environment variable: SCRIBE_TARGET_POSTGRES_DATABASE
• System property: target.postgres.database
--target-postgres-schema stringPostgres schema (default: public)
• Environment variable: SCRIBE_TARGET_POSTGRES_SCHEMA
• System property: target.postgres.schema
--target-postgres-port intPostgres port (default: 5432)
• Environment variable: SCRIBE_TARGET_POSTGRES_PORT
• System property: target.postgres.port
--target-encoding-numericasstring booleanEncode numeric as string instead of JSON number (default: true)
• Environment variable: SCRIBE_TARGET_ENCODING_NUMERICASSTRING
• System property: target.encoding.numericAsString
--target-encoding-excludenulls booleanOmit fields with NULL values from resulting JSON (default: false)
• Environment variable: SCRIBE_TARGET_ENCODING_EXCLUDENULLS
• System property: target.encoding.excludeNulls
--target-encoding-int64asstring booleanEncode int64 as string instead of JSON number (default: true)
• Environment variable: SCRIBE_TARGET_ENCODING_INT64ASSTRING
• System property: target.encoding.int64AsString
--target-schema-autoapply booleanApply metadata inferred schema on startup (default: true)
• Environment variable: SCRIBE_TARGET_SCHEMA_AUTOAPPLY
• System property: target.schema.autoApply
--target-schema-baseline booleanBaseline existing database schema during apply (default: false)
• Environment variable: SCRIBE_TARGET_SCHEMA_BASELINE
• System property: target.schema.baseline
--source-ledger-host stringLedger API host (default: localhost)
• Environment variable: SCRIBE_SOURCE_LEDGER_HOST
• System property: source.ledger.host
--source-ledger-cachedir fileCache Directory (default: /tmp/scribe)
• Environment variable: SCRIBE_SOURCE_LEDGER_CACHEDIR
• System property: source.ledger.cacheDir
--source-ledger-buffersize intBuffer size for gRPC channel (default: 128)
• Environment variable: SCRIBE_SOURCE_LEDGER_BUFFERSIZE
• System property: source.ledger.bufferSize
--source-ledger-keepalive-time stringDuration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)
• Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIME
• System property: source.ledger.keepAlive.time
--source-ledger-keepalive-timeout stringDuration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)
• Environment variable: SCRIBE_SOURCE_LEDGER_KEEPALIVE_TIMEOUT
• System property: source.ledger.keepAlive.timeout
--source-ledger-auth enumAuthorisation mode (default: NoAuth)
• Environment variable: SCRIBE_SOURCE_LEDGER_AUTH
• System property: source.ledger.auth
• Enumeration values: OAuth, NoAuth
--source-ledger-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CAFILE
• System property: source.ledger.tls.cafile
--source-ledger-tls-cert fileClient’s certificate (leave empty if embedded into private key file) (optional)
• Environment variable: SCRIBE_SOURCE_LEDGER_TLS_CERT
• System property: source.ledger.tls.cert
--source-ledger-tls-key fileClient’s private key (leave empty for server-only TLS) (optional)
• Environment variable: SCRIBE_SOURCE_LEDGER_TLS_KEY
• System property: source.ledger.tls.key
--source-ledger-port intLedger API port (default: 6865)
• Environment variable: SCRIBE_SOURCE_LEDGER_PORT
• System property: source.ledger.port

./scribe.jar datastore postgres-document prune parameters

ParameterDescription
--config filePath to configuration overrides via an external HOCON file (optional)
• Environment variable: SCRIBE_CONFIG
• System property: config
--prune-target stringInclusive boundary up to which to prune. Can be an offset, timestamp (ISO 8601) or duration (ISO 8601)
• Environment variable: SCRIBE_PRUNE_TARGET
• System property: prune.target
--prune-mode enumPrecomputes effects of pruning through dry-run, or actually runs it (default: DryRun)
• Environment variable: SCRIBE_PRUNE_MODE
• System property: prune.mode
• Enumeration values: DryRun, Force
--logger-destination fileLog output file (default: output.log)
• Environment variable: SCRIBE_LOGGER_DESTINATION
• System property: logger.destination
--logger-mappings mapCustom mappings for log levels
• Environment variable: SCRIBE_LOGGER_MAPPINGS
• System property: logger.mappings
--logger-format enumLog output format (default: Plain)
• Environment variable: SCRIBE_LOGGER_FORMAT
• System property: logger.format
• Enumeration values: Plain, PlainAsync, Json, JsonAsync
--logger-pattern [enum | string]Log pattern (default: Plain)
• Environment variable: SCRIBE_LOGGER_PATTERN
• System property: logger.pattern
• Enumeration values: Plain, Standard, Structured
--logger-level enumLog level (default: Info)
• Environment variable: SCRIBE_LOGGER_LEVEL
• System property: logger.level
• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None
--postgres-host stringPostgres host (default: localhost)
• Environment variable: SCRIBE_POSTGRES_HOST
• System property: postgres.host
--postgres-appname stringApplication name for Postgres connections (default: scribe)
• Environment variable: SCRIBE_POSTGRES_APPNAME
• System property: postgres.appName
--postgres-buffersize intBuffer size for transactions processing (default: 128)
• Environment variable: SCRIBE_POSTGRES_BUFFERSIZE
• System property: postgres.bufferSize
--postgres-tls-mode enumSSL mode required for Postgres connectivity (default: Disable)
• Environment variable: SCRIBE_POSTGRES_TLS_MODE
• System property: postgres.tls.mode
• Enumeration values: Disable, Require, VerifyCA, VerifyFull
--postgres-tls-cert fileClient’s certificate (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_CERT
• System property: postgres.tls.cert
--postgres-tls-key fileClient’s private key (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_KEY
• System property: postgres.tls.key
--postgres-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_CAFILE
• System property: postgres.tls.cafile
--postgres-keepalive booleanEnable/disable TCP keep-alive probe (default: true)
• Environment variable: SCRIBE_POSTGRES_KEEPALIVE
• System property: postgres.keepAlive
--postgres-maxconnections intMaximum number of JDBC connections (default: 16)
• Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS
• System property: postgres.maxConnections
--postgres-password stringPostgres user password (default: ********)
• Environment variable: SCRIBE_POSTGRES_PASSWORD
• System property: postgres.password
--postgres-username stringPostgres user name (default: postgres)
• Environment variable: SCRIBE_POSTGRES_USERNAME
• System property: postgres.username
--postgres-schema stringPostgres schema (default: public)
• Environment variable: SCRIBE_POSTGRES_SCHEMA
• System property: postgres.schema
--postgres-database stringPostgres database (default: postgres)
• Environment variable: SCRIBE_POSTGRES_DATABASE
• System property: postgres.database
--postgres-port intPostgres port (default: 5432)
• Environment variable: SCRIBE_POSTGRES_PORT
• System property: postgres.port

./scribe.jar datastore postgres-document schema show parameters

ParameterDescription
--config filePath to configuration overrides via an external HOCON file (optional)
• Environment variable: SCRIBE_CONFIG
• System property: config
--ledger-host stringLedger API host (default: localhost)
• Environment variable: SCRIBE_LEDGER_HOST
• System property: ledger.host
--ledger-cachedir fileCache Directory (default: /tmp/scribe)
• Environment variable: SCRIBE_LEDGER_CACHEDIR
• System property: ledger.cacheDir
--ledger-buffersize intBuffer size for gRPC channel (default: 128)
• Environment variable: SCRIBE_LEDGER_BUFFERSIZE
• System property: ledger.bufferSize
--ledger-keepalive-time stringDuration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)
• Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME
• System property: ledger.keepAlive.time
--ledger-keepalive-timeout stringDuration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)
• Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT
• System property: ledger.keepAlive.timeout
--ledger-auth enumAuthorisation mode (default: NoAuth)
• Environment variable: SCRIBE_LEDGER_AUTH
• System property: ledger.auth
• Enumeration values: OAuth, NoAuth
--ledger-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_LEDGER_TLS_CAFILE
• System property: ledger.tls.cafile
--ledger-tls-cert fileClient’s certificate (leave empty if embedded into private key file) (optional)
• Environment variable: SCRIBE_LEDGER_TLS_CERT
• System property: ledger.tls.cert
--ledger-tls-key fileClient’s private key (leave empty for server-only TLS) (optional)
• Environment variable: SCRIBE_LEDGER_TLS_KEY
• System property: ledger.tls.key
--ledger-port intLedger API port (default: 6865)
• Environment variable: SCRIBE_LEDGER_PORT
• System property: ledger.port
--logger-destination fileLog output file (default: output.log)
• Environment variable: SCRIBE_LOGGER_DESTINATION
• System property: logger.destination
--logger-mappings mapCustom mappings for log levels
• Environment variable: SCRIBE_LOGGER_MAPPINGS
• System property: logger.mappings
--logger-format enumLog output format (default: Plain)
• Environment variable: SCRIBE_LOGGER_FORMAT
• System property: logger.format
• Enumeration values: Plain, PlainAsync, Json, JsonAsync
--logger-pattern [enum | string]Log pattern (default: Plain)
• Environment variable: SCRIBE_LOGGER_PATTERN
• System property: logger.pattern
• Enumeration values: Plain, Standard, Structured
--logger-level enumLog level (default: Info)
• Environment variable: SCRIBE_LOGGER_LEVEL
• System property: logger.level
• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None
--filter-contracts stringFilter expression determining which templates and interfaces to include (default: *)
• Environment variable: SCRIBE_FILTER_CONTRACTS
• System property: filter.contracts
--oauth-clientid stringClient’s identifier (optional)
• Environment variable: SCRIBE_OAUTH_CLIENTID
• System property: oauth.clientId
--oauth-accesstoken stringAccess token (optional)
• Environment variable: SCRIBE_OAUTH_ACCESSTOKEN
• System property: oauth.accessToken
--oauth-scope [enum | string]Token scope (default: Default)
• Environment variable: SCRIBE_OAUTH_SCOPE
• System property: oauth.scope
• Enumeration values: Default, None
--oauth-parameters mapCustom parameters
• Environment variable: SCRIBE_OAUTH_PARAMETERS
• System property: oauth.parameters
--oauth-preemptexpiry stringThe duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)
• Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY
• System property: oauth.preemptExpiry
--oauth-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_OAUTH_CAFILE
• System property: oauth.cafile
--oauth-endpoint uriToken endpoint URL (optional)
• Environment variable: SCRIBE_OAUTH_ENDPOINT
• System property: oauth.endpoint
--oauth-issuer uriOIDC-compliant issuer URL (optional)
• Environment variable: SCRIBE_OAUTH_ISSUER
• System property: oauth.issuer
--oauth-clientsecret stringClient’s secret (optional)
• Environment variable: SCRIBE_OAUTH_CLIENTSECRET
• System property: oauth.clientSecret

./scribe.jar datastore postgres-document schema apply parameters

ParameterDescription
--config filePath to configuration overrides via an external HOCON file (optional)
• Environment variable: SCRIBE_CONFIG
• System property: config
--ledger-host stringLedger API host (default: localhost)
• Environment variable: SCRIBE_LEDGER_HOST
• System property: ledger.host
--ledger-cachedir fileCache Directory (default: /tmp/scribe)
• Environment variable: SCRIBE_LEDGER_CACHEDIR
• System property: ledger.cacheDir
--ledger-buffersize intBuffer size for gRPC channel (default: 128)
• Environment variable: SCRIBE_LEDGER_BUFFERSIZE
• System property: ledger.bufferSize
--ledger-keepalive-time stringDuration (ISO 8601) of interval between ping frames (PT0S to disable) (default: PT40S)
• Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIME
• System property: ledger.keepAlive.time
--ledger-keepalive-timeout stringDuration (ISO 8601) of timeout for a ping frame to be acknowledged (default: PT20S)
• Environment variable: SCRIBE_LEDGER_KEEPALIVE_TIMEOUT
• System property: ledger.keepAlive.timeout
--ledger-auth enumAuthorisation mode (default: NoAuth)
• Environment variable: SCRIBE_LEDGER_AUTH
• System property: ledger.auth
• Enumeration values: OAuth, NoAuth
--ledger-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_LEDGER_TLS_CAFILE
• System property: ledger.tls.cafile
--ledger-tls-cert fileClient’s certificate (leave empty if embedded into private key file) (optional)
• Environment variable: SCRIBE_LEDGER_TLS_CERT
• System property: ledger.tls.cert
--ledger-tls-key fileClient’s private key (leave empty for server-only TLS) (optional)
• Environment variable: SCRIBE_LEDGER_TLS_KEY
• System property: ledger.tls.key
--ledger-port intLedger API port (default: 6865)
• Environment variable: SCRIBE_LEDGER_PORT
• System property: ledger.port
--logger-destination fileLog output file (default: output.log)
• Environment variable: SCRIBE_LOGGER_DESTINATION
• System property: logger.destination
--logger-mappings mapCustom mappings for log levels
• Environment variable: SCRIBE_LOGGER_MAPPINGS
• System property: logger.mappings
--logger-format enumLog output format (default: Plain)
• Environment variable: SCRIBE_LOGGER_FORMAT
• System property: logger.format
• Enumeration values: Plain, PlainAsync, Json, JsonAsync
--logger-pattern [enum | string]Log pattern (default: Plain)
• Environment variable: SCRIBE_LOGGER_PATTERN
• System property: logger.pattern
• Enumeration values: Plain, Standard, Structured
--logger-level enumLog level (default: Info)
• Environment variable: SCRIBE_LOGGER_LEVEL
• System property: logger.level
• Enumeration values: All, Fatal, Error, Warning, Info, Debug, Trace, None
--filter-contracts stringFilter expression determining which templates and interfaces to include (default: *)
• Environment variable: SCRIBE_FILTER_CONTRACTS
• System property: filter.contracts
--schema-autoapply booleanApply metadata inferred schema on startup (default: true)
• Environment variable: SCRIBE_SCHEMA_AUTOAPPLY
• System property: schema.autoApply
--schema-baseline booleanBaseline existing database schema during apply (default: false)
• Environment variable: SCRIBE_SCHEMA_BASELINE
• System property: schema.baseline
--postgres-host stringPostgres host (default: localhost)
• Environment variable: SCRIBE_POSTGRES_HOST
• System property: postgres.host
--postgres-appname stringApplication name for Postgres connections (default: scribe)
• Environment variable: SCRIBE_POSTGRES_APPNAME
• System property: postgres.appName
--postgres-buffersize intBuffer size for transactions processing (default: 128)
• Environment variable: SCRIBE_POSTGRES_BUFFERSIZE
• System property: postgres.bufferSize
--postgres-tls-mode enumSSL mode required for Postgres connectivity (default: Disable)
• Environment variable: SCRIBE_POSTGRES_TLS_MODE
• System property: postgres.tls.mode
• Enumeration values: Disable, Require, VerifyCA, VerifyFull
--postgres-tls-cert fileClient’s certificate (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_CERT
• System property: postgres.tls.cert
--postgres-tls-key fileClient’s private key (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_KEY
• System property: postgres.tls.key
--postgres-tls-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_POSTGRES_TLS_CAFILE
• System property: postgres.tls.cafile
--postgres-keepalive booleanEnable/disable TCP keep-alive probe (default: true)
• Environment variable: SCRIBE_POSTGRES_KEEPALIVE
• System property: postgres.keepAlive
--postgres-maxconnections intMaximum number of JDBC connections (default: 16)
• Environment variable: SCRIBE_POSTGRES_MAXCONNECTIONS
• System property: postgres.maxConnections
--postgres-password stringPostgres user password (default: ********)
• Environment variable: SCRIBE_POSTGRES_PASSWORD
• System property: postgres.password
--postgres-username stringPostgres user name (default: postgres)
• Environment variable: SCRIBE_POSTGRES_USERNAME
• System property: postgres.username
--postgres-schema stringPostgres schema (default: public)
• Environment variable: SCRIBE_POSTGRES_SCHEMA
• System property: postgres.schema
--postgres-database stringPostgres database (default: postgres)
• Environment variable: SCRIBE_POSTGRES_DATABASE
• System property: postgres.database
--postgres-port intPostgres port (default: 5432)
• Environment variable: SCRIBE_POSTGRES_PORT
• System property: postgres.port
--oauth-clientid stringClient’s identifier (optional)
• Environment variable: SCRIBE_OAUTH_CLIENTID
• System property: oauth.clientId
--oauth-accesstoken stringAccess token (optional)
• Environment variable: SCRIBE_OAUTH_ACCESSTOKEN
• System property: oauth.accessToken
--oauth-scope [enum | string]Token scope (default: Default)
• Environment variable: SCRIBE_OAUTH_SCOPE
• System property: oauth.scope
• Enumeration values: Default, None
--oauth-parameters mapCustom parameters
• Environment variable: SCRIBE_OAUTH_PARAMETERS
• System property: oauth.parameters
--oauth-preemptexpiry stringThe duration (ISO 8601) prior to expiry of current, for a new token to be requested (default: PT1M)
• Environment variable: SCRIBE_OAUTH_PREEMPTEXPIRY
• System property: oauth.preemptExpiry
--oauth-cafile fileTrusted Certificate Authority (CA) certificate (optional)
• Environment variable: SCRIBE_OAUTH_CAFILE
• System property: oauth.cafile
--oauth-endpoint uriToken endpoint URL (optional)
• Environment variable: SCRIBE_OAUTH_ENDPOINT
• System property: oauth.endpoint
--oauth-issuer uriOIDC-compliant issuer URL (optional)
• Environment variable: SCRIBE_OAUTH_ISSUER
• System property: oauth.issuer
--oauth-clientsecret stringClient’s secret (optional)
• Environment variable: SCRIBE_OAUTH_CLIENTSECRET
• System property: oauth.clientSecret