Статья создана

🚧 [Experimental] Run SQL query

Runs the specified saved SQL query and returns its result.

Request

POST

https://api.datalens.tech/rpc/runSqlQuery

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json

{
  "sqlQueryId": "example",
  "params": {}
}

Name

Description

sqlQueryId

Type: string

ID of the SQL query to run.

Example: example

params

Type: object

[additional]

Any of 5 types

Type: string

Example: example
Type: number
Type: boolean
Type: array
Any of 3 types
Type: string

Example: example

Type: number

Type: boolean
Example
```
[
  "example"
]
```
Type: object

from

Type: string

Start of the interval.

Example: example

to

Type: string

End of the interval.

Example: example
Example
```
{
  "from": "example",
  "to": "example"
}
```

Example: example

Values of the query parameters, keyed by name. A parameter left out here falls back to its default value.

Example

{}

Responses

200 OK

Response

Body

application/json

{
  "id": "example",
  "connectionId": "example",
  "tenantId": "example",
  "status": "success",
  "query": "example",
  "statementPositions": [
    [
      null
    ]
  ],
  "results": [
    {
      "status": "success",
      "columns": [
        {}
      ],
      "rows": [
        [
          null
        ]
      ],
      "hasMoreRows": true,
      "affectedRows": 0.5
    }
  ],
  "createdBy": "example",
  "createdAt": "example",
  "updatedAt": "example"
}

Name

Description

connectionId

Type: string

ID of the connection the query was executed on.

Example: example

createdAt

Type: string

Date and time when the query run was created.

Example: example

createdBy

Type: string

ID of the user who ran the query.

Example: example

Type: string

ID of the query run.

Example: example

query

Type: string

Text of the executed query.

Example: example

results

Type: array

Any of 2 types

Type: object

columns

Type: object[]

name

Type: string

Name of the column.

Example: example

Columns of the statement result. Empty for statements that return no rows.

Example

[
  {
    "name": "example"
  }
]

hasMoreRows

Type: boolean

Whether the statement returned more rows than included in rows.

rows

Type: array

Any of 5 types

Type: string

Example: example
Type: number
Type: boolean
Type: null

Example: null
Type: null

Example: null

Rows of the statement result, with values in the order of the columns.

Example

[
  [
    "example"
  ]
]

status

Type: string

Status of the statement.

Const: success

Example: example

affectedRows

Type: number

Number of rows affected by the statement.

Example

{
  "status": "success",
  "columns": [
    {
      "name": "example"
    }
  ],
  "rows": [
    [
      "example"
    ]
  ],
  "hasMoreRows": true,
  "affectedRows": 0.5
}

Type: object

code	Type: string Error code. Example: `example`
message	Type: string Error message. Example: `example`
status	Type: string Status of the statement. Const: `error` Example: `example`
databaseMessage	Type: string Message returned by the database. Example: `example`

Example

{
  "status": "error",
  "code": "example",
  "message": "example",
  "databaseMessage": "example"
}

Results of the executed statements, in the order of the statements.

Example

[
  {
    "status": "success",
    "columns": [
      {
        "name": "example"
      }
    ],
    "rows": [
      [
        null
      ]
    ],
    "hasMoreRows": true,
    "affectedRows": 0.5
  }
]

statementPositions

Type: unknown[][]

Start and end indexes of the executed statements.

Example

[
  [
    null
  ]
]

status

Type: string

Status of the query run.

Enum: success, error, pending, partial_success

tenantId

Type: string

ID of the DataLens tenant.

Example: example

updatedAt

Type: string

Date and time when the query run was updated.

Example: example

🚧 [Experimental] Run SQL query

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

Была ли статья полезна?

Request

Headers

Body

Responses

200 OK

Body