Interface Sorci

Namespace

Hierarchy

Sorci

Implemented by

SorciPostgres

Index

Methods - Stream

appendEvent getEventById getEventsByQuery

Methods - Tooling

close createStream dropAllTestStream dropCurrentStream insertEvents setupTestStream truncate

Stream Methods

appendEvent

appendEvent(payload: AppendEventPayload): Promise<string>
Will append an event with optimistic concurrency control. Uses Dynamic Consistency Boundary (DCB) to detect conflicts without table locks. If queryV2 & lastKnownEventId are provided, it checks if any relevant events were added since lastKnownEventId. If yes, throws a concurrency error.

Returns
The event id
Parameters
- payload: AppendEventPayload
Returns Promise<string>
- Defined in sorci.interface.ts:157

getEventById

getEventById(id: string): Promise<undefined | PersistedEvent>
Will retrieve one event by it's id
Parameters
- id: string
Returns Promise<undefined | PersistedEvent>
- Defined in sorci.interface.ts:165

getEventsByQuery

getEventsByQuery(query: Query): Promise<PersistedEvent[]>
Will retrieve every event that match the Query
Parameters
- query: Query
Returns Promise<PersistedEvent[]>
- Defined in sorci.interface.ts:171

Tooling Methods

close

close(): Promise<void>
Will close all database connections Usefull to cleanup after tests

Returns Promise<void>
- Defined in sorci.interface.ts:145

createStream

createStream(): Promise<void>
Will create necessary tables, function & triggers

Returns Promise<void>
- Defined in sorci.interface.ts:102

dropAllTestStream

dropAllTestStream(payload?: {
excludeCurrentStream: boolean;
}): Promise<void>
Will destroy every stream prefixed by 'test-' Usefull to cleanup all test stream
Parameters
- Optional payload: {
  excludeCurrentStream: boolean;
  }
  - excludeCurrentStream: boolean
Returns Promise<void>
- Defined in sorci.interface.ts:138

dropCurrentStream

dropCurrentStream(): Promise<void>
Will drop the current stream Usefull to cleanup a test stream

Returns Promise<void>
- Defined in sorci.interface.ts:131

insertEvents

insertEvents(events: ToPersistEvent[]): Promise<string[]>
Will insert events in the stream without any concurrency check Usefull to setup a test stream with a lot of events

Returns
An array of event id
Parameters
- events: ToPersistEvent[]
Returns Promise<string[]>
- Defined in sorci.interface.ts:116

setupTestStream

setupTestStream(streamName?: string): Promise<void>
Will create a stream with random name prefixed by 'test-' Usefull to setup a test stream

Remarks
You can give a name to the stream if you want to
Parameters
- Optional streamName: string
Returns Promise<void>
- Defined in sorci.interface.ts:124

truncate

truncate(): Promise<void>
Will remove every events of the stream

Returns Promise<void>
- Defined in sorci.interface.ts:108

Generated using TypeDoc