Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions ydb/docs/en/core/_includes/alerts/no-translation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% note info %}

This а article is currently in development and will soon be available on the website.

{% endnote %}
36 changes: 18 additions & 18 deletions ydb/docs/en/core/changelog-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Released on January 12, 2024. To update to version **2.8.0**, select the [Downlo

* Added configuration management commands for the cluster `ydb admin config` and `ydb admin volatile-config`.

* Added support for loading PostgreSQL-compatible data types by [ydb import file csv|tsv|json](reference/ydb-cli/export_import/import-file.md) command. Only for row-oriented tables.
* Added support for loading PostgreSQL-compatible data types by [ydb import file csv|tsv|json](reference/ydb-cli/export-import/import-file.md) command. Only for row-oriented tables.

* Added support for directory load from an S3-compatible storage in the [ydb import s3](reference/ydb-cli/export_import/s3_import.md) command. Currently only available on Linux and Mac OS.
* Added support for directory load from an S3-compatible storage in the [ydb import s3](reference/ydb-cli/export-import/import-s3.md) command. Currently only available on Linux and Mac OS.

* Added support for outputting the results of [ydb table query execute](reference/ydb-cli/table-query-execute.md), [ydb yql](reference/ydb-cli/yql.md) and [ydb scripting yql](reference/ydb-cli/scripting-yql.md) commands in the [Apache Parquet](https://parquet.apache.org/docs/) format.

Expand Down Expand Up @@ -90,17 +90,17 @@ Released on September 7, 2023. To update to version **2.6.0**, select the [Downl

**Bug fixes:**

* Fixed string loss when loading with the [ydb import file json](reference/ydb-cli/export_import/import-file.md) command.
* Fixed string loss when loading with the [ydb import file json](reference/ydb-cli/export-import/import-file.md) command.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redirects.yaml needs to be update with these URL changes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.../export_import/... нет в редиректах :)


* Fixed ignored statistics during the warm-up of commands [ydb workload topic run write|read|full](reference/ydb-cli/workload-topic.md#run-write).

* Fixed incomplete statistics output in the [ydb scripting yql](reference/ydb-cli/scripting-yql.md) and [ydb yql](reference/ydb-cli/yql.md) commands.

* Fixed incorrect output of progress bar in [ydb tools dump](reference/ydb-cli/export_import/tools_dump.md) and [ydb tools restore](reference/ydb-cli/export_import/tools_restore.md) commands.
* Fixed incorrect output of progress bar in [ydb tools dump](reference/ydb-cli/export-import/tools-dump.md) and [ydb tools restore](reference/ydb-cli/export-import/tools-restore.md) commands.

* Fixed loading large files with the header in the [ydb import file csv|tsv](reference/ydb-cli/export_import/import-file.md) command.
* Fixed loading large files with the header in the [ydb import file csv|tsv](reference/ydb-cli/export-import/import-file.md) command.

* Fixed hanging of the [ydb tools restore --import-data](reference/ydb-cli/export_import/tools_restore.md#optional) command.
* Fixed hanging of the [ydb tools restore --import-data](reference/ydb-cli/export-import/tools-restore.md#optional) command.

* Fixed error `Unknown value Rejected` when executing the [ydb operation list build index](reference/ydb-cli/operation-list.md) command.

Expand All @@ -110,25 +110,25 @@ Released on June 20, 2023. To update to version **2.5.0**, select the [Downloads

**Features:**

* For the `ydb import file` command, a parameter [--timeout](reference/ydb-cli/export_import/import-file.md#optional) has been added that specifies the time within which the operation should be performed on the server.
* Added a progress bar in commands [ydb scheme rmdir --recursive](reference/ydb-cli/commands/dir.md#rmdir) and [ydb import file](reference/ydb-cli/export_import/import-file.md).
* For the `ydb import file` command, a parameter [--timeout](reference/ydb-cli/export-import/import-file.md#optional) has been added that specifies the time within which the operation should be performed on the server.
* Added a progress bar in commands [ydb scheme rmdir --recursive](reference/ydb-cli/commands/dir.md#rmdir) and [ydb import file](reference/ydb-cli/export-import/import-file.md).
* Added the command [ydb workload kv run read-rows](reference/ydb-cli/workload-kv.md#read-rows-kv), which loads the database with requests to read rows using a new experimental API call ReadRows (implemented only in the [main](https://github.com/ydb-platform/ydb) branch), which performs faster key reading than [select](reference/ydb-cli/workload-kv.md#select-kv).
* New parameters `--warmup-time`, `--percentile`, `--topic` have been added to the [ydb workload topic](reference/ydb-cli/workload-topic.md), setting the test warm-up time, the percentile in the statistics output and the topic name, respectively.
* Added the [ydb workload tpch](reference/ydb-cli/workload-tpch.md) command to run the TPC-H benchmark.
* Added the `--ordered` flag in the command [ydb tools dump](reference/ydb-cli/export_import/tools_dump.md), which preserves the order by primary key in tables.
* Added the `--ordered` flag in the command [ydb tools dump](reference/ydb-cli/export-import/tools-dump.md), which preserves the order by primary key in tables.

**Performance:**

* The data loading speed in the `ydb import file` command has been increased by adding parallel loading. The number of threads is set by the new parameter [--threads](reference/ydb-cli/export_import/import-file.md#optional).
* A performance of the [ydb import file json](reference/ydb-cli/export_import/import-file.md) command has been increased by reducing the number of data copies.
* The data loading speed in the `ydb import file` command has been increased by adding parallel loading. The number of threads is set by the new parameter [--threads](reference/ydb-cli/export-import/import-file.md#optional).
* A performance of the [ydb import file json](reference/ydb-cli/export-import/import-file.md) command has been increased by reducing the number of data copies.

## Version 2.4.0 {#2-4-0}

Released on May 24, 2023. To update to version **2.4.0**, select the [Downloads](downloads/index.md#ydb-cli) section.

**Features:**

* Added the ability to upload multiple files in parallel with the command [ydb import file](reference/ydb-cli/export_import/import-file.md#multiple-files).
* Added the ability to upload multiple files in parallel with the command [ydb import file](reference/ydb-cli/export-import/import-file.md#multiple-files).
* Added support for deleting column tables for the command [ydb scheme rmdir --recursive](reference/ydb-cli/commands/dir.md#rmdir).
* Improved stability of the command [ydb workload topic](reference/ydb-cli/workload-topic.md).

Expand All @@ -144,8 +144,8 @@ Release date: May 1, 2023. To update to version **2.3.0**, select the [Downloads
* Added the [--recursive](reference/ydb-cli/commands/dir.md#rmdir-options) option for the `ydb scheme rmdir` command. Use it to delete a directory recursively, with all its content.
* Added support for the `topic` and `coordination node` types in the [ydb scheme describe](reference/ydb-cli/commands/scheme-describe.md) command.
* Added the [--commit](reference/ydb-cli/topic-read.md#osnovnye-opcionalnye-parametry) option for the `ydb topic consumer` command. Use it to commit messages you have read.
* Added the [--columns](reference/ydb-cli/export_import/import-file.md#optional) option for the `ydb import file csv|tsv` command. Use it as an alternative to the file header when specifying a column list.
* Added the [--newline-delimited](reference/ydb-cli/export_import/import-file.md#optional) option for the `ydb import file csv|tsv` command. Use it to make sure that your data is newline-free. This option streamlines import by reading data from several file sections in parallel.
* Added the [--columns](reference/ydb-cli/export-import/import-file.md#optional) option for the `ydb import file csv|tsv` command. Use it as an alternative to the file header when specifying a column list.
* Added the [--newline-delimited](reference/ydb-cli/export-import/import-file.md#optional) option for the `ydb import file csv|tsv` command. Use it to make sure that your data is newline-free. This option streamlines import by reading data from several file sections in parallel.

**Bug fixes:**

Expand All @@ -172,8 +172,8 @@ Release date: December 30, 2022. To update to version **2.1.1**, select the [Dow
**Improvements:**

* Added support for the `--stats` option of the [ydb scheme describe](reference/ydb-cli/commands/scheme-describe.md) command for column-oriented tables.
* Added support for Parquet files to enable their import with the [ydb import](reference/ydb-cli/export_import/import-file.md) command.
* Added support for additional logging and retries for the [ydb import](reference/ydb-cli/export_import/import-file.md) command.
* Added support for Parquet files to enable their import with the [ydb import](reference/ydb-cli/export-import/import-file.md) command.
* Added support for additional logging and retries for the [ydb import](reference/ydb-cli/export-import/import-file.md) command.

## Version 2.1.0 {#2-1-0}

Expand All @@ -186,7 +186,7 @@ Release date: November 18, 2022. To update to version **2.1.0**, select the [Dow
* Added the `-1` option for the [ydb scheme ls](reference/ydb-cli/commands/scheme-ls.md) command to enable output of a single object per row.
* 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/s3_conn.md#auth) command.
* 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.

**Bug fixes:**
Expand Down Expand Up @@ -230,5 +230,5 @@ Release date: June 25, 2022. To update to version **1.9.1**, select the [Downloa

**Features:**

* Added the ability to compress data when exporting it to S3-compatible storage (see the `--compression` option of the [ydb export s3](reference/ydb-cli/export_import/s3_export.md) command).
* Added the ability to compress data when exporting it to S3-compatible storage (see the `--compression` option of the [ydb export s3](reference/ydb-cli/export-import/export-s3.md) command).
* Added the ability to manage new {{ ydb-short-name }} CLI version availability auto checks (see the `--disable-checks` and `--enable-checks` options of the [ydb version](reference/ydb-cli/version.md) command).
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/datamodel/external_table.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/datamodel/secrets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
3 changes: 3 additions & 0 deletions ydb/docs/en/core/concepts/datamodel/toc_i.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ items:
- { name: Directory, href: dir.md }
- { name: Table, href: table.md }
- { name: Topic, href: ../topic.md }
- { name: Secrets, href: secrets.md }
- { name: External tables, href: external_table.md }
- { name: External data source, href: external_data_source.md }
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/federated_query.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/federated_query/clickhouse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/federated_query/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/federated_query/postgresql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/concepts/federated_query/s3/formats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
8 changes: 8 additions & 0 deletions ydb/docs/en/core/concepts/federated_query/s3/toc_i.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
items:
- { name: Reading data through connections, href: external_data_source.md }
- { name: Reading data through external tables, href: external_table.md }
- { name: Upload data to S3 buckets, href: write_data.md }
- { name: Data formats and compression algorithms, href: formats.md }
- { name: Data partitioning, href: partitioning.md }
- { name: Advanced partitioning, href: partition_projection.md }

2 changes: 2 additions & 0 deletions ydb/docs/en/core/concepts/federated_query/s3/toc_p.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
items:
- include: { mode: link, path: toc_i.yaml }
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../../_includes/alerts/no-translation.md) %}
6 changes: 6 additions & 0 deletions ydb/docs/en/core/concepts/federated_query/toc_i.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
items:
- { name: Overview, href: index.md }
- { name: PostgreSQL, href: postgresql.md }
- { name: ClickHouse, href: clickhouse.md }
- name: S3
include: { path: s3/toc_i.yaml, mode: link }
2 changes: 2 additions & 0 deletions ydb/docs/en/core/concepts/federated_query/toc_p.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
items:
- include: { mode: link, path: toc_i.yaml }
2 changes: 2 additions & 0 deletions ydb/docs/en/core/concepts/toc_i.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,5 @@ items:
href: cluster/common_scheme_ydb.md
- name: Disk subsystem of a cluster
href: cluster/distributed_storage.md
- name: Federated query
include: { path: federated_query/toc_p.yaml, mode: link }
8 changes: 4 additions & 4 deletions ydb/docs/en/core/maintenance/backup_and_recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ Backups protect against data loss by letting you restore data.

### Files {#files}

To back up data to a file, run the `ydb tools dump` command. To learn more about this command, follow the [link](../reference/ydb-cli/export_import/tools_dump.md) to the {{ ydb-short-name }} CLI reference.
To back up data to a file, run the `ydb tools dump` command. To learn more about this command, follow the [link](../reference/ydb-cli/export-import/tools-dump.md) to the {{ ydb-short-name }} CLI reference.

To restore data from a backup, run the `ydb tools restore` command. To learn more about this command, follow the [link](../reference/ydb-cli/export_import/tools_restore.md) to the {{ ydb-short-name }} CLI reference.
To restore data from a backup, run the `ydb tools restore` command. To learn more about this command, follow the [link](../reference/ydb-cli/export-import/tools-restore.md) to the {{ ydb-short-name }} CLI reference.

### S3-compatible storage {#s3}

To back up data to S3-compatible storage (such as [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/Introduction.html)), run the `ydb export s3` command. To learn more about this command, follow the [link](../reference/ydb-cli/export_import/s3_export.md) to the {{ ydb-short-name }} CLI reference.
To back up data to S3-compatible storage (such as [AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/Introduction.html)), run the `ydb export s3` command. To learn more about this command, follow the [link](../reference/ydb-cli/export-import/export-s3.md) to the {{ ydb-short-name }} CLI reference.

To restore data from a backup created in S3-compatible storage, run the `ydb import s3` command. To learn more about this command, follow the [link](../reference/ydb-cli/export_import/s3_import.md) to the {{ ydb-short-name }} CLI reference.
To restore data from a backup created in S3-compatible storage, run the `ydb import s3` command. To learn more about this command, follow the [link](../reference/ydb-cli/export-import/import-s3.md) to the {{ ydb-short-name }} CLI reference.

{% include [_includes/backup_and_recovery/cli_overlay.md](_includes/backup_and_recovery/cli_overlay.md) %}

Expand Down
1 change: 1 addition & 0 deletions ydb/docs/en/core/maintenance/manual/config-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/maintenance/manual/dynamic-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/maintenance/manual/replacing_nodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../../_includes/alerts/no-translation.md) %}
10 changes: 10 additions & 0 deletions ydb/docs/en/core/maintenance/manual/toc_i.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,13 @@ items:
href: balancing_load.md
- name: Freeing up space on physical devices
href: disk_end_space.md
- name: Replacing a node's FQDN
href: replacing_nodes.md
- name: Config overview
href: config-overview.md
- name: Dynamic cluster configuration
href: dynamic-config.md
- name: Cluster configuration DSL
href: dynamic-config-selectors.md
- name: Temporary configurations
href: dynamic-config-volatile-config.md
1 change: 1 addition & 0 deletions ydb/docs/en/core/operations/crud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../_includes/alerts/no-translation.md) %}
1 change: 1 addition & 0 deletions ydb/docs/en/core/operations/query_plans_optimization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{% include [no-translation](../_includes/alerts/no-translation.md) %}
4 changes: 3 additions & 1 deletion ydb/docs/en/core/operations/toc_i.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ items:
href: crud.md
hidden: true
- name: Custom attributes in tables
href: manage-users-attr.md
href: manage-users-attr.md
- name: Query plans optimization
href: query_plans_optimization.md
12 changes: 6 additions & 6 deletions ydb/docs/en/core/reference/ydb-cli/_includes/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ Any command can be run from the command line with the `--help` option to get hel
| [config profile set](../profile/activate.md) | Activating a [profile](../profile/index.md) |
| [discovery list](../commands/discovery-list.md) | List of endpoints |
| [discovery whoami](../commands/discovery-whoami.md) | Authentication |
| [export s3](../export_import/s3_export.md) | Exporting data to S3 storage |
| [import file csv](../export_import/import-file.md) | Importing data from a CSV file |
| [import file tsv](../export_import/import-file.md) | Importing data from a TSV file |
| [import s3](../export_import/s3_import.md) | Importing data from S3 storage |
| [export s3](../export-import/export-s3.md) | Exporting data to S3 storage |
| [import file csv](../export-import/import-file.md) | Importing data from a CSV file |
| [import file tsv](../export-import/import-file.md) | Importing data from a TSV file |
| [import s3](../export-import/import-s3.md) | Importing data from S3 storage |
| [init](../profile/create.md) | Initializing the CLI, creating a [profile](../profile/index.md) |
| [operation cancel](../operation-cancel.md) | Aborting long-running operations |
| [operation forget](../operation-forget.md) | Deleting long-running operations from the list |
Expand Down Expand Up @@ -64,9 +64,9 @@ Any command can be run from the command line with the `--help` option to get hel
| [table ttl set](../table-ttl-set.md) | Setting TTL parameters |
| [table ttl reset](../table-ttl-reset.md) | Resetting TTL parameters |
| [tools copy](../tools-copy.md) | Copying tables |
| [tools dump](../export_import/tools_dump.md) | Dumping a directory or table to the file system |
| [tools dump](../export-import/tools-dump.md) | Dumping a directory or table to the file system |
| [tools rename](../commands/tools/rename.md) | Renaming tables |
| [tools restore](../export_import/tools_restore.md) | Restoring data from the file system |
| [tools restore](../export-import/tools-restore.md) | Restoring data from the file system |
| [topic create](../topic-create.md) | Creating a topic |
| [topic alter](../topic-alter.md) | Updating topic parameters and consumers |
| [topic drop](../topic-drop.md) | Deleting a topic |
Expand Down
Loading