Skip to content

Commit fc8464a

Browse files
authored
[docs] markdown and build fixes (#9028)
1 parent f6d081d commit fc8464a

File tree

794 files changed

+6037
-4694
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

794 files changed

+6037
-4694
lines changed

ydb/docs/.yfmlint

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ log-levels:
33
MD002: 'error' # First heading should be a top-level heading
44
MD003: 'disabled' # Heading style
55
MD004: 'disabled' # Unordered list style
6-
MD005: 'error' # Inconsistent indentation for list items at the same level
6+
MD005: 'disabled' # Inconsistent indentation for list items at the same level
77
MD006: 'error' # Consider starting bulleted lists at the beginning of the line
8-
MD007: 'error' # Unordered list indentation
8+
MD007: 'disabled' # Unordered list indentation
99
MD009: 'error' # Trailing spaces
1010
MD010: 'error' # Hard tabs
1111
MD011: 'error' # Reversed link syntax
1212
MD012: 'disabled' # Multiple consecutive blank lines
1313
MD013: 'disabled' # Line length
1414
MD014: 'disabled' # Dollar signs used before commands without showing output
1515
MD018: 'disabled' # No space after hash on atx style heading
16-
MD019: 'disabled' # Multiple spaces after hash on atx style heading
17-
MD020: 'disabled' # No space inside hashes on closed atx style heading
18-
MD021: 'disabled' # Multiple spaces inside hashes on closed atx style heading
16+
MD019: 'error' # Multiple spaces after hash on atx style heading
17+
MD020: 'error' # No space inside hashes on closed atx style heading
18+
MD021: 'error' # Multiple spaces inside hashes on closed atx style heading
1919
MD022: 'disabled' # Headings should be surrounded by blank lines
2020
MD023: 'disabled' # Headings must start at the beginning of the line
2121
MD024: 'disabled' # Multiple headings with the same content
@@ -29,11 +29,11 @@ log-levels:
2929
MD032: 'disabled' # Lists should be surrounded by blank lines
3030
MD033: 'disabled' # Inline HTML
3131
MD034: 'disabled' # Bare URL used
32-
MD035: 'disabled' # Horizontal rule style
32+
MD035: 'error' # Horizontal rule style
3333
MD036: 'disabled' # Emphasis used instead of a heading
34-
MD037: 'error' # Spaces inside emphasis markers
34+
MD037: 'disabled' # Spaces inside emphasis markers
3535
MD038: 'error' # Spaces inside code span elements
36-
MD039: 'error' # Spaces inside link text
36+
MD039: 'disabled' # Spaces inside link text
3737
MD040: 'disabled' # Fenced code blocks should have a language specified
3838
MD041: 'disabled' # First line in a file should be a top-level heading
3939
MD042: 'error' # No empty links
@@ -64,4 +64,4 @@ log-levels:
6464

6565
# Inline code length
6666
YFM001:
67-
maximum: 140
67+
maximum: 140

ydb/docs/en/core/changelog-cli.md

Lines changed: 23 additions & 55 deletions
Large diffs are not rendered by default.

ydb/docs/en/core/changelog-server.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
Release date: May 14, 2024.
66

7-
**Performance:**
7+
### Performance
88

99
* [Fixed](https://github.com/ydb-platform/ydb/pull/3638) an issue of increased CPU consumption by a topic actor `PERSQUEUE_PARTITION_ACTOR`.
1010
* [Optimized](https://github.com/ydb-platform/ydb/pull/2083) resource usage by SchemeBoard replicas. The greatest effect is noticeable when modifying the metadata of tables with a large number of partitions.
1111

12-
**Bug fixes:**
12+
### Bug fixes
1313

1414
* [Fixed a bug](https://github.com/ydb-platform/ydb/pull/2169) of possible partial commit of accumulated changes when using persistent distributed transactions. This error occurs in an extremely rare combination of events, including restarting tablets that service the table partitions involved in the transaction.
1515
* [Fixed a bug](https://github.com/ydb-platform/ydb/pull/3165) involving a race condition between the table merge and garbage collection processes, which could result in garbage collection ending with an invariant violation error, leading to an abnormal termination of the `ydbd` server process.
@@ -24,7 +24,7 @@ Release date: May 14, 2024.
2424

2525
Release date: October 12, 2023.
2626

27-
**Functionality:**
27+
### Functionality
2828

2929
* Implemented visibility of own changes. With this feature enabled you can read changed values from the current transaction, which has not been committed yet. This functionality also allows multiple modifying operations in one transaction on a table with secondary indexes.
3030
* Added support for [column tables](concepts/datamodel/table.md#column-tables). It is now possible to create analytical reports based on stored data in YDB with performance comparable to specialized analytical DBMS.
@@ -38,21 +38,21 @@ Release date: October 12, 2023.
3838
* **_(Experimental)_** Added support for PostgreSQL compatibility. This involves executing SQL queries in PostgreSQL dialect on the YDB infrastructure using the PostgreSQL network protocol. With this capability, familiar PostgreSQL tools such as psql and drivers (e.g., pq for Golang and psycopg2 for Python) can be used. Queries can be developed using the familiar PostgreSQL syntax and take advantage of YDB's benefits such as horizontal scalability and fault tolerance.
3939
* **_(Experimental)_** Added support for federated queries. This enables retrieving information from various data sources without the need to move the data into YDB. Federated queries support interaction with ClickHouse and PostgreSQL databases, as well as S3 class data stores (Object Storage). YQL queries can be used to access these databases without duplicating data between systems.
4040

41-
**Embedded UI:**
41+
### Embedded UI
4242

4343
* A new option `PostgreSQL` has been added to the query type selector settings, which is available when the `Enable additional query modes` parameter is enabled. Also, the query history now takes into account the syntax used when executing the query.
4444
* The YQL query template for creating a table has been updated. Added a description of the available parameters.
4545
* Now sorting and filtering for Storage and Nodes tables takes place on the server. To use this functionality, you need to enable the parameter `Offload tables filters and sorting to backend` in the experiments section.
4646
* Buttons for creating, changing and deleting [topics](concepts/topic.md) have been added to the context menu.
4747
* Added sorting by criticality for all issues in the tree in `Healthcheck`.
4848

49-
**Performance:**
49+
### Performance
5050

5151
* Implemented read iterators. This feature allows to separate reads and computations. Read iterators allow datashards to increase read queries throughput.
5252
* The performance of writing to YDB topics has been optimized.
5353
* Improved tablet balancing during node overload.
5454

55-
**Bug fixes:**
55+
### Bug fixes
5656

5757
* Fixed an error regarding potential blocking of reading iterators of snapshots, of which the coordinators were unaware.
5858
* Memory leak when closing the connection in Kafka proxy has been fixed.
@@ -130,12 +130,12 @@ Release date: October 12, 2023.
130130

131131
Release date: August 14, 2023.
132132

133-
**Functionality:**
133+
### Functionality
134134

135135
* **_(Experimental)_** Implemented visibility of own changes. With this feature enabled you can read changed values from the current transaction, which has not been committed yet. This functionality also allows multiple modifying operations in one transaction on a table with secondary indexes. To enable this feature add `enable_kqp_immediate_effects: true` under `table_service_config` section into [configuration file](deploy/configuration/config.md).
136136
* **_(Experimental)_** Implemented read iterators. This feature allows to separate reads and computations. Read iterators allow datashards to increase read queries throughput. To enable this feature add `enable_kqp_data_query_source_read: true` under `table_service_config` section into [configuration file](deploy/configuration/config.md).
137137

138-
**Embedded UI:**
138+
### Embedded UI
139139

140140
* Navigation improvements:
141141
* Diagnostics and Development mode switches are moved to the left panel.
@@ -145,13 +145,13 @@ Release date: August 14, 2023.
145145
* Info tab for scheme objects displays parameters using terms from `CREATE` or `ALTER` statements.
146146
* Added [column tables](concepts/datamodel/table.md#column-tables) support.
147147

148-
**Performance:**
148+
### Performance
149149

150150
* For scan queries, you can now effectively search for individual rows using a primary key or secondary indexes. This can bring you a substantial performance gain in many cases. Similarly to regular queries, you need to explicitly specify its name in the query text using the `VIEW` keyword to use a secondary index.
151151

152152
* **_(Experimental)_** Added an option to give control of the system tablets of the database (SchemeShard, Coordinators, Mediators, SysViewProcessor) to its own Hive instead of the root Hive, and do so immediately upon creating a new database. Without this flag, the system tablets of the new database are created in the root Hive, which can negatively impact its load. Enabling this flag makes databases completely isolated in terms of load, that may be particularly relevant for installations, consisting from a roughly hundred or more databases. To enable this feature add `alter_database_create_hive_first: true` under `feature_flags` section into [configuration file](deploy/configuration/config.md).
153153

154-
**Bug fixes:**
154+
### Bug fixes
155155

156156
* Fixed a bug in the autoconfiguration of the actor system, resulting in all the load being placed on the system pool.
157157
* Fixed a bug that caused full scanning when searching by prefix of the primary key using `LIKE`.
@@ -171,21 +171,21 @@ Release date: August 14, 2023.
171171

172172
Release date: May 5, 2023. To update to version 23.1, select the [Downloads](downloads/index.md#ydb-server) section.
173173

174-
**Functionality:**
174+
### Functionality
175175

176176
* Added [initial table scan](concepts/cdc.md#initial-scan) when creating a CDC changefeed. Now, you can export all the data existing at the time of changefeed creation.
177177
* Added [atomic index replacement](dev/secondary-indexes.md#atomic-index-replacement). Now, you can atomically replace one pre-defined index with another. This operation is absolutely transparent for your application. Indexes are replaced seamlessly, with no downtime.
178178
* Added the [audit log](security/audit-log.md): Event stream including data about all the operations on {{ ydb-short-name }} objects.
179179

180-
**Performance:**
180+
### Performance
181181

182182
* Improved formats of data exchanged between query stages. As a result, we accelerated SELECTs by 10% on parameterized queries and by up to 30% on write operations.
183183
* Added [autoconfiguring](deploy/configuration/config.md#autoconfig) for the actor system pools based on the workload against them. This improves performance through more effective CPU sharing.
184184
* Optimized the predicate logic: Processing of parameterized OR or IN constraints is automatically delegated to DataShard.
185185
* (Experimental) For scan queries, you can now effectively search for individual rows using a primary key or secondary indexes. This can bring you a substantial gain in performance in many cases. Similarly to regular queries, to use a secondary index, you need to explicitly specify its name in the query text using the `VIEW` keyword.
186186
* The query's computational graph is now cached at query runtime, reducing the CPU resources needed to build the graph.
187187

188-
**Bug fixes:**
188+
### Bug fixes
189189

190190
* Fixed bugs in the distributed data warehouse implementation. We strongly recommend all our users to upgrade to the latest version.
191191
* Fixed the error that occurred on building an index on NOT NULL columns.
@@ -197,13 +197,13 @@ Release date: May 5, 2023. To update to version 23.1, select the [Downloads](dow
197197

198198
Release date: March 7, 2023. To update to version **22.5**, select the [Downloads](downloads/index.md#ydb-server) section.
199199

200-
**What's new:**
200+
### What's new
201201

202202
* Added [changefeed configuration parameters](yql/reference/syntax/alter_table.md#changefeed-options) to transfer additional information about changes to a topic.
203203
* You can now [rename tables](concepts/datamodel/table.md#rename) that have TTL enabled.
204204
* You can now [manage the record retention period](concepts/cdc.md#retention-period).
205205

206-
**Bug fixes and improvements:**
206+
### Bug fixes and improvements
207207

208208
* Fixed an error inserting 0 rows with a BulkUpsert.
209209
* Fixed an error importing Date/DateTime columns from CSV.
@@ -216,7 +216,7 @@ Release date: March 7, 2023. To update to version **22.5**, select the [Download
216216

217217
Release date: October 12, 2022. To update to version **22.4**, select the [Downloads](downloads/index.md#ydb-server) section.
218218

219-
**What's new:**
219+
### What's new
220220

221221
* {{ ydb-short-name }} Topics and Change Data Capture (CDC):
222222

ydb/docs/en/core/concepts/_includes/limits-ydb.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ This section describes the parameters of limits set in {{ ydb-short-name }}.
44

55
## Schema object limits {#schema-object}
66

7-
The table below shows the limits that apply to schema objects: tables, databases, and columns. The _Object_ column specifies the type of schema object that the limit applies to.
8-
The _Error type_ column shows the status that the query ends with if an error occurs. For more information about statuses, see [Error handling in the API](../../reference/ydb-sdk/error_handling.md).
7+
The table below shows the limits that apply to schema objects: tables, databases, and columns. The "Object" column specifies the type of schema object that the limit applies to.
8+
The "Error type" column shows the status that the query ends with if an error occurs. For more information about statuses, see [Error handling in the API](../../reference/ydb-sdk/error_handling.md).
99

1010
| Objects | Limit | Value | Explanation | Internal<br/>name | Error<br/>type |
1111
| :--- | :--- | :--- | :--- | :---: | :---: |

ydb/docs/en/core/concepts/_includes/scan_query.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Scan Queries is a separate data access interface designed primarily for running
55
This method of executing queries has the following unique features:
66

77
* Only *Read-Only* queries.
8-
* In *SERIALIZABLE_RW* mode, a data snapshot is taken and then used for all subsequent operations. As a result, the impact on OLTP transactions is minimal (only taking a snapshot).
8+
* In `SERIALIZABLE_RW` mode, a data snapshot is taken and then used for all subsequent operations. As a result, the impact on OLTP transactions is minimal (only taking a snapshot).
99
* The output of a query is a data stream ([grpc stream](https://grpc.io/docs/what-is-grpc/core-concepts/)). This means scan queries have no limit on the number of rows in the result.
1010
* Due to the high overhead, it is only suitable for ad hoc queries.
1111

ydb/docs/en/core/concepts/_includes/transactions.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@ By default, {{ ydb-short-name }} transactions are executed in *Serializable* mod
1313
If consistency or freshness requirement for data read by a transaction can be relaxed, a user can take advantage of execution modes with lower guarantees:
1414

1515
* *Online Read-Only*: Each read operation in the transaction is reading the data that is most recent at execution time. The consistency of retrieved data depends on the *allow_inconsistent_reads* setting:
16+
1617
* *false* (consistent reads): Each individual read operation returns consistent data, but no consistency is guaranteed between reads. Reading the same table range twice may return different results.
1718
* *true* (inconsistent reads): Even the data fetched by a particular read operation may contain inconsistent results.
19+
1820
* *Stale Read-Only*: Read operations within a transaction may return results that are slightly out-of-date (lagging by fractions of a second). Each individual read returns consistent data, but no consistency between different reads is guaranteed.
1921
* *Snapshot Read-Only*: All the read operations within a transaction access the database snapshot. All the data reads are consistent. The snapshot is taken when the transaction begins, meaning the transaction sees all changes committed before it began.
2022

ydb/docs/en/core/concepts/auth.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,17 @@ Authentication by username and password includes the following steps:
4444
1. The client accesses the database and presents their username and password to the {{ ydb-short-name }} authentication service.
4545

4646
You can only use lower case Latin letters and digits in usernames. No restrictions apply to passwords (empty passwords can be used).
47+
4748
1. The authentication service passes authentication data to the {{ ydb-short-name }} authentication component.
4849
1. The component validates authentication data. If the data matches, it generates a token and returns it to the authentication service.
4950

5051
Tokens accelerate authentication and strengthen security. Tokens have a default lifetime of 12 hours. YDB SDK rotates tokens by accessing the authentication service.
5152

5253
The username and hashed password are stored in the table inside the authentication component. The password is hashed by the [Argon2]{% if lang == "en" %}(https://en.wikipedia.org/wiki/Argon2){% endif %}{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Argon2){% endif %} method. In authentication mode, only the system administrator can use a username/password pair to access the table.
54+
5355
1. The authentication system returns the token to the client.
5456
1. The client accesses the database, presenting their token as authentication data.
5557

5658
To enable username/password authentication, use `true` in the `enforce_user_token_requirement` key of the cluster's [configuration file](../deploy/configuration/config.md#auth).
5759

58-
To learn how to manage roles and users, see [{#T}](../security/access-management.md).
59-
60-
<!-- ### API получения токенов IAM {#token-refresh-api}
61-
62-
Для ротации токенов {{ ydb-short-name }} SDK и CLI используют gRPC-запрос к {{ yandex-cloud }} IAM API [IamToken - create]{% if lang == "en" %}(https://cloud.yandex.com/en/docs/iam/api-ref/grpc/iam_token_service#Create){% endif %}{% if lang == "ru" %}(https://cloud.yandex.ru/docs/iam/api-ref/grpc/iam_token_service#Create){% endif %}. В режиме **Refresh Token** заданный параметром OAuth токен передается в атрибуте `yandex_passport_oauth_token`. В режиме **Service Account Key** на основании заданных атрибутов сервисной учетной записи и ключа шифрования формируется короткоживущий JWT-токен и передается в атрибуте `jwt`. Исходный код формирования JWT-токена доступен в составе SDK (например, метод `get_jwt()` в [коде на Python](https://github.com/ydb-platform/ydb-python-sdk/blob/main/ydb/iam/auth.py)).
63-
64-
{{ ydb-short-name }} SDK и CLI позволяют подменить хост для обращения к API получения токенов, что дает возможность реализовать аналогичный API в корпоративных контекстах. -->
60+
To learn how to manage roles and users, see [{#T}](../security/access-management.md).

0 commit comments

Comments
 (0)