DomainBatchOptions
Defined in: js-api/src/domains.ts:620
Options for domain table batch.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
allOrNothing? | boolean | Abort the whole batch on any row error (default true); false applies good rows and reports bad ones per row. | js-api/src/domains.ts:625 |
errorOnDuplicate? | boolean | Report business-key duplicates as errors instead of skipping them. | js-api/src/domains.ts:627 |
format? | "csv" | "d42" | "parquet" | "json" | Payload format for Uint8Array data: 'd42' (default; DataFrame.toByteArray() output) or 'parquet' (converted client-side via the Arrow package — fails with a clear error when Arrow is not installed). Ignored for other payloads — the format is inferred: DataFrame → sent as d42, string → 'csv', object[] → 'json'. | js-api/src/domains.ts:634 |
mode? | "insert" | "upsert" | 'insert' (default) or 'upsert' (merge by the table's business key). | js-api/src/domains.ts:622 |
throwOnError? | boolean | Reject with a DomainValidationError carrying the report when the batch is aborted. | js-api/src/domains.ts:629 |
validateOnly? | boolean | Judge the payload and write NOTHING: the server runs the whole commit path — coercions, per-row validation, required and auto-number checks, intra-batch and live business-key duplicates, FK existence, immutable columns, and the merge itself — then rolls the transaction back, so the verdicts are the ones a real commit would produce. Resolves to a DomainBatchValidation instead of a DomainBatchReport; allOrNothing is forced false (a preview judges every row). | js-api/src/domains.ts:641 |