Class SorciPostgres

Namespace

Hierarchy

SorciPostgres

Implements

Sorci

Constructors

constructor

new SorciPostgres(payload: SorciConstructorPayload): SorciPostgres
Parameters
- payload: SorciConstructorPayload
Returns SorciPostgres
- Defined in sorci.postgres.ts:32
new SorciPostgres(payload: {
connectionString: string;
streamName: string;
}): SorciPostgres
Parameters
- payload: {
  connectionString: string;
  streamName: string;
  }
  - connectionString: string
  - streamName: string
Returns SorciPostgres
- Defined in sorci.postgres.ts:33

Properties

`Private` _sql

_sql: any

`Private` _streamName

_streamName: string

Accessors

sql

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

streamName

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

streamNameReadOnly

get streamNameReadOnly(): string
Returns string
- Defined in sorci.postgres.ts:96

streamNameReadOnlyIdentifier

get streamNameReadOnlyIdentifier(): any
Returns any
- Defined in sorci.postgres.ts:113

streamNameWritable

get streamNameWritable(): string
Returns string
- Defined in sorci.postgres.ts:92

streamNameWritableIdentifier

get streamNameWritableIdentifier(): any
Returns any
- Defined in sorci.postgres.ts:109

syncronizationFunctionName

get syncronizationFunctionName(): string
Returns string
- Defined in sorci.postgres.ts:100

syncronizationFunctionNameIdentifier

get syncronizationFunctionNameIdentifier(): any
Returns any
- Defined in sorci.postgres.ts:117

syncronizationTriggerName

get syncronizationTriggerName(): string
Returns string
- Defined in sorci.postgres.ts:104

syncronizationTriggerNameIdentifier

get syncronizationTriggerNameIdentifier(): any
Returns any
- Defined in sorci.postgres.ts:121

Methods

appendEvent

appendEvent(payload: {
    sourcingEvent: ToPersistEvent;
} | {
    eventIdentifier: string;
    query: Query;
    sourcingEvent: ToPersistEvent;
}): Promise<any>
Will append an event. It will make sure there is no concurrency issue if query & eventIdentifier is provided

Returns
The event id
Parameters
- payload: {
      sourcingEvent: ToPersistEvent;
  } | {
      eventIdentifier: string;
      query: Query;
      sourcingEvent: ToPersistEvent;
  }
Returns Promise<any>
Implementation of Sorci.appendEvent
- Defined in sorci.postgres.ts:349

`Private` appendEventWithQuery

appendEventWithQuery(payload: {
    eventIdentifier: string;
    query: Query;
    sourcingEvent: ToPersistEvent;
}): Promise<any>
Parameters
- payload: {
      eventIdentifier: string;
      query: Query;
      sourcingEvent: ToPersistEvent;
  }
  - eventIdentifier: string
  - query: Query
  - sourcingEvent: ToPersistEvent
Returns Promise<any>
- Defined in sorci.postgres.ts:377

`Private` appendEventWithoutQuery

appendEventWithoutQuery(sourcingEvent: ToPersistEvent): Promise<string>
Parameters
- sourcingEvent: ToPersistEvent
Returns Promise<string>
- Defined in sorci.postgres.ts:424

cleanStream

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

createBasicTable

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

createStream

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

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

createSyncronizationPgFunction

createSyncronizationPgFunction(): Promise<void>
Returns Promise<void>
- Defined in sorci.postgres.ts:158

createSyncronizationTrigger

createSyncronizationTrigger(): Promise<void>
Returns Promise<void>
- Defined in sorci.postgres.ts:178

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>
Implementation of Sorci.dropAllTestStream
- Defined in sorci.postgres.ts:240

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:236

getEventById

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

getEventsByQuery

getEventsByQuery(query: Query): Promise<any>
Will retrieve every event that match the Query
Parameters
- query: Query
Returns Promise<any>
Implementation of Sorci.getEventsByQuery
- Defined in sorci.postgres.ts:326

`Private` getStreamNameReadOnly

getStreamNameReadOnly(streamName: string): string
Parameters
- streamName: string
Returns string
- Defined in sorci.postgres.ts:75

`Private` getStreamNameWritable

getStreamNameWritable(streamName: string): string
Parameters
- streamName: string
Returns string
- Defined in sorci.postgres.ts:71

`Private` getSyncronizationFunctionName

getSyncronizationFunctionName(streamName: string): string
Parameters
- streamName: string
Returns string
- Defined in sorci.postgres.ts:80

`Private` getSyncronizationTriggerName

getSyncronizationTriggerName(streamName: string): string
Parameters
- streamName: string
Returns string
- Defined in sorci.postgres.ts:86

`Private` getWhereStatement

getWhereStatement(sql: Sql<{}>, query: Query): PendingQuery<Row[]>
Parameters
- sql: Sql<{}>
- query: Query
Returns PendingQuery<Row[]>
- Defined in sorci.postgres.ts:289

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[]>
Implementation of Sorci.insertEvents
- Defined in sorci.postgres.ts:280

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>
Implementation of Sorci.setupTestStream
- Defined in sorci.postgres.ts:201

truncate

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

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

Class SorciPostgres

Namespace

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

payload: SorciConstructorPayload

Returns SorciPostgres

Parameters

payload: { connectionString: string; streamName: string; }

connectionString: string

streamName: string

Returns SorciPostgres

Properties

Private _sql

Private _streamName

Accessors

sql

Returns any

streamName

Returns string

streamNameReadOnly

Returns string

streamNameReadOnlyIdentifier

Returns any

streamNameWritable

Returns string

streamNameWritableIdentifier

Returns any

syncronizationFunctionName

Returns string

syncronizationFunctionNameIdentifier

Returns any

syncronizationTriggerName

Returns string

syncronizationTriggerNameIdentifier

Returns any

Methods

appendEvent

Returns

Parameters

payload: { sourcingEvent: ToPersistEvent; } | { eventIdentifier: string; query: Query; sourcingEvent: ToPersistEvent; }

Returns Promise<any>

Private appendEventWithQuery

Parameters

payload: { eventIdentifier: string; query: Query; sourcingEvent: ToPersistEvent; }

eventIdentifier: string

query: Query

sourcingEvent: ToPersistEvent

Returns Promise<any>

Private appendEventWithoutQuery

Parameters

sourcingEvent: ToPersistEvent

Returns Promise<string>

cleanStream

Parameters

streamName: string

Returns Promise<any>

createBasicTable

Parameters

tableName: string

Returns Promise<void>

createStream

Returns Promise<void>

createSyncronizationPgFunction

Returns Promise<void>

createSyncronizationTrigger

Returns Promise<void>

dropAllTestStream

Parameters

Optional payload: { excludeCurrentStream: boolean; }

excludeCurrentStream: boolean

Returns Promise<void>

dropCurrentStream

payload: {
connectionString: string;
streamName: string;
}

`Private` _sql

`Private` _streamName

payload: {
sourcingEvent: ToPersistEvent;
} | {
eventIdentifier: string;
query: Query;
sourcingEvent: ToPersistEvent;
}

`Private` appendEventWithQuery

payload: {
eventIdentifier: string;
query: Query;
sourcingEvent: ToPersistEvent;
}

`Private` appendEventWithoutQuery

`Optional` payload: {
excludeCurrentStream: boolean;
}

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

`Private` getStreamNameReadOnly

`Private` getStreamNameWritable

`Private` getSyncronizationFunctionName

`Private` getSyncronizationTriggerName

`Private` getWhereStatement

`Optional` streamName: string