Skip to content

Commit f759853

Browse files
authored
[docs] some fixes for en/core/dev/example-app/ (#8648)
1 parent 9a0a109 commit f759853

20 files changed

+41
-54
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% note info %}
22

3-
The article is being updated.
3+
The article is currently being updated.
44

55
{% endnote %}
66

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
`PRAGMA TablePathPrefix` adds a specified prefix to the database table paths. It uses standard file system path concatenation: i.e., it supports parent folder referencing and requires no trailing slash. For example:
1+
`PRAGMA TablePathPrefix` adds a specified prefix to the table paths. It uses standard filesystem path concatenation, meaning it supports parent folder referencing and does not require a trailing slash. For example:
22

33
```sql
44
PRAGMA TablePathPrefix = "/cluster/database";
55
SELECT * FROM episodes;
66
```
77

8-
For more information about PRAGMA in YQL, see the [YQL documentation](../../../../yql/reference/index.md).
9-
8+
For more information about `PRAGMA` in YQL, refer to the [YQL documentation](../../../../yql/reference/index.md).

ydb/docs/en/core/dev/example-app/_includes/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example applications working with {{ ydb-short-name }}
22

3-
This section describes the code of same-type test apps implemented using {{ ydb-short-name }} SDKs in different programming languages:
3+
This section outlines the implementation of example applications, all designed to perform similar functions, using the {{ ydb-short-name }} SDKs across various programming languages. Each app is developed to demonstrate how a respective SDK can be utilized in a specific language.
44

55
{% if oss %}
66

@@ -14,7 +14,7 @@ This section describes the code of same-type test apps implemented using {{ ydb-
1414

1515
{% node info %}
1616

17-
Additional information on how these example applications work is available in [{{ ydb-short-name }} SDK reference documentation](../../../reference/ydb-sdk/index.md).
17+
Refer to [{{ ydb-short-name }} SDK reference documentation](../../../reference/ydb-sdk/index.md) for more details.
1818

1919
{% endnote %}
2020

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
## Initializing a database connection {#init}
22

3-
To interact with {{ ydb-short-name }}, create an instance of the driver, client, and session:
4-
5-
* The {{ ydb-short-name }} driver lets the app and {{ ydb-short-name }} interact at the transport layer. The driver must exist throughout the {{ ydb-short-name }} access lifecycle and be initialized before creating a client or session.
6-
* The {{ ydb-short-name }} client runs on top of the {{ ydb-short-name }} driver and enables the handling of entities and transactions.
7-
* The {{ ydb-short-name }} session contains information about executed transactions and prepared queries, and is part of the {{ ydb-short-name }} client context.
3+
To interact with {{ ydb-short-name }}, create instances of the driver, client, and session:
84

5+
* The {{ ydb-short-name }} driver facilitates interaction between the app and {{ ydb-short-name }} nodes at the transport layer. It must be initialized before creating a client or session and must persist throughout the {{ ydb-short-name }} access lifecycle.
6+
* The {{ ydb-short-name }} client operates on top of the {{ ydb-short-name }} driver and enables the handling of entities and transactions.
7+
* The {{ ydb-short-name }} session, which is part of the {{ ydb-short-name }} client context, contains information about executed transactions and prepared queries.
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
## Creating tables {#create-table}
22

3-
Creating tables to be used in operations on a test app. This step results in the creation of DB tables of the series directory data model:
3+
Create tables to be used in operations on a test app. This step results in the creation of database tables for the series directory data model:
44

55
- `Series`
66
- `Seasons`
77
- `Episodes`
88

9-
Once the tables are created, the method for getting information about data schema objects is called and the result of its execution is output.
10-
9+
After the tables are created, a method for retrieving information about data schema objects is called, and the result of its execution is displayed.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
## Adding data {#write-queries}
22

3-
Adding data to the created tables using an [`UPSERT`](../../../../yql/reference/syntax/upsert_into.md) statement of [YQL](../../../../yql/reference/index.md). A data update request is sent within a single request to the server with transaction auto-commit mode enabled.
4-
3+
Add data to the created tables using the [`UPSERT`](../../../../yql/reference/syntax/upsert_into.md) statement in [YQL](../../../../yql/reference/index.md). A data update request is sent to the server as a single request with transaction auto-commit mode enabled.
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
## Retrieving data with a Select {#query-processing}
2-
3-
Retrieving data using a [`SELECT`](../../../../yql/reference/syntax/select/index.md) statement in [YQL](../../../../yql/reference/index.md). Handling the retrieved data selection in the app.
1+
## Retrieving data {#query-processing}
42

3+
Retrieve data using a [`SELECT`](../../../../yql/reference/syntax/select/index.md) statement in [YQL](../../../../yql/reference/index.md). Handle the retrieved data selection in the app.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
## Parameterized queries {#param-queries}
22

3-
Querying data using parameters. This query execution option is preferable as it allows the server to reuse the query execution plan for subsequent calls and also protects from such vulnerabilities as [SQL Injection](https://en.wikipedia.org/wiki/SQL_injection).
4-
3+
Query data using parameters. This query execution method is preferable because it allows the server to reuse the query execution plan for subsequent calls and protects against vulnerabilities such as [SQL injection](https://en.wikipedia.org/wiki/SQL_injection).
Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
## Parameterized prepared queries {#param-prepared-queries}
22

3-
Parameterized prepared queries are saved as templates where specially formatted names are replaced by relevant parameter values each time you execute the query. Use parameterized queries to improve performance by reducing how often queries that only differ in parameter values are compiled and recompiled. The prepared query is stored in the session context.
4-
5-
Code snippet for parameterized prepared queries:
3+
Parameterized prepared queries are saved as templates, where specially formatted placeholders are replaced with relevant parameter values each time the query is executed. Use parameterized queries to improve performance by reducing the need for frequent compilation and recompilation of queries that differ only in parameter values. The prepared query is stored in the session context.
64

5+
Code snippet for parameterized prepared queries:
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
## Scan queries {#scan-query}
22

3-
Making a [scan query](../../../../concepts/scan_query.md) that results in a data stream. Streaming lets you read an unlimited number of rows and amount of data.
4-
3+
Execute a [scan query](../../../../concepts/scan_query.md) to produce a data stream. Streaming allows to read an unlimited number of rows and an unlimited amount of data.

0 commit comments

Comments
 (0)