CassandraRememberEntitiesStoreOptionsBuilder
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:31
Fluent builder for CassandraRememberEntitiesStoreOptionsType.
Carries withX methods for the shared CassandraConnection
fields too — the connection mixin is not built on its own; the store
exposes its connection surface directly (same pattern as
CassandraJournalOptions).
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CassandraRememberEntitiesStoreOptionsBuilder():
CassandraRememberEntitiesStoreOptionsBuilder
Returns
Section titled “Returns”CassandraRememberEntitiesStoreOptionsBuilder
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”build()
Section titled “build()”build():
Partial<T>
Defined in: src/util/OptionsBuilder.ts:51
Snapshot the set fields as an independent Partial<T> (own props only).
Returns
Section titled “Returns”Partial<T>
Inherited from
Section titled “Inherited from”withAutoCreateKeyspace()
Section titled “withAutoCreateKeyspace()”withAutoCreateKeyspace(
autoCreateKeyspace?):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:66
If true, create the keyspace on startup (simple strategy, rf=1).
Parameters
Section titled “Parameters”autoCreateKeyspace?
Section titled “autoCreateKeyspace?”boolean = true
Returns
Section titled “Returns”this
withAutoCreateTables()
Section titled “withAutoCreateTables()”withAutoCreateTables(
autoCreateTables?):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:88
Auto-create the table on first use. Default: true.
Parameters
Section titled “Parameters”autoCreateTables?
Section titled “autoCreateTables?”boolean = true
Returns
Section titled “Returns”this
withClient()
Section titled “withClient()”withClient(
client):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:93
Inject a pre-built CQL client instead of letting the store instantiate its own.
Parameters
Section titled “Parameters”client
Section titled “client”Returns
Section titled “Returns”this
withConsistency()
Section titled “withConsistency()”withConsistency(
consistency):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:76
CQL consistency level for all reads and writes. Default LOCAL_QUORUM (6).
Parameters
Section titled “Parameters”consistency
Section titled “consistency”number
Returns
Section titled “Returns”this
withContactPoints()
Section titled “withContactPoints()”withContactPoints(
contactPoints):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:41
Node(s) to seed the cluster topology from.
Parameters
Section titled “Parameters”contactPoints
Section titled “contactPoints”readonly string[]
Returns
Section titled “Returns”this
withCredentials()
Section titled “withCredentials()”withCredentials(
username,password):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:56
Username/password for PLAIN auth.
Parameters
Section titled “Parameters”username
Section titled “username”string
password
Section titled “password”string
Returns
Section titled “Returns”this
withKeyspace()
Section titled “withKeyspace()”withKeyspace(
keyspace):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:51
Keyspace to USE after connect. Must already exist, or pass withAutoCreateKeyspace(true).
Parameters
Section titled “Parameters”keyspace
Section titled “keyspace”string
Returns
Section titled “Returns”this
withLocalDataCenter()
Section titled “withLocalDataCenter()”withLocalDataCenter(
localDataCenter):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:46
Local DC — required for DCAwareRoundRobinPolicy. Defaults to datacenter1.
Parameters
Section titled “Parameters”localDataCenter
Section titled “localDataCenter”string
Returns
Section titled “Returns”this
withPort()
Section titled “withPort()”withPort(
port):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:61
Port — defaults to 9042.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
withReplication()
Section titled “withReplication()”withReplication(
replication):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:71
Replication options used by autoCreateKeyspace. Ignored otherwise.
Parameters
Section titled “Parameters”replication
Section titled “replication”class?
Section titled “class?”"SimpleStrategy" | "NetworkTopologyStrategy"
dataCenters?
Section titled “dataCenters?”Readonly<Record<string, number>>
For NetworkTopologyStrategy, map of DC → replication factor.
replicationFactor?
Section titled “replicationFactor?”number
Returns
Section titled “Returns”this
withTable()
Section titled “withTable()”withTable(
table):this
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:83
Table for the remember-entities state. Default: remember_entities.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
create()
Section titled “create()”
staticcreate():CassandraRememberEntitiesStoreOptionsBuilder
Defined in: src/cluster/sharding/CassandraRememberEntitiesStoreOptions.ts:34
Start a fresh builder. Equivalent to new CassandraRememberEntitiesStoreOptionsBuilder().
Returns
Section titled “Returns”CassandraRememberEntitiesStoreOptionsBuilder