v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1338139174.7 KB
projects

Executes a pipeline query.

post/v1/{+database}/documents:executePipeline

Path parameters

databasestring required

Required. Database identifier, in the form projects/{project}/databases/{database}.

Request body

autoCommitTransactionboolean

Optional. Automatically commits the transaction after the pipeline has been executed. Only permitted in combination with transaction or new_transaction.

transactionstring byte

Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.

readTimestring google-datetime

Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.

Response

Successful response