diff options
33 files changed, 56 insertions, 56 deletions
diff --git a/ydb/apps/ydb/CHANGELOG.md b/ydb/apps/ydb/CHANGELOG.md index 5c8b85363fc..e2f14cd8414 100644 --- a/ydb/apps/ydb/CHANGELOG.md +++ b/ydb/apps/ydb/CHANGELOG.md @@ -293,7 +293,7 @@ Also now you can load test YDB topics, using wide transactions that span over al * You can now save the IAM service URL in a profile. * Added support for username and password-based authentication without specifying the password. * Added support for AWS profiles in the [ydb export s3](reference/ydb-cli/export-import/auth-s3.md#auth) command. -* You can now create profiles using `stdin`. For example, you can pass the [YC CLI](https://cloud.yandex.ru/docs/cli/) `yc ydb database get information` command output to the `ydb config profile create` command input. +* You can now create profiles using `stdin`. For example, you can pass the [YC CLI](https://yandex.cloud/docs/cli/) `yc ydb database get information` command output to the `ydb config profile create` command input. ### Bug fixes diff --git a/ydb/docs/en/core/_includes/parameterized-query.md b/ydb/docs/en/core/_includes/parameterized-query.md index 36e489e4209..7f4cf502264 100644 --- a/ydb/docs/en/core/_includes/parameterized-query.md +++ b/ydb/docs/en/core/_includes/parameterized-query.md @@ -3,9 +3,9 @@ A brief help is provided below. For a detailed description with examples, see [{ | Name | Description | ---|--- | `-p, --param` | The value of a single parameter of a YQL query, in the format: `$name=value`, where `$name` is the parameter name and `value` is its value (a valid [JSON value](https://www.json.org/json-ru.html)). | -| `--param-file` | Name of the file in [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format and in [UTF-8]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/UTF-8){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/UTF-8){% endif %} encoding that specifies values of the parameters matched against the YQL query parameters by key names. | -| `--input-format` | Format of parameter values. Applies to all the methods of parameter transmission (among command parameters, in a file or using `stdin`).<br/>Acceptable values:<ul><li>`json-unicode` (default):[JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li></ul> | -| `--stdin-format` | The parameter format and framing for `stdin`. To set both values, specify the parameter twice.<br/>**Format of parameter encoding for `stdin`**<br/>Acceptable values:<ul><li>`json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li><li>`raw` is binary data; the parameter name is set in `--stdin-par`.</li></ul>If the format of parameter encoding for `stdin` isn't specified, the format set in `--input-format` is used.<br/><br/>**Classification of parameter sets for `stdin` (framing)**<br/>Acceptable values:<ul><li>`no-framing` (default): Framing isn't used</li><li>`newline-delimited`: The newline character is used in `stdin` to end a given parameter set, separating it from the next one.</li></ul> | +| `--param-file` | Name of the file in [JSON](https://en.wikipedia.org/wiki/JSON) format and in [UTF-8](https://en.wikipedia.org/wiki/UTF-8) encoding that specifies values of the parameters matched against the YQL query parameters by key names. | +| `--input-format` | Format of parameter values. Applies to all the methods of parameter transmission (among command parameters, in a file or using `stdin`).<br/>Acceptable values:<ul><li>`json-unicode` (default):[JSON](https://en.wikipedia.org/wiki/JSON).</li><li>`json-base64`: [JSON](https://en.wikipedia.org/wiki/JSON) format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64](https://en.wikipedia.org/wiki/Base64)-encoded.</li></ul> | +| `--stdin-format` | The parameter format and framing for `stdin`. To set both values, specify the parameter twice.<br/>**Format of parameter encoding for `stdin`**<br/>Acceptable values:<ul><li>`json-unicode`: [JSON](https://en.wikipedia.org/wiki/JSON).</li><li>`json-base64`: [JSON](https://en.wikipedia.org/wiki/JSON) format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64](https://en.wikipedia.org/wiki/Base64)-encoded.</li><li>`raw` is binary data; the parameter name is set in `--stdin-par`.</li></ul>If the format of parameter encoding for `stdin` isn't specified, the format set in `--input-format` is used.<br/><br/>**Classification of parameter sets for `stdin` (framing)**<br/>Acceptable values:<ul><li>`no-framing` (default): Framing isn't used</li><li>`newline-delimited`: The newline character is used in `stdin` to end a given parameter set, separating it from the next one.</li></ul> | | `--stdin-par` | The name of the parameter whose value will be sent over `stdin` is specified without a `$`. | | `--batch` | The batch mode of transmitting parameter sets received via `stdin`.<br/>Acceptable values:<ul><li>`iterative` (default): Batch mode is disabled</li><li>`full`: Full-scale batch mode is enabled</li><li>`adaptive`: Adaptive batching is enabled | | `--batch-limit` | A maximum number of sets of parameters per batch in the adaptive batch mode. The setting of `0` removes the limit.<br/><br/>The default value is `1000`.<br/><br/> | diff --git a/ydb/docs/en/core/changelog-cli.md b/ydb/docs/en/core/changelog-cli.md index a9ee24dc368..a64d7b13ef2 100644 --- a/ydb/docs/en/core/changelog-cli.md +++ b/ydb/docs/en/core/changelog-cli.md @@ -320,7 +320,7 @@ Release date: November 18, 2022. To update to version **2.1.0**, select the [Dow * You can now save the IAM service URL in a profile. * Added support for username and password-based authentication without specifying the password. * Added support for AWS profiles in the [ydb export s3](reference/ydb-cli/export-import/auth-s3.md#auth) command. -* You can now create profiles using `stdin`. For example, you can pass the [YC CLI](https://cloud.yandex.ru/docs/cli/) `yc ydb database get information` command output to the `{{ ydb-cli }} config profile create` command input. +* You can now create profiles using `stdin`. For example, you can pass the [YC CLI](https://yandex.cloud/docs/cli/) `yc ydb database get information` command output to the `{{ ydb-cli }} config profile create` command input. ### Bug fixes diff --git a/ydb/docs/en/core/concepts/federated_query/s3/_includes/date_formats.md b/ydb/docs/en/core/concepts/federated_query/s3/_includes/date_formats.md index 845e7f40685..0f977ee6b8c 100644 --- a/ydb/docs/en/core/concepts/federated_query/s3/_includes/date_formats.md +++ b/ydb/docs/en/core/concepts/federated_query/s3/_includes/date_formats.md @@ -1,7 +1,7 @@ |Name|Description|Example| |---|---|---| |`POSIX`|String in `%Y-%m-%d %H:%M:%S` format|2001-03-26 16:10:00| -|`ISO`|Format, corresponding to the [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601) standard|2001-03-26 16:10:00Z| +|`ISO`|Format, corresponding to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard|2001-03-26 16:10:00Z| |`UNIX_TIME_SECONDS`|Number of seconds that have elapsed since the 1st of january 1970 (00:00:00 UTC)|985623000| |`UNIX_TIME_MILLISECONDS`|Number of milliseconds that have elapsed since the 1st of january 1970 (00:00:00 UTC)|985623000000| |`UNIX_TIME_MICROSECONDS`|Number of microseconds that have elapsed since the 1st of january 1970 (00:00:00 UTC)|985623000000000|
\ No newline at end of file diff --git a/ydb/docs/en/core/devops/ansible/initial-deployment.md b/ydb/docs/en/core/devops/ansible/initial-deployment.md index af912a6b4a3..3de32a1e541 100644 --- a/ydb/docs/en/core/devops/ansible/initial-deployment.md +++ b/ydb/docs/en/core/devops/ansible/initial-deployment.md @@ -138,7 +138,7 @@ The values of the `system_timezone` and `system_ntp_servers` variables depend on - Yandex Cloud * `system_timezone`: Europe/Moscow - * `system_ntp_servers`: [0.ru.pool.ntp.org, 1.ru.pool.ntp.org, ntp0.NL.net, ntp2.vniiftri.ru, ntp.ix.ru, ntps1-1.cs.tu-berlin.de] [Learn more](https://cloud.yandex.ru/en/docs/tutorials/infrastructure-management/ntp) about Yandex Cloud NTP server settings. + * `system_ntp_servers`: [0.ru.pool.ntp.org, 1.ru.pool.ntp.org, ntp0.NL.net, ntp2.vniiftri.ru, ntp.ix.ru, ntps1-1.cs.tu-berlin.de] [Learn more](https://yandex.cloud/en/docs/tutorials/infrastructure-management/ntp) about Yandex Cloud NTP server settings. {% endlist %} diff --git a/ydb/docs/en/core/devops/kubernetes/initial-deployment.md b/ydb/docs/en/core/devops/kubernetes/initial-deployment.md index 1b0a1995217..b9ef5dd9936 100644 --- a/ydb/docs/en/core/devops/kubernetes/initial-deployment.md +++ b/ydb/docs/en/core/devops/kubernetes/initial-deployment.md @@ -1,6 +1,6 @@ # Getting started with {{ ydb-short-name }} in {{ k8s }} -Deploying {{ ydb-short-name }} in {{ k8s }} is a simple way to set up and run a {{ ydb-short-name }} cluster. {{ k8s }} allows to use an universal approach to managing your application in any cloud service provider. This guide provides instructions on how to deploy {{ ydb-short-name }} in [AWS EKS](https://aws.amazon.com/eks/) or [{{ managed-k8s-full-name }}](https://cloud.yandex.com/services/managed-kubernetes). +Deploying {{ ydb-short-name }} in {{ k8s }} is a simple way to set up and run a {{ ydb-short-name }} cluster. {{ k8s }} allows to use an universal approach to managing your application in any cloud service provider. This guide provides instructions on how to deploy {{ ydb-short-name }} in [AWS EKS](https://aws.amazon.com/eks/) or [{{ managed-k8s-full-name }}](https://yandex.cloud/services/managed-kubernetes). ## Prerequisites @@ -43,7 +43,7 @@ Skip this section if you have already configured a suitable {{ k8s }} cluster. - {{ managed-k8s-full-name }} - Follow the instructions in the [{{ managed-k8s-full-name }} quick start guide](https://cloud.yandex.com/en/docs/managed-kubernetes/quickstart). + Follow the instructions in the [{{ managed-k8s-full-name }} quick start guide](https://yandex.cloud/en/docs/managed-kubernetes/quickstart). {% endlist %} diff --git a/ydb/docs/en/core/integrations/ingestion/import-jdbc.md b/ydb/docs/en/core/integrations/ingestion/import-jdbc.md index 1f06f6ae987..ae0f6003dab 100644 --- a/ydb/docs/en/core/integrations/ingestion/import-jdbc.md +++ b/ydb/docs/en/core/integrations/ingestion/import-jdbc.md @@ -178,7 +178,7 @@ Below is the explanation of the configuration file structure: In case the Service Account authentication is used, either explicitly or through the YDB_SERVICE_ACCOUNT_KEY_FILE_CREDENTIALS env, the key file must be generated as written in the following document: - https://cloud.yandex.com/en/docs/iam/operations/authorized-key/create + https://yandex.cloud/en/docs/iam/operations/authorized-key/create --> <!-- Custom TLS certificates, if needed --> <tls-certificate-file>ca.crt</tls-certificate-file> diff --git a/ydb/docs/en/core/reference/ydb-cli/_includes/result_format_csv_tsv.md b/ydb/docs/en/core/reference/ydb-cli/_includes/result_format_csv_tsv.md index 250c9b50406..3d468068996 100644 --- a/ydb/docs/en/core/reference/ydb-cli/_includes/result_format_csv_tsv.md +++ b/ydb/docs/en/core/reference/ydb-cli/_includes/result_format_csv_tsv.md @@ -1,2 +1,2 @@ -* `csv`: Output in [CSV](https://ru.wikipedia.org/wiki/CSV) format. -* `tsv`: Output in [TSV](https://ru.wikipedia.org/wiki/TSV) format. +* `csv`: Output in [CSV](https://en.wikipedia.org/wiki/CSV) format. +* `tsv`: Output in [TSV](https://en.wikipedia.org/wiki/Tab-separated_values) format. diff --git a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/import-file.md b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/import-file.md index c1d1d7c14a9..3cb03ed0ae3 100644 --- a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/import-file.md +++ b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/import-file.md @@ -56,7 +56,7 @@ The file includes data without any additional information. The `,` character is {% note info %} -The `release_date` column in the `series` table has the [Date](../../../../yql/reference/types/primitive.md#datetime) type, so the release date in the imported file has a numeric format. To import values in the [timestamp]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/ISO_8601){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/ISO_8601){% endif %} format, use string-type table columns for them. Alternatively, you can import them to a temporary table and convert them to a relevant type. +The `release_date` column in the `series` table has the [Date](../../../../yql/reference/types/primitive.md#datetime) type, so the release date in the imported file has a numeric format. To import values in the [timestamp](https://en.wikipedia.org/wiki/ISO_8601) format, use string-type table columns for them. Alternatively, you can import them to a temporary table and convert them to a relevant type. {% endnote %} diff --git a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_conn.md b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_conn.md index 82193871e3f..21bc2ea3de2 100644 --- a/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_conn.md +++ b/ydb/docs/en/core/reference/ydb-cli/export-import/_includes/s3_conn.md @@ -47,9 +47,9 @@ If a certain authentication parameter is omitted in the command line and cannot ### {{ yandex-cloud }} -Below is an example of getting access keys for the [{{ yandex-cloud }} Object Storage]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/storage/){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/storage/){% endif %} using the {{ yandex-cloud }} CLI. +Below is an example of getting access keys for the [{{ yandex-cloud }} Object Storage](https://yandex.cloud/docs/storage/) using the {{ yandex-cloud }} CLI. -1. [Install and set up]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/cli/quickstart){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/cli/quickstart){% endif %} the {{ yandex-cloud }} CLI. +1. [Install and set up](https://yandex.cloud/docs/cli/quickstart) the {{ yandex-cloud }} CLI. 2. Use the following command to get the ID of your cloud folder (`folder-id`) (you'll need to add it to the commands below): @@ -63,7 +63,7 @@ Below is an example of getting access keys for the [{{ yandex-cloud }} Object St folder-id: b2ge70qdcff4bo9q6t19 ``` -3. To [create a service account]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/iam/operations/sa/create){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/iam/operations/sa/create){% endif %}, run the command: +3. To [create a service account](https://yandex.cloud/docs/iam/operations/sa/create), run the command: ```bash yc iam service-account create --name s3account @@ -79,7 +79,7 @@ Below is an example of getting access keys for the [{{ yandex-cloud }} Object St yc iam service-account get --name <account-name> ``` -4. [Grant roles to your service account]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/iam/operations/sa/assign-role-for-sa){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/iam/operations/sa/assign-role-for-sa){% endif %} according to your intended S3 access level by running the command: +4. [Grant roles to your service account](https://yandex.cloud/docs/iam/operations/sa/assign-role-for-sa) according to your intended S3 access level by running the command: {% list tabs %} @@ -101,9 +101,9 @@ Below is an example of getting access keys for the [{{ yandex-cloud }} Object St Where `<folder-id>` is the cloud folder ID that you retrieved at step 2 and `<s3-account-id>` is the id of the account you created at step 3. - You can also read a [full list]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/iam/concepts/access-control/roles#object-storage){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/iam/concepts/access-control/roles#object-storage){% endif %} of {{ yandex-cloud }} roles. + You can also read a [full list](https://yandex.cloud/docs/iam/concepts/access-control/roles#object-storage) of {{ yandex-cloud }} roles. -5. Get [static access keys]{% if lang == "ru" %}(https://cloud.yandex.ru/docs/iam/operations/sa/create-access-key){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/docs/iam/operations/sa/create-access-key){% endif %} by running the command: +5. Get [static access keys](https://yandex.cloud/docs/iam/operations/sa/create-access-key) by running the command: ```bash yc iam access-key create --service-account-name s3account diff --git a/ydb/docs/en/core/reference/ydb-cli/operation-get.md b/ydb/docs/en/core/reference/ydb-cli/operation-get.md index 9c4d4348dfd..75ecb1f0552 100644 --- a/ydb/docs/en/core/reference/ydb-cli/operation-get.md +++ b/ydb/docs/en/core/reference/ydb-cli/operation-get.md @@ -22,7 +22,7 @@ View a description of the command to obtain the status of a long-running operati | Name | Description | |------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--format` | Input format.<br/>Default value: `pretty`.<br/>Acceptable values:<ul><li>`pretty`: A human-readable format.</li><li>`proto-json-base64`: Protobuf result in [JSON] format{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, binary strings are encoded in [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}.</li></ul> | +| `--format` | Input format.<br/>Default value: `pretty`.<br/>Acceptable values:<ul><li>`pretty`: A human-readable format.</li><li>`proto-json-base64`: Protobuf result in [JSON](https://en.wikipedia.org/wiki/JSON) format, binary strings are encoded in [Base64](https://en.wikipedia.org/wiki/Base64).</li></ul> | ## Examples {examples} diff --git a/ydb/docs/en/core/reference/ydb-cli/profile/_includes/create.md b/ydb/docs/en/core/reference/ydb-cli/profile/_includes/create.md index a9e6837dd0f..181946cadc9 100644 --- a/ydb/docs/en/core/reference/ydb-cli/profile/_includes/create.md +++ b/ydb/docs/en/core/reference/ydb-cli/profile/_includes/create.md @@ -207,10 +207,10 @@ Creating a new `mydb1` profile: ```text Pick desired action to configure authentication method: [1] Use static credentials (user & password) - [2] Use IAM token (iam-token) cloud.yandex.com/docs/iam/concepts/authorization/iam-token - [3] Use OAuth token of a Yandex Passport user (yc-token). Doesn't work with federative accounts. cloud.yandex.com/docs/iam/concepts/authorization/oauth-token - [4] Use metadata service on a virtual machine (use-metadata-credentials) cloud.yandex.com/docs/compute/operations/vm-connect/auth-inside-vm - [5] Use service account key file (sa-key-file) cloud.yandex.com/docs/iam/operations/iam-token/create-for-sa + [2] Use IAM token (iam-token) yandex.cloud/docs/iam/concepts/authorization/iam-token + [3] Use OAuth token of a Yandex Passport user (yc-token). Doesn't work with federative accounts. yandex.cloud/docs/iam/concepts/authorization/oauth-token + [4] Use metadata service on a virtual machine (use-metadata-credentials) yandex.cloud/docs/compute/operations/vm-connect/auth-inside-vm + [5] Use service account key file (sa-key-file) yandex.cloud/docs/iam/operations/iam-token/create-for-sa [6] Set new access token (ydb-token) [7] Don't save authentication data for profile "mydb1" Please enter your numeric choice: diff --git a/ydb/docs/en/core/reference/ydb-cli/topic-read.md b/ydb/docs/en/core/reference/ydb-cli/topic-read.md index 5b8fb3e95c8..f16724fbef1 100644 --- a/ydb/docs/en/core/reference/ydb-cli/topic-read.md +++ b/ydb/docs/en/core/reference/ydb-cli/topic-read.md @@ -61,7 +61,7 @@ If consumer name is not specified, message consumption will start from the first - Defaults to `none`. - Possible values: - `base64`: A message is transformed into [Base64](https://ru.wikipedia.org/wiki/Base64) + `base64`: A message is transformed into [Base64](https://en.wikipedia.org/wiki/Base64) `none`: The contents of a message are output byte by byte without transforming them. `--file VAL` (`-f VAL`): Write the messages read to the specified file. If not set, messages are output to `stdout`. diff --git a/ydb/docs/en/core/reference/ydb-cli/topic-write.md b/ydb/docs/en/core/reference/ydb-cli/topic-write.md index 59bf8109f09..15ba602c4b9 100644 --- a/ydb/docs/en/core/reference/ydb-cli/topic-write.md +++ b/ydb/docs/en/core/reference/ydb-cli/topic-write.md @@ -30,7 +30,7 @@ The `topic write` command writes messages to a topic from a file or `stdin`: - Defaults to `none`. - Possible values: - - `base64`: Decode each message in the input stream from [Base64](https://ru.wikipedia.org/wiki/Base64) and write the output to the topic. If decoding fails, the command is aborted with an error. + - `base64`: Decode each message in the input stream from [Base64](https://en.wikipedia.org/wiki/Base64) and write the output to the topic. If decoding fails, the command is aborted with an error. - `none`: Write the contents of a message from the input stream to the topic byte by byte without transforming them. ### Additional parameters diff --git a/ydb/docs/en/core/reference/ydb-sdk/_includes/auth.md b/ydb/docs/en/core/reference/ydb-sdk/_includes/auth.md index 22f62946a55..d7e4f9cbbf2 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/_includes/auth.md +++ b/ydb/docs/en/core/reference/ydb-sdk/_includes/auth.md @@ -73,7 +73,7 @@ You can click any of the methods below to go to the source code of an example in | Static Credentials | [ydb::StaticCredentialsAuth](https://github.com/ydb-platform/ydb-rs-sdk/blob/master/ydb/examples/auth-static-credentials.rs) | | Service Account Key | not supported | | Determined by environment variables | not supported | - | Execution of an external command | ydb.CommandLineYcToken (for example, for authentication using a {{ yandex-cloud }} [IAM token]{% if lang == "ru"%}(https://cloud.yandex.ru/docs/iam/concepts/authorization/iam-token){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/en/docs/iam/concepts/authorization/iam-token){% endif %} from the developer's computer ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```) | + | Execution of an external command | ydb.CommandLineYcToken (for example, for authentication using a {{ yandex-cloud }} [IAM token](https://yandex.cloud/en/docs/iam/concepts/authorization/iam-token) from the developer's computer ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```) | - PHP diff --git a/ydb/docs/en/core/security/audit-log.md b/ydb/docs/en/core/security/audit-log.md index 21612d09a68..4f5492259b8 100644 --- a/ydb/docs/en/core/security/audit-log.md +++ b/ydb/docs/en/core/security/audit-log.md @@ -11,7 +11,7 @@ _An audit log_ is a stream that includes data about all the operations that trie The data of the audit log stream can be delivered to: * File on each {{ ydb-short-name }} cluster node. -* Agent for delivering [Unified Agent](https://cloud.yandex.ru/docs/monitoring/concepts/data-collection/unified-agent/) metrics. +* Agent for delivering [Unified Agent](https://yandex.cloud/docs/monitoring/concepts/data-collection/unified-agent/) metrics. * Standard error stream, `stderr`. You can use any of the listed destinations or their combinations. @@ -66,7 +66,7 @@ audit_config: | Key | Description | --- | --- | `file_backend` | Write the audit log to a file at each cluster node.</ul>Optional. | -| `format` | Audit log format. The default value is `JSON`.<br/>Acceptable values:<ul><li>`JSON`: Serialized [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`TXT`: Text format.</ul>Optional. | +| `format` | Audit log format. The default value is `JSON`.<br/>Acceptable values:<ul><li>`JSON`: Serialized [JSON](https://en.wikipedia.org/wiki/JSON).</li><li>`TXT`: Text format.</ul>Optional. | | `file_path` | Path to the file that the audit log will be streamed to. If the path and the file are missing, they will be created on each node at cluster startup. If the file exists, the data will be appended to it.<br/>This parameter is required if you use `file_backend`. | | `unified_agent_backend` | Stream the audit log to the Unified Agent. In addition, you need to define the `uaclient_config` section in the [cluster configuration](../reference/configuration/index.md).</ul>Optional. | | `log_name` | The session metadata delivered with the message. Using the metadata, you can redirect the log stream to one or more child channels based on the condition: `_log_name: "session_meta_log_name"`.<br/>Optional. | diff --git a/ydb/docs/en/core/security/authentication.md b/ydb/docs/en/core/security/authentication.md index e55603a9f65..be978989da8 100644 --- a/ydb/docs/en/core/security/authentication.md +++ b/ydb/docs/en/core/security/authentication.md @@ -13,7 +13,7 @@ The following authentication modes are supported: * [Anonymous](#anonymous) authentication. * Authentication by [username and password](#static-credentials). * [LDAP](#ldap-auth-provider) authentication. -* [Authentication through a third-party IAM provider](#iam), for example, [Yandex Identity and Access Management](https://cloud.yandex.com/en/docs/iam/). +* [Authentication through a third-party IAM provider](#iam), for example, [Yandex Identity and Access Management](https://yandex.cloud/en/docs/iam/). ## Anonymous authentication {#anonymous} diff --git a/ydb/docs/en/core/yql/reference/builtins/aggregation.md b/ydb/docs/en/core/yql/reference/builtins/aggregation.md index 04f3db645ff..3f7c8c3ad0f 100644 --- a/ydb/docs/en/core/yql/reference/builtins/aggregation.md +++ b/ydb/docs/en/core/yql/reference/builtins/aggregation.md @@ -116,7 +116,7 @@ FROM my_table; ## SOME {#some} -Get the value for an expression specified as an argument, for one of the table rows. Gives no guarantee of which row is used. It's similar to the [any()]{% if lang == "en" %}(https://clickhouse.tech/docs/en/sql-reference/aggregate-functions/reference/any/){% else %}(https://clickhouse.tech/docs/ru/sql-reference/aggregate-functions/reference/any/){% endif %} function in ClickHouse. +Get the value for an expression specified as an argument, for one of the table rows. Gives no guarantee of which row is used. It's similar to the [any()](https://clickhouse.com/docs/en/sql-reference/aggregate-functions/reference/any/) function in ClickHouse. Because of no guarantee, `SOME` is computationally cheaper than [MIN / MAX](#min-max) often used in similar situations. diff --git a/ydb/docs/en/core/yql/reference/syntax/select/match_recognize.md b/ydb/docs/en/core/yql/reference/syntax/select/match_recognize.md index b782c78b6df..e6c46c4f51a 100644 --- a/ydb/docs/en/core/yql/reference/syntax/select/match_recognize.md +++ b/ydb/docs/en/core/yql/reference/syntax/select/match_recognize.md @@ -312,7 +312,7 @@ PARTITION BY device_id, zone_id ## Limitations {#limitations} -Our support for the `MATCH_RECOGNIZE` expression will eventually comply with [SQL-2016](https://ru.wikipedia.org/wiki/SQL:2016); currently, however, the following limitations apply: +Our support for the `MATCH_RECOGNIZE` expression will eventually comply with [SQL-2016](https://en.wikipedia.org/wiki/SQL:2016); currently, however, the following limitations apply: - [`MEASURES`](#measures). Functions `PREV`/`NEXT` are not supported. - [`AFTER MATCH SKIP`](#after_match_skip). Only the `AFTER MATCH SKIP TO NEXT ROW` and `AFTER MATCH SKIP PAST LAST ROW` modes are supported. diff --git a/ydb/docs/ru/core/_includes/parameterized-query.md b/ydb/docs/ru/core/_includes/parameterized-query.md index bab87f86417..0a48d81522f 100644 --- a/ydb/docs/ru/core/_includes/parameterized-query.md +++ b/ydb/docs/ru/core/_includes/parameterized-query.md @@ -3,9 +3,9 @@ Имя | Описание ---|--- `-p, --param` | Значение одного параметра YQL-запроса в формате `$name=value`, где `$name` — имя параметра, а `value` — его значение (корректный [JSON value](https://www.json.org/json-ru.html)). -`--param-file` | Имя файла в формате [JSON](https://{{lang}}.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://{{lang}}.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами YQL-запроса по именам ключей. -`--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json-unicode` (по умолчанию) — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://{{lang}}.wikipedia.org/wiki/Base64).</li></ul> -`--stdin-format` | Формат представления параметров и фрейминг для `stdin`. Чтобы задать оба значения, укажите параметр дважды.<br/>**Формат представления параметров на `stdin`**<br/>Возможные значения:<ul><li>`json-unicode` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://{{lang}}.wikipedia.org/wiki/Base64).</li><li>`raw` — бинарные данные, имя параметра задается опцией `--stdin-par`.</li><li>`csv` — формат [CSV](https://{{lang}}.wikipedia.org/wiki/CSV).</li><li>`tsv` — формат [TSV](https://{{lang}}.wikipedia.org/wiki/TSV).</li></ul>Если формат представления параметров на `stdin` не задан, то применяется формат, заданный параметром `--input-format`.<br/><br/>**Разделение наборов параметров (фрейминг) для `stdin`**<br/>Возможные значения:<ul><li>`no-framing` (по умолчанию) — фрейминг не применяется</li><li>`newline-delimited` — символ перевода строки отмечает на `stdin` окончание одного набора параметров, отделяя его от следующего.</li></ul> +`--param-file` | Имя файла в формате [JSON](https://ru.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://ru.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами YQL-запроса по именам ключей. +`--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json-unicode` (по умолчанию) — [JSON](https://ru.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://ru.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://ru.wikipedia.org/wiki/Base64).</li></ul> +`--stdin-format` | Формат представления параметров и фрейминг для `stdin`. Чтобы задать оба значения, укажите параметр дважды.<br/>**Формат представления параметров на `stdin`**<br/>Возможные значения:<ul><li>`json-unicode` — [JSON](https://ru.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://ru.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://ru.wikipedia.org/wiki/Base64).</li><li>`raw` — бинарные данные, имя параметра задается опцией `--stdin-par`.</li><li>`csv` — формат [CSV](https://ru.wikipedia.org/wiki/CSV).</li><li>`tsv` — формат [TSV](https://ru.wikipedia.org/wiki/TSV).</li></ul>Если формат представления параметров на `stdin` не задан, то применяется формат, заданный параметром `--input-format`.<br/><br/>**Разделение наборов параметров (фрейминг) для `stdin`**<br/>Возможные значения:<ul><li>`no-framing` (по умолчанию) — фрейминг не применяется</li><li>`newline-delimited` — символ перевода строки отмечает на `stdin` окончание одного набора параметров, отделяя его от следующего.</li></ul> `--columns` | Строка с именами колонок, заменяющими header CSV/TSV документа, читаемого со stdin'а. Имена колонок должны быть в том же формате, что и сам документ. `--skip-rows` | Число строк с начала данных, читаемых со stdin'a, которые нужно пропустить, не включая строку header'a. `--stdin-par` | Имя параметра, значение которого будет передано через `stdin`, указывается без символа `$`. diff --git a/ydb/docs/ru/core/concepts/_includes/transactions.md b/ydb/docs/ru/core/concepts/_includes/transactions.md index 167f43e5a3a..6209ab1f0b7 100644 --- a/ydb/docs/ru/core/concepts/_includes/transactions.md +++ b/ydb/docs/ru/core/concepts/_includes/transactions.md @@ -29,7 +29,7 @@ Ниже перечислены возможности и ограничения поддержки YQL в {{ ydb-short-name }}, которые могут быть неочевидны на первый взгляд и на которые стоит обратить внимание: * Допускаются multistatement transactions, то есть транзакции, состоящие из последовательности выражений YQL. При выполнении транзакции допускается взаимодействие с клиентской программой, иначе говоря, взаимодействие клиента с базой может выглядеть следующим образом: `BEGIN; выполнить SELECT; проанализировать результаты SELECT на клиенте; ...; выполнить UPDATE; COMMIT`. Стоит отметить, что если тело транзакции полностью сформировано до обращения к базе данных, то транзакция может обрабатываться эффективнее. -* В {{ ydb-short-name }} не поддерживается возможность смешивать DDL и DML запросы в одной транзакции. Традиционное понятие [ACID]{% if lang == "en" %}(https://en.wikipedia.org/wiki/ACID){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/ACID){% endif %} транзакции применимо именно к DML запросам, то есть к запросам, которые меняют данные. DDL запросы должны быть идемпотентными, то есть повторяемы в случае ошибки. Если необходимо выполнить действие со схемой, то каждое из действий будет транзакционно, а набор действий — нет. +* В {{ ydb-short-name }} не поддерживается возможность смешивать DDL и DML запросы в одной транзакции. Традиционное понятие [ACID](https://ru.wikipedia.org/wiki/ACID) транзакции применимо именно к DML запросам, то есть к запросам, которые меняют данные. DDL запросы должны быть идемпотентными, то есть повторяемы в случае ошибки. Если необходимо выполнить действие со схемой, то каждое из действий будет транзакционно, а набор действий — нет. * Реализация YQL в {{ ydb-short-name }} использует механизм [Optimistic Concurrency Control](https://en.wikipedia.org/wiki/Optimistic_concurrency_control). На затронутые в ходе транзакции сущности ставятся оптимистичные блокировки, при завершении транзакции проверяется, что блокировки не были инвалидированы. Оптимистичность блокировок выливается в важное для пользователя свойство — в случае конфликта выигрывает транзакция, которая завершается первой. Конкурирующие транзакции завершатся с ошибкой `Transaction locks invalidated`. * Все изменения, производимые в рамках транзакции, накапливаются в памяти сервера базы данных и применяются в момент завершения транзакции. Если взятые блокировки не были инвалидированы, то все накопленные изменения применяются атомарно, если хотя бы одна блокировка была инвалидирована, то ни одно из изменений не будет применено. Описанная схема накладывает некоторые ограничения: объем изменений, осуществляемых в рамках одной транзакции, должен умещаться в оперативную память. diff --git a/ydb/docs/ru/core/concepts/_includes/ttl.md b/ydb/docs/ru/core/concepts/_includes/ttl.md index e760f2dcdce..505f75f6228 100644 --- a/ydb/docs/ru/core/concepts/_includes/ttl.md +++ b/ydb/docs/ru/core/concepts/_includes/ttl.md @@ -46,7 +46,7 @@ eviction_time = valueof(ttl_column) + evict_after_seconds * `Uint64`; * `DyNumber`. -* Значение TTL-колонки с числовым типом (`Uint32`, `Uint64`, `DyNumber`) интерпретируется как величина от [Unix-эпохи]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unix_time){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Unix-время){% endif %}. Поддерживаемые единицы измерения (задаются в настройках TTL): +* Значение TTL-колонки с числовым типом (`Uint32`, `Uint64`, `DyNumber`) интерпретируется как величина от [Unix-эпохи](https://ru.wikipedia.org/wiki/Unix-время). Поддерживаемые единицы измерения (задаются в настройках TTL): * секунды; * миллисекунды; diff --git a/ydb/docs/ru/core/concepts/connect.md b/ydb/docs/ru/core/concepts/connect.md index 92e24db8225..e4c86d6c1ac 100644 --- a/ydb/docs/ru/core/concepts/connect.md +++ b/ydb/docs/ru/core/concepts/connect.md @@ -15,7 +15,7 @@ ## Путь базы данных {#database} -Путь базы данных (`database`) - строка, определяющая где на кластере {{ ydb-short-name }} находится база данных, к которой адресован запрос. Имеет структуру [пути к файлу]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Path_(computing)){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Путь_к_файлу){% endif %}, с использованием символа `/` в качестве разделителя. Начинается всегда с символа `/`. +Путь базы данных (`database`) - строка, определяющая где на кластере {{ ydb-short-name }} находится база данных, к которой адресован запрос. Имеет структуру [пути к файлу](https://ru.wikipedia.org/wiki/Путь_к_файлу), с использованием символа `/` в качестве разделителя. Начинается всегда с символа `/`. На кластере {{ ydb-short-name }} может быть развернуто множество баз данных, и их пути определяются конфигурацией кластера. Как и эндпоинт, для облачных баз данных `database` показывается в консоли управления на странице требуемой БД, а также обычно может быть получен через CLI облачного поставщика. @@ -49,6 +49,6 @@ ## Корневой сертификат для TLS {#tls-cert} -При использовании протокола с шифрованием ([gRPC over TLS](https://grpc.io/docs/guides/auth/), или grpcs) продолжение сетевого соединения возможно только в том случае, если клиент уверен в том, что ему действительно отвечает подлинный сервер, с которым он пытается установить соединение, а не кто-то посередине, перехвативший запрос в сети. Это обеспечивается проверкой через [цепочки доверия]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Chain_of_trust){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Цепочка_доверия){% endif %}, для работы которой на клиенте должен быть установлен т.н. корневой сертификат. +При использовании протокола с шифрованием ([gRPC over TLS](https://grpc.io/docs/guides/auth/), или grpcs) продолжение сетевого соединения возможно только в том случае, если клиент уверен в том, что ему действительно отвечает подлинный сервер, с которым он пытается установить соединение, а не кто-то посередине, перехвативший запрос в сети. Это обеспечивается проверкой через [цепочки доверия](https://ru.wikipedia.org/wiki/Цепочка_доверия), для работы которой на клиенте должен быть установлен т.н. корневой сертификат. В состав операционных систем, на которых запускается клиент, уже входит набор корневых сертификатов от основных мировых центров сертификации. Однако, владелец кластера {{ ydb-short-name }} может использовать свой центр сертификации, не связанный ни с одним из мировых, что часто встречается в корпоративных окружениях, и почти всегда применяется при самостоятельном развертывании кластеров с поддержкой шифрования на соединениях. В этом случае владелец кластера должен каким-либо образом передать свой корневой сертификат для использования на стороне клиента. Такой сертификат может быть установлен в хранилище сертификатов операционной системы, где запускается клиент (вручную пользователем или корпоративной командой администраторов ОС), или встроен в состав самого клиента (как это сделано для {{ yandex-cloud }} в {{ ydb-short-name }} CLI и SDK). diff --git a/ydb/docs/ru/core/concepts/topic.md b/ydb/docs/ru/core/concepts/topic.md index c87a4453916..59cfa440443 100644 --- a/ydb/docs/ru/core/concepts/topic.md +++ b/ydb/docs/ru/core/concepts/topic.md @@ -2,7 +2,7 @@ Топик в {{ ydb-short-name }} — это сущность для хранения неструктурированных сообщений, предназначенная для их доставки множеству подписчиков. Фактически, топик — это именованный набор сообщений. -Приложение-писатель записывает сообщения в топик. Приложения-читатели независимы друг от друга, они получают, "считывают", сообщения из топика в том порядке, в котором они были записаны. С помощью топика реализуется архитектурный шаблон [издатель-подписчик]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Publish–subscribe_pattern){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Издатель-подписчик_(шаблон_проектирования)){% endif %}. +Приложение-писатель записывает сообщения в топик. Приложения-читатели независимы друг от друга, они получают, "считывают", сообщения из топика в том порядке, в котором они были записаны. С помощью топика реализуется архитектурный шаблон [издатель-подписчик](https://ru.wikipedia.org/wiki/Издатель_—_подписчик). Топик {{ ydb-short-name }} обладает следующими свойствами: @@ -52,7 +52,7 @@ #### Выключено (DISABLED) -Автопартиционирование отключено. В этом случае число партиций остаётся неизменным, и автоматическое масштабирование не происходит. +Автопартиционирование отключено. В этом случае число партиций остаётся неизменным, и автоматическое масштабирование не происходит. Исходное количество партиции указывается при создании топика. При ручном изменении числа партиций в этом режиме добавляются новые партиции. Все ранее существовавшие партиции остаются активными. diff --git a/ydb/docs/ru/core/dev/secondary-indexes.md b/ydb/docs/ru/core/dev/secondary-indexes.md index e17ec3e209b..3a1c162488b 100644 --- a/ydb/docs/ru/core/dev/secondary-indexes.md +++ b/ydb/docs/ru/core/dev/secondary-indexes.md @@ -2,7 +2,7 @@ {% include [not_allow_for_olap](../_includes/not_allow_for_olap_note_main.md) %} -[Индексы]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Индекс_(базы_данных)){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Database_index){% endif %} — вспомогательные структуры в базах данных, позволяющие находить подходящие под определенный критерий данные без необходимости их полного перебора, а также получать отсортированные выборки без выполнения фактической сортировки, требующей обработки полного набора всех сортируемых данных. +[Индексы](https://ru.wikipedia.org/wiki/Индекс_(базы_данных)) — вспомогательные структуры в базах данных, позволяющие находить подходящие под определенный критерий данные без необходимости их полного перебора, а также получать отсортированные выборки без выполнения фактической сортировки, требующей обработки полного набора всех сортируемых данных. Данные в строковых таблицах {{ ydb-short-name }} всегда проиндексированы по первичному ключу. Это означает, что получение любой записи из строковой таблицы с заданными значениями полей, составляющих первичный ключ, всегда будет занимать минимальное фиксированное время, вне зависимости от общего количества записей в строковой таблице. Также наличие индекса по первичному ключу позволяет получить любой последовательный диапазон записей по возрастанию или убыванию первичного ключа. Время исполнения такой операции будет зависеть только от количества получаемых записей, но не зависеть от общего количества записей в строковой таблице. diff --git a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-file.md b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-file.md index 2d9dcb01ed6..d2b8285e329 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-file.md +++ b/ydb/docs/ru/core/reference/ydb-cli/export-import/_includes/import-file.md @@ -56,7 +56,7 @@ {% note info %} -Столбец `release_date` таблицы `series` имеет тип [Date](../../../../yql/reference/types/primitive.md#datetime), поэтому дата релиза в файле для импорта представлена в виде числа. Чтобы импортировать значения в формате [timestamp]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/ISO_8601){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/ISO_8601){% endif %}, используйте для них столбцы таблицы строкового типа, либо импортируйте их во временную таблицу и выполните преобразование к нужному типу. +Столбец `release_date` таблицы `series` имеет тип [Date](../../../../yql/reference/types/primitive.md#datetime), поэтому дата релиза в файле для импорта представлена в виде числа. Чтобы импортировать значения в формате [timestamp](https://ru.wikipedia.org/wiki/ISO_8601), используйте для них столбцы таблицы строкового типа, либо импортируйте их во временную таблицу и выполните преобразование к нужному типу. {% endnote %} diff --git a/ydb/docs/ru/core/reference/ydb-cli/operation-list.md b/ydb/docs/ru/core/reference/ydb-cli/operation-list.md index 27500bb0c90..b066bb3c335 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/operation-list.md +++ b/ydb/docs/ru/core/reference/ydb-cli/operation-list.md @@ -27,7 +27,7 @@ ---|--- `-s`, `--page-size` | Количество операций на одной странице. Если список операций содержит больше строк, чем задано в параметре `--page-size`, то вывод будет разделен на несколько страниц. Для получения следующей страницы укажите параметр `--page-token`. `-t`, `--page-token` | Токен страницы. -`--format` | Формат вывода.<br/>Значение по умолчанию — `pretty`.<br/>Возможные значения:<ul><li>`pretty` — человекочитаемый формат;</li><li>`proto-json-base64` — вывод Protobuf в формате [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, бинарные строки закодированы в [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}.</li></ul> +`--format` | Формат вывода.<br/>Значение по умолчанию — `pretty`.<br/>Возможные значения:<ul><li>`pretty` — человекочитаемый формат;</li><li>`proto-json-base64` — вывод Protobuf в формате [JSON](https://ru.wikipedia.org/wiki/JSON), бинарные строки закодированы в [Base64](https://ru.wikipedia.org/wiki/Base64).</li></ul> ## Примеры {examples} diff --git a/ydb/docs/ru/core/reference/ydb-cli/parameterized-queries-cli.md b/ydb/docs/ru/core/reference/ydb-cli/parameterized-queries-cli.md index 6d627f34b00..4e0eb0e4fa8 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/parameterized-queries-cli.md +++ b/ydb/docs/ru/core/reference/ydb-cli/parameterized-queries-cli.md @@ -17,7 +17,7 @@ * [ydb scripting yql](scripting-yql.md); * [ydb table query execute](table-query-execute.md). -Данные команды поддерживают одинаковый синтаксис и возможности передачи параметров запросов. Значения параметров могут быть заданы в командной строке, загружены из файлов в формате [JSON](https://{{lang}}.wikipedia.org/wiki/JSON), а также считаны с `stdin` в бинарном формате или в формате [JSON](https://{{lang}}.wikipedia.org/wiki/JSON). При передаче параметров через `stdin` поддерживается многократное поточное исполнение YQL-запроса с разными значениями параметров и возможностью пакетирования. +Данные команды поддерживают одинаковый синтаксис и возможности передачи параметров запросов. Значения параметров могут быть заданы в командной строке, загружены из файлов в формате [JSON](https://ru.wikipedia.org/wiki/JSON), а также считаны с `stdin` в бинарном формате или в формате [JSON](https://ru.wikipedia.org/wiki/JSON). При передаче параметров через `stdin` поддерживается многократное поточное исполнение YQL-запроса с разными значениями параметров и возможностью пакетирования. {% note warning %} @@ -32,9 +32,9 @@ Имя | Описание ---|--- `-p, --param` | Выражение в формате `$name=value`, где `$name` — имя параметра YQL-запроса, а `value` — его значение (корректный [JSON value](https://www.json.org/json-ru.html)). Может быть указано несколько раз.<br/><br/>Все указываемые параметры должны быть декларированы в YQL-запросе [оператором DECLARE](../../yql/reference/syntax/declare.md), иначе будет выдана ошибка «Query does not contain parameter». Если один и тот же параметр указан несколько раз, будет выдана ошибка «Parameter value found in more than one source».<br/><br/>В зависимости от используемой операционной системы может понадобиться экранирование символа `$` или запись выражения в одинарных кавычках `'`. -`--param-file` | Имя файла в формате [JSON](https://{{lang}}.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://{{lang}}.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами YQL-запроса по именам ключей. Может быть указано несколько раз.<br/><br/>Если значения декларированного в YQL-запросе параметра будут обнаружены одновременно в нескольких файлах, или заданы в командной строке опцией `--param`, будет выдана ошибка «Parameter value found in more than one source».<br/><br/>Имена ключей в JSON-файле указываются без начального символа `$`. Ключи, которые присутствуют в файле, но не декларированы в YQL-запросе, будут проигнорированы без выдачи сообщения об ошибке. -`--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json-unicode` (по умолчанию) — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://{{lang}}.wikipedia.org/wiki/Base64). Такая возможность позволяет передавать бинарные данные, декодирование которых из Base64 выполнит {{ ydb-short-name }} CLI.</li></ul> -`--stdin-format` | Формат представления значений параметров на `stdin`.<br/>{{ ydb-short-name }} CLI автоматически определяет что на стандартное устройство ввода `stdin` перенаправлен файл или выход другой команды командной оболочки, и в этом случае интерпретирует полученные данные в соответствии с возможными значениями:<ul><li>`json-unicode` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://{{lang}}.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://{{lang}}.wikipedia.org/wiki/Base64).</li><li>`raw` — бинарные данные.</li><li>`csv` — формат [CSV](https://{{lang}}.wikipedia.org/wiki/CSV). По умолчанию имена параметров должны находиться в header'е CSV файла. При единичном исполнении запроса допустима только одна строка в файле, не считая header'a.</li><li>`tsv` — формат [TSV](https://{{lang}}.wikipedia.org/wiki/TSV).</li></ul>Если формат представления параметров на `stdin` не задан, то применяется формат, заданный параметром `--input-format`. +`--param-file` | Имя файла в формате [JSON](https://ru.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://ru.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами YQL-запроса по именам ключей. Может быть указано несколько раз.<br/><br/>Если значения декларированного в YQL-запросе параметра будут обнаружены одновременно в нескольких файлах, или заданы в командной строке опцией `--param`, будет выдана ошибка «Parameter value found in more than one source».<br/><br/>Имена ключей в JSON-файле указываются без начального символа `$`. Ключи, которые присутствуют в файле, но не декларированы в YQL-запросе, будут проигнорированы без выдачи сообщения об ошибке. +`--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json-unicode` (по умолчанию) — [JSON](https://ru.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://ru.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://ru.wikipedia.org/wiki/Base64). Такая возможность позволяет передавать бинарные данные, декодирование которых из Base64 выполнит {{ ydb-short-name }} CLI.</li></ul> +`--stdin-format` | Формат представления значений параметров на `stdin`.<br/>{{ ydb-short-name }} CLI автоматически определяет что на стандартное устройство ввода `stdin` перенаправлен файл или выход другой команды командной оболочки, и в этом случае интерпретирует полученные данные в соответствии с возможными значениями:<ul><li>`json-unicode` — [JSON](https://ru.wikipedia.org/wiki/JSON).</li><li>`json-base64` — [JSON](https://ru.wikipedia.org/wiki/JSON), в котором значения параметров с типом «бинарная строка» (`DECLARE $par AS String`) представлены в кодировке [Base64](https://ru.wikipedia.org/wiki/Base64).</li><li>`raw` — бинарные данные.</li><li>`csv` — формат [CSV](https://ru.wikipedia.org/wiki/CSV). По умолчанию имена параметров должны находиться в header'е CSV файла. При единичном исполнении запроса допустима только одна строка в файле, не считая header'a.</li><li>`tsv` — формат [TSV](https://ru.wikipedia.org/wiki/TSV).</li></ul>Если формат представления параметров на `stdin` не задан, то применяется формат, заданный параметром `--input-format`. `--columns` | Строка с именами колонок, заменяющими header CSV/TSV документа, читаемого со stdin'а. Имена колонок должны быть в том же формате, что и сам документ. При указании опции считается, что header отсутствует. Опция допустима только с форматами stdin'a CSV и TSV. `--skip-rows` | Число строк с начала данных, читаемых со stdin'a, которые нужно пропустить, не включая строку header'a, если она имеется. Опция допустима только с форматами stdin'a CSV и TSV. `--stdin-par` | Имя параметра, значение которого передано через `stdin`. Указывается без символа `$`. Обязательно при использовании формата `raw` в `--stdin-format`.<br/><br/>При использовании с JSON-форматами `stdin` интерпретируется не как JSON-документ, а как JSON value, с передачей значения в параметр с указанным именем. diff --git a/ydb/docs/ru/core/reference/ydb-cli/parameterized-query-execution.md b/ydb/docs/ru/core/reference/ydb-cli/parameterized-query-execution.md index f675c974389..a9b159882a8 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/parameterized-query-execution.md +++ b/ydb/docs/ru/core/reference/ydb-cli/parameterized-query-execution.md @@ -21,9 +21,9 @@ | Имя | Описание | ---|--- | `-p, --param` | Значение одного параметра запроса в формате `$name=value` или `name=value`, где `name` — имя параметра, а `value` — его значение (корректный [JSON value](https://www.json.org/json-ru.html)). | -| `--input-file` | Имя файла в формате [JSON](https://{{lang}}.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://{{lang}}.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами запроса по именам ключей. Может быть использован максимум один файл с параметрами. | -| `--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json` (по умолчанию): Формат [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`csv` — формат [CSV](https://{{lang}}.wikipedia.org/wiki/CSV). По умолчанию имена параметров должны находиться в header'е CSV файла. При единичном исполнении запроса допустима только одна строка в файле, не считая header'a.</li><li>`tsv` — формат [TSV](https://{{lang}}.wikipedia.org/wiki/TSV).</li><li>`raw`: Входной поток из `stdin` или `--input-file` содержит только значение параметра в виде бинарных данных. Имя параметра должно быть указано опцией `--input-param-name`.</li></ul> | -| `--input-binary-strings` | Формат кодировния значения параметров с типом «бинарная строка» (`DECLARE $par AS String`). Говорит о том, как должны интерпретироваться бинарные строки из входного потока.<br/>Возможные значения:<ul><li>`unicode`: Каждый байт в бинарной строке, не являющийся печатаемым ASCII-символом (codes 32-126), должен быть закодирован в кодировке [UTF-8]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/UTF-8){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/UTF-8){% endif %}.</li><li>`base64`: Бинарные строки представлены в кодировке [Base64](https://{{lang}}.wikipedia.org/wiki/Base64). Такая возможность позволяет передавать бинарные данные, декодирование которых из Base64 выполнит {{ ydb-short-name }} CLI.</li></ul> | +| `--input-file` | Имя файла в формате [JSON](https://ru.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://ru.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами запроса по именам ключей. Может быть использован максимум один файл с параметрами. | +| `--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).<br/>Возможные значения:<ul><li>`json` (по умолчанию): Формат [JSON](https://ru.wikipedia.org/wiki/JSON).</li><li>`csv` — формат [CSV](https://ru.wikipedia.org/wiki/CSV). По умолчанию имена параметров должны находиться в header'е CSV файла. При единичном исполнении запроса допустима только одна строка в файле, не считая header'a.</li><li>`tsv` — формат [TSV](https://ru.wikipedia.org/wiki/TSV).</li><li>`raw`: Входной поток из `stdin` или `--input-file` содержит только значение параметра в виде бинарных данных. Имя параметра должно быть указано опцией `--input-param-name`.</li></ul> | +| `--input-binary-strings` | Формат кодировния значения параметров с типом «бинарная строка» (`DECLARE $par AS String`). Говорит о том, как должны интерпретироваться бинарные строки из входного потока.<br/>Возможные значения:<ul><li>`unicode`: Каждый байт в бинарной строке, не являющийся печатаемым ASCII-символом (codes 32-126), должен быть закодирован в кодировке [UTF-8](https://ru.wikipedia.org/wiki/UTF-8).</li><li>`base64`: Бинарные строки представлены в кодировке [Base64](https://ru.wikipedia.org/wiki/Base64). Такая возможность позволяет передавать бинарные данные, декодирование которых из Base64 выполнит {{ ydb-short-name }} CLI.</li></ul> | Если значения указаны для всех параметров, которые не допускают `NULL` (то есть с типом NOT NULL), [в составе оператора `DECLARE`](../../yql/reference/syntax/declare.md), запрос будет выполнен на сервере. Если отсутствует значение хотя бы для одного такого параметра, выполнение команды завершится с ошибкой и сообщением "Не задано значение для параметра". diff --git a/ydb/docs/ru/core/reference/ydb-cli/table-query-execute.md b/ydb/docs/ru/core/reference/ydb-cli/table-query-execute.md index 3eb8e013bca..420752b5bc7 100644 --- a/ydb/docs/ru/core/reference/ydb-cli/table-query-execute.md +++ b/ydb/docs/ru/core/reference/ydb-cli/table-query-execute.md @@ -28,9 +28,9 @@ ||`-t`, `--type` | Тип запроса. Возможные значения: -* `data` — YQL-запрос, содержащий [DML]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Manipulation_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Manipulation_Language){% endif %} операции, допускает как изменение данных в базе, так и получение нескольких выборок с ограничением в 1000 строк в каждой выборке. +* `data` — YQL-запрос, содержащий [DML](https://ru.wikipedia.org/wiki/Data_Manipulation_Language) операции, допускает как изменение данных в базе, так и получение нескольких выборок с ограничением в 1000 строк в каждой выборке. * `scan` — YQL-запрос типа [скан](../../concepts/scan_query.md), допускает только чтение данных из базы, может вернуть только одну выборку, но без ограничения на количество записей в ней. Алгоритм исполнения запроса типа `scan` на сервере более сложный по сравнению с `data`, поэтому в отсутствие требований по возврату более 1000 строк эффективнее использовать тип запроса `data`. -* `scheme` — YQL-запрос, содержащий [DDL]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Definition_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Definition_Language){% endif %} операции. +* `scheme` — YQL-запрос, содержащий [DDL](https://ru.wikipedia.org/wiki/Data_Definition_Language) операции. Значение по умолчанию — `data`.|| ||`--stats` | Режим сбора статистики. diff --git a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md index 42e4b65f179..4eb95f9581e 100644 --- a/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md +++ b/ydb/docs/ru/core/reference/ydb-sdk/_includes/auth.md @@ -73,7 +73,7 @@ Service Account Key | не поддерживается Static Credentials | [ydb::StaticCredentialsAuth](https://github.com/ydb-platform/ydb-rs-sdk/blob/master/ydb/examples/auth-static-credentials.rs) Определяется по переменным окружения | не поддерживается - Выполнение внешней команды | ydb.CommandLineYcToken (например, для авторизации с помощью [IAM-токена]{% if lang == "ru"%}(https://cloud.yandex.ru/docs/iam/concepts/authorization/iam-token){% endif %}{% if lang == "en" %}(https://cloud.yandex.com/en/docs/iam/concepts/authorization/iam-token){% endif %} {{ yandex-cloud }} с компьютера разработчика ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```) + Выполнение внешней команды | ydb.CommandLineYcToken (например, для авторизации с помощью [IAM-токена](https://cloud.yandex.ru/docs/iam/concepts/authorization/iam-token) {{ yandex-cloud }} с компьютера разработчика ```ydb::CommandLineYcToken.from_cmd("yc iam create-token")```) - PHP diff --git a/ydb/docs/ru/core/security/audit-log.md b/ydb/docs/ru/core/security/audit-log.md index 1409a5b4bf6..84510a5e29f 100644 --- a/ydb/docs/ru/core/security/audit-log.md +++ b/ydb/docs/ru/core/security/audit-log.md @@ -66,7 +66,7 @@ audit_config: | Ключ | Описание | |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `file_backend` | Сохранять аудитный лог в файл на каждом узле кластера.</ul>Необязательный. | -| `format` | Формат аудитного лога. Значение по умолчанию: `JSON`.<br/>Возможные значения:<ul><li>`JSON` — [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} в сериализованном виде;</li><li>`TXT` — текст.</ul>Необязательный. | +| `format` | Формат аудитного лога. Значение по умолчанию: `JSON`.<br/>Возможные значения:<ul><li>`JSON` — [JSON](https://ru.wikipedia.org/wiki/JSON) в сериализованном виде;</li><li>`TXT` — текст.</ul>Необязательный. | | `file_path` | Путь к файлу, в который будет направлен аудитный лог. Путь и файл в случае их отсутствия будут созданы на каждом узле при старте кластера. Если файл существует, запись в него будет продолжена.<br/>Обязательный при использовании `file_backend`. | | `unified_agent_backend` | Направить аудитный лог в Unified Agent. Необходимо также описать секцию `uaclient_config` в [конфигурации кластера](../reference/configuration/index.md).</ul>Необязательный. | | `log_name` | Метаданные сессии, которые передаются вместе с сообщением. Позволяют направить логирующий поток в один или несколько дочерних каналов по условию `_log_name: "session_meta_log_name"`.<br/>Необязательный. | diff --git a/ydb/docs/ru/core/yql/reference/syntax/join.md b/ydb/docs/ru/core/yql/reference/syntax/join.md index 42f5717f2db..7c2bf67e006 100644 --- a/ydb/docs/ru/core/yql/reference/syntax/join.md +++ b/ydb/docs/ru/core/yql/reference/syntax/join.md @@ -98,7 +98,7 @@ INNER JOIN b_table VIEW b_index_ref AS b ON a.ref = b.ref; Если в выражении помимо `JOIN` выполняется фильтрация данных, то рекомендуется обернуть те условия, про которые известно, что они вернут `true` для большинства строк, в вызов функции `LIKELY(...)`. Если предположение о преобладании положительных значений в условии окажется верно, такая подсказка может положительно сказаться на времени выполнения запроса. Также `LIKELY` может быть полезен в том случае, когда вычисление предиката ресурсоёмко и при этом сам JOIN значительно сокращает число строк. Перед любым источником данных для `JOIN` можно указать ключевое слово `ANY`, которое служит для подавления дубликатов по ключам `JOIN` с соответствующей стороны. В этом случае из множества строк с одинаковым значением ключей `JOIN` остается только одна (не уточняется какая именно – отсюда и название `ANY`). -Данный синтаксис отличается от принятого в [ClickHouse]{% if lang == "en" %}(https://clickhouse.com/docs/en/sql-reference/statements/select/join/){% endif %}{% if lang == "ru" %}(https://clickhouse.tech/docs/ru/sql-reference/statements/select/join/){% endif %}, где `ANY` пишется перед типом `JOIN` и работает только для правой стороны. +Данный синтаксис отличается от принятого в [ClickHouse](https://clickhouse.tech/docs/ru/sql-reference/statements/select/join/), где `ANY` пишется перед типом `JOIN` и работает только для правой стороны. Запрос |