routier-collection / plugins/replication/src / OptimisticUpdatesDbPlugin
Class: OptimisticUpdatesDbPlugin
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:22
Implements
IDbPlugin
Constructors
Constructor
new OptimisticUpdatesDbPlugin(
source,options?):OptimisticUpdatesDbPlugin
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:60
Parameters
source
IDbPlugin
options?
OptimisticUpdatesDbPluginOptions
Returns
OptimisticUpdatesDbPlugin
Accessors
databaseName
Get Signature
get databaseName():
string
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:56
The SOURCE's name. The read plugin is a per-instance scratch copy with a uuid name; identifying by it would give every instance its own subscription scope and cut two stores over one source database off from each other.
Returns
string
Implementation of
IDbPlugin.databaseName
Methods
query()
query<
TEntity,TShape>(event,done):void
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:81
Will query the read plugin if there is one, otherwise the source plugin will be queried
Type Parameters
TEntity
TEntity extends object
TShape
TShape extends unknown = TEntity
Parameters
event
DbPluginQueryEvent<TEntity, TShape>
done
PluginEventCallbackResult<ITranslatedValue<TShape>>
Returns
void
Implementation of
IDbPlugin.query
destroy()
destroy(
event,done):void
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:185
Destroys or cleans up the plugin, closing connections or freeing resources.
Parameters
event
DbPluginEvent
done
PluginEventCallbackResult<never>
Callback with an optional error.
Returns
void
Implementation of
IDbPlugin.destroy
bulkPersist()
bulkPersist(
event,done):void
Defined in: plugins/replication/src/OptimisticUpdatesDbPlugin.ts:189
Executes bulk operations (add, update, remove) on the database.
Parameters
event
DbPluginBulkPersistEvent
The bulk operations event containing schema, parent, and changes.
done
PluginEventCallbackPartialResult<BulkPersistResult>
Callback with the result or error.
Returns
void
Implementation of
IDbPlugin.bulkPersist