Protected_Protected_Protected_ProtectedallowedProtected OptionalauthProtectedbaseProtectedendpointProtected OptionalqueryStaticPKEY_The string identifier for primary keys, mapped to 'id' by default.
Protected_Resolves the canonical database path for a record, respecting standard collection structures and hierarchical subcollection configurations.
Optionaluid: stringProtected_Processes raw data entries to convert relational reference objects into native database foreign key IDs
if the adapter has been configured with useNativeForeignKeys = true.
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.
The Query instance defining the collection and filters.
The aggregate operation.
Optionalproperty: stringThe name of the property to aggregate.
A promise resolving to the aggregated result.
ProtectedbuildOptionaluid: stringProtectedcheckPerforms an HTTP POST request to create a new resource on the remote API.
The DataObject payload to serialize and transmit.
OptionaldesiredUid: stringIgnored by REST (usually assigned by the remote API).
A promise resolving to the data object populated with the API response UID.
Performs an HTTP DELETE request to remove a specific resource from the API.
The DataObject referencing the resource to delete.
A promise resolving upon successful deletion.
Removes a middleware from the pipeline by its class name.
The exact name of the middleware class to remove.
Orchestrates the sequential execution of all attached middlewares for a given action.
The payload traversing the middlewares.
The context (READ, CREATE, UPDATE, DELETE).
Whether to run the before or after pipeline.
Optionalparams: MiddlewareParamsOptional parameters passed down to the middlewares.
A promise resolving to the potentially mutated DataObject.
Performs an HTTP GET request to query a collection endpoint. Serializes filters and pagination into URL query parameters.
The template DataObject defining the collection.
Active search filters.
Limits and batch offsets.
Optional parent context for nested endpoints.
A promise resolving to an array of populated DataObjects and metadata.
Generates raw SQL for altering a table schema.
ProtectedgetHelper method to extract the destination collection name from a DataObject.
The DataObject evaluating the context.
The resolved collection string.
Retrieves a specific configuration parameter.
The parameter key to fetch.
The value associated with the key, or undefined.
Returns true if a given middleware is attached
boolean
Process Query instance and return result
Array
Executes a raw query on the backend. Only supported by SQL adapters.
Optionalparams: any[]Performs an HTTP GET request to retrieve a specific resource by its UID.
The empty DataObject containing the collection and UID.
A promise resolving to the populated DataObject.
ProtectedserializeOverrides or adds a backend configuration parameter dynamically.
The parameter key to modify.
The new value to assign.
Performs an HTTP PATCH request to update an existing remote resource.
The DataObject payload containing the modified data.
A promise resolving to the updated DataObject.
Backend adapter implementation bridging Quatrain's DataObjects to an external REST API. Maps CRUD operations to standard HTTP methods (POST, GET, PATCH, DELETE).