routier-collection / core/src / IDbPlugin
Interface: IDbPlugin
Defined in: core/src/plugins/types.ts:10
Interface for a database plugin, which provides query, destroy, and bulk operations.
Properties
databaseName
readonlydatabaseName:string
Defined in: core/src/plugins/types.ts:32
Uniquely identifies the database this plugin talks to, INCLUDING host or path where a bare name would collide — orders.db in two directories is two databases, and mydb on two hosts is two databases. Two instances over the same database must return the same string, in this process and in any other; two over different databases must not.
Used to scope schema subscription channels, so instances of one database (another tab, a worker) see each other's change notifications and unrelated databases holding the same schema do not.
Required rather than optional on purpose. An absent value used to fall back to scoping by schema alone, which shares one channel across every database holding that schema — the exact cross-talk this prevents, arrived at by omission. Requiring it also makes a wrapper that forgets to forward it a compile error rather than a silent regression.
Derive it, never generate it: a random value is unique per PROCESS, not per database, so another tab would never match one and cross-context notifications would stop.
Must not contain credentials — it becomes part of a channel key, so build it from host/port/database rather than returning a connection string.
Methods
query()
query<
TRoot,TShape>(event,done):void
Defined in: core/src/plugins/types.ts:38
Executes a query operation on the database.
Type Parameters
TRoot
TRoot extends object
TShape
TShape extends unknown = TRoot
Parameters
event
DbPluginQueryEvent<TRoot, TShape>
The query event containing schema, parent, and query operation.
done
PluginEventCallbackResult<ITranslatedValue<TShape>>
Callback with the result or error.
Returns
void
destroy()
destroy(
event,done):void
Defined in: core/src/plugins/types.ts:43
Destroys or cleans up the plugin, closing connections or freeing resources.
Parameters
event
done
PluginEventCallbackResult<never>
Callback with an optional error.
Returns
void
bulkPersist()
bulkPersist(
event,done):void
Defined in: core/src/plugins/types.ts:49
Executes bulk operations (add, update, remove) on the database.
Parameters
event
The bulk operations event containing schema, parent, and changes.
done
PluginEventCallbackPartialResult<BulkPersistResult>
Callback with the result or error.
Returns
void