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

🚧 [Experimental] Create SQL query

Creates a saved SQL query in the specified workbook.

Request

POST

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

Headers

Name

Description

x-dl-api-version

Type: string

API version header.

Const: 3

Example: 3

Body

application/json

{
  "workbookId": "example",
  "name": "example",
  "description": "example",
  "connectionId": "example",
  "query": "example",
  "params": [
    {
      "name": "example",
      "type": null,
      "defaultValue": {}
    }
  ]
}

Name

Description

connectionId

Type: string

ID of the connection. Supported connection types: PostgreSQL, ClickHouse, MySQL, Greenplum, Trino.

Example: example

name

Type: string

Name of the SQL query in the workbook.

Example: example

query

Type: string

Text of the SQL query.

Example: example

workbookId

Type: string

ID of the workbook where the SQL query should be created.

Example: example

description

Type: string

Description of the SQL query.

Example: example

params

Type: array

All of 2 types

Type: object

name

Type: string

Example: example
Example
```
{
  "name": "example"
}
```

Any of 3 types

Type: object

type

Any of 2 types

Type: string

Const: date-interval

Example: example
Type: string

Const: datetime-interval

Example: example

Type of the parameter.

Example: example

defaultValue

Type: object

from

Type: string

Start of the interval.

Example: example

Type: string

End of the interval.

Example: example

Default value of the parameter.

Example

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

Example

{
  "type": "date-interval",
  "defaultValue": {
    "from": "example",
    "to": "example"
  }
}

Type: object

type

Any of 2 types

Type: string

Const: date

Example: example
Type: string

Const: datetime

Example: example

Type of the parameter.

Example: example

defaultValue

Type: string

Default value of the parameter.

Example: example

Example

{
  "type": "date",
  "defaultValue": "example"
}

Type: object

type

Any of 3 types

Type: string

Const: string

Example: example
Type: string

Const: number

Example: example
Type: string

Const: boolean

Example: example

Type of the parameter.

Example: example

defaultValue

Any of 3 types

Type: string

Example: example
Type: number
Type: boolean

Default value of the parameter.

Example: example

Example

{
  "type": "string",
  "defaultValue": "example"
}

Example

{
  "type": "date-interval",
  "defaultValue": {
    "from": "example",
    "to": "example"
  }
}

Parameters of the SQL query.

Example

[
  {
    "name": "example",
    "type": "date-interval",
    "defaultValue": {
      "from": "example",
      "to": "example"
    }
  }
]

Responses

200 OK

Response

Body

application/json

{
  "entry": {
    "entryId": "example",
    "scope": "sql_query",
    "type": "example",
    "key": "example",
    "workbookId": "example",
    "collectionId": "example",
    "revId": "example",
    "savedId": "example",
    "publishedId": "example",
    "data": {
      "connectionId": "example",
      "query": "example",
      "statementPositions": [
        [
          null
        ]
      ],
      "params": [
        {}
      ]
    },
    "annotation": {
      "description": "example"
    },
    "createdBy": "example",
    "createdAt": "example",
    "updatedBy": "example",
    "updatedAt": "example",
    "revUpdatedBy": "example",
    "revUpdatedAt": "example",
    "tenantId": "example",
    "hidden": true,
    "version": 0.5,
    "links": {}
  }
}

Name

Description

entry

Type: SqlQuery

Example

{
  "entryId": "example",
  "scope": "sql_query",
  "type": "example",
  "key": "example",
  "workbookId": "example",
  "collectionId": "example",
  "revId": "example",
  "savedId": "example",
  "publishedId": "example",
  "data": {
    "connectionId": "example",
    "query": "example",
    "statementPositions": [
      [
        null
      ]
    ],
    "params": [
      {
        "name": "example"
      }
    ]
  },
  "annotation": {
    "description": "example"
  },
  "createdBy": "example",
  "createdAt": "example",
  "updatedBy": "example",
  "updatedAt": "example",
  "revUpdatedBy": "example",
  "revUpdatedAt": "example",
  "tenantId": "example",
  "hidden": true,
  "version": 0.5,
  "links": {}
}

SqlQuery

Name

Description

annotation

Type: object | null

Annotation of the SQL query.

Example

{
  "description": "example"
}

collectionId

Type: string | null

ID of the collection containing the SQL query.

Example: example

createdAt

Type: string

Date and time when the SQL query was created.

Example: example

