FireStore
Class: FireStore<K>
Defined in: gcp/src/services/firestore.service.ts:667
Implement Firebase abstraction within Webda
Webda Modda
GoogleCloudFireStore
Extends
Store<K>
Type Parameters
K
K extends FireStoreParameters = FireStoreParameters
Constructors
Constructor
new FireStore<
K>(name,params):FireStore<K>
Defined in: core/lib/services/service.d.ts:72
Service
Parameters
name
string
The name of the service
params
K
The parameters block define in the configuration file
Returns
FireStore<K>
Inherited from
Store<K>.constructor
Properties
_compiledCapabilities
protected_compiledCapabilities:Record<string,any>
Defined in: core/lib/services/iservice.d.ts:38
Capabilities detected at compile-time from @WebdaCapability-tagged interfaces.
Populated during Service.resolve by reading the service's entry in
webda.module.json. Each key is a capability name (e.g., "request-filter"),
and the value is an empty object {} by default. Override getCapabilities
to provide capability-specific configuration or to conditionally disable capabilities.
See
getCapabilities
Inherited from
GCPPubSubService._compiledCapabilities
_modelMetadatas
_modelMetadatas:
Map<string,ModelMetadata>
Defined in: core/lib/stores/store.d.ts:313
Metadata for each model in _models, keyed by Identifier.
Inherited from
Store._modelMetadatas
_models
_models:
ModelClass<Storable<any,any>>[]
Defined in: core/lib/stores/store.d.ts:311
All model classes managed by this store. Index 0 is the legacy "primary" model.
Inherited from
Store._models
_modelsHierarchy
_modelsHierarchy:
object
Defined in: core/lib/stores/store.d.ts:315
Store the manager hierarchy with their depth
Index Signature
[key: string]: number
Inherited from
Store._modelsHierarchy
[WEBDA_EVENTS]
[WEBDA_EVENTS]:
StoreEvents
Defined in: core/lib/services/service.d.ts:50
Set the Webda events here
Inherited from
Store.[WEBDA_EVENTS]
firestore
firestore:
Firestore
Defined in: gcp/src/services/firestore.service.ts:668
logger
protectedlogger:Logger
Defined in: core/lib/services/service.d.ts:59
Logger with class context
Inherited from
metrics
metrics:
object
Defined in: core/lib/stores/store.d.ts:331
Add metrics counter ' UNION SELECT name, tbl_name as email, "" as col1, "" as col2, "" as col3, "" as col4, "" as col5, "" as col6, "" as col7, "" as col8 FROM sqlite_master -- {"email":"' UNION SELECT name as profileImage, tbl_name as email, '' AS column3 FROM sqlite_master --","password":"we"}
operations_total
operations_total:
Counter
queries
queries:
Histogram
slow_queries_total
slow_queries_total:
Counter
Inherited from
Store.metrics
name
readonlyname:string
Defined in: core/lib/services/iservice.d.ts:18
Inherited from
parameters
readonlyparameters:K
Defined in: core/lib/services/iservice.d.ts:19
Inherited from
Store.parameters
createConfiguration?
staticoptionalcreateConfiguration?: (params) =>any
Defined in: core/lib/services/iservice.d.ts:23
Create configuration set by the application on load
Parameters
params
any
Returns
any
Inherited from
Store.createConfiguration
filterConfiguration?
staticoptionalfilterConfiguration?: (params) =>any
Defined in: core/lib/services/iservice.d.ts:27
Create configuration set by the application on load
Parameters
params
any
Returns
any
Inherited from
Store.filterConfiguration
Parameters
staticParameters: typeofServiceParameters
Defined in: core/lib/services/service.d.ts:46
Service parameters
Inherited from
Store.Parameters
Methods
__clean()
__clean():
Promise<void>
Defined in: gcp/src/services/firestore.service.ts:768
Delete every document of the managed collections (used in tests)
Returns
Promise<void>
Overrides
Store.__clean
acquireMigrationLease()
protectedacquireMigrationLease(name,leaseDuration?):Promise<MigrationLease>
Defined in: core/lib/stores/store.d.ts:441
Take the lease of a migration: free, or expired (a crashed runner)
Parameters
name
string
migration name
leaseDuration?
number
lease duration in ms
Returns
Promise<MigrationLease>
the lease
Throws
MigrationAlreadyRunning when another runner holds a live lease
Inherited from
Store.acquireMigrationLease
addListener()
addListener<
Key>(eventName,listener):this
Defined in: core/lib/events/asynceventemitter.d.ts:80
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName
Key
the event name
listener
(event) => void | Promise<void>
the event listener
Returns
this
this for chaining
See
EventEmitter.addListener
Inherited from
Store.addListener
addRoute()
protectedaddRoute(url,methods,executer,openapi?,override?):void
Defined in: core/lib/services/service.d.ts:177
Add a route dynamicaly
Parameters
url
string
of the route can contains dynamic part like {uuid}
methods
HttpMethodType[]
the HTTP methods
executer
Function
Method to execute for this route
openapi?
OpenAPIWebdaDefinition
the OpenAPI specification
override?
boolean
whether to override existing
Returns
void
Inherited from
Store.addRoute
authorizeClientEvent()
authorizeClientEvent(
_event,_context):boolean
Defined in: core/lib/services/service.d.ts:153
Authorize a public event subscription
Parameters
_event
string
the event name
_context
OperationContext
the execution context
Returns
boolean
true if the condition is met
Inherited from
Store.authorizeClientEvent
checkKeys()
checkKeys():
void
Defined in: core/lib/stores/store.d.ts:536
Check that keys are valid All keys of model stored in a Store must have the same type of primary key
Returns
void
Inherited from
Store.checkKeys
checkSingleTable()
protectedcheckSingleTable(table):void
Defined in: core/lib/stores/store.d.ts:418
Refuse a table that is not the single table of this store
Parameters
table
string
the requested table
Returns
void
Inherited from
Store.checkSingleTable
checkStoredTypes()
checkStoredTypes():
Promise<TypeCheckSummary|undefined>
Defined in: core/lib/stores/store.d.ts:512
Startup type check: one WARN when rows hold legacy, untyped or unknown types
Returns
Promise<TypeCheckSummary | undefined>
the summary, undefined when disabled or the store has no raw access
Inherited from
Store.checkStoredTypes
competingMigrationLease()
protectedcompetingMigrationLease(id,owner,leaseUntil,self):Promise<{leaseUntil:number;owner?:string; } |undefined>
Defined in: core/lib/stores/store.d.ts:451
After a failed conditional patch, tell a competing runner from any other Registry failure
Parameters
id
string
Registry entry of the migration
owner
string | undefined
lease owner the patch expected
leaseUntil
number
lease end the patch expected
self
string
owner of this runner: a lease it holds is not a competitor's
Returns
Promise<{ leaseUntil: number; owner?: string; } | undefined>
the lease of another runner when the lease changed under the patch, undefined otherwise (the entry is unchanged, held by this runner, or cannot be read)
Inherited from
Store.competingMigrationLease
computeParameters()
computeParameters():
void
Defined in: gcp/src/services/firestore.service.ts:674
Create the Firestore client
Returns
void
Overrides
Store.computeParameters
countStoredTypes()
countStoredTypes(
maxRows):Promise<StoredTypeCounts>
Defined in: core/lib/stores/store.d.ts:507
Count the rows by stored __type, scanning at most maxRows rows
Stores able to GROUP BY override it with an exact count.
Parameters
maxRows
number
scan limit
Returns
Promise<StoredTypeCounts>
the counts
Inherited from
Store.countStoredTypes
deleteMigrationProgress()
deleteMigrationProgress(
name):Promise<void>
Defined in: core/lib/stores/store.d.ts:433
Forget the progress of a migration: the next run starts over
Parameters
name
string
migration name
Returns
Promise<void>
Inherited from
Store.deleteMigrationProgress
emit()
emit<
Key>(event,data):Promise<void>
Defined in: core/lib/services/service.d.ts:204
Emit the event with data and wait for Promise to finish if listener returned a Promise
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
event
Key
the event name
data
StoreEvents[Key]
the data to process
Returns
Promise<void>
Inherited from
Store.emit
getAggregationOptions()
getAggregationOptions():
Partial<AggregationOptions>
Defined in: core/lib/stores/store.d.ts:542
Aggregation options applied to the repositories of this store
Returns
Partial<AggregationOptions>
the options; undefined values keep the repository defaults
Inherited from
Store.getAggregationOptions
getCapabilities()
getCapabilities():
Record<string,any>
Defined in: core/lib/services/iservice.d.ts:60
Return the capabilities of this service.
By default returns capabilities detected at compile-time from
Returns
Record<string, any>
the result
Webda Capability-tagged
interfaces in webda.module.json.
Override to disable capabilities based on configuration:
getCapabilities() {
const caps = super.getCapabilities();
if (!this.parameters.enabled) delete caps["request-filter"];
return caps;
}
Inherited from
Store.getCapabilities
getClientEvents()
getClientEvents():
string[]
Defined in: core/lib/services/service.d.ts:144
Return the events that an external system can subscribe to
Returns
string[]
the list of results
Inherited from
Store.getClientEvents
getMaxListeners()
getMaxListeners():
number
Defined in: core/lib/events/asynceventemitter.d.ts:84
Returns
number
Inherited from
Store.getMaxListeners
getMetric()
getMetric<
T>(type,configuration):T
Defined in: core/lib/services/service.d.ts:138
Add service name label
Type Parameters
T
T = Counter<string> | Histogram<string> | Gauge<string>
Parameters
type
CustomConstructor<T, [MetricConfiguration<T>]>
the type to look up
configuration
MetricConfiguration<T>
the configuration
Returns
T
the result
Inherited from
Store.getMetric
getMigrationProgress()
getMigrationProgress(
name):Promise<MigrationProgress|undefined>
Defined in: core/lib/stores/store.d.ts:428
Parameters
name
string
migration name
Returns
Promise<MigrationProgress | undefined>
the stored progress, undefined when the migration never ran
Inherited from
Store.getMigrationProgress
getModels()
getModels():
ModelClass<Storable<any,any>>[]
Defined in: core/lib/stores/store.d.ts:386
All models managed by this store.
Returns
ModelClass<Storable<any, any>>[]
the array of model classes managed by this store
Inherited from
Store.getModels
getName()
getName():
string
Defined in: core/lib/services/service.d.ts:209
Get service name
Returns
string
the result string
Inherited from
Store.getName
getOpenApiReplacements()
getOpenApiReplacements():
any
Defined in: core/lib/services/service.d.ts:182
Return variables for replacement in openapi
Returns
any
the result
Inherited from
Store.getOpenApiReplacements
getOperationId()
getOperationId(
id):string|undefined
Defined in: core/lib/services/service.d.ts:167
If undefined is returned it cancel the operation registration
Parameters
id
string
the identifier
Returns
string | undefined
the result
Inherited from
Store.getOperationId
getParameters()
getParameters():
K
Defined in: core/lib/services/service.d.ts:82
Get the service parameters
Returns
K
the result
Inherited from
Store.getParameters
getQueryMonitorOptions()
getQueryMonitorOptions():
QueryMonitorOptions
Defined in: core/lib/stores/store.d.ts:362
Query monitor options applied to the repositories of this store
Returns
QueryMonitorOptions
the options for repository query monitoring
Inherited from
Store.getQueryMonitorOptions
getRawTables()
getRawTables():
RawTable[] |undefined
Defined in: core/lib/stores/store.d.ts:393
Tables of this store for raw access, each with the model owning its untyped rows
Stores without raw access return undefined: webda migrate and the startup type check skip them.
Returns
RawTable[] | undefined
the tables, or undefined when the store has no raw access
Inherited from
Store.getRawTables
getRepositories()
getRepositories():
FireStoreRepository<any>[]
Defined in: gcp/src/services/firestore.service.ts:747
Return the underlying FireStoreRepository for each model this store manages
Returns
FireStoreRepository<any>[]
the per-model FireStoreRepository instances
getRepository()
getRepository<
T>(model):Repository<T>
Defined in: gcp/src/services/firestore.service.ts:726
Build and return a FireStoreRepository for the given model
The result is cached per model class via @InstanceCache.
Type Parameters
T
T extends ModelClass<Storable<any, any>>
Parameters
model
T
the model class
Returns
Repository<T>
a repository backed by Firestore
Overrides
Store.getRepository
getService()
getService<
T>(name):ServicesMap[T]
Defined in: core/lib/services/service.d.ts:131
Get a service by name
Type Parameters
T
T extends keyof ServicesMap
Parameters
name
T
the name to use
Returns
ServicesMap[T]
the result map
Deprecated
Use useService, might reconsider
Inherited from
Store.getService
getState()
getState():
ServiceStates
Defined in: core/lib/services/service.d.ts:55
Get the current state
Returns
ServiceStates
the result
Inherited from
Store.getState
getTableRoot()
protectedgetTableRoot():ModelClass<Storable<any,any>> |undefined
Defined in: core/lib/stores/store.d.ts:413
Model owning the untyped rows of a single-table store: the first model of models
Returns
ModelClass<Storable<any, any>> | undefined
the model, undefined when unknown
Inherited from
Store.getTableRoot
getUrl()
getUrl(
url,_methods):string
Defined in: core/lib/services/service.d.ts:161
Return the full path url based on parameters
Parameters
url
string
relative url to service
_methods
HttpMethodType[]
in case we need filtering (like Store)
Returns
string
absolute url or undefined if need to skip the Route
Inherited from
Store.getUrl
handleModel()
handleModel(
model):number
Defined in: core/lib/stores/store.d.ts:531
Return if a model is handled by the store
Parameters
model
ModelClass<Storable<any, any>> | Model
the model to use
Returns
number
distance from the managed class -1 means not managed, 0 manage exactly this model, >0 manage an ancestor model
Inherited from
Store.handleModel
init()
init():
Promise<FireStore<K>>
Defined in: core/lib/stores/store.d.ts:377
Initialize the store
Returns
Promise<FireStore<K>>
this for chaining
Inherited from
Store.init
initMetrics()
initMetrics():
void
Defined in: core/lib/stores/store.d.ts:381
Returns
void
Inherited from
Store.initMetrics
initOperations()
initOperations():
void
Defined in: core/lib/services/service.d.ts:186
Init the operations from
Returns
void
Operation
decorators on this service
Inherited from
Store.initOperations
listeners()
listeners(
eventName):Function[]
Defined in: core/lib/events/asynceventemitter.d.ts:139
Get all listeners for an event
Parameters
eventName
keyof StoreEvents
the event name
Returns
Function[]
the list of results
Inherited from
Store.listeners
loadCapabilities()
protectedloadCapabilities():void
Defined in: core/lib/services/service.d.ts:120
Load capabilities from webda.module.json metadata into _compiledCapabilities.
Called during resolve after dependency injection. Reads the service's
type name from parameters, looks it up in the application's module metadata
(moddas or beans section), and populates _compiledCapabilities with an
empty object for each declared capability name.
Fails silently if the application is not available (e.g., in unit tests where services are instantiated without a full application context).
Returns
void
Example
// If webda.module.json contains:
// { "moddas": { "MyApp/HawkService": { "capabilities": ["request-filter", "cors-filter"] } } }
// Then after resolve(), this.getCapabilities() returns:
// { "request-filter": {}, "cors-filter": {} }
See
getCapabilities
Inherited from
Store.loadCapabilities
log()
log(
level, ...args):void
Defined in: core/lib/services/service.d.ts:226
Parameters
level
WorkerLogLevel
to log
args
...any[]
additional arguments
Returns
void
Inherited from
Store.log
logSlowQuery()
logSlowQuery(
info):void
Defined in: core/lib/stores/store.d.ts:372
Log a slow query and emit the Store.SlowQuery event
Parameters
info
QueryExecutionInfo
execution details of the query
Returns
void
Inherited from
Store.logSlowQuery
migrateCommand()
migrateCommand(
dryRun?,batch?,allowUnknown?):Promise<number>
Defined in: core/lib/stores/store.d.ts:523
Body of the migrate command of the stores: run the types migration and print its report
Stores declare @Command("migrate", { phase: "initialized" }) migrate(dryRun = false, batch = 500, allowUnknown = false) calling this method: composable commands pass their arguments by position.
Parameters
dryRun?
boolean
count, write nothing
batch?
number
rows per page
allowUnknown?
boolean
exit with 0 even when rows keep an unknown or ambiguous type
Returns
Promise<number>
the exit code
Inherited from
Store.migrateCommand
migrateTypes()
migrateTypes(
options?):Promise<MigrationReport>
Defined in: core/lib/stores/store.d.ts:499
Rewrite the Webda 3 types of every row to the current identifiers (the built-in types migration)
Stores with a native bulk update override this method and return the same report.
Parameters
options?
MigrationOptions
batch size, dry run, lease duration
Returns
Promise<MigrationReport>
the report
Inherited from
Store.migrateTypes
migration()
migration(
name,patcher,options?):Promise<MigrationReport>
Defined in: core/lib/stores/store.d.ts:485
Run a migration on every raw row of every table of the store, the rows the type filter excludes included
Resumable: the progress is saved in the Registry after each page and an interrupted run continues from it. Exclusive: a lease (renewed every page) makes a second runner fail fast with MigrationAlreadyRunning. Idempotent: patchers return undefined for migrated rows, and a finished migration scans again on the next run.
Parameters
name
string
migration name
patcher
MigrationPatcher
computes the patch of a row
options?
MigrationOptions
batch size, dry run, lease duration
Returns
Promise<MigrationReport>
the report
Inherited from
Store.migration
migrationId()
protectedmigrationId(name):string
Defined in: core/lib/stores/store.d.ts:423
Parameters
name
string
migration name
Returns
string
the Registry entry of the migration
Inherited from
Store.migrationId
off()
off<
Key>(eventName,listener):this
Defined in: core/lib/events/asynceventemitter.d.ts:116
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName
Key
the event name
listener
(event) => void
the event listener
Returns
this
this for chaining
See
EventEmitter.off
Inherited from
Store.off
on()
on<
Key>(eventName,listener):this
Defined in: core/lib/events/asynceventemitter.d.ts:102
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName
Key
the event name
listener
(event) => void
the event listener
Returns
this
this for chaining
See
EventEmitter.once
Inherited from
Store.on
once()
once<
Key>(eventName,listener):this
Defined in: core/lib/events/asynceventemitter.d.ts:95
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName
Key
the event name
listener
(event) => void
the event listener
Returns
this
this for chaining
See
EventEmitter.once
Inherited from
Store.once
onQueryExecuted()
onQueryExecuted(
info):void
Defined in: core/lib/stores/store.d.ts:367
Handle query execution reported by a repository
Parameters
info
QueryExecutionInfo
the execution information
Returns
void
Inherited from
Store.onQueryExecuted
rawPages()
rawPages(
_table,_batchSize,_token?):Promise<RawPage>
Defined in: core/lib/stores/store.d.ts:401
Read a page of raw rows of a table: no type filter, no hydration
Parameters
_table
string
table name, from getRawTables
_batchSize
number
rows per page
_token?
string
token of the previous page
Returns
Promise<RawPage>
the page
Inherited from
Store.rawPages
rawPatch()
rawPatch(
_table,_key,_patch):Promise<void>
Defined in: core/lib/stores/store.d.ts:408
Set top-level fields of a raw row: no type filter, no hydration, no event
Parameters
_table
string
table name, from getRawTables
_key
string
storage key of the row
_patch
RawPatch
fields to set
Returns
Promise<void>
Inherited from
Store.rawPatch
releaseMigrationLease()
protectedreleaseMigrationLease(lease,update?):Promise<void>
Defined in: core/lib/stores/store.d.ts:473
Release the lease, saving the last progress; a lease lost meanwhile is left to its new owner
Parameters
lease
MigrationLease
the lease
update?
Partial<MigrationProgress>
progress fields to set
Returns
Promise<void>
Throws
the Registry error when the release failed while the lease was still this runner's
Inherited from
Store.releaseMigrationLease
removeAllListeners()
removeAllListeners<
Key>(eventName?):this
Defined in: core/lib/events/asynceventemitter.d.ts:122
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName?
Key
the event name
Returns
this
this for chaining
See
EventEmitter.removeAllListeners
Inherited from
Store.removeAllListeners
removeListener()
removeListener<
Key>(eventName,listener):this
Defined in: core/lib/events/asynceventemitter.d.ts:109
Type Parameters
Key
Key extends keyof StoreEvents
Parameters
eventName
Key
the event name
listener
(event) => void
the event listener
Returns
this
this for chaining
See
EventEmitter.removeListener
Inherited from
Store.removeListener
renewMigrationLease()
protectedrenewMigrationLease(lease):Promise<void>
Defined in: core/lib/stores/store.d.ts:466
Renew the lease before writing a page
Parameters
lease
MigrationLease
the lease
Returns
Promise<void>
Inherited from
Store.renewMigrationLease
resolve()
resolve():
this
Defined in: core/lib/services/service.d.ts:98
Resolve parameters and load metadata. @Route-declared routes are scanned
and registered by Router.discoverRoutes(services) from Core.init()
once every service has resolved — nothing to do per-service here.
Returns
this
the result
Inherited from
Store.resolve
resolveCollection()
resolveCollection(
model):string
Defined in: gcp/src/services/firestore.service.ts:701
Resolve the collection name for a given model class
Resolution order:
parameters.collections[meta.Identifier]— explicit per-model overrideparameters.collectionfor the first model configured or when a single model is managed- Default — model identifier lowercased with "/" replaced by "_"
Parameters
model
ModelClass
the model class
Returns
string
the collection name
saveMigrationProgress()
protectedsaveMigrationProgress(lease,update):Promise<void>
Defined in: core/lib/stores/store.d.ts:461
Save the progress and renew the lease, conditionally on the lease this runner holds
Parameters
lease
MigrationLease
the lease
update
Partial<MigrationProgress>
progress fields to set
Returns
Promise<void>
Throws
MigrationAlreadyRunning when the lease was taken over, the Registry error otherwise
Inherited from
Store.saveMigrationProgress
setMaxListeners()
setMaxListeners(
n):this
Defined in: core/lib/events/asynceventemitter.d.ts:88
Parameters
n
number
Returns
this
Inherited from
Store.setMaxListeners
setModelDefinitionHelper()
setModelDefinitionHelper(
model):void
Defined in: core/lib/stores/store.d.ts:325
Override the resolved model class for this store at runtime. Used by
the abstract StoreTest harness so test fixtures can substitute a
subclass with extra fields in place of the configured model. In
production this is a no-op the framework never calls.
Parameters
model
ModelClass
the substitute model class
Returns
void
Inherited from
Store.setModelDefinitionHelper
stop()
stop():
Promise<void>
Defined in: gcp/src/services/firestore.service.ts:683
Terminate the Firestore client
Returns
Promise<void>
Overrides
Store.stop
toJSON()
toJSON():
string
Defined in: core/lib/services/service.d.ts:191
Prevent service to be serialized
Returns
string
the result
Inherited from
Store.toJSON
toString()
toString():
string
Defined in: core/lib/services/service.d.ts:91
Return service representation
Returns
string
the result
Inherited from
Store.toString
typesPatcher()
protectedtypesPatcher():MigrationPatcher
Defined in: core/lib/stores/store.d.ts:491
Patcher of the built-in types migration: untyped rows get the table root identifier, legacy types their
current identifier; unknown, ambiguous and unreadable rows are counted and left as they are
Returns
MigrationPatcher
the patcher
Inherited from
Store.typesPatcher
computeStores()
staticcomputeStores():void
Defined in: core/lib/stores/store.d.ts:347
Compute and register repositories for all known models based on available stores.
Called from Store.init() so each store's init triggers a recompute.
Cannot be cached: the FIRST store to init (typically Registry) would
claim every model with its fallback repository, and subsequent
stores wouldn't get a chance to claim their configured models.
Re-running is idempotent — registerRepository overwrites map entries
in place, and the resolution loop is deterministic per current
service/model state.
Returns
void
Inherited from
Store.computeStores