Skip to content

Commit ce9e302

Browse files
authored
Bring order: replace </br> and <br> to <br/> in docs (#7235)
1 parent a84e542 commit ce9e302

File tree

74 files changed

+521
-532
lines changed

Some content is hidden

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

74 files changed

+521
-532
lines changed

ydb/docs/en/core/_includes/olap-data-types.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
| Data type | Can be used in<br>column-oriented tables | Can be used<br>as primary key |
1+
| Data type | Can be used in<br/>column-oriented tables | Can be used<br/>as primary key |
22
---|---|---
33
| `Bool` |||
44
| `Int8` |||

ydb/docs/en/core/_includes/parameterized-query.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ A brief help is provided below. For a detailed description with examples, see [{
44
---|---
55
| `-p, --param` | The value of a single parameter of a YQL query, in the format: `$name=value`, where `$name` is the parameter name and `value` is its value (a valid [JSON value](https://www.json.org/json-ru.html)). |
66
| `--param-file` | Name of the file in [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format and in [UTF-8]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/UTF-8){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/UTF-8){% endif %} encoding that specifies values of the parameters matched against the YQL query parameters by key names. |
7-
| `--input-format` | Format of parameter values. Applies to all the methods of parameter transmission (among command parameters, in a file or using `stdin`).<br>Acceptable values:<ul><li>`json-unicode` (default):[JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li></ul> |
8-
| `--stdin-format` | The parameter format and framing for `stdin`. To set both values, specify the parameter twice.<br>**Format of parameter encoding for `stdin`**<br>Acceptable values:<ul><li>`json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li><li>`raw` is binary data; the parameter name is set in `--stdin-par`.</li></ul>If the format of parameter encoding for `stdin` isn't specified, the format set in `--input-format` is used.<br><br>**Classification of parameter sets for `stdin` (framing)**<br>Acceptable values:<ul><li>`no-framing` (default): Framing isn't used</li><li>`newline-delimited`: The newline character is used in `stdin` to end a given parameter set, separating it from the next one.</li></ul> |
7+
| `--input-format` | Format of parameter values. Applies to all the methods of parameter transmission (among command parameters, in a file or using `stdin`).<br/>Acceptable values:<ul><li>`json-unicode` (default):[JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li></ul> |
8+
| `--stdin-format` | The parameter format and framing for `stdin`. To set both values, specify the parameter twice.<br/>**Format of parameter encoding for `stdin`**<br/>Acceptable values:<ul><li>`json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}.</li><li>`json-base64`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} format in which values of binary string parameters (`DECLARE $par AS String`) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded.</li><li>`raw` is binary data; the parameter name is set in `--stdin-par`.</li></ul>If the format of parameter encoding for `stdin` isn't specified, the format set in `--input-format` is used.<br/><br/>**Classification of parameter sets for `stdin` (framing)**<br/>Acceptable values:<ul><li>`no-framing` (default): Framing isn't used</li><li>`newline-delimited`: The newline character is used in `stdin` to end a given parameter set, separating it from the next one.</li></ul> |
99
| `--stdin-par` | The name of the parameter whose value will be sent over `stdin` is specified without a `$`. |
10-
| `--batch` | The batch mode of transmitting parameter sets received via `stdin`.<br>Acceptable values:<ul><li>`iterative` (default): Batch mode is disabled</li><li>`full`: Full-scale batch mode is enabled</li><li>`adaptive`: Adaptive batching is enabled |
11-
| `--batch-limit` | A maximum number of sets of parameters per batch in the adaptive batch mode. The setting of `0` removes the limit.<br><br>The default value is `1000`.<br><br> |
12-
| `--batch-max-delay` | The maximum delay related to processing the resulting parameter set in the adaptive batch mode. It's set as a number of `s`, `ms`, `m`.<br><br>Default value: `1s` (1 second).<br><br> |
10+
| `--batch` | The batch mode of transmitting parameter sets received via `stdin`.<br/>Acceptable values:<ul><li>`iterative` (default): Batch mode is disabled</li><li>`full`: Full-scale batch mode is enabled</li><li>`adaptive`: Adaptive batching is enabled |
11+
| `--batch-limit` | A maximum number of sets of parameters per batch in the adaptive batch mode. The setting of `0` removes the limit.<br/><br/>The default value is `1000`.<br/><br/> |
12+
| `--batch-max-delay` | The maximum delay related to processing the resulting parameter set in the adaptive batch mode. It's set as a number of `s`, `ms`, `m`.<br/><br/>Default value: `1s` (1 second).<br/><br/> |

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This section describes the parameters of limits set in {{ ydb-short-name }}.
77
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.
88
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

10-
| Objects | Limit | Value | Explanation | Internal<br>name | Error<br>type |
10+
| Objects | Limit | Value | Explanation | Internal<br/>name | Error<br/>type |
1111
| :--- | :--- | :--- | :--- | :---: | :---: |
1212
| Database | Maximum path depth | 32 | Maximum number of nested path elements (directories, tables). | MaxDepth | SCHEME_ERROR |
1313
| Database | Maximum number of paths (schema objects) | 10,000 | Maximum number of path elements (directories, tables) in a database. | MaxPaths | GENERIC_ERROR |
@@ -41,7 +41,7 @@ The _Error type_ column shows the status that the query ends with if an error oc
4141

4242
The table below lists the limits that apply to query execution. The _Call_ column specifies the public API call that will end with the error status specified in the _Status_ column.
4343

44-
| Parameter | Value | Call | Explanation | Status<br>in case of<br>a violation<br>of the limit |
44+
| Parameter | Value | Call | Explanation | Status<br/>in case of<br/>a violation<br/>of the limit |
4545
| :--- | :--- | :--- | :--- | :---: |
4646
| Maximum number of rows in query results | 1,000 | ExecuteDataQuery | Complete results of some queries executed using the `ExecuteDataQuery` method may contain more rows than allowed. In this case, a query will return the maximum number of rows allowed, and the result will have the `truncated` flag set. | SUCCESS |
4747
| Maximum query result size | 50 MB | ExecuteDataQuery | Complete results of some queries may exceed the set limit. In this case, a query will fail returning no data. | PRECONDITION_FAILED |

ydb/docs/en/core/concepts/column-table.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ What's currently not supported:
3232

3333
## Supported data types {#olap-data-types}
3434

35-
| Data type | Can be used in<br>column-oriented tables | Can be used<br>as primary key |
35+
| Data type | Can be used in<br/>column-oriented tables | Can be used<br/>as primary key |
3636
---|---|---
3737
| `Bool` |||
3838
| `Date` |||
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
|Path format|Description|Example|
22
|----|----|---|
3-
|Path ends with a `/`|Path to a directory|The path `/a` addresses all contents of the directory:<br>`/a/b/c/d/1.txt`<br>`/a/b/2.csv`|
4-
|Path contains a wildcard character `*`|Any files nested in the path|The path `/a/*.csv` addresses files in directories:<br>`/a/b/c/1.csv`<br>`/a/2.csv`<br>`/a/b/c/d/e/f/g/2.csv`|
5-
|Path does not end with `/` and does not contain wildcard characters|Path to a single file|The path `/a/b.csv` addresses the specific file `/a/b.csv`|
3+
|Path ends with a `/`|Path to a directory|The path `/a` addresses all contents of the directory:<br/>`/a/b/c/d/1.txt`<br/>`/a/b/2.csv`|
4+
|Path contains a wildcard character `*`|Any files nested in the path|The path `/a/*.csv` addresses files in directories:<br/>`/a/b/c/1.csv`<br/>`/a/2.csv`<br/>`/a/b/c/d/e/f/g/2.csv`|
5+
|Path does not end with `/` and does not contain wildcard characters|Path to a single file|The path `/a/b.csv` addresses the specific file `/a/b.csv`|

ydb/docs/en/core/concepts/federated_query/s3/partition_projection.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,10 @@ It is used for columns whose values can be represented as integers ranging from
122122
| Field name | Mandatory | Description | Example values |
123123
|----------------------------|-----------|--------------------------------------------------------|-------------------------|
124124
| `projection.<field_name>.type` | Yes | Data type of the field | integer |
125-
| `projection.<field_name>.min` | Yes | Specifies the minimum allowable value as an integer | -100<br>004 |
126-
| `projection.<field_name>.max` | Yes | Specifies the maximum allowable value as an integer | -10<br>5000 |
127-
| `projection.<field_name>.interval` | No, default is `1` | Specifies the step between elements within the value range. For example, a step of 3 within the range 2 to 10 will result in the values: 2, 5, 8 | 2<br>11 |
128-
| `projection.<field_name>.digits` | No, default is `0` | Specifies the number of digits in the number. If the number of significant digits in the number is less than the specified value, the value is padded with leading zeros up to the specified number of digits. For example, if .digits=3 is specified and the number 2 is passed, it will be converted to 002 | 2<br>4 |
125+
| `projection.<field_name>.min` | Yes | Specifies the minimum allowable value as an integer | -100<br/>004 |
126+
| `projection.<field_name>.max` | Yes | Specifies the maximum allowable value as an integer | -10<br/>5000 |
127+
| `projection.<field_name>.interval` | No, default is `1` | Specifies the step between elements within the value range. For example, a step of 3 within the range 2 to 10 will result in the values: 2, 5, 8 | 2<br/>11 |
128+
| `projection.<field_name>.digits` | No, default is `0` | Specifies the number of digits in the number. If the number of significant digits in the number is less than the specified value, the value is padded with leading zeros up to the specified number of digits. For example, if .digits=3 is specified and the number 2 is passed, it will be converted to 002 | 2<br/>4 |
129129

130130
### Enum field type { #enum_type }
131131

@@ -134,7 +134,7 @@ It is used for columns whose values can be represented as a set of enumerated va
134134
| Field name | Mandatory | Description | Example values |
135135
|------------------------------|-----------|-------------------------------------------------------|-------------------------|
136136
| `projection.<field_name>.type` | Yes | Data type of the field | enum |
137-
| `projection.<field_name>.values` | Yes | Specifies the allowable values, separated by commas. Spaces are not ignored | 1, 2<br>A,B,C |
137+
| `projection.<field_name>.values` | Yes | Specifies the allowable values, separated by commas. Spaces are not ignored | 1, 2<br/>A,B,C |
138138

139139
### Date field type { #date_type }
140140

@@ -168,4 +168,4 @@ Data in S3 ({{objstorage-full-name}}) buckets can be placed in directories with
168168
|---------------------------|----------------------------------------------------|--------------------------|
169169
| `storage.location.template` | Path template for directory names. The path is specified as a text string with parameter macro substitutions `...${<field_name>}...${<field_name>}...` | `root/a/${year}/b/${month}/d`<br/>`${year}/${month}` |
170170

171-
If the path contains the characters `$`, `\`, or the characters `{}`, they must be escaped with the `\` character. For example, to work with a directory named `my$folder`, it needs to be specified as`my\$folder`.
171+
If the path contains the characters `$`, `\`, or the characters `{}`, they must be escaped with the `\` character. For example, to work with a directory named `my$folder`, it needs to be specified as`my\$folder`.

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ A {{ ydb-short-name }} cluster consists of static and dynamic nodes.
77

88
Cluster topology is determined by the fault tolerance requirements. The following operating modes are available:
99

10-
| Mode | Storage<br>volume multiplier | Minimum<br>number<br>of nodes | Description |
10+
| Mode | Storage<br/>volume multiplier | Minimum<br/>number<br/>of nodes | Description |
1111
--- | --- | --- | ---
12-
| `none` | 1 | 1 | There is no redundancy.<br>Any hardware failure causes the storage pool to become unavailable.<br>This mode is only recommended for functional testing. |
13-
| `block-4-2` | 1.5 | 8 | [Erasure coding](https://en.wikipedia.org/wiki/Erasure_code) with two blocks of redundancy added to the four blocks of source data is applied. Storage nodes are placed in at least 8 failure domains (usually racks).<br>The storage pool is available if any two domains fail, continuing to record all 6 data parts in the remaining domains.<br>This mode is recommended for storage pools within a single availability zone (usually a data processing center). |
14-
| `mirror-3-dc` | 3 | 9 | Data is replicated to 3 availability zones using 3 failure domains (usually racks) within each zone.<br>The storage pool is available if one availability zone and one failure domain fail in the remaining zones.<br>This mode is recommended for multi-data center installations. |
15-
| `mirror-3dc-3-nodes` | 3 | 3 | It is a simplified version of `mirror-3dc`. This mode requires at least 3 servers with 3 disks each. Each server must be located in an independent data center in order to provide the best fault tolerance.<br>Health in this mode is maintained if no more than 1 node fails.<br>This mode is only recommended for functional testing. |
12+
| `none` | 1 | 1 | There is no redundancy.<br/>Any hardware failure causes the storage pool to become unavailable.<br/>This mode is only recommended for functional testing. |
13+
| `block-4-2` | 1.5 | 8 | [Erasure coding](https://en.wikipedia.org/wiki/Erasure_code) with two blocks of redundancy added to the four blocks of source data is applied. Storage nodes are placed in at least 8 failure domains (usually racks).<br/>The storage pool is available if any two domains fail, continuing to record all 6 data parts in the remaining domains.<br/>This mode is recommended for storage pools within a single availability zone (usually a data processing center). |
14+
| `mirror-3-dc` | 3 | 9 | Data is replicated to 3 availability zones using 3 failure domains (usually racks) within each zone.<br/>The storage pool is available if one availability zone and one failure domain fail in the remaining zones.<br/>This mode is recommended for multi-data center installations. |
15+
| `mirror-3dc-3-nodes` | 3 | 3 | It is a simplified version of `mirror-3dc`. This mode requires at least 3 servers with 3 disks each. Each server must be located in an independent data center in order to provide the best fault tolerance.<br/>Health in this mode is maintained if no more than 1 node fails.<br/>This mode is only recommended for functional testing. |
1616

1717
{% note info %}
1818

ydb/docs/en/core/contributor/load-actors-kqp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Before this test, the necessary tables are created. After it's completed, they a
2121
| `NumOfSessions` | The number of parallel threads creating the load. Each thread writes data to its own session. |
2222
| `DeleteTableOnFinish` | Set it to `False` if you do not want the created tables deleted after the load stops. This might be helpful when a large table is created upon the actor's first run, and then queries are made to that table. |
2323
| `UniformPartitionsCount` | The number of partitions created in test tables. |
24-
| `WorkloadType` | Type of load.<br>For Stock:<ul><li>`0`: InsertRandomOrder.</li><li>`1`: SubmitRandomOrder.</li><li>`2`: SubmitSameOrder.</li><li>`3`: GetRandomCustomerHistory.</li><li>`4`: GetCustomerHistory.</li></ul>For Key-Value:<ul><li>`0`: UpsertRandom.</li><li>`1`: InsertRandom.</li><li>`2`: SelectRandom.</li></ul> |
25-
| `Workload` | Kind of load.<br>`Stock`:<ul><li>`ProductCount`: Number of products.</li><li>`Quantity`: Quantity of each product in stock.</li><li>`OrderCount`: Initial number of orders in the database.</li><li>`Limit`: Minimum number of shards for tables.</li></ul>`Kv`:<ul><li>`InitRowCount`: Before load is generated, the load actor writes the specified number of rows to the table.</li><li>`StringLen`: Length of the `value` string.</li><li>`ColumnsCnt`: Number of columns to use in the table.</li><li>`RowsCnt`: Number of rows to insert or read per SQL query.</li></ul> |
24+
| `WorkloadType` | Type of load.<br/>For Stock:<ul><li>`0`: InsertRandomOrder.</li><li>`1`: SubmitRandomOrder.</li><li>`2`: SubmitSameOrder.</li><li>`3`: GetRandomCustomerHistory.</li><li>`4`: GetCustomerHistory.</li></ul>For Key-Value:<ul><li>`0`: UpsertRandom.</li><li>`1`: InsertRandom.</li><li>`2`: SelectRandom.</li></ul> |
25+
| `Workload` | Kind of load.<br/>`Stock`:<ul><li>`ProductCount`: Number of products.</li><li>`Quantity`: Quantity of each product in stock.</li><li>`OrderCount`: Initial number of orders in the database.</li><li>`Limit`: Minimum number of shards for tables.</li></ul>`Kv`:<ul><li>`InitRowCount`: Before load is generated, the load actor writes the specified number of rows to the table.</li><li>`StringLen`: Length of the `value` string.</li><li>`ColumnsCnt`: Number of columns to use in the table.</li><li>`RowsCnt`: Number of rows to insert or read per SQL query.</li></ul> |
2626

2727
## Examples {#example}
2828

0 commit comments

Comments
 (0)