Skip to content

Commit a71889c

Browse files
asmyasnikovStepan BeloyarovSixOnMyface
authored andcommitted
[docs] Removed TOC links to PostgreSQL compatibility articles (#30280)
Co-authored-by: Stepan Beloyarov <beloyarovstep@yandex-team.ru> Co-authored-by: SixOnMyface <103491956+SixOnMyface@users.noreply.github.com>
1 parent 292133b commit a71889c

File tree

23 files changed

+13
-58
lines changed

23 files changed

+13
-58
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -422,15 +422,15 @@ Released on January 12, 2024. To update to version **2.8.0**, select the [Downlo
422422

423423
* Fixed an error displaying tables in `pretty` format with [Unicode](https://en.wikipedia.org/wiki/Unicode) characters.
424424

425-
* Fixed an error substituting the wrong primary key in the command [ydb tools pg-convert](postgresql/import.md#pg-convert).
425+
* Fixed an error substituting the wrong primary key in the command [ydb tools pg-convert](./postgresql/import.md#pg-convert).
426426

427427
## Version 2.7.0 {#2-7-0}
428428

429429
Released on October 23, 2023. To update to version **2.7.0**, select the [Downloads](downloads/ydb-cli.md) section.
430430

431431
### Features
432432

433-
* Added the [ydb tools pg-convert](postgresql/import.md#pg-convert) command, which prepares a dump obtained by the [pg_dump](https://www.postgresql.org/docs/current/app-pgdump.html) utility for loading into the YDB postgres-compatible layer.
433+
* Added the [ydb tools pg-convert](./postgresql/import.md#pg-convert) command, which prepares a dump obtained by the [pg_dump](https://www.postgresql.org/docs/current/app-pgdump.html) utility for loading into the YDB postgres-compatible layer.
434434
* Added the `{{ ydb-cli }} workload query` load testing command, which loads the database with [script execution queries](reference/ydb-cli/yql.md) in multiple threads.
435435
* Added new `{{ ydb-cli }} scheme permissions list` command to list permissions.
436436
* In the commands [ydb table query execute](reference/ydb-cli/table-query-execute.md), [ydb table query explain](reference/ydb-cli/commands/explain-plan.md), [ydb yql](reference/ydb-cli/yql.md), and [ydb scripting yql](reference/ydb-cli/scripting-yql.md), the `--flame-graph` option has been added, specifying the path to the file in which you need to save the visualization of query execution statistics.

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

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ In parallel with designing the schema, you need to set up your development envir
1111
Choose the {{ ydb-short-name }} API you want to use; there are several options:
1212

1313
- The recommended way for mainstream programming languages is using a [{{ ydb-short-name }} SDK](../reference/ydb-sdk/index.md). They provide high-level APIs and implement best practices on working with {{ ydb-short-name }}. {{ ydb-short-name }} SDKs are available for several popular languages and strive for feature parity, but not all are feature-complete. Refer to the [SDK feature comparison table](../reference/ydb-sdk/feature-parity.md) to check if the SDK for the programming language you had in mind will fit your needs or to choose a programming language with better feature coverage if you're flexible.
14-
- Alternatively, {{ ydb-short-name }} provides [PostgreSQL-compatible API](../postgresql/intro.md). It is intended to simplify migrating existing applications that have outgrown PostgreSQL. However, it is also useful for exotic programming languages that have a PostgreSQL client library but don't have a {{ ydb-short-name }} SDK. Refer to PostgreSQL compatibility documentation to check if its completeness will suit your needs.
1514
- If you are interested in [{{ ydb-short-name }} topics](../concepts/datamodel/topic.md) feature, it is worth noting that they also provide [Kafka-compatible API](../reference/kafka-api/index.md). Follow that link if this use case is relevant.
1615
- As a last resort, {{ ydb-short-name }}'s native API is based on the [gRPC](https://grpc.io/) protocol, which has an ecosystem around it, including code generation of clients. [{{ ydb-short-name}}'s gRPC specs are hosted on GitHub](https://github.com/ydb-platform/ydb/tree/main/ydb/public/api/grpc) and you could leverage them in your application. The generated clients are low-level and will require extra work to handle aspects like retries and timeouts properly, so go this route only if other options above aren't possible and you know what you're doing.
1716

@@ -36,11 +35,6 @@ Additionally, you'd want to set up at least one of the available ways to run ad-
3635
- Learn how to [handle {{ ydb-short-name }} SDK errors](../reference/ydb-sdk/error_handling.md).
3736
- Leverage your IDE capabilities to navigate the SDK code.
3837

39-
### For PostgreSQL-compatibility route
40-
41-
- Learn how to [connect PostgreSQL driver with {{ ydb-short-name }} cluster](../postgresql/docker-connect.md).
42-
- The rest should be similar to using vanilla PostgreSQL. Use your experience with it or refer to any favorite resources. However, refer to the list of [functions](../postgresql/functions.md) and statements to adjust your expectations.
43-
4438
## Testing
4539

4640
To write tests on applications working with {{ ydb-short-name }}:

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ Main resources:
2424
- [{#T}](../yql/reference/index.md)
2525
- [{#T}](../reference/ydb-sdk/index.md)
2626
- [{#T}](../reference/ydb-cli/index.md)
27-
- [{#T}](../postgresql/intro.md)
2827
- [{#T}](../reference/kafka-api/index.md)
2928

3029
If you're interested in developing {{ ydb-short-name }} core or satellite projects, refer to the [documentation for contributors](../contributor/index.md).

ydb/docs/en/core/index.yaml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,6 @@ links:
3434
- title: Working with the SDK
3535
description: YDB SDK reference
3636
href: reference/ydb-sdk/
37-
- title: PostgreSQL compatibility
38-
description: Integrate with PostgreSQL ecosystem
39-
href: postgresql/intro/
4037
- title: Troubleshooting
4138
description: Troubleshooting issues related to YDB databases and applications
4239
href: troubleshooting/

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This section provides the main information about {{ ydb-name }} integrations wit
44

55
{% note info %}
66

7-
In addition to its own native protocol, {{ ydb-name }} has a compatibility layer that allows external systems to connect to databases via network protocols PostgreSQL or Apache Kafka. Due to the compatibility layer, many tools designed to work with these systems can also interact with {{ ydb-name }}. The compatibility level of each specific application needs to be clarified separately.
7+
In addition to its own native protocol, {{ ydb-name }} has a compatibility layer that allows external systems to connect to databases via network protocols [PostgreSQL](../postgresql/intro.md) or [Apache Kafka](../reference/kafka-api/index.md). Due to the compatibility layer, many tools designed to work with these systems can also interact with {{ ydb-name }}. The compatibility level of each specific application needs to be clarified separately.
88

99
{% endnote %}
1010

@@ -44,5 +44,4 @@ In addition to its own native protocol, {{ ydb-name }} has a compatibility layer
4444
## See also
4545

4646
* [{#T}](../reference/ydb-sdk/index.md)
47-
* [{#T}](../postgresql/intro.md)
4847
* [{#T}](../reference/kafka-api/index.md)

ydb/docs/en/core/integrations/visualization/finebi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ FineBI is a powerful big data analytics tool. FineBI allows organizations to ana
44

55
[PostgreSQL compatibility mode in {{ ydb-short-name }}](../../postgresql/intro.md) enables the use of [FineBI](https://intl.finebi.com/) to query and visualize data from {{ ydb-short-name }}. In this case FineBI works with {{ ydb-short-name }} just like with PostgreSQL.
66

7-
{% include [../../postgresql/_includes/alert_preview.md](../../postgresql/_includes/alert_preview.md) %}
7+
{% note warning %}
8+
9+
At the moment, {{ ydb-short-name }}'s compatibility with PostgreSQL **is under development**, so not all PostgreSQL constructs and [functions](../../postgresql/functions.md) are supported yet. PostgreSQL compatibility is available for testing in the form of a Docker container, which can be deployed by following these [instructions](../../postgresql/docker-connect.md).
10+
11+
{% endnote %}
812

913
## Prerequisites
1014

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
items:
2+
- name: Overview
3+
href: intro.md
24
- name: Connection via PostgreSQL protocol
35
href: docker-connect.md
46
- name: PostgreSQL statements

ydb/docs/en/core/reference/configuration/tls.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,6 @@ grpc_config:
3232
ca: "/opt/ydb/certs/ca.crt"
3333
```
3434
35-
### PostgreSQL Wire Protocol
36-
37-
{{ ydb-short-name }} exposes a separate network port for the [PostgreSQL wire protocol](../../postgresql/intro.md). This protocol is used for external communication with client applications initially designed to work with [PostgreSQL](https://www.postgresql.org/).
38-
39-
Example of enabling TLS for the PostgreSQL wire protocol:
40-
41-
```yaml
42-
local_pg_wire_config:
43-
ssl_certificate: "/opt/ydb/certs/node.crt"
44-
```
45-
4635
### Kafka Wire Protocol
4736
4837
{{ ydb-short-name }} exposes a separate network port for the [Kafka wire protocol](../../reference/kafka-api/index.md). This protocol is used for external communication with client applications initially designed to work with [Apache Kafka](https://kafka.apache.org/).

ydb/docs/en/core/reference/docker/configuration.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66

77
| Name | Type | Default | Description |
88
| -- | -- | -- | -- |
9-
| [`POSTGRES_USER`](https://GitHub.com/ydb-platform/ydb/blob/c113fcffa7b1a20ad8dcb1b1760ae5bfa25370ca/ydb/public/tools/lib/cmds/__init__.py#L240) | `string` | `postgres` | User name for access via [compatibility with PostgreSQL](../../postgresql/intro.md) |
10-
| [`POSTGRES_PASSWORD`](https://GitHub.com/ydb-platform/ydb/blob/c113fcffa7b1a20ad8dcb1b1760ae5bfa25370ca/ydb/public/tools/lib/cmds/__init__.py#L240) | `string` | | User password for access via [compatibility with PostgreSQL](../../postgresql/intro.md) |
119
| [`YDB_GRPC_ENABLE_TLS`](https://GitHub.com/ydb-platform/ydb/blob/c113fcffa7b1a20ad8dcb1b1760ae5bfa25370ca/ydb/public/tools/lib/cmds/__init__.py#L258) | `0` or `1` | `1` | Enable the `grpcs://` protocol (gRPC over TLS) |
1210
| [`YDB_GRPC_TLS_DATA_PATH`](https://GitHub.com/ydb-platform/ydb/blob/8fefc809c83829d8d8b886e82534d009de4c8826/ydb/public/tools/lib/cmds/__init__.py#L291) | `string` | `/ydb_data` | Data path with TLS certificates for the `grpcs://` connection |
1311
| [`MON_PORT`](https://GitHub.com/ydb-platform/ydb/blob/8dde59cd0af86737d07a1cd8ff19811a2bd2b663/ydb/tests/library/harness/kikimr_port_allocator.py#L170) | `int` | `8765` | HTTP port of [Embedded UI](../../reference/embedded-ui/index.md) |

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
This documentation section contains reference information about various aspects of {{ ydb-short-name }}, including:
44

55
* [{#T}](../yql/reference/index.md)
6-
* [{#T}](../postgresql/intro.md)
76
* [{#T}](./embedded-ui/index.md)
87
* [{#T}](../integrations/index.md)
98
* [{#T}](./ydb-cli/index.md)

0 commit comments

Comments
 (0)