Class SqlLearningStore

The learning store over a SQL storage adapter (see the module's description).

Hierarchy

TransactionalLearningStore
- SqlLearningStore

Constructors

constructor

new SqlLearningStore(options): SqlLearningStore
Parameters
- options: SqlLearningStoreOptions
Returns SqlLearningStore
Throws
When the adapter has no transactions: a change and its ledger row must commit together.
Overrides TransactionalLearningStore.constructor
- Defined in src/cognition/learning/store/SqlLearningStore.ts:491

Methods

insertLedgerRow

insertLedgerRow(row): Promise<void>
Parameters
- row: StoredLedgerRow
Returns Promise<void>
Inherited from TransactionalLearningStore.insertLedgerRow
- Defined in src/cognition/learning/store/LearningStore.ts:223

ledgerRow

ledgerRow(id): Promise<undefined | StoredLedgerRow>
Parameters
- id: string
Returns Promise<undefined | StoredLedgerRow>
Inherited from TransactionalLearningStore.ledgerRow
- Defined in src/cognition/learning/store/LearningStore.ts:224

chainRows

chainRows(chainKey): Promise<StoredLedgerRow[]>
Parameters
- chainKey: string
Returns Promise<StoredLedgerRow[]>
Inherited from TransactionalLearningStore.chainRows
- Defined in src/cognition/learning/store/LearningStore.ts:225

chainWithHead

chainWithHead(chainKey): Promise<{
rows: StoredLedgerRow[];
head: undefined | ChainHead;
}>
Parameters
- chainKey: string
Returns Promise<{
rows: StoredLedgerRow[];
head: undefined | ChainHead;
}>
Inherited from TransactionalLearningStore.chainWithHead
- Defined in src/cognition/learning/store/LearningStore.ts:226

candidateRows

candidateRows(candidateId): Promise<StoredLedgerRow[]>
Parameters
- candidateId: string
Returns Promise<StoredLedgerRow[]>
Inherited from TransactionalLearningStore.candidateRows
- Defined in src/cognition/learning/store/LearningStore.ts:227

learnerLedgerRows

learnerLedgerRows(namespace, agentKey, userId): Promise<StoredLedgerRow[]>
Parameters
- namespace: string
- agentKey: string
- userId: string
Returns Promise<StoredLedgerRow[]>
Inherited from TransactionalLearningStore.learnerLedgerRows
- Defined in src/cognition/learning/store/LearningStore.ts:228

agentPendingRows

agentPendingRows(namespace, agentKey, createdBefore): Promise<StoredLedgerRow[]>
Parameters
- namespace: string
- agentKey: string
- createdBefore: string
Returns Promise<StoredLedgerRow[]>
Inherited from TransactionalLearningStore.agentPendingRows
- Defined in src/cognition/learning/store/LearningStore.ts:229

head

head(chainKey): Promise<undefined | ChainHead>
Parameters
- chainKey: string
Returns Promise<undefined | ChainHead>
Inherited from TransactionalLearningStore.head
- Defined in src/cognition/learning/store/LearningStore.ts:230

insertHead

insertHead(head): Promise<boolean>
Parameters
- head: ChainHead
Returns Promise<boolean>
Inherited from TransactionalLearningStore.insertHead
- Defined in src/cognition/learning/store/LearningStore.ts:231

advanceHead

advanceHead(chainKey, expectedSeq, next): Promise<boolean>
Parameters
- chainKey: string
- expectedSeq: number
- next: {
      lastId: string;
      lastHash: string;
      seq: number;
  }
  - lastId: string
  - lastHash: string
  - seq: number
Returns Promise<boolean>
Inherited from TransactionalLearningStore.advanceHead
- Defined in src/cognition/learning/store/LearningStore.ts:232

markHeadsForgotten

markHeadsForgotten(namespace, userId): Promise<number>
Parameters
- namespace: string
- userId: string
Returns Promise<number>
Inherited from TransactionalLearningStore.markHeadsForgotten
- Defined in src/cognition/learning/store/LearningStore.ts:233

traitRow

traitRow(namespace, agentKey, userId): Promise<undefined | StoredTraitRow>
Parameters
- namespace: string
- agentKey: string
- userId: string
Returns Promise<undefined | StoredTraitRow>
Inherited from TransactionalLearningStore.traitRow
- Defined in src/cognition/learning/store/LearningStore.ts:234

insertTraitRow

insertTraitRow(row): Promise<boolean>
Parameters
- row: StoredTraitRow
Returns Promise<boolean>
Inherited from TransactionalLearningStore.insertTraitRow
- Defined in src/cognition/learning/store/LearningStore.ts:235

updateTraitRow

updateTraitRow(row, expectedVersion): Promise<boolean>
Parameters
- row: StoredTraitRow
- expectedVersion: number
Returns Promise<boolean>
Inherited from TransactionalLearningStore.updateTraitRow
- Defined in src/cognition/learning/store/LearningStore.ts:236

freezeRows

freezeRows(): Promise<FreezeRow[]>
Returns Promise<FreezeRow[]>
Inherited from TransactionalLearningStore.freezeRows
- Defined in src/cognition/learning/store/LearningStore.ts:237

insertFreeze

insertFreeze(row): Promise<void>
Parameters
- row: FreezeRow
Returns Promise<void>
Inherited from TransactionalLearningStore.insertFreeze
- Defined in src/cognition/learning/store/LearningStore.ts:238

deleteFreeze

deleteFreeze(scopeKey, mode): Promise<boolean>
Parameters
- scopeKey: string
- mode: "frozen" | "off"
Returns Promise<boolean>
Inherited from TransactionalLearningStore.deleteFreeze
- Defined in src/cognition/learning/store/LearningStore.ts:239

sessionRow

sessionRow(namespace, agentKey, sessionId, userId, kind): Promise<undefined | SessionRow>
Parameters
- namespace: string
- agentKey: string
- sessionId: string
- userId: string
- kind: "learner" | "visitor"
Returns Promise<undefined | SessionRow>
Inherited from TransactionalLearningStore.sessionRow
- Defined in src/cognition/learning/store/LearningStore.ts:240

putSessionRow

putSessionRow(row, expectedVersion?): Promise<void>
Parameters
- row: SessionRow
- Optional expectedVersion: number
Returns Promise<void>
Inherited from TransactionalLearningStore.putSessionRow
- Defined in src/cognition/learning/store/LearningStore.ts:241

sessionRowsOf

sessionRowsOf(namespace, userId): Promise<SessionRow[]>
Parameters
- namespace: string
- userId: string
Returns Promise<SessionRow[]>
Inherited from TransactionalLearningStore.sessionRowsOf
- Defined in src/cognition/learning/store/LearningStore.ts:242

isForgotten

isForgotten(hash): Promise<boolean>
Parameters
- hash: string
Returns Promise<boolean>
Inherited from TransactionalLearningStore.isForgotten
- Defined in src/cognition/learning/store/LearningStore.ts:243

insertForgotten

insertForgotten(hash, forgottenAt): Promise<void>
Parameters
- hash: string
- forgottenAt: string
Returns Promise<void>
Inherited from TransactionalLearningStore.insertForgotten
- Defined in src/cognition/learning/store/LearningStore.ts:244

learnerDocs

learnerDocs(table, namespace, agentKey, userId): Promise<LearnerDocRow[]>
Parameters
- table: LearnerDocTable
- namespace: string
- agentKey: string
- userId: string
Returns Promise<LearnerDocRow[]>
Inherited from TransactionalLearningStore.learnerDocs
- Defined in src/cognition/learning/store/LearningStore.ts:245

deleteUserRows

deleteUserRows(namespace, userId): Promise<Record<string, number>>
Parameters
- namespace: string
- userId: string
Returns Promise<Record<string, number>>
Inherited from TransactionalLearningStore.deleteUserRows
- Defined in src/cognition/learning/store/LearningStore.ts:246

transaction

transaction<T>(fn): Promise<T>
Type Parameters
- T
Parameters
- fn: ((tx) => Promise<T>)
  - - (tx): Promise<T>
    - Parameters
      tx: LearningStoreTx
      Returns Promise<T>
Returns Promise<T>
Overrides TransactionalLearningStore.transaction
- Defined in src/cognition/learning/store/SqlLearningStore.ts:512

sessionRowsIn

sessionRowsIn(namespace, agentKey, sessionId): Promise<SessionRow[]>
Parameters
- namespace: string
- agentKey: string
- sessionId: string
Returns Promise<SessionRow[]>
- Defined in src/cognition/learning/store/SqlLearningStore.ts:524

close

close(): Promise<void>
Leaves the adapter open: it is the host's.

Returns Promise<void>
Overrides TransactionalLearningStore.close
- Defined in src/cognition/learning/store/SqlLearningStore.ts:529

Properties

`Readonly` kind

kind: "sql" = ...