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": "
data [required]
\nobject
JSON:API resource object for a DDSQL tabular query response.
attributes [required]
\nobject
Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.
columns
\n[object]
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.
name [required]
\nstring
Name of the column as projected by the SQL statement.
type [required]
\nstring
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.
values [required]
\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.
query_id
\nstring
Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.
state [required]
\nenum
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
warnings
\n[string]
Non-fatal messages emitted by the query engine while serving this response.
id [required]
\nstring
Stable identifier for the query response resource.
type [required]
\nenum
JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response
default: ddsql_query_response
meta [required]
\nobject
Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.
elapsed [required]
\nint64
Server-side time spent serving this request, in milliseconds.
request_id [required]
\nstring
Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.
data [required]
\nobject
JSON:API resource object for a DDSQL tabular query response.
attributes [required]
\nobject
Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.
columns
\n[object]
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.
name [required]
\nstring
Name of the column as projected by the SQL statement.
type [required]
\nstring
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.
values [required]
\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:
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\nDATE 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.
query_id
\nstring
Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.
state [required]
\nenum
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
warnings
\n[string]
Non-fatal messages emitted by the query engine while serving this response.
id [required]
\nstring
Stable identifier for the query response resource.
type [required]
\nenum
JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response
default: ddsql_query_response
meta [required]
\nobject
Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.
elapsed [required]
\nint64
Server-side time spent serving this request, in milliseconds.
request_id [required]
\nstring
Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.
data [required]
\nobject
JSON:API resource object for a DDSQL tabular query response.
attributes [required]
\nobject
Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.
columns
\n[object]
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.
name [required]
\nstring
Name of the column as projected by the SQL statement.
type [required]
\nstring
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.
values [required]
\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.
query_id
\nstring
Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.
state [required]
\nenum
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
warnings
\n[string]
Non-fatal messages emitted by the query engine while serving this response.
id [required]
\nstring
Stable identifier for the query response resource.
type [required]
\nenum
JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response
default: ddsql_query_response
meta [required]
\nobject
Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.
elapsed [required]
\nint64
Server-side time spent serving this request, in milliseconds.
request_id [required]
\nstring
Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.
data [required]
\nobject
JSON:API resource object for a DDSQL tabular query response.
attributes [required]
\nobject
Attributes of a DDSQL tabular query response. query_id is set when\nstate is running; columns is set when state is completed.
columns
\n[object]
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.
name [required]
\nstring
Name of the column as projected by the SQL statement.
type [required]
\nstring
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.
values [required]
\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:
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\nDATE 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.
query_id
\nstring
Opaque token to pass to the fetch endpoint to poll for results.\nSet when state is running and absent when state is completed.
state [required]
\nenum
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
warnings
\n[string]
Non-fatal messages emitted by the query engine while serving this response.
id [required]
\nstring
Stable identifier for the query response resource.
type [required]
\nenum
JSON:API resource type for a DDSQL tabular query response. \nAllowed enum values: ddsql_query_response
default: ddsql_query_response
meta [required]
\nobject
Top-level JSON:API meta block accompanying every DDSQL tabular query response.\nCarries standard observability handles for client-side correlation.
elapsed [required]
\nint64
Server-side time spent serving this request, in milliseconds.
request_id [required]
\nstring
Echo of the DD-Request-ID header assigned by Datadog's edge to this request,\nfor support correlation.