Skip to main content

MutationResult

Defined in: js-api/src/entities/data-connection.ts:338

The structured result of a database write (DbTable insert/upsert/update/delete). Mutations never return a DataFrame. inserted/updated/skipped are best-effort — some dialects cannot tell inserts from updates on an upsert and leave the split null.

Properties

PropertyTypeDescriptionDefined in
affectedRowsnumberTotal rows affected across the operation.js-api/src/entities/data-connection.ts:340
errorCount?number | null-js-api/src/entities/data-connection.ts:346
errorMessage?stringTop-level SQL error message — set ⇔ the whole operation failed and was rolled back (nothing applied). Such failures REJECT the returned promise, so you will only see this field on a resolved result coming from a pre-fix server.js-api/src/entities/data-connection.ts:350
errors?RowError[]Per-row failures (populated on partial mode / batch errors).js-api/src/entities/data-connection.ts:342
generatedKeys?Record<string, any>[]-js-api/src/entities/data-connection.ts:352
inserted?number | null-js-api/src/entities/data-connection.ts:343
perStatement?object[]-js-api/src/entities/data-connection.ts:351
plan?DdlPlanThe executed (or, under dryRun, planned) DDL plan; DDL and dryRun results only.js-api/src/entities/data-connection.ts:354
skipped?number | null-js-api/src/entities/data-connection.ts:345
updated?number | null-js-api/src/entities/data-connection.ts:344