Read a transactional row

Reads one row by primary key at the transaction's snapshot, seeing the transaction's own buffered writes first.

GET /v1/tenants/{tenant}/tx/{tx_id}/rows/{schema}/{pk}

Read a record within your transactionThis view may differ from a read outside the transaction.

Choose transaction and recordSupply its transaction ID, table and primary key.
Read the transaction's viewPrefer its pending changes over the saved snapshot row.
Inspect the nested rowRead column values under the row property.

Before you start

Use your database bearer token.

Connection setup

Begin a transaction and replace TX_ID with its returned tx_id. Finish the transaction with commit or rollback.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`tx_id`	`string`	Required
`schema`	`string`	Required
`pk`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

The record is nested under row and reflects the transaction's snapshot and its own pending changes. It may differ from a read made outside the transaction.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
409	Resolve the conflict before retrying.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
501	Check deployment support for this operation.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/tx/%3CTX_ID%3E/rows/demo.people/u1" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

{
  "tx_id": "11111111-1111-4111-8111-111111111111",
  "row": {
    "id": "u1",
    "follows_id": "u2",
    "score": 10
  },
  "_preview": true
}

Before the transaction writes a replacement row; after tx_row_put, read-your-own-write returns score 11.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses