Skip to content

Commit bc9f4aa

Browse files
authored
YDBDOCS-633: continue restructuring (#4036)
1 parent a9d1892 commit bc9f4aa

Some content is hidden

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

69 files changed

+117
-148
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Release date: May 1, 2023. To update to version **2.3.0**, select the [Downloads
137137
**Features:**
138138

139139
* Added the interactive mode of query execution. To switch to the interactive mode, run [ydb yql](reference/ydb-cli/yql.md) without arguments. This mode is experimental: backward compatibility is not guaranteed yet.
140-
* Added the [ydb index rename](reference/ydb-cli/commands/secondary_index.md#rename) command for [atomic replacement](dba/secondary-indexes.md#atomic-index-replacement) or renaming of a secondary index.
140+
* Added the [ydb index rename](reference/ydb-cli/commands/secondary_index.md#rename) command for [atomic replacement](dev/secondary-indexes.md#atomic-index-replacement) or renaming of a secondary index.
141141
* Added the `ydb workload topic` command for generating the load that reads messages from topics and writes messages to topics.
142142
* 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.
143143
* Added support for the `topic` and `coordination node` types in the [ydb scheme describe](reference/ydb-cli/commands/scheme-describe.md) command.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Release date: May 5, 2023. To update to version 23.1, select the [Downloads](dow
154154
**Functionality:**
155155

156156
* 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.
157-
* Added [atomic index replacement](dba/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.
157+
* 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.
158158
* Added the [audit log](security/audit-log.md): Event stream including data about all the operations on {{ ydb-short-name }} objects.
159159

160160
**Performance:**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ This method of executing queries has the following unique features:
1111

1212
{% node info %}
1313

14-
From the *Scan Queries* interface, you can query [system tables](../../dba/system-views.md).
14+
From the *Scan Queries* interface, you can query [system tables](../../dev/system-views.md).
1515

1616
{% endnote %}
1717

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ A secondary index can be:
5959

6060
## Purpose and use of secondary indexes {#best_practices}
6161

62-
For information about the purpose and use of secondary indexes for app development, see the [recommendations](../../dba/secondary-indexes.md).
62+
For information about the purpose and use of secondary indexes for app development, see the [recommendations](../../dev/secondary-indexes.md).
6363

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,4 +243,4 @@ You can add a changefeed to an existing table or erase it using the [ADD CHANGEF
243243

244244
## CDC purpose and use {#best_practices}
245245

246-
For information about using CDC when developing apps, see [best practices](../dba/cdc.md).
246+
For information about using CDC when developing apps, see [best practices](../dev/cdc.md).

ydb/docs/en/core/concepts/datamodel/_includes/table.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Searching using an index allows you to swiftly locate the required rows without
2828

2929
You can create a row-oriented table through the YDB web interface, CLI, or SDK. Regardless of the method you choose to interact with YDB, it's important to keep in mind the following rule: the table must have at least one primary key column, and it's permissible to create a table consisting solely of primary key columns.
3030

31-
By default, when creating a row-oriented table, all columns are optional and can have `NULL` values. This behavior can be modified by setting the `NOT NULL` conditions for key columns that are part of the primary key. Primary keys are unique, and row-oriented tables are always sorted by this key. This means that point reads by the key, as well as range queries by key or key prefix, are efficiently executed (essentially using an index). It's permissible to create a table consisting solely of key columns. When choosing a key, it's crucial to be careful, so we recommend reviewing the article: ["Choosing a Primary Key for Maximum Performance"](../../../dba/primary-key/row-oriented.md).
31+
By default, when creating a row-oriented table, all columns are optional and can have `NULL` values. This behavior can be modified by setting the `NOT NULL` conditions for key columns that are part of the primary key. Primary keys are unique, and row-oriented tables are always sorted by this key. This means that point reads by the key, as well as range queries by key or key prefix, are efficiently executed (essentially using an index). It's permissible to create a table consisting solely of key columns. When choosing a key, it's crucial to be careful, so we recommend reviewing the article: ["Choosing a Primary Key for Maximum Performance"](../../../dev/primary-key/row-oriented.md).
3232

3333
### Partitioning row-oriented tables {#partitioning}
3434

@@ -221,7 +221,7 @@ WITH (STORE = COLUMN);
221221
Unlike data partitioning in row-oriented {{ ydb-short-name }} tables, key values are not used to partition data in column-oriented tables. This way, you can uniformly distribute data across all your existing partitions. This kind of partitioning enables you to avoid hotspots at data inserta and speeding up analytical queries that process (that is, read) large amounts of data.
222222

223223

224-
How you select partitioning keys substantially affects the performance of queries to your column-oriented tables. Learn more in [{#T}](../../../dba/primary-key/column-oriented.md).
224+
How you select partitioning keys substantially affects the performance of queries to your column-oriented tables. Learn more in [{#T}](../../../dev/primary-key/column-oriented.md).
225225

226226
To manage data partitioning, use the `AUTO_PARTITIONING_MIN_PARTITIONS_COUNT` additional parameter. The system ignores other partitioning parameters for column-oriented tables.
227227

ydb/docs/en/core/dba/index.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

ydb/docs/en/core/dba/toc_i.yaml

Lines changed: 0 additions & 21 deletions
This file was deleted.

ydb/docs/en/core/dba/toc_p.yaml

Lines changed: 0 additions & 6 deletions
This file was deleted.
File renamed without changes.

ydb/docs/en/core/dev/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
First of all, you'll need to obtain access to a {{ ydb-short-name }} cluster. Follow the [quickstart instructions](../quickstart.md) to get a basic local instance. Later on, you can work with your DevOps team to [build a production-ready cluster](../devops/index.md) or leverage one of the cloud service providers that offer a managed {{ ydb-short-name }} service.
44

5-
The second step is designing a data schema for an application you will build from scratch or adapt the schema of an existing application if you're migrating from another database management system. Work with your DBA on this, or refer to the documentation [for DBA](../dba/index.md) yourself if you don't have one on your team.
5+
The second step is designing a data schema for an application you will build from scratch or adapt the schema of an existing application if you're migrating from another database management system. Work with your DBA on this, or refer to the documentation [for DBA](../dev/index.md) yourself if you don't have one on your team.
66

77
In parallel with designing the schema, you need to set up your development environment for interaction with {{ ydb-short-name }}. There are a few main aspects to it, explored below.
88

ydb/docs/en/core/dev/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,16 @@ Main resources:
77
- [{#T}](getting-started.md)
88
- [{#T}](example-app/index.md)
99
- [{#T}](yql-tutorial/index.md)
10+
- Choosing a primary key for:
11+
- [Row-oriented tables](primary-key/row-oriented.md)
12+
- [Column-oriented tables](primary-key/column-oriented.md)
13+
- [{#T}](secondary-indexes.md)
1014
- [{#T}](batch-upload.md)
1115
- [{#T}](paging.md)
1216
- [{#T}](timeouts.md)
17+
- [{#T}](system-views.md)
18+
- [{#T}](cdc.md)
19+
- [{#T}](custom-attributes.md)
1320
- Reference:
1421
- [{#T}](../yql/reference/index.md)
1522
- [{#T}](../reference/ydb-sdk/index.md)
File renamed without changes.

ydb/docs/en/core/dev/toc_p.yaml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,27 @@ items:
1111
include:
1212
mode: link
1313
path: example-app/toc_p.yaml
14+
- name: Primary keys
15+
include:
16+
mode: link
17+
path: primary-key/toc_p.yaml
18+
- name: Secondary indexes
19+
href: secondary-indexes.md
20+
- name: Query plans optimization
21+
href: query-plans-optimization.md
22+
hidden: true
1423
- name: Batch upload
1524
href: batch-upload.md
1625
- name: Paging
1726
href: paging.md
1827
- name: Timeouts
19-
href: timeouts.md
28+
href: timeouts.md
29+
- name: System views
30+
href: system-views.md
31+
- name: Change Data Capture
32+
href: cdc.md
33+
- name: Terraform
34+
href: terraform.md
35+
hidden: true
36+
- name: Custom attributes
37+
href: custom-attributes.md

ydb/docs/en/core/dba/backup-and-recovery.md renamed to ydb/docs/en/core/devops/manual/backup-and-recovery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@ Backups protect against data loss by letting you restore data.
1313

1414
### Files {#files}
1515

16-
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.
16+
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.
1717

18-
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.
18+
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.
1919

2020
### S3-compatible storage {#s3}
2121

22-
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.
22+
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.
2323

24-
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.
24+
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.
2525

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

ydb/docs/en/core/devops/manual/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Main resources:
77
- [{#T}](../../deploy/index.md)
88
- [{#T}](../../maintenance/manual/index.md)
99
- [{#T}](../../devops/manual/monitoring.md)
10+
- [{#T}](logging.md)
11+
- [{#T}](backup-and-recovery.md)
1012
- [{#T}](../../reference/embedded-ui/index.md)
1113
- [{#T}](system-views.md)
12-
- [{#T}](logging.md)

ydb/docs/en/core/devops/manual/system-views.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Hereinafter, in the descriptions of available fields, the **Key** column contain
88

99
{% note info %}
1010

11-
There are also similar system views describing what's happening inside a given database, they are covered in a [separate article for DBAs](../../dba/system-views.md).
11+
There are also similar system views describing what's happening inside a given database, they are covered in a [separate article for DBAs](../../dev/system-views.md).
1212

1313
{% endnote %}
1414

ydb/docs/en/core/devops/manual/toc_p.yaml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@ items:
99
include:
1010
mode: link
1111
path: ../../maintenance/manual/toc_p.yaml
12+
- name: Backup and recovery
13+
href: backup-and-recovery.md
1214
- name: Monitoring
1315
href: monitoring.md
16+
- name: Logging
17+
href: logging.md
1418
- name: Updating YDB
1519
href: upgrade.md
1620
- name: Changing an actor system's configuration
@@ -19,5 +23,4 @@ items:
1923
href: ../../maintenance/manual/cms.md
2024
- name: System views
2125
href: system-views.md
22-
- name: Logging
23-
href: logging.md
26+

ydb/docs/en/core/faq/_includes/common.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ To design a primary key properly, follow the rules below.
2929
* The fewer table partitions a query uses, the faster it runs. For greater performance, follow the one query — one partition rule.
3030
* Avoid situations where a small part of the DB is under much heavier load than the rest of the DB.
3131

32-
For more information, see [choosing a primary key](../../dba/primary-key/index.md).
32+
For more information, see [choosing a primary key](../../dev/primary-key/index.md).
3333

3434
#### How do I evenly distribute load across table partitions? {#balance-shard-load}
3535

@@ -40,7 +40,7 @@ You can use the following techniques to distribute the load evenly across table
4040
* use a hash of the key column values as the primary key.
4141
* Reduce the number of partitions used in a single query.
4242

43-
For more information, see [choosing a primary key](../../dba/primary-key/index.md).
43+
For more information, see [choosing a primary key](../../dev/primary-key/index.md).
4444

4545
#### Can I use NULL in a key column? {#null}
4646

ydb/docs/en/core/index.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ links:
1616
- title: For DevOps
1717
description: How to run production YDB clusters
1818
href: devops/
19-
- title: For DBA
20-
description: How to run manage YDB databases
21-
href: dba/
2219
- title: For Developers
2320
description: How to develop applications working with YDB
2421
href: dev/
22+
- title: For Security Engineers
23+
description: How to secure YDB clusters
24+
href: security/
2525
- title: For Contributors
2626
description: How to contribute to YDB core and satellite projects
2727
href: contributor/

ydb/docs/en/core/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ As you can see, it is a simple key-value table. Let's walk through the query ste
142142
* Each SQL statement kind like `CREATE TABLE` has more detailed explanation in [YQL reference](yql/reference/index.md).
143143
* `example` is the table name identifier, while `key` and `value` are column name identifiers. It is recommended to use simple names for identifiers like these, but if you need one that contains non-trivial symbols, wrap the name in backticks.
144144
* `UInt64` and `String` are data type names. `String` represents a binary string, and `UInt64` is a 64-bit unsigned integer. Thus, our example table stores string values identified by unsigned integer keys. More details [about data types](yql/reference/types/index.md).
145-
* `PRIMARY KEY` is one of the fundamental concepts of SQL that has a significant impact on both application logic and performance. Following the SQL standard, the primary key also implies an unique constraint, meaning the table cannot have multiple rows with equal primary keys. In this example table, it's quite straightforward which column should be chosen as the primary key, which we specify as `(key)` in round brackets after the respective keyword. In real-world scenarios, tables often have dozens of columns, and primary keys can be compound (consisting of multiple columns in a specified order), making choosing the right primary key more of an art. If you are interested in this topic, there's a [guide on choosing the primary key for maximizing performance](dba/primary-key/row-oriented.md). YDB tables are required to have a primary key.
145+
* `PRIMARY KEY` is one of the fundamental concepts of SQL that has a significant impact on both application logic and performance. Following the SQL standard, the primary key also implies an unique constraint, meaning the table cannot have multiple rows with equal primary keys. In this example table, it's quite straightforward which column should be chosen as the primary key, which we specify as `(key)` in round brackets after the respective keyword. In real-world scenarios, tables often have dozens of columns, and primary keys can be compound (consisting of multiple columns in a specified order), making choosing the right primary key more of an art. If you are interested in this topic, there's a [guide on choosing the primary key for maximizing performance](dev/primary-key/row-oriented.md). YDB tables are required to have a primary key.
146146
147147
## Add sample data
148148

ydb/docs/en/core/reference/ydb-cli/commands/_includes/secondary_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ By using the `table index` command, you can create and delete [secondary indexes
1010

1111
You can also add or delete a secondary index with the [ADD INDEX and DROP INDEX](../../../../yql/reference/syntax/alter_table.md#secondary-index) directives of YQL ALTER TABLE.
1212

13-
To learn about secondary indexes and their use in application development, see [Secondary indexes](../../../../dba/secondary-indexes.md) under "Recommendations".
13+
To learn about secondary indexes and their use in application development, see [Secondary indexes](../../../../dev/secondary-indexes.md) under "Recommendations".
1414

1515
## Creating a secondary index {#add}
1616

ydb/docs/en/core/toc_i.yaml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ items:
1111
include:
1212
mode: link
1313
path: devops/toc_p.yaml
14-
- name: For DBA
15-
include:
16-
mode: link
17-
path: dba/toc_p.yaml
1814
- name: For Developers
1915
include:
2016
mode: link

0 commit comments

Comments
 (0)