Class SorciPostgres`Namespace`

Implements

Sorci

Other

constructor

new SorciPostgres(payload: SorciConstructorPayload): SorciPostgres
Parameters
- payload: SorciConstructorPayload
Returns SorciPostgres
- Defined in sorci.postgres.ts:258
new SorciPostgres(
    payload: {
        buildAdvisoryLocks?: (
            payload: { query: Query },
        ) => { hash: number; key: string }[];
        connectionString: string;
        streamName: string;
    },
): SorciPostgres
Parameters
- payload: {
      buildAdvisoryLocks?: (
          payload: { query: Query },
      ) => { hash: number; key: string }[];
      connectionString: string;
      streamName: string;
  }
Returns SorciPostgres
- Defined in sorci.postgres.ts:259

sql

get sql(): any
Returns any
- Defined in sorci.postgres.ts:309

streamName

get streamName(): string
Returns string
- Defined in sorci.postgres.ts:313

streamNameIdentifier

get streamNameIdentifier(): any
Returns any
- Defined in sorci.postgres.ts:318

cleanStream

cleanStream(streamName: string): Promise<any>
Parameters
- streamName: string
Returns Promise<any>
- Defined in sorci.postgres.ts:371

createBasicTable

createBasicTable(tableName: string): Promise<void>
Parameters
- tableName: string
Returns Promise<void>
- Defined in sorci.postgres.ts:322

Projections

createProjection

createProjection(declaration: ProjectionDeclaration): Promise<void>
Create a new projection with schema. Throws if projection already exists.
Parameters
- declaration: ProjectionDeclaration
Returns Promise<void>
Implementation of Sorci.createProjection
- Defined in sorci.postgres.ts:912

dropProjection

dropProjection(name: string): Promise<void>
Drop a projection completely
Parameters
- name: string
Returns Promise<void>
Implementation of Sorci.dropProjection
- Defined in sorci.postgres.ts:1064

queryProjection

queryProjection(
name: string,
options?: { where?: Record<string, any> },
): Promise<any[]>
Query a projection
Parameters
- name: string
- Optionaloptions: { where?: Record<string, any> }
Returns Promise<any[]>
Implementation of Sorci.queryProjection
- Defined in sorci.postgres.ts:1044

refreshProjection

refreshProjection(name: string): Promise<void>
Manually refresh a projection by reprocessing all events
Parameters
- name: string
Returns Promise<void>
Implementation of Sorci.refreshProjection
- Defined in sorci.postgres.ts:1129

setEventReducingToProjection

setEventReducingToProjection(
    payload: {
        eventType: string;
        name: string;
        reducer: EventReducer;
        refreshProjection?: boolean;
    },
): Promise<void>
Set an event-specific reducer for a projection (adds new or updates existing)
Parameters
- payload: {
      eventType: string;
      name: string;
      reducer: EventReducer;
      refreshProjection?: boolean;
  }
Returns Promise<void>
Implementation of Sorci.setEventReducingToProjection
- Defined in sorci.postgres.ts:1090

updateProjection

updateProjection(
    payload: {
        alterationSQL: (sql: Sql, tableName: string) => PendingQuery<Row[]>;
        name: string;
    },
): Promise<void>
Update an existing projection's schema with custom SQL alterations. Throws if projection doesn't exist.
Parameters
- payload: {
  alterationSQL: (sql: Sql, tableName: string) => PendingQuery<Row[]>;
  name: string;
  }
Returns Promise<void>
Implementation of Sorci.updateProjection
- Defined in sorci.postgres.ts:1197

Stream

appendEvent

appendEvent(payload: AppendEventPayload): Promise<any>
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.
Parameters
- payload: AppendEventPayload
Returns Promise<any>
The event id
Implementation of Sorci.appendEvent
- Defined in sorci.postgres.ts:825

getEventById

