From dd8b5eb37b0dc1f4a66ed1332bbed5593efd5412 Mon Sep 17 00:00:00 2001 From: aishwarya24 Date: Fri, 28 Nov 2025 13:43:40 -0500 Subject: [PATCH 1/2] some ideas addressed --- .../change-data-capture/using-logical-replication/_index.md | 2 -- docs/content/stable/additional-features/colocation.md | 4 +--- .../additional-features/pg-extensions/extension-pgpartman.md | 2 -- .../additional-features/pg-extensions/extension-pgvector.md | 2 +- docs/content/stable/api/ysql/exprs/_index.md | 2 +- docs/content/stable/api/ysql/exprs/func_yb_index_check.md | 2 -- .../ysql-language-features/indexes-constraints/_index.md | 2 +- docs/content/stable/releases/ybdb-releases/v2024.1.md | 2 +- 8 files changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/content/stable/additional-features/change-data-capture/using-logical-replication/_index.md b/docs/content/stable/additional-features/change-data-capture/using-logical-replication/_index.md index 8d4896c404e5..dc72c661a33b 100644 --- a/docs/content/stable/additional-features/change-data-capture/using-logical-replication/_index.md +++ b/docs/content/stable/additional-features/change-data-capture/using-logical-replication/_index.md @@ -4,8 +4,6 @@ headerTitle: CDC using PostgreSQL replication protocol linkTitle: PostgreSQL protocol description: CDC using YugabyteDB PostgreSQL replication protocol. headcontent: Capture changes made to data in the database -tags: - feature: early-access aliases: - /stable/explore/change-data-capture/using-logical-replication/ menu: diff --git a/docs/content/stable/additional-features/colocation.md b/docs/content/stable/additional-features/colocation.md index 7396b549b9ae..0f1577c95917 100644 --- a/docs/content/stable/additional-features/colocation.md +++ b/docs/content/stable/additional-features/colocation.md @@ -251,9 +251,7 @@ For information on how to set up xCluster for non-colocated tables, refer to [xC ## Colocated tables with tablespaces -{{}}Colocated tables can be placed in [tablespaces](../../explore/going-beyond-sql/tablespaces/). When a colocated table is created in a tablespace, the colocation tablet is placed and replicated exclusively in the tablespace. - -During Early Access, by default colocation support for tablespaces is not enabled. To enable the feature, set the flag `ysql_enable_colocated_tables_with_tablespaces=true`. +Colocated tables can be placed in [tablespaces](../../explore/going-beyond-sql/tablespaces/). When a colocated table is created in a tablespace, the colocation tablet is placed and replicated exclusively in the tablespace. ### Create a colocated table in a tablespace diff --git a/docs/content/stable/additional-features/pg-extensions/extension-pgpartman.md b/docs/content/stable/additional-features/pg-extensions/extension-pgpartman.md index 1cbc02012602..1a0b61996fb3 100644 --- a/docs/content/stable/additional-features/pg-extensions/extension-pgpartman.md +++ b/docs/content/stable/additional-features/pg-extensions/extension-pgpartman.md @@ -3,8 +3,6 @@ title: pg_partman extension headerTitle: Partition manager extension linkTitle: pg_partman description: Using the pg_partman extension in YugabyteDB -tags: - feature: early-access menu: stable: identifier: extension-pgpartman diff --git a/docs/content/stable/additional-features/pg-extensions/extension-pgvector.md b/docs/content/stable/additional-features/pg-extensions/extension-pgvector.md index 372e4709d613..e605e981c936 100644 --- a/docs/content/stable/additional-features/pg-extensions/extension-pgvector.md +++ b/docs/content/stable/additional-features/pg-extensions/extension-pgvector.md @@ -162,7 +162,7 @@ SELECT category_id, AVG(embedding) FROM items GROUP BY category_id; ## Vector indexing -{{}} By default, vector search performs exact nearest neighbor search, ensuring perfect recall. +By default, vector search performs exact nearest neighbor search, ensuring perfect recall. To improve query performance, you can use approximate nearest neighbor (ANN) search, which trades some recall for speed. Unlike traditional indexes, approximate indexes may return different results for queries. diff --git a/docs/content/stable/api/ysql/exprs/_index.md b/docs/content/stable/api/ysql/exprs/_index.md index 64ad41bdc342..08b78e32d657 100644 --- a/docs/content/stable/api/ysql/exprs/_index.md +++ b/docs/content/stable/api/ysql/exprs/_index.md @@ -16,7 +16,7 @@ YSQL supports all PostgreSQL-compatible built-in functions and operators. The fo | Statement | Description | |-----------|-------------| -| {{}}[yb_index_check()](func_yb_index_check) | Checks if the given index is consistent with its base relation | +| [yb_index_check()](func_yb_index_check) | Checks if the given index is consistent with its base relation | | [yb_hash_code()](func_yb_hash_code) | Returns the partition hash code for a given set of expressions | | [yb_servers()](func_yb_servers) | Returns a list of all the nodes in your cluster and their location | | [gen_random_uuid()](func_gen_random_uuid) | Returns a random UUID | diff --git a/docs/content/stable/api/ysql/exprs/func_yb_index_check.md b/docs/content/stable/api/ysql/exprs/func_yb_index_check.md index 7e255adfa20e..33844933104f 100644 --- a/docs/content/stable/api/ysql/exprs/func_yb_index_check.md +++ b/docs/content/stable/api/ysql/exprs/func_yb_index_check.md @@ -3,8 +3,6 @@ title: yb_index_check() function [YSQL] headerTitle: yb_index_check() linkTitle: yb_index_check() description: Checks if the given index is consistent with its base relation. -tags: - feature: early-access menu: stable_api: identifier: api-ysql-exprs-yb_index_check diff --git a/docs/content/stable/explore/ysql-language-features/indexes-constraints/_index.md b/docs/content/stable/explore/ysql-language-features/indexes-constraints/_index.md index e68a5d8ceb34..a7e76dfdf8f2 100644 --- a/docs/content/stable/explore/ysql-language-features/indexes-constraints/_index.md +++ b/docs/content/stable/explore/ysql-language-features/indexes-constraints/_index.md @@ -90,7 +90,7 @@ Generalized Search Tree (GiST) indexes in SQL are versatile indexes that support ## Check indexes -{{}} Use the `yb_index_check()` utility function to check if an index is consistent with its base relation. Use it to detect inconsistencies that can creep in due to faulty storage, faulty RAM, or data files being overwritten or modified by unrelated software. +Use the `yb_index_check()` utility function to check if an index is consistent with its base relation. Use it to detect inconsistencies that can creep in due to faulty storage, faulty RAM, or data files being overwritten or modified by unrelated software. {{}} To understand how to use the function, see [yb_index_check()](../../../api/ysql/exprs/func_yb_index_check/) diff --git a/docs/content/stable/releases/ybdb-releases/v2024.1.md b/docs/content/stable/releases/ybdb-releases/v2024.1.md index 8a0f1a63b0a7..a010458b69a7 100644 --- a/docs/content/stable/releases/ybdb-releases/v2024.1.md +++ b/docs/content/stable/releases/ybdb-releases/v2024.1.md @@ -767,7 +767,7 @@ docker pull yugabytedb/yugabyte:2024.1.1.0-b137 ### Highlight -**PostgreSQL Logical Replication Protocol Support** {{}} +**PostgreSQL Logical Replication Protocol Support** {{}} We're excited to announce in the 2024.1.1.0 release support for the PostgreSQL Logical Replication Protocol for Change Data Capture (CDC), in addition to the existing native [gRPC Replication protocol](/v2024.1/additional-features/change-data-capture/using-yugabytedb-grpc-replication/). This feature allows you to manage CDC streams using [Publications](https://www.postgresql.org/docs/11/sql-createpublication.html) and [Replication Slots](https://www.postgresql.org/docs/11/logicaldecoding-explanation.html#LOGICALDECODING-REPLICATION-SLOTS), similar to native PostgreSQL. Additionally, a [new connector](/v2024.1/additional-features/change-data-capture/using-logical-replication/get-started/#get-started-with-yugabytedb-connector) is introduced that utilizes the logical replication protocol to consume the CDC streams via [Replication slots](https://www.postgresql.org/docs/current/logicaldecoding-explanation.html#LOGICALDECODING-REPLICATION-SLOTS). From 918b60025d5838122639d34d56165621103a8acf Mon Sep 17 00:00:00 2001 From: aishwarya24 Date: Fri, 28 Nov 2025 15:04:17 -0500 Subject: [PATCH 2/2] addressed a few more --- .../using-logical-replication/yugabytedb-connector.md | 8 ++------ .../architecture/transactions/concurrency-control.md | 2 +- .../architecture/transactions/read-restart-error.md | 2 +- .../stable/deploy/manual-deployment/start-masters.md | 4 ++-- .../stable/deploy/manual-deployment/system-config.md | 2 +- docs/content/stable/explore/transactions/_index.md | 2 +- .../stable/explore/transactions/explicit-locking.md | 2 +- .../stable/explore/transactions/transactional-ddl.md | 4 +--- docs/content/stable/reference/configuration/yb-master.md | 2 +- docs/content/stable/reference/configuration/yb-tserver.md | 2 +- 10 files changed, 12 insertions(+), 18 deletions(-) diff --git a/docs/content/stable/additional-features/change-data-capture/using-logical-replication/yugabytedb-connector.md b/docs/content/stable/additional-features/change-data-capture/using-logical-replication/yugabytedb-connector.md index 73b8345c015d..b4526c31d569 100644 --- a/docs/content/stable/additional-features/change-data-capture/using-logical-replication/yugabytedb-connector.md +++ b/docs/content/stable/additional-features/change-data-capture/using-logical-replication/yugabytedb-connector.md @@ -1549,13 +1549,9 @@ The following table lists the streaming metrics that are available. ### Parallel streaming -{{}}YugabyteDB also supports parallel streaming of a single table using logical replication. This means that you can start the replication for the table using parallel tasks, where each task polls on specific tablets. +YugabyteDB also supports parallel streaming of a single table using logical replication. This means that you can start the replication for the table using parallel tasks, where each task polls on specific tablets. -{{< note title="Important" >}} - -Parallel streaming is {{}}. To enable the feature, set the `ysql_enable_pg_export_snapshot` and `ysql_yb_enable_consistent_replication_from_hash_range` flags to true. - -{{< /note >}} +To enable the feature, set the `ysql_enable_pg_export_snapshot` and `ysql_yb_enable_consistent_replication_from_hash_range` flags to true. Use the following steps to configure parallel streaming using the YugabyteDB Connector. diff --git a/docs/content/stable/architecture/transactions/concurrency-control.md b/docs/content/stable/architecture/transactions/concurrency-control.md index 2be1c8a85d50..fdf46686ab53 100644 --- a/docs/content/stable/architecture/transactions/concurrency-control.md +++ b/docs/content/stable/architecture/transactions/concurrency-control.md @@ -1344,7 +1344,7 @@ Finally, advisory locks can be blocking or non-blocking: ## Table-level locks -{{}} Table-level locks for YSQL (available in {{}} and later) provide a mechanism to coordinate concurrent DML and DDL operations. The feature provides serializable semantics between DMLs and DDLs by introducing distributed locks on YSQL objects. PostgreSQL clients acquire locks to prevent DMLs and DDLs from running concurrently. +{{}} Table-level locks for YSQL (available in {{}} and later) provide a mechanism to coordinate concurrent DML and DDL operations. The feature provides serializable semantics between DMLs and DDLs by introducing distributed locks on YSQL objects. PostgreSQL clients acquire locks to prevent DMLs and DDLs from running concurrently. Support for table-level locks is disabled by default, and to enable the feature, set the [yb-tserver](../../../reference/configuration/yb-tserver/) flag [enable_object_locking_for_table_locks](../../../explore/transactions/explicit-locking/#enable-table-level-locks) to true. diff --git a/docs/content/stable/architecture/transactions/read-restart-error.md b/docs/content/stable/architecture/transactions/read-restart-error.md index aa5323fae28a..c465d27bc8d3 100644 --- a/docs/content/stable/architecture/transactions/read-restart-error.md +++ b/docs/content/stable/architecture/transactions/read-restart-error.md @@ -77,7 +77,7 @@ How does YugabyteDB prevent this clock skew anomaly? You can handle and mitigate read restart errors using the following techniques: -- {{}} Configure [highly accurate clocks](../../../deploy/manual-deployment/system-config#set-up-time-synchronization). +- {{}} Configure [highly accurate clocks](../../../deploy/manual-deployment/system-config#set-up-time-synchronization). - Implement retry logic in the application. Application retries can help mitigate read restart errors. Moreover, a statement or a transaction may fail in other ways such as transaction conflicts or infrastructure failures. Therefore, a retry mechanism is strongly recommended for a cloud-native, distributed database such as YugabyteDB. While implementing application retries is the best long-term approach, there are a few short-term solutions you can use in the interim. diff --git a/docs/content/stable/deploy/manual-deployment/start-masters.md b/docs/content/stable/deploy/manual-deployment/start-masters.md index dbd14ebea4e2..5f1bd962cd58 100644 --- a/docs/content/stable/deploy/manual-deployment/start-masters.md +++ b/docs/content/stable/deploy/manual-deployment/start-masters.md @@ -75,7 +75,7 @@ The number of comma-separated addresses in `--master_addresses` should equal the You can specify multiple directories using the [`--fs_data_dirs`](../../../reference/configuration/yb-master/#fs-data-dirs) flag. Replace the [`--rpc_bind_addresses`](../../../reference/configuration/yb-master/#rpc-bind-addresses) value with the private IP address of the host, and set the `placement_cloud`, `placement_region`, and `placement_zone` values appropriately. For single zone deployment, use the same value for the `placement_zone` flag. -{{}} Highly accurate clocks can be configured by specifying `--time_source=clockbound`. Requires [system configuration](../system-config#set-up-time-synchronization). +{{}} Highly accurate clocks can be configured by specifying `--time_source=clockbound`. Requires [system configuration](../system-config#set-up-time-synchronization). For the full list of configuration flags, see the [YB-Master reference](../../../reference/configuration/yb-master/). @@ -148,7 +148,7 @@ $ ./bin/yb-tserver \ Provide all of the master addresses using the [`--tserver_master_addrs`](../../../reference/configuration/yb-tserver/#tserver-master-addrs) flag. Replace the [`--rpc_bind_addresses`](../../../reference/configuration/yb-tserver/#rpc-bind-addresses) value with the private IP address of the host, and set the `placement_cloud`, `placement_region`, and `placement_zone` values appropriately. For single zone deployment, use the same value for the `--placement_zone` flag. -{{}} Highly accurate clocks can be configured by specifying `--time_source=clockbound`. Requires [system configuration](../system-config#set-up-time-synchronization). +{{}} Highly accurate clocks can be configured by specifying `--time_source=clockbound`. Requires [system configuration](../system-config#set-up-time-synchronization). For the full list of configuration flags, see the [YB-TServer reference](../../../reference/configuration/yb-tserver/). diff --git a/docs/content/stable/deploy/manual-deployment/system-config.md b/docs/content/stable/deploy/manual-deployment/system-config.md index c459b8b7ded7..256ea94d95df 100644 --- a/docs/content/stable/deploy/manual-deployment/system-config.md +++ b/docs/content/stable/deploy/manual-deployment/system-config.md @@ -47,7 +47,7 @@ sudo bash ./bin/configure_ptp.sh ### Configure ClockBound -{{}} [ClockBound](https://github.com/aws/clock-bound) is an open source daemon that allows you to compare timestamps to determine order for events and transactions, independent of an instance's geographic location. ClockBound provides a strict interval in which the reference time (true time) exists. +{{}} [ClockBound](https://github.com/aws/clock-bound) is an open source daemon that allows you to compare timestamps to determine order for events and transactions, independent of an instance's geographic location. ClockBound provides a strict interval in which the reference time (true time) exists. Although optional, configuring ClockBound improves clock accuracy by several orders of magnitude. ClockBound requires chrony and can be used in conjunction with PTP. diff --git a/docs/content/stable/explore/transactions/_index.md b/docs/content/stable/explore/transactions/_index.md index 69ab86929124..1b90327865c5 100644 --- a/docs/content/stable/explore/transactions/_index.md +++ b/docs/content/stable/explore/transactions/_index.md @@ -22,7 +22,7 @@ The following table summarizes the support for transactions across the YSQL and | Isolation levels | Serializable
Snapshot
Read Committed | Snapshot | Repeatable read isolation level in PostgreSQL maps to snapshot isolation in YSQL. | | `AUTOCOMMIT = false` setting | Yes | No | The transaction must be expressed as one statement in YCQL. | | Explicit locking | Yes | No | Ability to perform row- and table-level locking | -| {{}} Transactional DDL | Yes | No | Each DDL statement is a transaction in YSQL, even if other DDL statements are in a transaction block. | +| Transactional DDL | Yes | No | Each DDL statement is a transaction in YSQL, even if other DDL statements are in a transaction block. |