aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVitaly Isaev <vitalyisaev@ydb.tech>2024-09-24 08:46:59 +0300
committerGitHub <noreply@github.com>2024-09-24 08:46:59 +0300
commita6cd079d0e78e45c17f07ac52cd8e214da727b3b (patch)
tree3598b131a4b9756ed18eeaa0da567f39406a40e3
parentdde850f714d4b834ebdd7c920c0dab13d52de8ed (diff)
downloadydb-a6cd079d0e78e45c17f07ac52cd8e214da727b3b.tar.gz
YDB FQ: drop 'Preview' warning in FQ docs (#9188)
-rw-r--r--ydb/docs/en/core/concepts/datamodel/external_data_source.md7
-rw-r--r--ydb/docs/en/core/concepts/datamodel/external_table.md8
-rw-r--r--ydb/docs/en/core/concepts/datamodel/secrets.md8
-rw-r--r--ydb/docs/en/core/concepts/federated_query/index.md6
-rw-r--r--ydb/docs/ru/core/concepts/datamodel/external_data_source.md7
-rw-r--r--ydb/docs/ru/core/concepts/datamodel/external_table.md7
-rw-r--r--ydb/docs/ru/core/concepts/datamodel/secrets.md6
-rw-r--r--ydb/docs/ru/core/concepts/federated_query/index.md6
8 files changed, 15 insertions, 40 deletions
diff --git a/ydb/docs/en/core/concepts/datamodel/external_data_source.md b/ydb/docs/en/core/concepts/datamodel/external_data_source.md
index 7806d419ed..b1b4e76879 100644
--- a/ydb/docs/en/core/concepts/datamodel/external_data_source.md
+++ b/ydb/docs/en/core/concepts/datamodel/external_data_source.md
@@ -1,10 +1,5 @@
# External data sources
-{% note warning %}
-
-This functionality is in "Experimental" mode.
-
-{% endnote %}
An external data source is an object in {{ ydb-full-name }} that describes the connection parameters to an external data source. For example, in the case of ClickHouse, the external data source describes the network address, login, and password for authentication in the ClickHouse cluster. In the case of S3 ({{ objstorage-name }}), it describes the access credentials and the path to the bucket.
@@ -35,4 +30,4 @@ The following data sources can be used:
- [ClickHouse](../federated_query/clickhouse.md)
- [PostgreSQL](../federated_query/postgresql.md)
-- [Connections to S3 ({{ objstorage-name }})](../federated_query/s3/external_data_source.md) \ No newline at end of file
+- [Connections to S3 ({{ objstorage-name }})](../federated_query/s3/external_data_source.md)
diff --git a/ydb/docs/en/core/concepts/datamodel/external_table.md b/ydb/docs/en/core/concepts/datamodel/external_table.md
index fe92ee2a70..8448076619 100644
--- a/ydb/docs/en/core/concepts/datamodel/external_table.md
+++ b/ydb/docs/en/core/concepts/datamodel/external_table.md
@@ -1,11 +1,5 @@
# External tables
-{% note warning %}
-
-This functionality is in "Preview" mode.
-
-{% endnote %}
-
Some [external data sources](external_data_source.md), such as database management systems, store data in a structured format, while others, like S3 ({{objstorage-full-name}}), store data as individual files. To work with file-based data sources, you need to understand both the file placement rules and the formats of the stored data.
A special entity, `EXTERNAL TABLE,` describes the stored data in such sources. External tables allow you to define the schema of the stored files and the schema of file placement within the source.
@@ -31,4 +25,4 @@ INSERT INTO s3_test_data
SELECT * FROM Table
```
-More details on working with external tables describing S3 buckets ({{ objstorage-name }}) can be found in section [{#T}](../federated_query/s3/external_table.md). \ No newline at end of file
+More details on working with external tables describing S3 buckets ({{ objstorage-name }}) can be found in section [{#T}](../federated_query/s3/external_table.md).
diff --git a/ydb/docs/en/core/concepts/datamodel/secrets.md b/ydb/docs/en/core/concepts/datamodel/secrets.md
index 2a7e8f3ee2..996fe7f9b2 100644
--- a/ydb/docs/en/core/concepts/datamodel/secrets.md
+++ b/ydb/docs/en/core/concepts/datamodel/secrets.md
@@ -1,5 +1,11 @@
# Secrets
+{% note warning %}
+
+This functionality is in "Preview" mode.
+
+{% endnote %}
+
To work with external data sources in {{ ydb-full-name }}, [federated queries](../federated_query/index.md) are used. Federated queries utilize various access credentials for authentication in external systems. These credentials are stored in separate objects called secrets. Secrets are only available for writing and updating; their values cannot be retrieved.
{% note warning %}
@@ -24,4 +30,4 @@ Special objects called `SECRET_ACCESS` are used to manage access to secrets. To
```yql
CREATE OBJECT `MySecretName:another_user` (TYPE SECRET_ACCESS)
-``` \ No newline at end of file
+```
diff --git a/ydb/docs/en/core/concepts/federated_query/index.md b/ydb/docs/en/core/concepts/federated_query/index.md
index f43b74f6ad..3b959b6803 100644
--- a/ydb/docs/en/core/concepts/federated_query/index.md
+++ b/ydb/docs/en/core/concepts/federated_query/index.md
@@ -1,11 +1,5 @@
# Federated queries
-{% note warning %}
-
-This functionality is in "Preview" mode.
-
-{% endnote %}
-
Federated queries allow retrieving information from various data sources without needing to transfer the data from these sources into {{ ydb-full-name }} storage. Currently, federated queries support interaction with ClickHouse, PostgreSQL, and S3-compatible data stores. Using YQL queries, you can access these databases without the need to duplicate data between systems.
To work with data stored in external DBMSs, it is sufficient to create an [external data source](../datamodel/external_data_source.md). To work with unstructured data stored in S3 buckets, you additionally need to create an [external table](../datamodel/external_table.md). In both cases, it is necessary to create [secrets](../datamodel/secrets.md) objects first that store confidential data required for authentication in external systems.
diff --git a/ydb/docs/ru/core/concepts/datamodel/external_data_source.md b/ydb/docs/ru/core/concepts/datamodel/external_data_source.md
index 85c9063b0c..78a29248a1 100644
--- a/ydb/docs/ru/core/concepts/datamodel/external_data_source.md
+++ b/ydb/docs/ru/core/concepts/datamodel/external_data_source.md
@@ -1,12 +1,5 @@
# Внешние источники данных
-{% note warning %}
-
-Данная функциональность находится в режиме "Experimental".
-
-{% endnote %}
-
-
Внешний источник (external data source) - это объект в {{ ydb-full-name }}, описывающий параметры подключения к внешнему источнику данных. Например, в случае ClickHouse внешний источник описывает сетевой адрес, логин и пароль для аутентификации в кластере ClickHouse, а в случае S3 ({{ objstorage-name }}) описывает реквизиты доступа и путь к бакету.
В следующем примере приведен пример создания внешнего источника, ведущего на кластер ClickHouse:
diff --git a/ydb/docs/ru/core/concepts/datamodel/external_table.md b/ydb/docs/ru/core/concepts/datamodel/external_table.md
index d2c5601358..457d1c7d77 100644
--- a/ydb/docs/ru/core/concepts/datamodel/external_table.md
+++ b/ydb/docs/ru/core/concepts/datamodel/external_table.md
@@ -1,12 +1,5 @@
# Внешние таблицы
-{% note warning %}
-
-Данная функциональность находится в режиме "Preview".
-
-{% endnote %}
-
-
Часть [внешних источников](external_data_source.md), например, системы управления базами данных, хранят данные в схематизированном виде, а часть, как S3 ({{objstorage-full-name}}), в виде отдельных файлов. Для работы с файловыми источниками данных необходимо знать как правила расположения файлов, так и форматы самих хранимых данных.
Для описания хранимых данных в таких источниках используется специальная сущность - внешние таблицы, `EXTERNAL TABLE`. Внешние таблицы позволяют задать схему данных у хранимых файлов, а также описать схему расположения файлов внутри источника.
diff --git a/ydb/docs/ru/core/concepts/datamodel/secrets.md b/ydb/docs/ru/core/concepts/datamodel/secrets.md
index a5b83a9e1d..bc952a5c6a 100644
--- a/ydb/docs/ru/core/concepts/datamodel/secrets.md
+++ b/ydb/docs/ru/core/concepts/datamodel/secrets.md
@@ -1,5 +1,11 @@
# Секреты
+{% note warning %}
+
+Данная функциональность находится в режиме "Preview".
+
+{% endnote %}
+
Для работы с внешними источниками данных в {{ ydb-full-name }} используются [федеративные запросы](../federated_query/index.md). Для аутентификации во внешних системах федеративные запросы используют различные реквизиты доступа. Реквизиты доступа хранятся в отдельных объектах - секретах. Секреты доступны только для записи и обновления, получить значение секрета нельзя.
{% note warning %}
diff --git a/ydb/docs/ru/core/concepts/federated_query/index.md b/ydb/docs/ru/core/concepts/federated_query/index.md
index e45a0711d1..5d54766cb2 100644
--- a/ydb/docs/ru/core/concepts/federated_query/index.md
+++ b/ydb/docs/ru/core/concepts/federated_query/index.md
@@ -1,11 +1,5 @@
# Федеративные запросы
-{% note warning %}
-
-Данная функциональность находится в режиме "Preview".
-
-{% endnote %}
-
Федеративные запросы - это способ получать информацию из различных источников данных без необходимости переноса данных этих источников внутрь {{ ydb-full-name }}. В настоящее время федеративные запросы поддерживают взаимодействие с базами данных ClickHouse, PostgreSQL и с хранилищами данных класса S3. При помощи YQL запросов вы сможете обращаться к этим базам данных без необходимости дублирования данных между системами.
Для работы с данными, хранящимися во внешних СУБД, достаточно создать [внешний источник данных](../datamodel/external_data_source.md). Для работы с несхематизированными данными, хранящимися в бакетах S3 нужно дополнительно создать [внешнюю таблицу](../datamodel/external_table.md). В обоих случаях необходимо предварительно создать объекты-[секреты](../datamodel/secrets.md), хранящие конфиденциальные данные, необходимые для аутентификации во внешних системах.