Class: TransactionDb
Defined in: packages/client/src/core/transaction-engine/handle.ts:241
The handle's db-like surface. Writes stage; reads overlay. Not a Proxy over the guarded db on purpose: this object has no adapter methods or escape hatches to forward, so staging cannot become a fourth door around the authoring path.
Methods
bulkDocs()
bulkDocs(docs, options?): Promise<object[]>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:317
Stages a batch. Validated sequentially - the first refusal unwinds every entry this call staged, so a failing batch stages nothing. Documents stage before relations, mirroring the commit batch, so a relation and its endpoint can arrive in one array in any order.
Parameters
| Parameter | Type |
|---|---|
docs | | Document[] | { docs: Document[]; } |
options? | any |
Returns
Promise<object[]>
bulkGet()
bulkGet(request): Promise<{
results: any[];
}>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:256
Parameters
| Parameter | Type |
|---|---|
request | { docs: object[]; } |
request.docs | object[] |
Returns
Promise<{
results: any[];
}>
find()
find(query): Promise<{
docs: Document[];
}>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:266
Raw-style Mango find over the transaction's view. Like stack.db.find, this
skips the read pipeline (no policy filter, no decryption of committed rows);
findDocuments on the handle is the polished read.
Parameters
| Parameter | Type |
|---|---|
query | { fields?: string[]; limit?: number; selector: { [key: string]: any; }; skip?: number; sort?: any; } |
query.fields? | string[] |
query.limit? | number |
query.selector | { [key: string]: any; } |
query.skip? | number |
query.sort? | any |
Returns
Promise<{
docs: Document[];
}>
get()
get(docId, options?): Promise<Document>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:251
Parameters
| Parameter | Type |
|---|---|
docId | string |
options? | any |
Returns
Promise<Document>
post()
post(doc): Promise<{
id: string;
ok: true;
rev?: string;
staged: true;
}>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:288
Parameters
| Parameter | Type |
|---|---|
doc | Document |
Returns
Promise<{
id: string;
ok: true;
rev?: string;
staged: true;
}>
put()
put(doc, options?): Promise<{
id: string;
ok: true;
rev?: string;
staged: true;
}>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:280
Parameters
| Parameter | Type |
|---|---|
doc | Document |
options? | any |
Returns
Promise<{
id: string;
ok: true;
rev?: string;
staged: true;
}>
remove()
remove(doc, rev?): Promise<{
id: string;
ok: true;
staged: true;
}>;
Defined in: packages/client/src/core/transaction-engine/handle.ts:303
Hard removal, staged: the commit writes _deleted: true. Soft deletion is handle.deleteDocument.
Parameters
| Parameter | Type |
|---|---|
doc | | string | { _id: string; _rev?: string; } |
rev? | string |
Returns
Promise<{
id: string;
ok: true;
staged: true;
}>