Skip to main content

TableMutationBuilder

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

Fluent builder for structured UPDATE/DELETE mutations. A thin wrapper over DbTable that accumulates SET assignments and WHERE conditions. In phase A a WHERE condition is equality by value; a string value may use string patterns (e.g. contains foo). Numeric/date range grammar (> 5, 10-20) in where is phase B. Build via grok.data.db.buildMutation(...).

Constructors​

Constructor​

new TableMutationBuilder(connectionId, tableName): TableMutationBuilder

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

Parameters​

ParameterType
connectionIdstring
tableNamestring

Returns​

TableMutationBuilder

Properties​

PropertyModifierTypeDefined in
connectionIdreadonlystringjs-api/src/entities/data-connection.ts:336
tableNamereadonlystringjs-api/src/entities/data-connection.ts:336

Methods​

allowFullTable()​

allowFullTable(): TableMutationBuilder

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

Allows a DELETE with no WHERE conditions (a full-table wipe — off by default).

Returns​

TableMutationBuilder


delete()​

delete(): Promise<MutationResult>

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

Runs the accumulated DELETE.

Returns​

Promise<MutationResult>


set()​

set(column, value): TableMutationBuilder

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

Assigns column = value in the SET clause (update only).

Parameters​

ParameterType
columnstring
valueany

Returns​

TableMutationBuilder


update()​

update(): Promise<MutationResult>

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

Runs the accumulated UPDATE.

Returns​

Promise<MutationResult>


where()​

where(column, pattern): TableMutationBuilder

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

Adds a WHERE condition: equality by value (a string value may use string patterns).

Parameters​

ParameterType
columnstring
patternany

Returns​

TableMutationBuilder


from()​

static from(tableName, connectionId): TableMutationBuilder

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

Creates a builder for [tableName] against the [connectionId] connection (nqName).

Parameters​

ParameterType
tableNamestring
connectionIdstring

Returns​

TableMutationBuilder