Reference
Environment variables
Flow credentials
Referenced by name from a config rather than read implicitly.
| Variable | Used by |
|---|---|
TRELLARA_SOURCE_DATABASE_URL | src |
TRELLARA_TARGET_DATABASE_URL | src |
Kafka
Resolved only while constructing the librdkafka client; the resolved value is not retained in the public config types.
| Variable | Used by |
|---|---|
TRELLARA_KAFKA_BOOTSTRAP_SERVERS | bin, src |
TRELLARA_KAFKA_CA | src |
TRELLARA_KAFKA_CLIENT_ID | bin, src |
TRELLARA_KAFKA_MESSAGE_TIMEOUT_MS | bin, src |
TRELLARA_KAFKA_PASSWORD | src |
TRELLARA_KAFKA_PROOF_PATH | bin, src |
TRELLARA_KAFKA_USERNAME | src |
Iceberg and object storage
Catalog and bucket coordinates for the lake path.
| Variable | Used by |
|---|---|
TRELLARA_ICEBERG_CATALOG_NAME | src |
TRELLARA_ICEBERG_REST_CREDENTIAL | src |
TRELLARA_ICEBERG_REST_SCOPE | src |
TRELLARA_ICEBERG_REST_TOKEN | src |
TRELLARA_ICEBERG_REST_URI | src |
TRELLARA_ICEBERG_S3_BUCKET | src |
TRELLARA_ICEBERG_S3_ENDPOINT | src |
TRELLARA_ICEBERG_S3_PATH_STYLE | src |
TRELLARA_ICEBERG_S3_PREFIX | src |
TRELLARA_ICEBERG_S3_REGION | src |
TRELLARA_ICEBERG_WAREHOUSE | src |
Native extension relay
Only relevant if you deploy the optional extension. The relay secret is also a PostgreSQL GUC flagged SUPERUSER_ONLY and NO_SHOW_ALL.
| Variable | Used by |
|---|---|
TRELLARA_NATIVE_RELAY_DURABILITY | bin, src |
TRELLARA_NATIVE_RELAY_EXIT_AFTER_SYNC | bin, src |
TRELLARA_NATIVE_RELAY_SECRET | bin, src |
TRELLARA_NATIVE_RELAY_SOCKET | bin, src |
TRELLARA_NATIVE_RELAY_SPOOL | bin, src |
Testing and development only
These gate the PostgreSQL integration tests and the compose harness. They are never read by a released binary doing production work.
| Variable | Used by |
|---|---|
TRELLARA_INLINE_SOURCE | src |
TRELLARA_INLINE_TARGET | src |
TRELLARA_SOURCE_TEST_DATABASE_URL | tests |
TRELLARA_TARGET_TEST_DATABASE_URL | tests |
TRELLARA_TEST_DATABASE_URL | tests |
TRELLARA_TEST_KAFKA_CA_ | trellara-stream-kafka |
TRELLARA_TEST_KAFKA_PASSWORD_ | trellara-stream-kafka |
TRELLARA_TEST_KAFKA_USER_ | trellara-stream-kafka |
TRELLARA_TEST_MTLS_CA_ | trellara-stream-kafka |
TRELLARA_TEST_MTLS_CERTIFICATE_ | trellara-stream-kafka |
TRELLARA_TEST_MTLS_KEY_ | trellara-stream-kafka |
How config refers to them
Trellara never reads a credential from the environment implicitly. A config names the variable it wants, and the name is validated when the document is parsed rather than when the connection is opened:
database_url: source: environment_variable name: TRELLARA_SOURCE_DATABASE_URL
The other accepted shape is source: file with an absolute path. Under environment: production an inline value is rejected outright, so these two are the only forms that reach a running service.
Generated from the repository at
347a884 by tools/gen_reference.py. If this page and the
code disagree, the code is right and this page is a bug.