diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 4c14125b071..54d65ccc68d 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -11198,8 +11198,7 @@ menu: - v2 operationids: - FetchDdsqlTabularQuery - unstable: - - v2 + unstable: [] order: 2 - name: Execute a tabular DDSQL query url: /api/latest/ddsql/execute-a-tabular-ddsql-query/ @@ -11211,8 +11210,7 @@ menu: - v2 operationids: - ExecuteDdsqlTabularQuery - unstable: - - v2 + unstable: [] order: 1 - name: DORA Metrics url: /api/latest/dora-metrics/ diff --git a/content/en/api/v2/ddsql/examples.json b/content/en/api/v2/ddsql/examples.json index 2bc1c79ff8d..b4e1b719291 100644 --- a/content/en/api/v2/ddsql/examples.json +++ b/content/en/api/v2/ddsql/examples.json @@ -29,7 +29,7 @@ "request_id": "req-7f3e7d2c-1a0b-4d3e-9b2a-3c4d5e6f7082" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource object for a DDSQL tabular query response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.

\n
\n
\n
\n
\n
\n

columns

\n
\n

[object]

\n

Column-major result set. Each element carries one column's name, type, and values,\nwith one value per row of the result. Set when state is completed.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the column as projected by the SQL statement.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

DDSQL data type of the column's values, for example VARCHAR, BIGINT,\nDECIMAL, BOOLEAN, TIMESTAMP, JSON, or an array variant such as\nVARCHAR[]. See the\nDDSQL data-types reference\nfor the full, up-to-date list.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[]

\n

Column values in row order. The element type matches the column's type;\nfor example a VARCHAR column carries strings, a TIMESTAMP column carries\nUnix-millisecond integers. null is allowed for missing values.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query_id

\n
\n

string

\n

Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

Lifecycle state of a DDSQL tabular query response.\nrunning means the query is still executing and the client should poll\nthe fetch endpoint with the returned query_id. completed means the\nresult set is inlined in columns and no further polling is required. \nAllowed enum values: running,completed

\n
\n \n
\n
\n
\n
\n
\n

warnings

\n
\n

[string]

\n

Non-fatal messages emitted by the query engine while serving this response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Stable identifier for the query response resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response

default: ddsql_query_response

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.

\n
\n
\n
\n
\n
\n

elapsed [required]

\n
\n

int64

\n

Server-side time spent serving this request, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

request_id [required]

\n
\n

string

\n

Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource object for a DDSQL tabular query response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.

\n
\n
\n
\n
\n
\n

columns

\n
\n

[object]

\n

Column-major result set. Each element carries one column's name, type, and values,\nwith one value per row of the result. Set when state is completed.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the column as projected by the SQL statement.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

DDSQL data type of the column's values, for example VARCHAR, BIGINT,\nDECIMAL, BOOLEAN, TIMESTAMP, JSON, or an array variant such as\nVARCHAR[]. See the\nDDSQL data-types reference\nfor the full, up-to-date list.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[]

\n

Column values in row order, one entry per result row. The element type\nfollows the column's type. The following serialization rules should be\ntaken into account:

\n
    \n
  • BIGINT values are encoded as JSON numbers in the signed 64-bit integer range.
  • \n
  • DECIMAL values are encoded as JSON numbers with 64-bit double precision.
  • \n
  • TIMESTAMP and DATE values are encoded as Unix-millisecond integers; a\nDATE resolves to midnight UTC.
  • \n
  • JSON values are returned as a JSON-encoded string.
  • \n
\n

null is allowed for any column type where a value is missing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query_id

\n
\n

string

\n

Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

Lifecycle state of a DDSQL tabular query response.\nrunning means the query is still executing and the client should poll\nthe fetch endpoint with the returned query_id. completed means the\nresult set is inlined in columns and no further polling is required. \nAllowed enum values: running,completed

\n
\n \n
\n
\n
\n
\n
\n

warnings

\n
\n

[string]

\n

Non-fatal messages emitted by the query engine while serving this response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Stable identifier for the query response resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response

default: ddsql_query_response

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.

\n
\n
\n
\n
\n
\n

elapsed [required]

\n
\n

int64

\n

Server-side time spent serving this request, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

request_id [required]

\n
\n

string

\n

Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -153,7 +153,7 @@ "request_id": "req-7f3e7d2c-1a0b-4d3e-9b2a-3c4d5e6f7082" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource object for a DDSQL tabular query response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.

\n
\n
\n
\n
\n
\n

columns

\n
\n

[object]

\n

