MsSqlJournalOptionsType

Defined in: src/persistence/journals/MsSqlJournalOptions.ts:5

Connection options shared by all three SQL Server stores.

Extends

• MsSqlConnection.StoreSerializerOptionsBase

Properties

autoCreateTables?

readonly optional autoCreateTables?: boolean

Defined in: src/persistence/journals/MsSqlJournalOptions.ts:11

Run the guarded CREATE TABLE statements on first use. Default: true.

---

eventsTable?

readonly optional eventsTable?: string

Defined in: src/persistence/journals/MsSqlJournalOptions.ts:7

Events table name. Default: events.

---

pool?

readonly optional pool?: MsSqlPoolLike

Defined in: src/persistence/journals/MsSqlClient.ts:77

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

Inherited from

MsSqlConnection.pool

---

poolConfig?

readonly optional poolConfig?: Record<string, unknown>

Defined in: src/persistence/journals/MsSqlClient.ts:71

mssql config object — { server, port, user, password, database, options: { encrypt, trustServerCertificate }, pool: { max } }. Takes precedence over url.

Inherited from

MsSqlConnection.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/MsSqlJournalOptions.ts:9

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

---

url?

readonly optional url?: string

Defined in: src/persistence/journals/MsSqlClient.ts:65

Connection string, e.g. Server=host,1433;Database=app;User Id=sa;Password=…;Encrypt=true, or the mssql://user:pass@host:1433/db URL form.

Inherited from

MsSqlConnection.url