Configuration and command reference

Use this page when you need the exact application configuration Threadline reads. These settings are global to the :threadline application; pass operation-specific options directly to a public function when that function offers them.

The reference separates literal application keys from adapter-module options. That distinction matters: literal keys select Threadline behavior, while a configured adapter owns the options stored under its module name.

Runtime configuration

The following fourteen keys are Threadline's supported application-environment contract. An omitted key has the default or absence behavior stated here.

Known limitation: primary_key: only accepts bare identifiers

A declared primary_key: column name must match ^[A-Za-z_][A-Za-z0-9_]*$ (letters, digits, underscore, not starting with a digit) and be at most 63 bytes — the same rule Threadline applies to schema, table, and function identifiers. This is stricter than what PostgreSQL itself allows: a double-quoted identifier such as "1code", "post-id", or "post id" is legal DDL, and Threadline would capture it correctly if it were auto-detected as part of a real primary key. But that same column name cannot currently be declared through primary_key: for a table that has no real primary key — there is no quoting escape hatch in this option today.

If your join table (or other PK-less table) needs primary_key: and its key columns were created with quoted, non-bare names, rename the columns to bare identifiers before declaring the override, or create a real primary key / unique index over bare-identifier columns instead.

Advanced operator polling

The three polling keys control browser-facing LiveView refreshes only:

config :threadline, coverage_poll_ms: 30_000
config :threadline, export_status_poll_ms: 5_000
config :threadline, retention_poll_ms: 5_000

Set each to a positive integer number of milliseconds. These values do not change retention-pruner cadence, export cleanup cadence, or queue execution. Those schedules live in the :retention and :exports keyword lists described above. Polling test hooks and socket assigns are internal implementation details, not router mount options.

Adapter-module options

After selecting an adapter with :storage_adapter or :export_queue_adapter, Threadline reads a keyword list stored under that adapter module. This is a separate dynamic key class, not another literal atom key.

For example, the built-in S3 adapter requires a bucket:

config :threadline, storage_adapter: Threadline.Storage.S3
config :threadline, Threadline.Storage.S3, bucket: "my-audit-exports"

The built-in Oban queue adapter accepts :oban_name, :queue, and :worker_mod options:

config :threadline, export_queue_adapter: Threadline.ExportQueue.Oban

config :threadline, Threadline.ExportQueue.Oban,
  oban_name: Oban,
  queue: :threadline_exports

A custom adapter owns and documents its own keyword options. Threadline passes those options to the adapter's init/1 callback during application startup. Use the public Threadline.Storage and Threadline.ExportQueue behaviours as the implementation contracts; do not depend on another adapter's private options.

Commands available to host projects

Adding Threadline as a dependency makes these eleven Mix tasks available to the host project. Run them from the host project's root so they load its configuration and dependencies.

These tasks are the supported command interface for adopters. Their module pages and the linked guides define their options and safety boundaries.

Commands for this repository

Mix aliases belong to the project that defines them. Therefore none of the aliases below is installed into a host application when it adds Threadline as a dependency. They are supported contributor commands only when working in the Threadline repository.

mix threadline.verify_topology is also repository-only. It requires the repository's PgBouncer test topology and is not part of the adopter command contract.

Maintainer-only commands

The following tools are shipped from source today but are not supported adopter or contributor interfaces. They operate on maintainer evidence, local credentials, or a repository-specific capture corpus:

• mix critic.measure
• mix critic.synth
• mix verify.ui_critique
• mix verify.capture
• mix verify.operator_component_contracts

There are no additional internal Mix tasks or aliases in the current source inventory. Adding a task or alias requires placing it in exactly one of these classes and updating this reference.

Next steps

• Adopt Threadline through the canonical first-hour path.
• Configure and operate the mounted audit surface.
• Review the production-readiness checklist.