Class FirestoreAdapter

Backend adapter implementation for Google Cloud Firestore. Maps Quatrain's DataObjects and Queries to Firestore documents and collections. Inherits all baseline CRUD and Query logic from AbstractBackendAdapter.

Hierarchy (View Summary)

AbstractBackendAdapter
- FirestoreAdapter

Index

Constructors

constructor

new FirestoreAdapter(params?: BackendParameters): FirestoreAdapter
Parameters
- params: BackendParameters = {}
Returns FirestoreAdapter
Overrides AbstractBackendAdapter.constructor
- Defined in backend-firestore/src/FirestoreAdapter.ts:57

Properties

`Protected`_alias

_alias: string = ''

`Protected`_middlewares

_middlewares: BM[] = []

`Protected`_params

_params: BackendParameters = {}

`Static`PKEY_IDENTIFIER

PKEY_IDENTIFIER: FieldPath = ...

The reserved field path identifier for a document's primary key in Firestore.

Accessors

alias

get alias(): string
Returns string
Inherited from AbstractBackendAdapter.alias
- Defined in backend/src/AbstractBackendAdapter.ts:108
set alias(alias: string): void
Parameters
- alias: string
Returns void
Inherited from AbstractBackendAdapter.alias
- Defined in backend/src/AbstractBackendAdapter.ts:104

Methods

`Protected`_buildPath

_buildPath(dataObject: DataObjectClass<any>, uid?: string): string
Resolves the canonical database path for a record, respecting standard collection structures and hierarchical subcollection configurations.
Parameters
- dataObject: DataObjectClass<any>
- Optionaluid: string
Returns string
Overrides AbstractBackendAdapter._buildPath
- Defined in backend-firestore/src/FirestoreAdapter.ts:65

`Protected`_deleteQueryBatch

_deleteQueryBatch(db: Firestore, query: Query, resolve: any): Promise<void>
Parameters
- db: Firestore
- query: Query
- resolve: any
Returns Promise<void>
- Defined in backend-firestore/src/FirestoreAdapter.ts:273

`Protected`_resolveNativeForeignKeys

_resolveNativeForeignKeys(data: any[]): any[]
Processes raw data entries to convert relational reference objects into native database foreign key IDs if the adapter has been configured with useNativeForeignKeys = true.
Parameters
- data: any[]
Returns any[]
Inherited from AbstractBackendAdapter._resolveNativeForeignKeys
- Defined in backend/src/AbstractBackendAdapter.ts:387

addMiddleware

addMiddleware(middleware: BM): void
Attaches a new middleware to the adapter's execution pipeline. Middlewares are triggered before or after database actions.
Parameters
- middleware: BM
  The instantiated middleware to attach.
Returns void
Throws
If a middleware with the same class name is already attached.
Inherited from AbstractBackendAdapter.addMiddleware
- Defined in backend/src/AbstractBackendAdapter.ts:68

aggregate

aggregate(
    query: Query<any>,
    operation: "sum" | "avg" | "distinct" | "min" | "max" | "count",
    property?: string,
): Promise<any>
Executes an aggregation operation (sum, avg, distinct, min, max, count) on a query. The default implementation fetches all matching records and performs in-memory aggregation. Specific database adapters should override this to perform native query aggregation.
Parameters
- query: Query<any>
  The Query instance defining the collection and filters.
- operation: "sum" | "avg" | "distinct" | "min" | "max" | "count"
  The aggregate operation.
- Optionalproperty: string
  The name of the property to aggregate.
Returns Promise<any>
A promise resolving to the aggregated result.
Inherited from AbstractBackendAdapter.aggregate
- Defined in backend/src/AbstractBackendAdapter.ts:264

create

create(
dataObject: DataObjectClass<any>,
desiredUid: string | undefined,
): Promise<DataObjectClass<any>>
Create record in backend
Parameters
- dataObject: DataObjectClass<any>
  DataObject instance to persist in backend
- desiredUid: string | undefined
Returns Promise<DataObjectClass<any>>
DataObject
Overrides AbstractBackendAdapter.create
- Defined in backend-firestore/src/FirestoreAdapter.ts:100

delete

delete(
dataObject: DataObjectClass<any>,
hardDelete?: boolean,
): Promise<DataObjectClass<any>>
Removes a document from Firestore. If softDelete is enabled in backend parameters and hardDelete is false, it updates the document's status to DELETED instead of destroying the record.
Parameters
- dataObject: DataObjectClass<any>
  The DataObject representing the document to delete.
