v1

latestOpenAPI 3.0.32026-07-1711124.9 KB
query

Execute a v10 transaction

???

post/query/1

Headers

x-format'simple' | 'tagged' | 'decorated'

A format specifier for the arguments and response of the query

Determines the encoded format expected for the query arguments field, and the data field of a successful response.

x-last-txn-tsinteger

If set, will act as the minimum snapshot time the query will be executed at. Clients will automatically populate this based on the highest "txn_ts" result value observed of any transaction the client has processed.

x-typecheckboolean

Enable or disable typechecking of the query before evaluation. Defaults to the value of the "typechecked" on the database configuration.

x-linearizedboolean

If true, unconditionally run the query as strictly serialized. This affects read-only transactions, as transactions which write will already be strictly serialized.

x-performance-hintsboolean

If true, include query performance hints in the summary field of the response.

x-query-timeout-msinteger

A client-specified query timeout in milliseconds.

x-max-contention-retriesinteger

The maximum number of times a transaction is allowed to retry due to concurrent contention failure before an error is returned.

x-query-tagsstring

A string-encoded set of caller-determined tags which identify the request. Provided back via logging and the query response body. The format is a list of key value pairs, like so. - foo=bar - foo=bar,baz=blah Each key and each value may only contain the characters [a-zA-Z0-9_]. These are also valid tags. - foo_bar=baz - foo3=1234,5=6 All of these are invalid. - foo bar=3 // no spaces - foo=bar, // no trailing commas - foo==bar // too many = Each key must be less than or equal to 40 bytes. Each value must be less than or equal to 80 bytes. There can only be a maximum of 25 key/value pairs total. Additionally, the entire header cannot be more than 3000 bytes.

Request body

argumentsobject

An object containing values provided to the submitted transaction as variables. Note that variable names must be valid FQL identifiers.

Response

Successful operation

static_typestring

The query's inferred static result type, if the query was typechecked.

txn_tsinteger

The transaction commit time in micros since epoch. Used by drivers to populate the x-last-txn-ts request header in order to get a consistent prefix RYOW guarantee.

schema_versioninteger

The schema version used by the query. This can be used by clients displaying schema to determine when they should refresh their schema. If the schema version that a client has stored differs from the one returned by the query, schema should be refreshed.

summarystring

A comprehensive, human readable summary of any errors, warnings and/or logs returned from the query.

{"stackTrail":"components:schemas:QuerySuccess:allOf:properties:query_tags","oasType":"schema","type":"unknown","description":"The value of the x-query-tags header, if it was provided."}
All 1 operations