Console
    Contact Us Start free

    Cloud Spanner V1 Client - Class CommitRequest (1.104.0)

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

    The request for Commit .

    Generated from protobuf message google.spanner.v1.CommitRequest

    Namespace

    Google \ Cloud \ Spanner \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ session
    string

    Required. The session in which the transaction to be committed is running.

    ↳ transaction_id
    string

    Commit a previously-started transaction.

    ↳ single_use_transaction
    TransactionOptions

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

    ↳ mutations
    array< Mutation >

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    ↳ return_commit_stats
    bool

    If true , then statistics related to the transaction will be included in the CommitResponse . Default value is false .

    ↳ max_commit_delay
    Google\Protobuf\Duration

    Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

    ↳ request_options
    RequestOptions

    Common options for this request.

    ↳ precommit_token
    MultiplexedSessionPrecommitToken

    Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.

    getSession

    Required. The session in which the transaction to be committed is running.

    Returns
    Type
    Description
    string

    setSession

    Required. The session in which the transaction to be committed is running.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getTransactionId

    Commit a previously-started transaction.

    Returns
    Type
    Description
    string

    hasTransactionId

    setTransactionId

    Commit a previously-started transaction.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getSingleUseTransaction

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

    Returns
    Type
    Description
    TransactionOptions |null

    hasSingleUseTransaction

    setSingleUseTransaction

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

    Parameter
    Name
    Description
    var
    TransactionOptions
    Returns
    Type
    Description
    $this

    getMutations

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setMutations

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    Parameter
    Name
    Description
    var
    array< Mutation >
    Returns
    Type
    Description
    $this

    getReturnCommitStats

    If true , then statistics related to the transaction will be included in the CommitResponse .

    Default value is false .

    Returns
    Type
    Description
    bool

    setReturnCommitStats

    If true , then statistics related to the transaction will be included in the CommitResponse .

    Default value is false .

    Parameter
    Name
    Description
    var
    bool
    Returns
    Type
    Description
    $this

    getMaxCommitDelay

    Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

    Returns
    Type
    Description
    Google\Protobuf\Duration |null

    hasMaxCommitDelay

    clearMaxCommitDelay

    setMaxCommitDelay

    Optional. The amount of latency this request is willing to incur in order to improve throughput. If this field is not set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a batching delay value between 0 and 500 ms.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    getRequestOptions

    Common options for this request.

    Returns
    Type
    Description
    RequestOptions |null

    hasRequestOptions

    clearRequestOptions

    setRequestOptions

    Common options for this request.

    Parameter
    Name
    Description
    var
    RequestOptions
    Returns
    Type
    Description
    $this

    getPrecommitToken

    Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error.

    This feature is not yet supported and will result in an UNIMPLEMENTED error.

    Returns
    Type
    Description
    MultiplexedSessionPrecommitToken |null

    hasPrecommitToken

    clearPrecommitToken

    setPrecommitToken

    Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error.

    This feature is not yet supported and will result in an UNIMPLEMENTED error.

    Parameter
    Name
    Description
    var
    MultiplexedSessionPrecommitToken
    Returns
    Type
    Description
    $this

    getTransaction

    Returns
    Type
    Description
    string

    static::build

    Parameters
    Name
    Description
    session
    string

    Required. The session in which the transaction to be committed is running. Please see SpannerClient::sessionName() for help formatting this field.

    transactionId
    string

    Commit a previously-started transaction.

    mutations
    array< Mutation >

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    Returns
    Type
    Description
    CommitRequest

    static::buildFromSessionSingleUseTransactionMutations

    Parameters
    Name
    Description
    session
    string

    Required. The session in which the transaction to be committed is running. Please see SpannerClient::sessionName() for help formatting this field.

    singleUseTransaction
    TransactionOptions

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the CommitRequest is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

    mutations
    array< Mutation >

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

    Returns
    Type
    Description
    CommitRequest
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: