CassandraRememberEntitiesStoreOptionsType

Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:9

Plain options-object shape consumed by CassandraRememberEntitiesStore — the shared CassandraConnection fields plus the store-specific table / autoCreateTables / client.

Extends

• CassandraConnection

Properties

autoCreateKeyspace?

readonly optional autoCreateKeyspace?: boolean

Defined in: src/persistence/journals/CassandraClient.ts:44

If true, create the keyspace on startup (simple strategy, rf=1). Dev-friendly default.

Inherited from

CassandraConnection.autoCreateKeyspace

---

autoCreateTables?

readonly optional autoCreateTables?: boolean

Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:13

Auto-create the table on first use. Default: true.

---

client?

readonly optional client?: CassandraClientLike

Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:21

Inject a pre-built CQL client. When omitted, the store instantiates its own (via cassandra-driver) — but typical deployments share one client across journal + snapshot store + remember-entities, so passing the existing one in is the recommended pattern.

---

consistency?

readonly optional consistency?: number

Defined in: src/persistence/journals/CassandraClient.ts:57

CQL consistency level to use for all reads and writes. Default: LOCAL_QUORUM (value 6 in the driver). Pass the numeric value from cassandra-driver’s types.consistencies.

Inherited from

CassandraConnection.consistency

---

contactPoints

readonly contactPoints: readonly string[]

Defined in: src/persistence/journals/CassandraClient.ts:34

Node(s) to seed the cluster topology from.

Inherited from

CassandraConnection.contactPoints

---

credentials?

readonly optional credentials?: object

Defined in: src/persistence/journals/CassandraClient.ts:40

Optional username/password for PLAIN auth.

password

password: string

username

username: string

Inherited from

CassandraConnection.credentials

---

keyspace

readonly keyspace: string

Defined in: src/persistence/journals/CassandraClient.ts:38

Keyspace to USE after connect. Must already exist, or pass autoCreateKeyspace: true.

Inherited from

CassandraConnection.keyspace

---

localDataCenter?

readonly optional localDataCenter?: string

Defined in: src/persistence/journals/CassandraClient.ts:36

Local DC — required for DCAwareRoundRobinPolicy. Defaults to datacenter1.

Inherited from

CassandraConnection.localDataCenter

---

port?

readonly optional port?: number

Defined in: src/persistence/journals/CassandraClient.ts:42

Port — defaults to 9042.

Inherited from

CassandraConnection.port

---

replication?

readonly optional replication?: object

Defined in: src/persistence/journals/CassandraClient.ts:46

Replication options used by autoCreateKeyspace. Ignored otherwise.

class?

readonly optional class?: "SimpleStrategy" | "NetworkTopologyStrategy"

dataCenters?

readonly optional dataCenters?: Readonly<Record<string, number>>

For NetworkTopologyStrategy, map of DC → replication factor.

replicationFactor?

readonly optional replicationFactor?: number

Inherited from

CassandraConnection.replication

---

table?

readonly optional table?: string

Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:11

Table for the remember-entities state. Default: remember_entities.