createdBy

Type: string

ID of the user who created the SQL query.

Example: example

data

Type: object

connectionId

Type: string

ID of the connection.

Example: example

query

Type: string

Text of the SQL query.

Example: example

statementPositions

Type: unknown[][]

Start and end indexes of the query statements.

Example

[
  [
    null
  ]
]

params

Type: array

All of 2 types

Type: object

name

Type: string

Example: example
Example
```
{
  "name": "example"
}
```

Any of 3 types

Type: object

type

Any of 2 types

Type: string

Const: date-interval

Example: example
Type: string

Const: datetime-interval

Example: example

Type of the parameter.

Example: example

defaultValue

Type: object

from

Type: string

Start of the interval.

Example: example

Type: string

End of the interval.

Example: example

Default value of the parameter.

Example

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

Example

{
  "type": "date-interval",
  "defaultValue": {
    "from": "example",
    "to": "example"
  }
}

Type: object

type

Any of 2 types

Type: string

Const: date

Example: example
Type: string

Const: datetime

Example: example

Type of the parameter.

Example: example

defaultValue

Type: string

Default value of the parameter.

Example: example

Example

{
  "type": "date",
  "defaultValue": "example"
}

Type: object

type

Any of 3 types

Type: string

Const: string

Example: example
Type: string

Const: number

Example: example
Type: string

Const: boolean

Example: example

Type of the parameter.

Example: example

defaultValue

Any of 3 types

Type: string

Example: example
Type: number
Type: boolean

Default value of the parameter.

Example: example

Example

{
  "type": "string",
  "defaultValue": "example"
}

Example

{
  "type": "date-interval",
  "defaultValue": {
    "from": "example",
    "to": "example"
  }
}

Parameters of the SQL query.

Example

[
  {
    "name": "example",
    "type": "date-interval",
    "defaultValue": {
      "from": "example",
      "to": "example"
    }
  }
]

Data of the SQL query entry.

Example

{
  "connectionId": "example",
  "query": "example",
  "statementPositions": [
    [
      null
    ]
  ],
  "params": [
    {
      "name": "example",
      "type": null,
      "defaultValue": {}
    }
  ]
}

entryId

Type: string

Unique identifier of the SQL query.

Example: example

hidden

Type: boolean

Whether the SQL query is hidden.

key

Type: string

Key of the SQL query entry.

Example: example

publishedId

Type: string | null

ID of the published SQL query revision.

Example: example

revId

Type: string

ID of the current SQL query revision.

Example: example

savedId

Type: string

ID of the saved SQL query revision.

Example: example

scope

Type: string

Scope of the SQL query entry.

Const: sql_query

Example: example

tenantId

Type: string

ID of the tenant that owns the SQL query.

Example: example

type

Type: string

Type of the SQL query entry.

Example: example

updatedAt

Type: string

Date and time when the SQL query was last updated.

Example: example

updatedBy

Type: string

ID of the user who last updated the SQL query.

Example: example

version

Type: number | null

Schema version of the SQL query.

workbookId

Type: string

ID of the workbook containing the SQL query.

Example: example

links

Type: object | null

Links to the entries the SQL query depends on.

Example

{}

revUpdatedAt

Type: string

Date and time when the current revision was last updated.

Example: example

revUpdatedBy

Type: string

ID of the user who last updated the current revision.

Example: example

Example

{
  "entryId": "example",
  "scope": "sql_query",
  "type": "example",
  "key": "example",
  "workbookId": "example",
  "collectionId": "example",
  "revId": "example",
  "savedId": "example",
  "publishedId": "example",
  "data": {
    "connectionId": "example",
    "query": "example",
    "statementPositions": [
      [
        null
      ]
    ],
    "params": [
      {
        "name": "example"
      }
    ]
  },
  "annotation": {
    "description": "example"
  },
  "createdBy": "example",
  "createdAt": "example",
  "updatedBy": "example",
  "updatedAt": "example",
  "revUpdatedBy": "example",
  "revUpdatedAt": "example",
  "tenantId": "example",
  "hidden": true,
  "version": 0.5,
  "links": {}
}

🚧 [Experimental] Create SQL query

RequestRequest

HeadersHeaders

BodyBody

ResponsesResponses

200 OK200 OK

BodyBody

SqlQuerySqlQuery

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

Request

Headers

Body

Responses

200 OK

Body

SqlQuery