Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor yql documentation #13701

Merged
merged 4 commits into from
Jan 29, 2025
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions ydb/docs/en/core/concepts/_includes/ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ The *BRO* has the following properties:
* Nanoseconds.

* You can't specify multiple TTL columns.
* You can't delete the TTL column. However, if this is required, you should first [disable TTL](../../recipes/yql/ttl.md#disable) for the table.
* You can't delete the TTL column. However, if this is required, you should first [disable TTL](../../yql/reference/recipes/ttl.md#disable) for the table.
* Only {{ objstorage-name }} is supported as external storage.
* The delete action can only be specified for the last tier.

## Setup {#setting}

Currently, you can manage TTL settings using:

* [YQL](../../recipes/yql/ttl.md).
* [YQL](../../yql/reference/recipes/ttl.md).
* [{{ ydb-short-name }} console client](../../recipes/ydb-cli/ttl.md).
* {{ ydb-short-name }} {% if oss %}C++, {% endif %}Go and Python [SDK](../../recipes/ydb-sdk/ttl.md).
2 changes: 1 addition & 1 deletion ydb/docs/en/core/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ A **semaphore** is an object within a [coordination node](#coordination-node) th

### YQL {#yql}

**YQL ({{ ydb-short-name }} Query Language)** is a high-level language for working with the system. It is a dialect of [ANSI SQL](https://en.wikipedia.org/wiki/SQL). There's a lot of content covering YQL, including a [tutorial](../dev/yql-tutorial/index.md), [reference](../yql/reference/syntax/index.md), and [recipes](../recipes/yql/index.md).
**YQL ({{ ydb-short-name }} Query Language)** is a high-level language for working with the system. It is a dialect of [ANSI SQL](https://en.wikipedia.org/wiki/SQL). There's a lot of content covering YQL, including a [tutorial](../dev/yql-tutorial/index.md), [reference](../yql/reference/syntax/index.md), and [recipes](../yql/reference/recipes/index.md).

### Federated queries {#federated-queries}

Expand Down
2 changes: 1 addition & 1 deletion ydb/docs/en/core/recipes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ This section of {{ ydb-short-name }} documentation contains ready-to-use recipes

* [{#T}](ydb-sdk/index.md)
* [{#T}](ydb-cli/index.md)
* [{#T}](yql/index.md)
* [{#T}](../yql/reference/recipes/index.md)
4 changes: 2 additions & 2 deletions ydb/docs/en/core/recipes/toc_p.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ items:
href: ydb-cli/index.md
include:
mode: link
path: ydb-cli/toc_p.yaml
path: ydb-cli/toc_p.yaml
- name: YQL
include:
mode: link
path: yql/toc_p.yaml
path: ../yql/reference/recipes/toc_i.yaml
2 changes: 1 addition & 1 deletion ydb/docs/en/core/recipes/ydb-cli/ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ {{ ydb-cli }} -e <endpoint> -d <database> table ttl set --column modified_at -

{% include [OLTP_not_allow_note](../../_includes/not_allow_for_oltp_note.md) %}

To enable data eviction, an [external data source](../../concepts/datamodel/external_data_source.md) object that describes a connection to the external storage is needed. Refer to [YQL recipe](../yql/ttl.md#enable-tiering-on-existing-tables) for examples of creating an external data source.
To enable data eviction, an [external data source](../../concepts/datamodel/external_data_source.md) object that describes a connection to the external storage is needed. Refer to [YQL recipe](../../yql/reference/recipes/ttl.md#enable-tiering-on-existing-tables) for examples of creating an external data source.

The example below shows how to enable data eviction by executing a YQL-query from {{ ydb-short-name }} CLI. Rows of the table `mytable` will be moved to the bucket described in the external data source `/Root/s3_cold_data` one hour after the time recorded in the column `created_at` and will be deleted after 24 hours.

Expand Down
2 changes: 1 addition & 1 deletion ydb/docs/en/core/recipes/ydb-sdk/ttl.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The example below shows how to use the `modified_at` column with a numeric type

{% include [OLTP_not_allow_note](../../_includes/not_allow_for_oltp_note.md) %}

To enable data eviction, an [external data source](../../concepts/datamodel/external_data_source.md) object that describes a connection to the external storage is needed. Refer to [YQL recipe](../yql/ttl.md#enable-tiering-on-existing-tables) for examples of creating an external data source.
To enable data eviction, an [external data source](../../concepts/datamodel/external_data_source.md) object that describes a connection to the external storage is needed. Refer to [YQL recipe](../../yql/reference/recipes/ttl.md#enable-tiering-on-existing-tables) for examples of creating an external data source.

In the following example, rows of the table `mytable` will be moved to the bucket described in the external data source `/Root/s3_cold_data` one hour after the time recorded in the column `created_at` and will be deleted after 24 hours:

Expand Down
18 changes: 0 additions & 18 deletions ydb/docs/en/core/yql/reference/_includes/index/intro.md

This file was deleted.

Empty file.
Empty file.
Loading
Loading