Skip to main content

SQLitePubSubParameters

@webda/sqlite

Class: SQLitePubSubParameters

Defined in: sqlite/src/sqlitepubsub.service.ts:12

Configuration for SQLitePubSubService

Extends​

  • ServiceParameters

Implements​

Constructors​

Constructor​

new SQLitePubSubParameters(): SQLitePubSubParameters

Returns​

SQLitePubSubParameters

Inherited from​

ServiceParameters.constructor

Properties​

autoCreateTable?​

optional autoCreateTable?: boolean

Defined in: sqlite/src/sqlitepubsub.service.ts:43

Create the table on init

Default​

true

batchSize?​

optional batchSize?: number

Defined in: sqlite/src/sqlitepubsub.service.ts:38

Max messages fetched per poll

Default​

100

busyTimeout?​

optional busyTimeout?: number

Defined in: sqlite/src/sqlitepubsub.service.ts:56

PRAGMA busy_timeout in ms

Default​

5000

Implementation of​

SQLiteConnectionParameters.busyTimeout

channel?​

optional channel?: string

Defined in: sqlite/src/sqlitepubsub.service.ts:17

Channel name

Default​

the service name lowercased

database?​

optional database?: SQLDatabase

Defined in: sqlite/src/sqlitepubsub.service.ts:51

Services giving the same database name share one handle

Implementation of​

SQLiteConnectionParameters.database

persistence?​

optional persistence?: SQLitePersistence

Defined in: sqlite/src/sqlitepubsub.service.ts:47

Omitted: in-process only (services sharing database.name); set: file shared by the processes of one host

Implementation of​

SQLiteConnectionParameters.persistence

pollInterval?​

optional pollInterval?: number

Defined in: sqlite/src/sqlitepubsub.service.ts:28

Poll interval in ms for messages written by other processes

Default​

100

pragmas?​

optional pragmas?: Record<string, string | number>

Defined in: sqlite/src/sqlitepubsub.service.ts:60

Extra PRAGMAs run on open

Implementation of​

SQLiteConnectionParameters.pragmas

retention?​

optional retention?: number

Defined in: sqlite/src/sqlitepubsub.service.ts:33

Seconds a message is kept for slow consumers before being purged

Default​

60

table?​

optional table?: string

Defined in: sqlite/src/sqlitepubsub.service.ts:23

Table holding the message log

Default​

"webda_pubsub"

Pattern​

/^[a-zA-Z_][a-zA-Z0-9_]*$/

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: sqlite/src/sqlitepubsub.service.ts:67

Parameters​

params?​

any = {}

the input parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with