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
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 |
↳ 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 |
getProjectId
Required. The ID of the project against which to make the request.
Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setProjectId
Required. The ID of the project against which to make the request.
Generated from protobuf field string project_id = 8 [(.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field string database_id = 9;
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.
Generated from protobuf field string database_id = 9;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getMode
The type of commit to perform. Defaults to TRANSACTIONAL
.
Generated from protobuf field .google.datastore.v1.CommitRequest.Mode mode = 5;
Returns | |
---|---|
Type | Description |
int |
setMode
The type of commit to perform. Defaults to TRANSACTIONAL
.
Generated from protobuf field .google.datastore.v1.CommitRequest.Mode mode = 5;
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.
Generated from protobuf field bytes transaction = 1;
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.
Generated from protobuf field bytes transaction = 1;
Parameter | |
---|---|
Name | Description |
var |
string
|
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 byinsert
update
followed byinsert
upsert
followed byinsert
delete
followed byupdate
When mode isNON_TRANSACTIONAL
, no two mutations may affect a single entity.
Generated from protobuf field repeated .google.datastore.v1.Mutation mutations = 6;
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 byinsert
update
followed byinsert
upsert
followed byinsert
delete
followed byupdate
When mode isNON_TRANSACTIONAL
, no two mutations may affect a single entity.
Generated from protobuf field repeated .google.datastore.v1.Mutation mutations = 6;
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Datastore\V1\Mutation>
|
Returns | |
---|---|
Type | Description |
$this |
getTransactionSelector
Returns | |
---|---|
Type | Description |
string |