- hardDelete: boolean = false
  Force absolute removal even if softDelete is globally enabled.
Returns Promise<DataObjectClass<any>>
A promise resolving to the processed DataObject (with cleared URI if hard deleted).
Overrides AbstractBackendAdapter.delete
- Defined in backend-firestore/src/FirestoreAdapter.ts:231

deleteCollection

deleteCollection(collection: string, batchSize?: number): Promise<void>
Completely obliterates an entire collection by batch-deleting all its documents recursively. Use with extreme caution.
Parameters
- collection: string
  The name of the root collection to delete.
- batchSize: number = 500
  The number of documents to delete per transaction chunk.
Returns Promise<void>
A promise resolving when the collection is empty.
Overrides AbstractBackendAdapter.deleteCollection
- Defined in backend-firestore/src/FirestoreAdapter.ts:263

deleteMiddleware

deleteMiddleware(middlewareClassName: string): void
Removes a middleware from the pipeline by its class name.
Parameters
- middlewareClassName: string
  The exact name of the middleware class to remove.
Returns void
Inherited from AbstractBackendAdapter.deleteMiddleware
- Defined in backend/src/AbstractBackendAdapter.ts:82

executeMiddlewares

executeMiddlewares(
    dataObject: DataObjectClass<any>,
    action: BackendAction,
    timing?: "before" | "after",
    params?: MiddlewareParams,
): Promise<DataObjectClass<any>>
Orchestrates the sequential execution of all attached middlewares for a given action.
Parameters
- dataObject: DataObjectClass<any>
  The payload traversing the middlewares.
- action: BackendAction
  The context (READ, CREATE, UPDATE, DELETE).
- timing: "before" | "after" = 'before'
  Whether to run the before or after pipeline.
- Optionalparams: MiddlewareParams
  Optional parameters passed down to the middlewares.
Returns Promise<DataObjectClass<any>>
A promise resolving to the potentially mutated DataObject.
Inherited from AbstractBackendAdapter.executeMiddlewares
- Defined in backend/src/AbstractBackendAdapter.ts:231

find

find(
    dataObject: DataObjectClass<any>,
    filters?: Filter[] | Filters | undefined,
    pagination?: SortAndLimit | undefined,
    parent?: any,
): Promise<QueryResultType<DataObjectClass<any>>>
Execute a query on a collection
Parameters
- dataObject: DataObjectClass<any>
- filters: Filter[] | Filters | undefined = undefined
- pagination: SortAndLimit | undefined = undefined
- parent: any = undefined
Returns Promise<QueryResultType<DataObjectClass<any>>>
Params
parent
Overrides AbstractBackendAdapter.find
- Defined in backend-firestore/src/FirestoreAdapter.ts:309

generateCreateSql

generateCreateSql(
collection: string,
properties: any[],
): { downSql: string; upSql: string }
Generates raw SQL for creating a table.
Parameters
- collection: string
- properties: any[]
Returns { downSql: string; upSql: string }
Throws
Always throws because Firestore is a NoSQL database and does not support SQL generation.
Overrides AbstractBackendAdapter.generateCreateSql
- Defined in backend-firestore/src/FirestoreAdapter.ts:482

generateDeltaSql

generateDeltaSql(
collection: string,
delta: any,
): { downSql: string[]; upSql: string[] }
Generates raw SQL for altering a table schema.
Parameters
- collection: string
- delta: any
Returns { downSql: string[]; upSql: string[] }
Throws
Always throws because Firestore does not support relational schema deltas.
Overrides AbstractBackendAdapter.generateDeltaSql
- Defined in backend-firestore/src/FirestoreAdapter.ts:490

getCollection

getCollection(dao: DataObjectClass<any>): string | undefined
Helper method to extract the destination collection name from a DataObject.
Parameters
- dao: DataObjectClass<any>
  The DataObject evaluating the context.
Returns string | undefined
The resolved collection string.
Inherited from AbstractBackendAdapter.getCollection
- Defined in backend/src/AbstractBackendAdapter.ts:118

getParam

getParam(key: BackendParametersKeys): any
Retrieves a specific configuration parameter.
Parameters
- key: BackendParametersKeys
  The parameter key to fetch.
