Mutation

import type { Mutation } from "https://googleapis.deno.dev/v1/datastore:v1.ts";

A mutation to apply to an entity.

interface Mutation {

baseVersion?: bigint;

conflictResolutionStrategy?: "STRATEGY_UNSPECIFIED" | "SERVER_VALUE" | "FAIL";

delete?: Key;

insert?: Entity;

propertyMask?: PropertyMask;

propertyTransforms?: PropertyTransform[];

update?: Entity;

updateTime?: Date;

upsert?: Entity;

}

§Properties

baseVersion?: bigint

[src]

The version of the entity that this mutation is being applied to. If this does not match the current version on the server, the mutation conflicts.

conflictResolutionStrategy?: "STRATEGY_UNSPECIFIED" | "SERVER_VALUE" | "FAIL"

[src]

The strategy to use when a conflict is detected. Defaults to SERVER_VALUE. If this is set, then conflict_detection_strategy must also be set.

delete?: Key

[src]

The key of the entity to delete. The entity may or may not already exist. Must have a complete key path and must not be reserved/read-only.

insert?: Entity

[src]

The entity to insert. The entity must not already exist. The entity key's final path element may be incomplete.

propertyMask?: PropertyMask

[src]

The properties to write in this mutation. None of the properties in the mask may have a reserved name, except for __key__. This field is ignored for delete. If the entity already exists, only properties referenced in the mask are updated, others are left untouched. Properties referenced in the mask but not in the entity are deleted.

propertyTransforms?: PropertyTransform[]

[src]

Optional. The transforms to perform on the entity. This field can be set only when the operation is insert, update, or upsert. If present, the transforms are be applied to the entity regardless of the property mask, in order, after the operation.

update?: Entity

[src]

The entity to update. The entity must already exist. Must have a complete key path.

updateTime?: Date

[src]

The update time of the entity that this mutation is being applied to. If this does not match the current update time on the server, the mutation conflicts.

upsert?: Entity

[src]

The entity to upsert. The entity may or may not already exist. The entity key's final path element may be incomplete.