getEventById(
    id: string,
): Promise<
    | { data: any; id: any; identifier: any; timestamp: any; type: any }
    | undefined,
>
Will retrieve one event by it's id
Parameters
- id: string
Returns Promise<
| { data: any; id: any; identifier: any; timestamp: any; type: any }
| undefined,
>
Implementation of Sorci.getEventById
- Defined in sorci.postgres.ts:450

getEventsByQuery

getEventsByQuery(query: Query, sql?: any): Promise<PersistedEvent[]>
Will retrieve every event that match the Query
Parameters
- query: Query
- sql: any = ...
Returns Promise<PersistedEvent[]>
Implementation of Sorci.getEventsByQuery
- Defined in sorci.postgres.ts:729

Tooling

close

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

Returns Promise<any>
Implementation of Sorci.close
- Defined in sorci.postgres.ts:435

createStream

createStream(): Promise<void>
Will create necessary table

Returns Promise<void>
Implementation of Sorci.createStream
- Defined in sorci.postgres.ts:358

dropAllTestStream

dropAllTestStream(payload?: { excludeCurrentStream: boolean }): Promise<void>
Will destroy every stream prefixed by 'test-' Usefull to cleanup all test stream
Parameters
- Optionalpayload: { excludeCurrentStream: boolean }
Returns Promise<void>
Implementation of Sorci.dropAllTestStream
- Defined in sorci.postgres.ts:401

dropCurrentStream

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

Returns Promise<void>
Implementation of Sorci.dropCurrentStream
- Defined in sorci.postgres.ts:397

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
Parameters
- events: ToPersistEvent[]
Returns Promise<string[]>
An array of event id
Implementation of Sorci.insertEvents
- Defined in sorci.postgres.ts:441

ready

ready(): Promise<void>
Wait for instance to finish loading projections from database

Returns Promise<void>
Implementation of Sorci.ready
- Defined in sorci.postgres.ts:304

setupTestStream

setupTestStream(streamName?: string): Promise<void>
Will create a stream with random name prefixed by 'test-' Usefull to setup a test stream
Parameters
- OptionalstreamName: string
Returns Promise<void>
Remarks
You can give a name to the stream if you want to
Implementation of Sorci.setupTestStream
- Defined in sorci.postgres.ts:363

truncate

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

Returns Promise<void>
Implementation of Sorci.truncate
- Defined in sorci.postgres.ts:429

Class SorciPostgresNamespace

Implements

Index

Other

Projections

Stream

Tooling

Other

constructor

Parameters

Returns SorciPostgres

Parameters

Returns SorciPostgres

sql

Returns any

streamName

Returns string

streamNameIdentifier

Returns any

cleanStream

Parameters

Returns Promise<any>

createBasicTable

Parameters

Returns Promise<void>

Projections

createProjection

Parameters

Returns Promise<void>

dropProjection

Parameters

Returns Promise<void>

queryProjection

Parameters

Returns Promise<any[]>

refreshProjection

Parameters

Returns Promise<void>

setEventReducingToProjection

Parameters

Returns Promise<void>

updateProjection

Parameters

Returns Promise<void>

Stream

appendEvent

Parameters

Returns Promise<any>

getEventById

Parameters

Returns Promise< | { data: any; id: any; identifier: any; timestamp: any; type: any } | undefined,>

getEventsByQuery

Parameters

Returns Promise<PersistedEvent[]>

Tooling

close

Returns Promise<any>

createStream

Returns Promise<void>

dropAllTestStream

Parameters

Returns Promise<void>

dropCurrentStream

Returns Promise<void>

insertEvents

Parameters

Returns Promise<string[]>

ready

Returns Promise<void>

setupTestStream

Parameters

Returns Promise<void>

Remarks

truncate

Returns Promise<void>

Settings

On This Page

Class SorciPostgres`Namespace`

Returns Promise<
| { data: any; id: any; identifier: any; timestamp: any; type: any }
| undefined,
>