Returns any
The value associated with the key, or undefined.
Inherited from AbstractBackendAdapter.getParam
- Defined in backend/src/AbstractBackendAdapter.ts:57

hasMiddleware

hasMiddleware(className: string): boolean
Returns true if a given middleware is attached
Parameters
- className: string
Returns boolean
boolean
Inherited from AbstractBackendAdapter.hasMiddleware
- Defined in backend/src/AbstractBackendAdapter.ts:93

log

log(message: string): void
Outputs an adapter-level diagnostic message to the console if debug mode is enabled.
Parameters
- message: string
  The textual content to log.
Returns void
Deprecated
Use Backend.debug() or Backend.log() (which itself is deprecated in favor of specific levels) instead.
Inherited from AbstractBackendAdapter.log
- Defined in backend/src/AbstractBackendAdapter.ts:216

query

query(query: Query<any>): Promise<QueryResultType<DataObjectClass<any>>>
Process Query instance and return result
Parameters
- query: Query<any>
Returns Promise<QueryResultType<DataObjectClass<any>>>
Array
Inherited from AbstractBackendAdapter.query
- Defined in backend/src/AbstractBackendAdapter.ts:180

rawQuery

rawQuery(sql: string, params?: any[]): Promise<any>
Executes a raw query on the backend. Only supported by SQL adapters.
Parameters
- sql: string
- Optionalparams: any[]
Returns Promise<any>
Inherited from AbstractBackendAdapter.rawQuery
- Defined in backend/src/AbstractBackendAdapter.ts:339

read

read(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>
Retrieves a document from Firestore by its path and populates the given DataObject.
Parameters
- dataObject: DataObjectClass<any>
  The target DataObject containing the path/UID to fetch.
Returns Promise<DataObjectClass<any>>
A promise resolving to the populated DataObject.

Throws
If no document exists at the calculated path.

Throws
If the path is improperly formatted.
Overrides AbstractBackendAdapter.read
- Defined in backend-firestore/src/FirestoreAdapter.ts:145

setParam

setParam(key: BackendParametersKeys, value: any): void
Overrides or adds a backend configuration parameter dynamically.
Parameters
- key: BackendParametersKeys
  The parameter key to modify.
- value: any
  The new value to assign.
Returns void
Inherited from AbstractBackendAdapter.setParam
- Defined in backend/src/AbstractBackendAdapter.ts:47

update

update(dataObject: DataObjectClass<any>): Promise<DataObjectClass<any>>
Updates an existing document in Firestore with the current state of the DataObject. Executes attached middlewares before and after the transaction.
Parameters
- dataObject: DataObjectClass<any>
  The DataObject containing the updated payload.
Returns Promise<DataObjectClass<any>>
A promise resolving to the updated DataObject.

Throws
If the parent references are invalid or the object has no UID.
Overrides AbstractBackendAdapter.update
- Defined in backend-firestore/src/FirestoreAdapter.ts:181

Class FirestoreAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FirestoreAdapter

Properties

Protected_alias

Protected_middlewares

Protected_params

StaticPKEY_IDENTIFIER

Accessors

alias

Returns string

Parameters

Returns void

Methods

Protected_buildPath

Parameters

Returns string

Protected_deleteQueryBatch

Parameters

Returns Promise<void>

Protected_resolveNativeForeignKeys

Parameters

Returns any[]

addMiddleware

Parameters

Returns void

Throws

aggregate

Parameters

Returns Promise<any>

create

Parameters

Returns Promise<DataObjectClass<any>>

delete

Parameters

Returns Promise<DataObjectClass<any>>

deleteCollection

Parameters

Returns Promise<void>

deleteMiddleware

Parameters

Returns void

executeMiddlewares

Parameters

Returns Promise<DataObjectClass<any>>

find

Parameters

Returns Promise<QueryResultType<DataObjectClass<any>>>

Params

generateCreateSql

Parameters

Returns { downSql: string; upSql: string }

Throws

generateDeltaSql

Parameters

Returns { downSql: string[]; upSql: string[] }

Throws

getCollection

Parameters

Returns string | undefined

getParam

Parameters

Returns any

hasMiddleware

Parameters

Returns boolean

log

Parameters

Returns void

Deprecated

query

Parameters

`Protected`_alias

`Protected`_middlewares

`Protected`_params

`Static`PKEY_IDENTIFIER

`Protected`_buildPath

`Protected`_deleteQueryBatch

`Protected`_resolveNativeForeignKeys