Cloud Datastore V1 Client - Class CommitRequest (1.31.0)

Reference documentation and code samples for the Cloud Datastore V1 Client class CommitRequest.

The request for Datastore.Commit.

Generated from protobuf message google.datastore.v1.CommitRequest

Namespace

Google \ Cloud \ Datastore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ project_id string

Required. The ID of the project against which to make the request.
↳ database_id string

The ID of the database against which to make the request. '(default)' is not allowed; please use empty string '' to refer the default database.
↳ mode int

The type of commit to perform. Defaults to TRANSACTIONAL.
↳ transaction string

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.
↳ single_use_transaction Google\Cloud\Datastore\V1\TransactionOptions

Options for beginning a new transaction for this request. The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.
↳ mutations array<Google\Cloud\Datastore\V1\Mutation>

The mutations to perform. When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request: - insert followed by insert - update followed by insert - upsert followed by insert - delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.

getProjectId

Required. The ID of the project against which to make the request.

Returns
Type Description
string

setProjectId

Required. The ID of the project against which to make the request.

Parameter
Name Description
var string
Returns
Type Description
$this

getDatabaseId

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

Returns
Type Description
string

setDatabaseId

The ID of the database against which to make the request.

'(default)' is not allowed; please use empty string '' to refer the default database.

Parameter
Name Description
var string
Returns
Type Description
$this

getMode

The type of commit to perform. Defaults to TRANSACTIONAL.

Returns
Type Description
int

setMode

The type of commit to perform. Defaults to TRANSACTIONAL.

Parameter
Name Description
var int
Returns
Type Description
$this

getTransaction

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Returns
Type Description
string

hasTransaction

setTransaction

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.

Parameter
Name Description
var string
Returns
Type Description
$this

getSingleUseTransaction

Options for beginning a new transaction for this request.

The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.

Returns
Type Description
Google\Cloud\Datastore\V1\TransactionOptions|null

hasSingleUseTransaction

setSingleUseTransaction

Options for beginning a new transaction for this request.

The transaction is committed when the request completes. If specified, TransactionOptions.mode must be TransactionOptions.ReadWrite.

Parameter
Name Description
var Google\Cloud\Datastore\V1\TransactionOptions
Returns
Type Description
$this

getMutations

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMutations

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.
Parameter
Name Description
var array<Google\Cloud\Datastore\V1\Mutation>
Returns
Type Description
$this

getTransactionSelector

Returns
Type Description
string

static::build

Parameters
Name Description
projectId string

Required. The ID of the project against which to make the request.
mode int

The type of commit to perform. Defaults to TRANSACTIONAL. For allowed values, use constants defined on Google\Cloud\Datastore\V1\CommitRequest\Mode
transaction string

The identifier of the transaction associated with the commit. A transaction identifier is returned by a call to Datastore.BeginTransaction.
mutations array<Google\Cloud\Datastore\V1\Mutation>

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update

When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.
Returns
Type Description
Google\Cloud\Datastore\V1\CommitRequest

static::buildFromProjectIdModeMutations

Parameters
Name Description
projectId string

Required. The ID of the project against which to make the request.
mode int

The type of commit to perform. Defaults to TRANSACTIONAL. For allowed values, use constants defined on Google\Cloud\Datastore\V1\CommitRequest\Mode
mutations array<Google\Cloud\Datastore\V1\Mutation>

The mutations to perform.

When mode is TRANSACTIONAL, mutations affecting a single entity are applied in order. The following sequences of mutations affecting a single entity are not permitted in a single Commit request:

  • insert followed by insert
  • update followed by insert
  • upsert followed by insert
  • delete followed by update

When mode is NON_TRANSACTIONAL, no two mutations may affect a single entity.
Returns
Type Description
Google\Cloud\Datastore\V1\CommitRequest