ReadonlynameThe name of the store (e.g. 'mongodb', 'redis', 'dynamodb')
ReadonlylibraryThe client library being used
Access the underlying native client for operations not wrapped here
Create a document in collection; returns the new document's id.
Fetch a document by id, returning its data.
Merge patch into a document's data, returning the updated data.
Delete a document by id.
Run an FQL query. When expr is provided it is executed directly;
otherwise all documents in collection are paginated and dereferenced.
Returns the query's data array.
Optionalexpr: unknownFetch every document in collection matching the ORM where clause. The
where is compiled to an FQL predicate applied via Filter over the
collection's documents; order/limit/offset are applied client-side.
Each result is normalized to its data fields plus an id.
This scans the collection (bounded by pageSize). For large collections,
define a Fauna index and use the raw query escape hatch for an
index-driven read.
Fetch the first document matching where (client-side limit 1), or null.
Count documents in collection matching where.
Optionalwhere: Record<string, any>Insert data and return the new document's id. Alias of insert.
Insert many documents atomically in a single FQL Map/Create, returning
the new document ids in order.
Update every document matching where, merging values into each match's
data, all in a single atomic FQL expression. Returns the number of
documents updated.
Optionalwhere: Record<string, any>Delete every document matching where in a single atomic FQL expression.
Returns the number of documents deleted.
Optionalwhere: Record<string, any>Insert-or-update: if a document matching where exists, merge data into
the first match; otherwise create a new document seeded with the where
equality keys plus data. Returns { created }.
Run several FQL write expressions atomically in a single transaction via
FQL's Do (Fauna evaluates a single query as one serializable
transaction). Pass expressions built with the query builder from
getQuery. Returns the value of the last expression.
Exposes the FQL query builder (faunadb.query) for building raw expressions.
Base interface for NoSQL stores.
NoSQL engines (document stores, key-value caches, partition-key stores) do not share the SQL-shaped
Dialectinterface (noquery(sql), no identifier escaping, no DDL).NoSqlStoreis intentionally minimal: connection lifecycle plus arawescape hatch. Each store's real API surface (find/insert/update for Mongo, hash/list/set ops for Redis, item CRUD for DynamoDB) lives on its own class, not on this interface, because forcing them into one shared query shape would misrepresent what each engine can actually do.