Skip to content

Commit 70fd94d

Browse files
Copilotasmyasnikov
andauthored
Remove all PostgreSQL compatibility documentation and references (#31978)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: asmyasnikov <14202262+asmyasnikov@users.noreply.github.com>
1 parent 592ef82 commit 70fd94d

File tree

23 files changed

+4
-394
lines changed

23 files changed

+4
-394
lines changed

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,6 @@ Released on November 26, 2024. To update to version **2.16.0**, select the [Down
272272
* Added support for [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)–formatted timestamps in the `{{ ydb-cli }} topic` commands.
273273
* Added the `--explain-ast` option to the `{{ ydb-cli }} sql` command, which prints the query AST.
274274
* Added ANSI SQL syntax highlighting in interactive mode.
275-
* Added support for [PostgreSQL syntax](./postgresql/intro.md) in the `{{ ydb-cli }} workload tpch` and `{{ ydb-cli }} workload tpcds` benchmarks.
276275
* Introduced the `-c` option for the `{{ ydb-cli }} workload tpcds run` command to compare results with expected values and display differences.
277276
* Added log events for the `{{ ydb-cli }} tools dump` and `{{ ydb-cli }} tools restore` commands.
278277
* Enhanced the `{{ ydb-cli }} tools restore` command to display error locations.
@@ -342,7 +341,6 @@ Released on January 12, 2024. To update to version **2.8.0**, select the [Downlo
342341
### Features
343342

344343
* Added new `{{ ydb-cli }} admin config` and `{{ ydb-cli }} admin volatile-config` commands for cluster configuration management.
345-
* Added support for loading PostgreSQL-compatible data types by [ydb import file csv|tsv|json](reference/ydb-cli/export-import/import-file.md) command. Only for row-oriented tables.
346344
* Added support for directory load from an S3-compatible storage in the [ydb import s3](reference/ydb-cli/export-import/import-s3.md) command. Currently only available on Linux and Mac OS.
347345
* Added support for outputting the results of [ydb table query execute](reference/ydb-cli/table-query-execute.md), [ydb yql](reference/ydb-cli/yql.md) and [ydb scripting yql](reference/ydb-cli/scripting-yql.md) commands in the [Apache Parquet](https://parquet.apache.org/docs/) format.
348346
* In the [ydb workload](reference/ydb-cli/commands/workload/index.md) commands, the `--executer` option has been added, which allows to specify which type of queries to use.
@@ -354,15 +352,12 @@ Released on January 12, 2024. To update to version **2.8.0**, select the [Downlo
354352

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

357-
* Fixed an error substituting the wrong primary key in the command [ydb tools pg-convert](postgresql/import.md#pg-convert).
358-
359355
## Version 2.7.0 {#2-7-0}
360356

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

363359
### Features
364360

365-
* 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.
366361
* 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.
367362
* Added new `{{ ydb-cli }} scheme permissions list` command to list permissions.
368363
* 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: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,36 +11,27 @@ 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

1817
## Install prerequisites
1918

20-
Choose the specific programming language you'll be using. [Install the respective {{ ydb-short-name }} SDK](../reference/ydb-sdk/index.md) or [a PostgreSQL driver](https://wiki.postgresql.org/wiki/List_of_drivers) depending on the route you have chosen above.
19+
Choose the specific programming language you'll be using. [Install the respective {{ ydb-short-name }} SDK](../reference/ydb-sdk/index.md).
2120

2221
Additionally, you'd want to set up at least one of the available ways to run ad-hoc queries for debugging purposes. Choose at least one according to your preferences:
2322

2423
* [{{ ydb-short-name }} CLI](../reference/ydb-cli/install.md)
2524
* [Embedded UI](../reference/embedded-ui/index.md)
2625
* Any SQL IDE that supports [JDBC](https://github.com/ydb-platform/ydb-jdbc-driver)
27-
* [psql](https://www.postgresql.org/docs/14/app-psql.html) or [pgAdmin](https://www.pgadmin.org/) for the PostgreSQL-compatible route.
2826

2927
## Start coding
3028

31-
### For {{ ydb-short-name }} SDK route
32-
3329
- Go through [YQL tutorial](yql-tutorial/index.md) to get familiar with {{ ydb-short-name }}'s SQL dialect.
3430
- Explore [example applications](example-app/index.md) to see how working with SDK's looks like.
3531
- Check out [SDK recipies](../recipes/ydb-sdk/index.md) for typical SDK use cases, which you can refer to later.
3632
- Learn how to [handle {{ ydb-short-name }} SDK errors](../reference/ydb-sdk/error_handling.md).
3733
- Leverage your IDE capabilities to navigate the SDK code.
3834

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-
4435
## Testing
4536

4637
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 the Apache Kafka network protocol. Due to the compatibility layer, many tools designed to work with Apache Kafka 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/_includes/toc-table.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,4 @@
44
| --- | :---: | --- |
55
| [Apache Superset](https://superset.apache.org) | [ydb-sqlalchemy](https://github.com/ydb-platform/ydb-sqlalchemy/releases) | [Instruction](../superset.md) |
66
| [DataLens](https://datalens.tech) | Full | [Instruction](../datalens.md) |
7-
| [FineBI](https://intl.finebi.com/) | [PostgreSQL wire protocol](../../../postgresql/intro.md) | [Instruction](../finebi.md) |
87
| [Grafana](https://grafana.com) | Full | [Instruction](../grafana.md) |

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

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

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/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)

ydb/docs/en/core/security/encryption/data-in-transit.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ As {{ ydb-short-name }} is a distributed system typically running on a cluster,
66
* {{ ydb-short-name }} as a server:
77

88
* [gRPC](../../reference/ydb-sdk/overview-grpc-api.md) for external communication with client applications designed to work natively with {{ ydb-short-name }} via the [SDK](../../reference/ydb-sdk/index.md) or [CLI](../../reference/ydb-cli/index.md).
9-
* [PostgreSQL wire protocol](../../postgresql/intro.md) for external communication with client applications initially designed to work with [PostgreSQL](https://www.postgresql.org/).
109
* [Kafka wire protocol](../../reference/kafka-api/index.md) for external communication with client applications initially designed to work with [Apache Kafka](https://kafka.apache.org/).
1110
* HTTP for running the [Embedded UI](../../reference/embedded-ui/index.md), exposing [metrics](../../devops/observability/monitoring.md), and other miscellaneous endpoints.
1211

0 commit comments

Comments
 (0)