PostgresJournalOptionsType

Defined in: src/persistence/journals/PostgresJournalOptions.ts:4

Connection options shared by all three Postgres stores.

Extends

• PostgresConnection.StoreSerializerOptionsBase

Properties

autoCreateTables?

readonly optional autoCreateTables?: boolean

Defined in: src/persistence/journals/PostgresJournalOptions.ts:10

Run CREATE TABLE IF NOT EXISTS on first use. Default: true.

---

eventsTable?

readonly optional eventsTable?: string

Defined in: src/persistence/journals/PostgresJournalOptions.ts:6

Events table name. Default: events.

---

pool?

readonly optional pool?: PgPoolLike

Defined in: src/persistence/journals/PostgresClient.ts:60

Pre-built pool — bypasses the lazy pg import entirely. Use to share ONE pool across the journal + snapshot + durable-state stores (see registerPostgresPlugins), or to inject a fake in tests.

Inherited from

PostgresConnection.pool

---

poolConfig?

readonly optional poolConfig?: Record<string, unknown>

Defined in: src/persistence/journals/PostgresClient.ts:54

Extra node-postgres Pool config, merged over { connectionString: url } — e.g. { max: 10, ssl: { rejectUnauthorized: false } }.

Inherited from

PostgresConnection.poolConfig

---

serializer?

readonly optional serializer?: Serializer<unknown>

Defined in: src/persistence/storage/StoreSerializerOptions.ts:23

Custom payload serializer. When set, the store writes rows in the self-describing __serialized__ framing (see PayloadCodec) instead of the default tagged JSON; rows of both formats can coexist in one stream, but reading a framed row back requires a serializer with the same id to be configured.

Inherited from

StoreSerializerOptionsBase.serializer

---

tagsTable?

readonly optional tagsTable?: string

Defined in: src/persistence/journals/PostgresJournalOptions.ts:8

Tags join table name. Default: ${eventsTable}_tags.

---

url?

readonly optional url?: string

Defined in: src/persistence/journals/PostgresClient.ts:49

Connection string, e.g. postgres://user:pass@host:5432/db.

Inherited from

PostgresConnection.url