Column-major result set. Each element carries one column's name, type, and values,\nwith one value per row of the result. Set when state is completed.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the column as projected by the SQL statement.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

DDSQL data type of the column's values, for example VARCHAR, BIGINT,\nDECIMAL, BOOLEAN, TIMESTAMP, JSON, or an array variant such as\nVARCHAR[]. See the\nDDSQL data-types reference\nfor the full, up-to-date list.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[]

\n

Column values in row order. The element type matches the column's type;\nfor example a VARCHAR column carries strings, a TIMESTAMP column carries\nUnix-millisecond integers. null is allowed for missing values.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query_id

\n
\n

string

\n

Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

Lifecycle state of a DDSQL tabular query response.\nrunning means the query is still executing and the client should poll\nthe fetch endpoint with the returned query_id. completed means the\nresult set is inlined in columns and no further polling is required. \nAllowed enum values: running,completed

\n
\n \n
\n
\n
\n
\n
\n

warnings

\n
\n

[string]

\n

Non-fatal messages emitted by the query engine while serving this response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Stable identifier for the query response resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response

default: ddsql_query_response

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.

\n
\n
\n
\n
\n
\n

elapsed [required]

\n
\n

int64

\n

Server-side time spent serving this request, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

request_id [required]

\n
\n

string

\n

Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

JSON:API resource object for a DDSQL tabular query response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.

\n
\n
\n
\n
\n
\n

columns

\n
\n

[object]

\n

Column-major result set. Each element carries one column's name, type, and values,\nwith one value per row of the result. Set when state is completed.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the column as projected by the SQL statement.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

string

\n

DDSQL data type of the column's values, for example VARCHAR, BIGINT,\nDECIMAL, BOOLEAN, TIMESTAMP, JSON, or an array variant such as\nVARCHAR[]. See the\nDDSQL data-types reference\nfor the full, up-to-date list.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[]

\n

Column values in row order, one entry per result row. The element type\nfollows the column's type. The following serialization rules should be\ntaken into account:

\n
    \n
  • BIGINT values are encoded as JSON numbers in the signed 64-bit integer range.
  • \n
  • DECIMAL values are encoded as JSON numbers with 64-bit double precision.
  • \n
  • TIMESTAMP and DATE values are encoded as Unix-millisecond integers; a\nDATE resolves to midnight UTC.
  • \n
  • JSON values are returned as a JSON-encoded string.
  • \n
\n

null is allowed for any column type where a value is missing.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

query_id

\n
\n

string

\n

Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

enum

\n

Lifecycle state of a DDSQL tabular query response.\nrunning means the query is still executing and the client should poll\nthe fetch endpoint with the returned query_id. completed means the\nresult set is inlined in columns and no further polling is required. \nAllowed enum values: running,completed

\n
\n \n
\n
\n
\n
\n
\n

warnings

\n
\n

[string]

\n

Non-fatal messages emitted by the query engine while serving this response.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Stable identifier for the query response resource.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response

default: ddsql_query_response

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

meta [required]

\n
\n

object

\n

Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.

\n
\n
\n
\n
\n
\n

elapsed [required]

\n
\n

int64

\n

Server-side time spent serving this request, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

request_id [required]

\n
\n

string

\n

Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 43765ff91f2..2ae1c30fabd 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -30851,9 +30851,17 @@ components: type: string values: description: |- - Column values in row order. The element type matches the column's `type`; - for example a `VARCHAR` column carries strings, a `TIMESTAMP` column carries - Unix-millisecond integers. `null` is allowed for missing values. + Column values in row order, one entry per result row. The element type + follows the column's `type`. The following serialization rules should be + taken into account: + + - `BIGINT` values are encoded as JSON numbers in the signed 64-bit integer range. + - `DECIMAL` values are encoded as JSON numbers with 64-bit double precision. + - `TIMESTAMP` and `DATE` values are encoded as Unix-millisecond integers; a + `DATE` resolves to midnight UTC. + - `JSON` values are returned as a JSON-encoded string. + + `null` is allowed for any column type where a value is missing. example: - web-store - checkout @@ -137059,9 +137067,6 @@ paths: tags: - DDSQL x-menu-order: 1 - x-unstable: |- - **Note**: This endpoint is in preview and is subject to change. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/ddsql/query/tabular/fetch: post: description: |- @@ -137171,9 +137176,6 @@ paths: tags: - DDSQL x-menu-order: 2 - x-unstable: |- - **Note**: This endpoint is in preview and is subject to change. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/deployment_gates: get: description: |-