Running a script

You can use the scripting yql subcommand to run a YQL script. The script can include queries of different types. Unlike yql, the scripting yql command has a limit on the number of returned rows and accessed data.

General format of the command:

ydb [global options...] scripting yql [options...]

View the description of the YQL script command:

ydb scripting yql --help

Parameters of the subcommand

Name Description
--timeout The time within which the operation should be completed on the server.
--stats Statistics mode.
Acceptable values:
  • none: Do not collect statistics.
  • basic: Collect statistics for basic events.
  • full: Collect statistics for all events.
Defaults to none.
-s, --script Text of the YQL query to be executed.
-f, --file Path to the text of the YQL query to be executed.
--explain Show the query execution plan.
--show-response-metadata Show the response metadata.
-p, --param Query parameters (for data queries and scan queries).
You can specify multiple parameters. To change the input format, use the --input-format subcommand parameter.
--input-format Input format.
Acceptable values:
  • json-unicode: JSON input with binary strings Unicode-encoded.
  • json-base64: JSON input with binary strings Base64-encoded.
--format Input format.
Default value: pretty.
Acceptable values:
  • pretty: A human-readable format.
  • json-unicode: JSON output with binary strings Unicode-encoded and each JSON string in a separate line.
  • json-unicode-array: JSON output with binary strings Unicode-encoded and the result output as an array of JSON strings with each JSON string in a separate line.
  • json-base64: JSON output with binary strings Base64-encoded and each JSON string in a separate line.
  • json-base64-array: JSON output with binary strings Base64-encoded and the result output as an array of JSON strings with each JSON string in a separate line.

Examples

Note

The examples use the db1 profile. To learn more, see Creating a connection profile.

Running queries with a timeout

Run a query with a timeout of 500 ms:

ydb yql \
  --script \
  "CREATE TABLE series ( \
  series_id Uint64, \
  title Utf8, \
  series_info Utf8, \
  release_date Uint64, \
  PRIMARY KEY (series_id) \
  );" \
  --timeout 500

If the server couldn't complete the query in 500 ms, it returns an error. If the client couldn't get an error message from the server, the query is interrupted on the client side in 500+200 ms.

Running a parameterized query

Run the parameterized query with statistics enabled:

ydb yql \
  --stats full \
  --script \
  "DECLARE \$myparam AS Uint64; \
  SELECT * FROM series WHERE series_id=\$myparam;" \
  --param '$myparam=1'

Result:

┌──────────────┬───────────┬──────────────────────────────────────────────────────────────────────────────┬────────────┐
| release_date | series_id | series_info                                                                  | title      |
├──────────────┼───────────┼──────────────────────────────────────────────────────────────────────────────┼────────────┤
| 13182        | 1         | "The IT Crowd is a British sitcom produced by Channel 4, written by Graham L | "IT Crowd" |
|              |           | inehan, produced by Ash Atalla and starring Chris O'Dowd, Richard Ayoade, Ka |            |
|              |           | therine Parkinson, and Matt Berry."                                          |            |
└──────────────┴───────────┴──────────────────────────────────────────────────────────────────────────────┴────────────┘

Statistics:
query_phases {
  duration_us: 14294
  table_access {
    name: "/my-db/series"
    reads {
      rows: 1
      bytes: 209
    }
    partitions_count: 1
  }
  cpu_time_us: 783
  affected_shards: 1
}
process_cpu_time_us: 5083
total_duration_us: 81373
total_cpu_time_us: 5866
In this article: