cloud: add Starter PostgreSQL Compatible docs - #23907
qiqi-power wants to merge 3 commits into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
contribution
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: pingcap/docs/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review. 📝 WalkthroughWalkthroughThe PR documents PostgreSQL-compatible TiDB Cloud Starter in Limited Public Preview. It adds guides for creation, connectivity, migration, SQL support, administration, monitoring, extensions, vector search, full-text search, and operational limits. Existing Starter documentation now distinguishes compatibility modes. ChangesPostgreSQL-compatible Starter documentation
Priority: ⬇️ Low Estimated code review effort: 3 (Moderate) | ~25 minutes Change: Other Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Description checkExplanation The description includes the template, CLA confirmation, and v8.5 selection, but the required change summary is empty. It therefore does not provide enough information about the purpose or scope of the pull request.
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 18
Caution
Some comments are outside the diff and can’t be posted inline due to GitHub limitations.
🟡 Minor · Extend the backup-setting instructions to… · backup-and-restore-serverless.md:60
tidb-cloud/backup-and-restore-serverless.md:60
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winExtend the backup-setting instructions to PostgreSQL-compatible Starter.
The new note states that PostgreSQL-compatible Starter supports configurable backup settings. This section still says the procedure applies only to Essential instances. Update Line 60 to include PostgreSQL-compatible Starter and Starter instances with configurable backup settings.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 2a80beba-a179-4c14-a2ef-a205d3b55ee6
📒 Files selected for processing (25)
tidb-cloud/backup-and-restore-serverless.mdtidb-cloud/connect-via-standard-connection-serverless.mdtidb-cloud/create-tidb-cluster-serverless.mdtidb-cloud/pg-on-starter/Import-with-psql.mdtidb-cloud/pg-on-starter/built-in-monitoring-pg.mdtidb-cloud/pg-on-starter/pg-advanced-sql.mdtidb-cloud/pg-on-starter/pg-auth-roles.mdtidb-cloud/pg-on-starter/pg-built-in-functions.mdtidb-cloud/pg-on-starter/pg-data-types.mdtidb-cloud/pg-on-starter/pg-ddl.mdtidb-cloud/pg-on-starter/pg-dml-queries.mdtidb-cloud/pg-on-starter/pg-extensions-overview.mdtidb-cloud/pg-on-starter/pg-full-text-search.mdtidb-cloud/pg-on-starter/pg-limits-constraints.mdtidb-cloud/pg-on-starter/pg-parquet-import.mdtidb-cloud/pg-on-starter/pg-quickstart.mdtidb-cloud/pg-on-starter/pg-row-level-security.mdtidb-cloud/pg-on-starter/pg-session-parameters.mdtidb-cloud/pg-on-starter/pg-sql-reference-overview.mdtidb-cloud/pg-on-starter/pg-system-catalog.mdtidb-cloud/pg-on-starter/pg-transactions-copy.mdtidb-cloud/pg-on-starter/pg-vector-search.mdtidb-cloud/pg-on-starter/postgresql-compatibility.mdtidb-cloud/select-cluster-tier.mdtidb-cloud/tidb-cloud-intro.md
Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.
| @@ -0,0 +1,291 @@ | |||
| --- | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use a lowercase filename.
This new file is named Import-with-psql.md. Rename it to import-with-psql.md and update references.
As per path instructions, new file names must use lowercase words separated by hyphens.
Source: Path instructions
| ```shell | ||
| pg_dump \ | ||
| --data-only \ | ||
| --no-owner \ | ||
| --no-privileges \ | ||
| "<SOURCE_DATABASE_URL>" \ | ||
| | psql "<TARGET_DATABASE_URL>" -v ON_ERROR_STOP=1 |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Do not hide pg_dump failures in the pipeline.
Without pipefail, the shell reports the status of the final psql command. If pg_dump fails after emitting a valid prefix, the command can appear successful after importing only part of the data. Run this pipeline in a shell that supports pipefail, or export and validate the dump before importing.
Committable change
+set -o pipefail
pg_dump \📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ```shell | |
| pg_dump \ | |
| --data-only \ | |
| --no-owner \ | |
| --no-privileges \ | |
| "<SOURCE_DATABASE_URL>" \ | |
| | psql "<TARGET_DATABASE_URL>" -v ON_ERROR_STOP=1 | |
| ```shell | |
| set -o pipefail | |
| pg_dump \ | |
| --data-only \ | |
| --no-owner \ | |
| --no-privileges \ | |
| "<SOURCE_DATABASE_URL>" \ | |
| | psql "<TARGET_DATABASE_URL>" -v ON_ERROR_STOP=1 |
| CREATE FUNCTION create_order(p_item TEXT) | ||
| RETURNS BIGINT AS $$ | ||
| DECLARE | ||
| new_id BIGINT; | ||
| BEGIN | ||
| INSERT INTO orders (item) | ||
| VALUES (p_item) | ||
| RETURNING id INTO new_id; |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win
Align create_order with the documented orders table.
tidb-cloud/pg-on-starter/pg-ddl.md defines orders with id, user_id, and amount; it has no item column. A reader who follows both pages cannot create this function successfully.
Committable replacement
-CREATE FUNCTION create_order(p_item TEXT)
+CREATE FUNCTION create_order(p_user_id BIGINT, p_amount NUMERIC)
@@
- INSERT INTO orders (item)
- VALUES (p_item)
+ INSERT INTO orders (user_id, amount)
+ VALUES (p_user_id, p_amount)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| CREATE FUNCTION create_order(p_item TEXT) | |
| RETURNS BIGINT AS $$ | |
| DECLARE | |
| new_id BIGINT; | |
| BEGIN | |
| INSERT INTO orders (item) | |
| VALUES (p_item) | |
| RETURNING id INTO new_id; | |
| CREATE FUNCTION create_order(p_user_id BIGINT, p_amount NUMERIC) | |
| RETURNS BIGINT AS $$ | |
| DECLARE | |
| new_id BIGINT; | |
| BEGIN | |
| INSERT INTO orders (user_id, amount) | |
| VALUES (p_user_id, p_amount) | |
| RETURNING id INTO new_id; |
| A `CASE` expression, such as `NEW.status := CASE WHEN ... END`, can still be used in an assignment. | ||
|
|
||
| ### AFTER trigger formatting | ||
|
|
||
| In an `AFTER` trigger function, keep a bare `RETURN NEW;` or `RETURN OLD;` on its own line. | ||
|
|
||
| For example: | ||
|
|
There was a problem hiding this comment.
🔒 Security & Privacy | 🛡️ Analyzed with Security Review | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
sed -n '320,355p' tidb-cloud/pg-on-starter/pg-row-level-security.md
rg -n "search_path|ALTER FUNCTION|SET search_path|SECURITY DEFINER" tidb-cloud/pg-on-starterRepository: pingcap/docs
Length of output: 2185
🏁 Script executed:
#!/bin/bash
set -eu
cat -n tidb-cloud/pg-on-starter/pg-row-level-security.md | sed -n '323,353p'
cat -n tidb-cloud/pg-on-starter/pg-session-parameters.md | sed -n '118,145p'
printf '\n-- function search_path controls in Starter docs --\n'
rg -n -C 2 "CREATE FUNCTION|SET search_path|function-local|ALTER FUNCTION|SET clause|configuration parameter" tidb-cloud/pg-on-starter/pg-*.mdRepository: pingcap/docs
Length of output: 7234
Security Misconfiguration
Exploitability: Moderate
CWE: CWE-427
Schema-qualify the SECURITY DEFINER example. RETURNS SETOF posts is fixed when the function is created, so the caller's search_path does not redirect the return type. However, SELECT * FROM posts can resolve through the caller-controlled search path while running with the owner's privileges. Use the trusted schema for both references.
Use schema-qualified references
| A `CASE` expression, such as `NEW.status := CASE WHEN ... END`, can still be used in an assignment. | |
| ### AFTER trigger formatting | |
| In an `AFTER` trigger function, keep a bare `RETURN NEW;` or `RETURN OLD;` on its own line. | |
| For example: | |
| CREATE FUNCTION list_all_posts() | |
| RETURNS SETOF public.posts | |
| LANGUAGE SQL | |
| SECURITY DEFINER | |
| AS $$ | |
| SELECT * FROM public.posts | |
| $$; |
| | `INTEGER` | `INT`, `INT4` | 4-byte signed integer. | | ||
| | `BIGINT` | `INT8` | 8-byte signed integer. | | ||
| | `DOUBLE PRECISION` | `FLOAT8` | 8-byte IEEE 754 floating-point number. | | ||
| | `NUMERIC` | `NUMERIC(p,s)`, `DECIMAL` | Exact numeric value with optional precision and scale. | |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Move NUMERIC(p,s) out of the alias column.
NUMERIC(p,s) is parameterized type syntax, not a type alias. Listing it as an alias can mislead users about the accepted type name.
Apply this replacement
-| `NUMERIC` | `NUMERIC(p,s)`, `DECIMAL` | Exact numeric value with optional precision and scale. |
+| `NUMERIC` | `DECIMAL` | Exact numeric value. Use `NUMERIC(p,s)` to specify precision and scale. |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `NUMERIC` | `NUMERIC(p,s)`, `DECIMAL` | Exact numeric value with optional precision and scale. | | |
| | `NUMERIC` | `DECIMAL` | Exact numeric value. Use `NUMERIC(p,s)` to specify precision and scale. | |
Source: Path instructions
| JOIN information_schema.referential_constraints AS rc | ||
| ON rc.constraint_name = tc.constraint_name | ||
| AND rc.constraint_schema = tc.constraint_schema | ||
| JOIN information_schema.constraint_column_usage AS ccu | ||
| ON ccu.constraint_name = rc.unique_constraint_name |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Join foreign-key metadata by schema.
The query joins ccu to referential_constraints only by constraint name. Same-named constraints in different schemas can produce incorrect or duplicate referenced columns. Include the unique-constraint schema in the join.
Committable replacement
ON ccu.constraint_name = rc.unique_constraint_name
+ AND ccu.constraint_schema = rc.unique_constraint_schema📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| JOIN information_schema.referential_constraints AS rc | |
| ON rc.constraint_name = tc.constraint_name | |
| AND rc.constraint_schema = tc.constraint_schema | |
| JOIN information_schema.constraint_column_usage AS ccu | |
| ON ccu.constraint_name = rc.unique_constraint_name | |
| JOIN information_schema.referential_constraints AS rc | |
| ON rc.constraint_name = tc.constraint_name | |
| AND rc.constraint_schema = tc.constraint_schema | |
| JOIN information_schema.constraint_column_usage AS ccu | |
| ON ccu.constraint_name = rc.unique_constraint_name | |
| AND ccu.constraint_schema = rc.unique_constraint_schema |
Source: Path instructions
| You can configure HNSW index build parameters when creating an index: | ||
|
|
||
| ```sql | ||
| CREATE INDEX idx_documents_embedding |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Use a unique name for the tuned HNSW example.
The page already creates idx_documents_embedding in Lines [94-96]. Running this example afterward on the same documents table fails because the index name already exists.
Apply this replacement
-CREATE INDEX idx_documents_embedding
+CREATE INDEX idx_documents_embedding_tuned📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| CREATE INDEX idx_documents_embedding | |
| CREATE INDEX idx_documents_embedding_tuned |
Source: Path instructions
|
|
||
| Arbitrary custom or third-party PostgreSQL extensions cannot be installed. Only extensions explicitly supported by TiDB Cloud are available. | ||
|
|
||
| For the list of available extensions and extension-specific limitations, see [Supported PostgreSQL extensions](<link>). |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Replace the placeholder extension link.
The link target is a placeholder rather than a repository page. It will produce a broken link for the supported extensions reference.
Apply this replacement
-For the list of available extensions and extension-specific limitations, see [Supported PostgreSQL extensions](<link>).
+For the list of available extensions and extension-specific limitations, see [Supported PostgreSQL extensions](/tidb-cloud/pg-on-starter/pg-extensions-overview.md).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| For the list of available extensions and extension-specific limitations, see [Supported PostgreSQL extensions](<link>). | |
| For the list of available extensions and extension-specific limitations, see [Supported PostgreSQL extensions](/tidb-cloud/pg-on-starter/pg-extensions-overview.md). |
Source: Path instructions
|
|
||
| To learn more about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-cloud-starter-pricing-details/). | ||
|
|
||
| ### PostgreSQL-compatible Starter |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🏁 Script executed:
sed -n '48,62l' tidb-cloud/select-cluster-tier.md
sed -n '50,61l' tidb-cloud/pg-on-starter/pg-quickstart.md
rg -n "MD022|markdownlint" .markdownlint* scripts package.json 2>/dev/null | head -80Repository: pingcap/docs
Length of output: 3081
🏁 Script executed:
printf '%s\n' '--- .markdownlint.yaml ---'
cat -n .markdownlint.yaml
printf '%s\n' '--- scripts/markdownlint ---'
cat -n scripts/markdownlint
printf '%s\n' '--- relevant file context ---'
sed -n '52,59l' tidb-cloud/select-cluster-tier.md
sed -n '53,59l' tidb-cloud/pg-on-starter/pg-quickstart.mdRepository: pingcap/docs
Length of output: 3713
🏁 Script executed:
cat -n .markdownlint.yaml | sed -n '25,42p'
cat -n scripts/markdownlintRepository: pingcap/docs
Length of output: 1076
🏁 Script executed:
sed -n '1,50p' .markdownlint.yaml; printf '\n---\n'; cat scripts/markdownlintRepository: pingcap/docs
Length of output: 1220
🏁 Script executed:
printf '%s\n' '--- scoped markdownlint controls in changed files ---'
rg -n -i 'markdownlint-(disable|enable)|MD022|blanks-around-headings' tidb-cloud/select-cluster-tier.md tidb-cloud/pg-on-starter/pg-quickstart.md || true
printf '%s\n' '--- checked-in markdownlint-related files ---'
git ls-files | rg '(^|/)(\.markdownlint(ignore|ya?ml)|markdownlint(\.ya?ml)?|\.markdownlintignore)$' || trueRepository: pingcap/docs
Length of output: 271
Add blank lines after both changed headings.
Markdownlint MD022 is enabled and requires a blank line between a heading and the following block.
| ### PostgreSQL-compatible Starter | |
| ### PostgreSQL-compatible Starter | |
In tidb-cloud/pg-on-starter/pg-quickstart.md, apply the same change:
| ### PostgreSQL-compatible Starter | |
| ## What's next | |
🧰 Tools
🪛 markdownlint-cli2 (0.23.2)
[warning] 55-55: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
| - TiDB Cloud Starter | ||
|
|
||
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free quota and consumption based billing once free limits are exceeded. | ||
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling database with MySQL compatibility, while PostgreSQL compatibility is available in limited Public Preview. It offers a generous free quota and consumption based billing once free limits are exceeded. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Scope the billing statement to MySQL-compatible Starter.
The current wording implies that PostgreSQL-compatible Starter receives consumption-based billing after quota exhaustion. The other changed pages state that PostgreSQL-compatible Starter rejects new connections and throttles existing connections instead. Qualify the billing behavior to MySQL-compatible Starter.
Committable change
- {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling database with MySQL compatibility, while PostgreSQL compatibility is available in limited Public Preview. It offers a generous free quota and consumption based billing once free limits are exceeded.
+ {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling database with MySQL compatibility, while PostgreSQL compatibility is available in Limited Public Preview. MySQL-compatible {{{ .starter }}} offers a generous free quota and consumption-based billing once free limits are exceeded.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling database with MySQL compatibility, while PostgreSQL compatibility is available in limited Public Preview. It offers a generous free quota and consumption based billing once free limits are exceeded. | |
| {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling database with MySQL compatibility, while PostgreSQL compatibility is available in Limited Public Preview. MySQL-compatible {{{ .starter }}} offers a generous free quota and consumption-based billing once free limits are exceeded. |
🧰 Tools
🪛 LanguageTool
[grammar] ~79-~79: Use a hyphen to join words.
Context: ...rs a generous free quota and consumption based billing once free limits are excee...
(QB_NEW_EN_HYPHEN)
ti-chi-bot
Bot
removed
the
missing-translation-status
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: pingcap/docs/.coderabbit.yaml
Review profile: ASSERTIVE
Plan: Advanced
Run ID: 933ff1bb-f744-470c-afa6-fb14d68f3e75
📒 Files selected for processing (3)
tidb-cloud/connect-via-standard-connection-serverless.mdtidb-cloud/select-cluster-tier.mdtidb-cloud/tidb-cloud-intro.md
Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.
| > - PostgreSQL-compatible {{{ .starter }}} currently supports public endpoints only. Private endpoints are not supported. | ||
| > - For MySQL-compatible {{{ .starter }}} and {{{ .essential }}} instances, you can also choose **Private Endpoint** in the **Connection Type** drop-down list. For more information, see the following documents: |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
🔎 Supported by static analysis
🤖 get_repo_knowledge executed:
get_repo_knowledge pingcap/docs /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/learnings /tmp/coderabbit-repo-knowledge/pingcap-docs-9c73f70c/conventions
Length of output: 4069
🏁 Script executed:
#!/bin/bash
set -e
printf '%s\n' '--- tracked candidate files ---'
git ls-files 'tidb-cloud/*standard*connection*serverless*' 'tidb-cloud/*private*endpoint*serverless*' 'tidb-cloud/*branch*overview*' | sed -n '1,120p'
printf '%s\n' '--- cited source sections ---'
for f in \
tidb-cloud/connect-via-standard-connection-serverless.md \
tidb-cloud/set-up-private-endpoint-connections-serverless.md \
tidb-cloud/branch-overview.md
do
if [ -f "$f" ]; then
printf '\n### %s\n' "$f"
wc -l "$f"
rg -n -C 5 'PostgreSQL-compatible|MySQL-compatible|Private Endpoint|private endpoint|Starter|starter|branch|Branch' "$f" | sed -n '1,260p'
fi
done
printf '%s\n' '--- related Japanese paths and matching passages ---'
rg -l -i 'private.?endpoint|postgresql.?compatible|mysql.?compatible|branch' tidb-cloud | rg -i 'connect|private|branch|serverless|mysql|postgres' | sed -n '1,120p'
rg -n -i -C 3 'PostgreSQL-compatible|MySQL-compatible|Private Endpoint|private endpoint' tidb-cloud --glob '*.md' | sed -n '1,320p'Repository: pingcap/docs
Length of output: 50370
🏁 Script executed:
#!/bin/bash
set -e
printf '%s\n' '--- compatibility-specific restrictions ---'
rg -n -i -C 4 'PostgreSQL-compatible|MySQL-compatible|private endpoint|private endpoints|branch(es)?' tidb-cloud \
--glob '*.md' \
--glob '!connect-via-standard-connection-serverless.md' \
--glob '!set-up-private-endpoint-connections-serverless.md' \
--glob '!branch-overview.md' \
| rg -i -C 3 'PostgreSQL-compatible|MySQL-compatible|private endpoint|private endpoints|branch' \
| sed -n '1,260p'
printf '%s\n' '--- private guide focused sections ---'
sed -n '1,70p;137,151p' tidb-cloud/set-up-private-endpoint-connections-serverless.md
printf '%s\n' '--- branch guide focused sections ---'
sed -n '1,22p;38,50p' tidb-cloud/branch-overview.md
printf '%s\n' '--- compatibility overview ---'
sed -n '35,75p' tidb-cloud/select-cluster-tier.md
printf '%s\n' '--- branch management references ---'
rg -n -i -C 3 'PostgreSQL-compatible|MySQL-compatible|branch' tidb-cloud/branch-manage.md tidb-cloud/ticloud-branch-*.md tidb-cloud/terraform-use-serverless-branch-resource.md | sed -n '1,260p'Repository: pingcap/docs
Length of output: 50370
Update the linked guides with the compatibility restrictions.
tidb-cloud/set-up-private-endpoint-connections-serverless.md describes private endpoints for generic Starter instances, and tidb-cloud/branch-overview.md describes branches for generic Starter instances. State that these features apply to MySQL-compatible Starter, not PostgreSQL-compatible Starter. The English and Japanese links and the branch sentence already include the required qualification.
📍 Affects 1 file
tidb-cloud/connect-via-standard-connection-serverless.md#L36-L37(this comment)tidb-cloud/connect-via-standard-connection-serverless.md#L48-L49tidb-cloud/connect-via-standard-connection-serverless.md#L52-L55
Source: Path instructions
|
@qiqi-power: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
2 participants
First-time contributors' checklist
What is changed, added, or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit