diff --git a/TOC-tidb-cloud-essential.md b/TOC-tidb-cloud-essential.md new file mode 100644 index 0000000000000..5d2be85212058 --- /dev/null +++ b/TOC-tidb-cloud-essential.md @@ -0,0 +1,667 @@ + + + +# Table of Contents + +## GET STARTED + +- Why TiDB Cloud + - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) + - [MySQL Compatibility](/mysql-compatibility.md) +- Get Started with TiDB Cloud + - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) + - [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md) + - [Try Out HTAP](/tidb-cloud/tidb-cloud-htap-quickstart.md) + - [Try Out TiDB Cloud CLI](/tidb-cloud/get-started-with-cli.md) +- Key Concepts + - [Overview](/tidb-cloud/key-concepts.md) + - [Architecture](/tidb-cloud/architecture-concepts.md) + - [Database Schema](/tidb-cloud/database-schema-concepts.md) + - [Transactions](/tidb-cloud/transaction-concepts.md) + - [SQL](/tidb-cloud/sql-concepts.md) + - [AI Features](/tidb-cloud/ai-feature-concepts.md) + - [Scalability](/tidb-cloud/scalability-concepts.md) + - [High Availability](/tidb-cloud/serverless-high-availability.md) + - [Monitoring](/tidb-cloud/monitoring-concepts.md) + - [Backup & Restore](/tidb-cloud/backup-and-restore-concepts.md) + - [Security](/tidb-cloud/security-concepts.md) + +## DEVELOP + +- Development Quick Start + - [Developer Guide Overview](/develop/dev-guide-overview.md) + - [Build a TiDB Cloud Cluster](/develop/dev-guide-build-cluster-in-cloud.md) + - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) +- Connect to TiDB Cloud + - GUI Database Tools + - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md) + - [DBeaver](/develop/dev-guide-gui-dbeaver.md) + - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md) + - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md) + - [Navicat](/develop/dev-guide-gui-navicat.md) + - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md) + - BI + - [Looker Studio](/tidb-cloud/dev-guide-bi-looker-studio.md) + - Java + - [JDBC](/develop/dev-guide-sample-application-java-jdbc.md) + - [MyBatis](/develop/dev-guide-sample-application-java-mybatis.md) + - [Hibernate](/develop/dev-guide-sample-application-java-hibernate.md) + - [Spring Boot](/develop/dev-guide-sample-application-java-spring-boot.md) + - [Connection Pools and Connection Parameters](/develop/dev-guide-connection-parameters.md) + - Go + - [Go-MySQL-Driver](/develop/dev-guide-sample-application-golang-sql-driver.md) + - [GORM](/develop/dev-guide-sample-application-golang-gorm.md) + - Python + - [mysqlclient](/develop/dev-guide-sample-application-python-mysqlclient.md) + - [MySQL Connector/Python](/develop/dev-guide-sample-application-python-mysql-connector.md) + - [PyMySQL](/develop/dev-guide-sample-application-python-pymysql.md) + - [SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md) + - [peewee](/develop/dev-guide-sample-application-python-peewee.md) + - [Django](/develop/dev-guide-sample-application-python-django.md) + - Node.js + - [node-mysql2](/develop/dev-guide-sample-application-nodejs-mysql2.md) + - [mysql.js](/develop/dev-guide-sample-application-nodejs-mysqljs.md) + - [Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) + - [Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) + - [TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md) + - [Next.js](/develop/dev-guide-sample-application-nextjs.md) + - Ruby + - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md) + - [Rails](/develop/dev-guide-sample-application-ruby-rails.md) + - C# + - [C#](/develop/dev-guide-sample-application-cs.md) + - [WordPress](/tidb-cloud/dev-guide-wordpress.md) + - Serverless Driver ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [TiDB Cloud Serverless Driver](/tidb-cloud/serverless-driver.md) + - [Node.js Example](/tidb-cloud/serverless-driver-node-example.md) + - [Prisma Example](/tidb-cloud/serverless-driver-prisma-example.md) + - [Kysely Example](/tidb-cloud/serverless-driver-kysely-example.md) + - [Drizzle Example](/tidb-cloud/serverless-driver-drizzle-example.md) +- Development Reference + - Design Database Schema + - [Overview](/develop/dev-guide-schema-design-overview.md) + - [Create a Database](/develop/dev-guide-create-database.md) + - [Create a Table](/develop/dev-guide-create-table.md) + - [Create a Secondary Index](/develop/dev-guide-create-secondary-indexes.md) + - Write Data + - [Insert Data](/develop/dev-guide-insert-data.md) + - [Update Data](/develop/dev-guide-update-data.md) + - [Delete Data](/develop/dev-guide-delete-data.md) + - [Periodically Delete Expired Data Using TTL (Time to Live)](/time-to-live.md) + - [Prepared Statements](/develop/dev-guide-prepared-statement.md) + - Read Data + - [Query Data from a Single Table](/develop/dev-guide-get-data-from-single-table.md) + - [Multi-table Join Queries](/develop/dev-guide-join-tables.md) + - [Subquery](/develop/dev-guide-use-subqueries.md) + - [Paginate Results](/develop/dev-guide-paginate-results.md) + - [Views](/develop/dev-guide-use-views.md) + - [Temporary Tables](/develop/dev-guide-use-temporary-tables.md) + - [Common Table Expression](/develop/dev-guide-use-common-table-expression.md) + - Read Replica Data + - [Follower Read](/develop/dev-guide-use-follower-read.md) + - [Stale Read](/develop/dev-guide-use-stale-read.md) + - [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md) + - Transaction + - [Overview](/develop/dev-guide-transaction-overview.md) + - [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md) + - [Transaction Restraints](/develop/dev-guide-transaction-restraints.md) + - [Handle Transaction Errors](/develop/dev-guide-transaction-troubleshoot.md) + - Optimize + - [Overview](/develop/dev-guide-optimize-sql-overview.md) + - [SQL Performance Tuning](/develop/dev-guide-optimize-sql.md) + - [Best Practices for Performance Tuning](/develop/dev-guide-optimize-sql-best-practices.md) + - [Best Practices for Indexing](/develop/dev-guide-index-best-practice.md) + - Other Optimization Methods + - [Avoid Implicit Type Conversions](/develop/dev-guide-implicit-type-conversion.md) + - [Unique Serial Number Generation](/develop/dev-guide-unique-serial-number-generation.md) + - Troubleshoot + - [SQL or Transaction Issues](/develop/dev-guide-troubleshoot-overview.md) + - [Unstable Result Set](/develop/dev-guide-unstable-result-set.md) + - [Timeouts](/develop/dev-guide-timeouts-in-tidb.md) + - Development Guidelines + - [Object Naming Convention](/develop/dev-guide-object-naming-guidelines.md) + - [SQL Development Specifications](/develop/dev-guide-sql-development-specification.md) + - [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md) + - Third-Party Support + - [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md) + - [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md) + +## GUIDES + +- Manage Cluster + - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) + - Manage TiDB Cloud Clusters + - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - Connect to Your TiDB Cloud Cluster + - [Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) + - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) + - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) + - Branch ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/branch-overview.md) + - [Manage Branches](/tidb-cloud/branch-manage.md) + - [GitHub Integration](/tidb-cloud/branch-github-integration.md) + - [Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md) + - [Export Data from TiDB Cloud](/tidb-cloud/serverless-export.md) + - Use an HTAP Cluster with TiFlash + - [TiFlash Overview](/tiflash/tiflash-overview.md) + - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) + - [Read Data from TiFlash](/tiflash/use-tidb-to-read-tiflash.md) + - [Use MPP Mode](/tiflash/use-tiflash-mpp-mode.md) + - [Use FastScan](/tiflash/use-fastscan.md) + - [Supported Push-down Calculations](/tiflash/tiflash-supported-pushdown-calculations.md) + - [TiFlash Query Result Materialization](/tiflash/tiflash-results-materialization.md) + - [TiFlash Late Materialization](/tiflash/tiflash-late-materialization.md) + - [Compatibility](/tiflash/tiflash-compatibility.md) + - [Pipeline Execution Model](/tiflash/tiflash-pipeline-model.md) + - Monitor and Alert + - [Overview](/tidb-cloud/monitor-tidb-cluster.md) + - [Built-in Metrics](/tidb-cloud/built-in-monitoring.md) + - [Cluster Events](/tidb-cloud/tidb-cloud-events.md) + - Tune Performance + - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) + - [Analyze Performance](/tidb-cloud/tune-performance.md) + - SQL Tuning + - [Overview](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) + - Understanding the Query Execution Plan + - [Overview](/explain-overview.md) + - [`EXPLAIN` Walkthrough](/explain-walkthrough.md) + - [Indexes](/explain-indexes.md) + - [Joins](/explain-joins.md) + - [MPP Queries](/explain-mpp.md) + - [Subqueries](/explain-subqueries.md) + - [Aggregation](/explain-aggregation.md) + - [Views](/explain-views.md) + - [Partitions](/explain-partitions.md) + - [Index Merge](/explain-index-merge.md) + - SQL Optimization Process + - [Overview](/sql-optimization-concepts.md) + - Logic Optimization + - [Overview](/sql-logical-optimization.md) + - [Subquery Related Optimizations](/subquery-optimization.md) + - [Column Pruning](/column-pruning.md) + - [Decorrelation of Correlated Subquery](/correlated-subquery-optimization.md) + - [Eliminate Max/Min](/max-min-eliminate.md) + - [Predicates Push Down](/predicate-push-down.md) + - [Partition Pruning](/partition-pruning.md) + - [TopN and Limit Push Down](/topn-limit-push-down.md) + - [Join Reorder](/join-reorder.md) + - [Derive TopN or Limit from Window Functions](/derive-topn-from-window.md) + - Physical Optimization + - [Overview](/sql-physical-optimization.md) + - [Index Selection](/choose-index.md) + - [Statistics](/statistics.md) + - [Extended Statistics](/extended-statistics.md) + - [Wrong Index Solution](/wrong-index-solution.md) + - [Distinct Optimization](/agg-distinct-optimization.md) + - [Cost Model](/cost-model.md) + - [Runtime Filter](/runtime-filter.md) + - [Prepared Execution Plan Cache](/sql-prepared-plan-cache.md) + - [Non-Prepared Execution Plan Cache](/sql-non-prepared-plan-cache.md) + - Control Execution Plans + - [Overview](/control-execution-plan.md) + - [Optimizer Hints](/optimizer-hints.md) + - [SQL Plan Management](/sql-plan-management.md) + - [The Blocklist of Optimization Rules and Expression Pushdown](/blocklist-control-plan.md) + - [Optimizer Fix Controls](/optimizer-fix-controls.md) + - [TiKV Follower Read](/follower-read.md) + - [Coprocessor Cache](/coprocessor-cache.md) + - Garbage Collection (GC) + - [Overview](/garbage-collection-overview.md) + - [Configuration](/garbage-collection-configuration.md) + - [Tune TiFlash Performance](/tiflash/tune-tiflash-performance.md) + - [Upgrade a TiDB Cluster](/tidb-cloud/upgrade-tidb-cluster.md) + - [Delete a TiDB Cluster](/tidb-cloud/delete-tidb-cluster.md) +- Migrate or Import Data + - [Overview](/tidb-cloud/tidb-cloud-migration-overview.md) + - Migrate Data into TiDB Cloud + - [Migrate and Merge MySQL Shards of Large Datasets](/tidb-cloud/migrate-sql-shards.md) + - [Migrate from Amazon RDS for Oracle Using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md) + - Import Data into TiDB Cloud + - [Import Sample Data](/tidb-cloud/import-sample-data-serverless.md) + - [Import Local Files](/tidb-cloud/tidb-cloud-import-local-files.md) + - [Import CSV Files from Cloud Storage](/tidb-cloud/import-csv-files-serverless.md) + - [Import Parquet Files from Cloud Storage](/tidb-cloud/import-parquet-files-serverless.md) + - [Import with MySQL CLI](/tidb-cloud/import-with-mysql-cli-serverless.md) + - Reference + - [Configure External Storage Access for TiDB Cloud](/tidb-cloud/serverless-external-storage.md) + - [Naming Conventions for Data Import](/tidb-cloud/naming-conventions-for-data-import.md) + - [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md) + - [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md) +- Vector Search ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/vector-search/vector-search-overview.md) + - Get Started + - [Get Started with SQL](/vector-search/vector-search-get-started-using-sql.md) + - [Get Started with Python](/vector-search/vector-search-get-started-using-python.md) + - Integrations + - [Overview](/vector-search/vector-search-integration-overview.md) + - AI Frameworks + - [LlamaIndex](/vector-search/vector-search-integrate-with-llamaindex.md) + - [Langchain](/vector-search/vector-search-integrate-with-langchain.md) + - AI Services + - [Amazon Bedrock](/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md) + - Embedding Models/Services + - [Jina AI](/vector-search/vector-search-integrate-with-jinaai-embedding.md) + - ORM Libraries + - [SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md) + - [peewee](/vector-search/vector-search-integrate-with-peewee.md) + - [Django ORM](/vector-search/vector-search-integrate-with-django-orm.md) + - Reference + - [Vector Data Types](/vector-search/vector-search-data-types.md) + - [Vector Functions and Operators](/vector-search/vector-search-functions-and-operators.md) + - [Vector Index](/vector-search/vector-search-index.md) + - [Improve Performance](/vector-search/vector-search-improve-performance.md) + - [Limitations](/vector-search/vector-search-limitations.md) +- Security + - Identity Access Control + - [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) + - [Standard SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md) + - [Organization SSO Authentication](/tidb-cloud/tidb-cloud-org-sso-authentication.md) + - [Identity Access Management](/tidb-cloud/manage-user-access.md) + - [OAuth 2.0](/tidb-cloud/oauth2.md) + - Network Access Control + - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) + - [Configure Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md) + - [TLS Connections to TiDB Cloud](/tidb-cloud/secure-connections-to-serverless-clusters.md) + - Audit Management + - [Console Audit Logging](/tidb-cloud/tidb-cloud-console-auditing.md) +- Billing + - [Invoices](/tidb-cloud/tidb-cloud-billing.md#invoices) + - [Billing Details](/tidb-cloud/tidb-cloud-billing.md#billing-details) + - [Cost Explorer](/tidb-cloud/tidb-cloud-billing.md#cost-explorer) + - [Billing Profile](/tidb-cloud/tidb-cloud-billing.md#billing-profile) + - [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) + - [Payment Method Setting](/tidb-cloud/tidb-cloud-billing.md#payment-method) + - [Billing from Cloud Provider Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-cloud-provider-marketplace) + - [Manage Budgets](/tidb-cloud/tidb-cloud-budget.md) +- Integrations + - [Airbyte](/tidb-cloud/integrate-tidbcloud-with-airbyte.md) + - [Cloudflare](/tidb-cloud/integrate-tidbcloud-with-cloudflare.md) + - [dbt](/tidb-cloud/integrate-tidbcloud-with-dbt.md) + - [Gitpod](/develop/dev-guide-playground-gitpod.md) + - [n8n](/tidb-cloud/integrate-tidbcloud-with-n8n.md) + - [Netlify](/tidb-cloud/integrate-tidbcloud-with-netlify.md) + - [ProxySQL](/develop/dev-guide-proxysql-integration.md) + - Terraform + - [Terraform Integration Overview](/tidb-cloud/terraform-tidbcloud-provider-overview.md) + - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) + - [Use the `tidbcloud_serverless_cluster` Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md) + - [Use the `tidbcloud_serverless_branch` Resource](/tidb-cloud/terraform-use-serverless-branch-resource.md) + - [Use the `tidbcloud_serverless_export` Resource](/tidb-cloud/terraform-use-serverless-export-resource.md) + - [Use the `tidbcloud_sql_user` Resource](/tidb-cloud/terraform-use-sql-user-resource.md) + - [Use the `tidbcloud_import` Resource](/tidb-cloud/terraform-use-import-resource.md) + - [Migrate Cluster Resource](/tidb-cloud/terraform-migrate-cluster-resource.md) + - [Vercel](/tidb-cloud/integrate-tidbcloud-with-vercel.md) + - [Zapier](/tidb-cloud/integrate-tidbcloud-with-zapier.md) + +## REFERENCE + +- SQL Reference + - [Explore SQL with TiDB](/basic-sql-operations.md) + - SQL Language Structure and Syntax + - Attributes + - [AUTO_INCREMENT](/auto-increment.md) + - [AUTO_RANDOM](/auto-random.md) + - [SHARD_ROW_ID_BITS](/shard-row-id-bits.md) + - [Literal Values](/literal-values.md) + - [Schema Object Names](/schema-object-names.md) + - [Keywords and Reserved Words](/keywords.md) + - [User-Defined Variables](/user-defined-variables.md) + - [Expression Syntax](/expression-syntax.md) + - [Comment Syntax](/comment-syntax.md) + - SQL Statements + - [Overview](/sql-statements/sql-statement-overview.md) + - [`ADMIN`](/sql-statements/sql-statement-admin.md) + - [`ADMIN CANCEL DDL`](/sql-statements/sql-statement-admin-cancel-ddl.md) + - [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md) + - [`ADMIN CHECK [TABLE|INDEX]`](/sql-statements/sql-statement-admin-check-table-index.md) + - [`ADMIN CLEANUP INDEX`](/sql-statements/sql-statement-admin-cleanup.md) + - [`ADMIN PAUSE DDL`](/sql-statements/sql-statement-admin-pause-ddl.md) + - [`ADMIN RECOVER INDEX`](/sql-statements/sql-statement-admin-recover.md) + - [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md) + - [`ADMIN SHOW DDL [JOBS|JOB QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md) + - [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md) + - [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md) + - [`ALTER SEQUENCE`](/sql-statements/sql-statement-alter-sequence.md) + - `ALTER TABLE` + - [Overview](/sql-statements/sql-statement-alter-table.md) + - [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md) + - [`ADD INDEX`](/sql-statements/sql-statement-add-index.md) + - [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md) + - [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) + - [`COMPACT`](/sql-statements/sql-statement-alter-table-compact.md) + - [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md) + - [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md) + - [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) + - [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md) + - [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) + - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) + - [`BATCH`](/sql-statements/sql-statement-batch.md) + - [`BEGIN`](/sql-statements/sql-statement-begin.md) + - [`CANCEL IMPORT JOB`](/sql-statements/sql-statement-cancel-import-job.md) + - [`COMMIT`](/sql-statements/sql-statement-commit.md) + - [`CREATE [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-create-binding.md) + - [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md) + - [`CREATE INDEX`](/sql-statements/sql-statement-create-index.md) + - [`CREATE ROLE`](/sql-statements/sql-statement-create-role.md) + - [`CREATE SEQUENCE`](/sql-statements/sql-statement-create-sequence.md) + - [`CREATE TABLE LIKE`](/sql-statements/sql-statement-create-table-like.md) + - [`CREATE TABLE`](/sql-statements/sql-statement-create-table.md) + - [`CREATE USER`](/sql-statements/sql-statement-create-user.md) + - [`CREATE VIEW`](/sql-statements/sql-statement-create-view.md) + - [`DEALLOCATE`](/sql-statements/sql-statement-deallocate.md) + - [`DELETE`](/sql-statements/sql-statement-delete.md) + - [`DESC`](/sql-statements/sql-statement-desc.md) + - [`DESCRIBE`](/sql-statements/sql-statement-describe.md) + - [`DO`](/sql-statements/sql-statement-do.md) + - [`DROP [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-drop-binding.md) + - [`DROP DATABASE`](/sql-statements/sql-statement-drop-database.md) + - [`DROP ROLE`](/sql-statements/sql-statement-drop-role.md) + - [`DROP SEQUENCE`](/sql-statements/sql-statement-drop-sequence.md) + - [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) + - [`DROP TABLE`](/sql-statements/sql-statement-drop-table.md) + - [`DROP USER`](/sql-statements/sql-statement-drop-user.md) + - [`DROP VIEW`](/sql-statements/sql-statement-drop-view.md) + - [`EXECUTE`](/sql-statements/sql-statement-execute.md) + - [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md) + - [`EXPLAIN`](/sql-statements/sql-statement-explain.md) + - [`FLASHBACK CLUSTER`](/sql-statements/sql-statement-flashback-cluster.md) + - [`FLASHBACK DATABASE`](/sql-statements/sql-statement-flashback-database.md) + - [`FLASHBACK TABLE`](/sql-statements/sql-statement-flashback-table.md) + - [`FLUSH PRIVILEGES`](/sql-statements/sql-statement-flush-privileges.md) + - [`FLUSH STATUS`](/sql-statements/sql-statement-flush-status.md) + - [`FLUSH TABLES`](/sql-statements/sql-statement-flush-tables.md) + - [`GRANT `](/sql-statements/sql-statement-grant-privileges.md) + - [`GRANT `](/sql-statements/sql-statement-grant-role.md) + - [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) + - [`INSERT`](/sql-statements/sql-statement-insert.md) + - [`KILL [TIDB]`](/sql-statements/sql-statement-kill.md) + - [`LOAD DATA`](/sql-statements/sql-statement-load-data.md) + - [`LOCK STATS`](/sql-statements/sql-statement-lock-stats.md) + - [`LOCK TABLES` and `UNLOCK TABLES`](/sql-statements/sql-statement-lock-tables-and-unlock-tables.md) + - [`PREPARE`](/sql-statements/sql-statement-prepare.md) + - [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md) + - [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md) + - [`RENAME USER`](/sql-statements/sql-statement-rename-user.md) + - [`REPLACE`](/sql-statements/sql-statement-replace.md) + - [`REVOKE `](/sql-statements/sql-statement-revoke-privileges.md) + - [`REVOKE `](/sql-statements/sql-statement-revoke-role.md) + - [`ROLLBACK`](/sql-statements/sql-statement-rollback.md) + - [`SAVEPOINT`](/sql-statements/sql-statement-savepoint.md) + - [`SELECT`](/sql-statements/sql-statement-select.md) + - [`SET DEFAULT ROLE`](/sql-statements/sql-statement-set-default-role.md) + - [`SET [NAMES|CHARACTER SET]`](/sql-statements/sql-statement-set-names.md) + - [`SET PASSWORD`](/sql-statements/sql-statement-set-password.md) + - [`SET ROLE`](/sql-statements/sql-statement-set-role.md) + - [`SET TRANSACTION`](/sql-statements/sql-statement-set-transaction.md) + - [`SET [GLOBAL|SESSION] `](/sql-statements/sql-statement-set-variable.md) + - [`SHOW ANALYZE STATUS`](/sql-statements/sql-statement-show-analyze-status.md) + - [`SHOW [GLOBAL|SESSION] BINDINGS`](/sql-statements/sql-statement-show-bindings.md) + - [`SHOW BUILTINS`](/sql-statements/sql-statement-show-builtins.md) + - [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md) + - [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md) + - [`SHOW COLUMN_STATS_USAGE`](/sql-statements/sql-statement-show-column-stats-usage.md) + - [`SHOW COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md) + - [`SHOW CREATE DATABASE`](/sql-statements/sql-statement-show-create-database.md) + - [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md) + - [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md) + - [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md) + - [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) + - [`SHOW ENGINES`](/sql-statements/sql-statement-show-engines.md) + - [`SHOW ERRORS`](/sql-statements/sql-statement-show-errors.md) + - [`SHOW FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md) + - [`SHOW GRANTS`](/sql-statements/sql-statement-show-grants.md) + - [`SHOW IMPORT JOB`](/sql-statements/sql-statement-show-import-job.md) + - [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md) + - [`SHOW MASTER STATUS`](/sql-statements/sql-statement-show-master-status.md) + - [`SHOW PRIVILEGES`](/sql-statements/sql-statement-show-privileges.md) + - [`SHOW PROCESSLIST`](/sql-statements/sql-statement-show-processlist.md) + - [`SHOW PROFILES`](/sql-statements/sql-statement-show-profiles.md) + - [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md) + - [`SHOW STATS_BUCKETS`](/sql-statements/sql-statement-show-stats-buckets.md) + - [`SHOW STATS_HEALTHY`](/sql-statements/sql-statement-show-stats-healthy.md) + - [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-stats-histograms.md) + - [`SHOW STATS_LOCKED`](/sql-statements/sql-statement-show-stats-locked.md) + - [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md) + - [`SHOW STATS_TOPN`](/sql-statements/sql-statement-show-stats-topn.md) + - [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md) + - [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md) + - [`SHOW TABLE STATUS`](/sql-statements/sql-statement-show-table-status.md) + - [`SHOW TABLES`](/sql-statements/sql-statement-show-tables.md) + - [`SHOW [GLOBAL|SESSION] VARIABLES`](/sql-statements/sql-statement-show-variables.md) + - [`SHOW WARNINGS`](/sql-statements/sql-statement-show-warnings.md) + - [`START TRANSACTION`](/sql-statements/sql-statement-start-transaction.md) + - [`TABLE`](/sql-statements/sql-statement-table.md) + - [`TRACE`](/sql-statements/sql-statement-trace.md) + - [`TRUNCATE`](/sql-statements/sql-statement-truncate.md) + - [`UNLOCK STATS`](/sql-statements/sql-statement-unlock-stats.md) + - [`UPDATE`](/sql-statements/sql-statement-update.md) + - [`USE`](/sql-statements/sql-statement-use.md) + - [`WITH`](/sql-statements/sql-statement-with.md) + - Data Types + - [Overview](/data-type-overview.md) + - [Default Values](/data-type-default-values.md) + - [Numeric Types](/data-type-numeric.md) + - [Date and Time Types](/data-type-date-and-time.md) + - [String Types](/data-type-string.md) + - [JSON Type](/data-type-json.md) + - Functions and Operators + - [Overview](/functions-and-operators/functions-and-operators-overview.md) + - [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md) + - [Operators](/functions-and-operators/operators.md) + - [Control Flow Functions](/functions-and-operators/control-flow-functions.md) + - [String Functions](/functions-and-operators/string-functions.md) + - [Numeric Functions and Operators](/functions-and-operators/numeric-functions-and-operators.md) + - [Date and Time Functions](/functions-and-operators/date-and-time-functions.md) + - [Bit Functions and Operators](/functions-and-operators/bit-functions-and-operators.md) + - [Cast Functions and Operators](/functions-and-operators/cast-functions-and-operators.md) + - [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md) + - [Locking Functions](/functions-and-operators/locking-functions.md) + - [Information Functions](/functions-and-operators/information-functions.md) + - JSON Functions + - [Overview](/functions-and-operators/json-functions.md) + - [Functions That Create JSON](/functions-and-operators/json-functions/json-functions-create.md) + - [Functions That Search JSON](/functions-and-operators/json-functions/json-functions-search.md) + - [Functions That Modify JSON](/functions-and-operators/json-functions/json-functions-modify.md) + - [Functions That Return JSON](/functions-and-operators/json-functions/json-functions-return.md) + - [JSON Utility Functions](/functions-and-operators/json-functions/json-functions-utility.md) + - [Functions That Aggregate JSON](/functions-and-operators/json-functions/json-functions-aggregate.md) + - [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md) + - [GROUP BY Modifiers](/functions-and-operators/group-by-modifier.md) + - [Window Functions](/functions-and-operators/window-functions.md) + - [Miscellaneous Functions](/functions-and-operators/miscellaneous-functions.md) + - [Precision Math](/functions-and-operators/precision-math.md) + - [Set Operations](/functions-and-operators/set-operators.md) + - [Sequence Functions](/functions-and-operators/sequence-functions.md) + - [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) + - [TiDB Specific Functions](/functions-and-operators/tidb-functions.md) + - [Clustered Indexes](/clustered-indexes.md) + - [Constraints](/constraints.md) + - [Generated Columns](/generated-columns.md) + - [SQL Mode](/sql-mode.md) + - [Table Attributes](/table-attributes.md) + - Transactions + - [Overview](/transaction-overview.md) + - [Isolation Levels](/transaction-isolation-levels.md) + - [Optimistic Transactions](/optimistic-transaction.md) + - [Pessimistic Transactions](/pessimistic-transaction.md) + - [Non-Transactional DML Statements](/non-transactional-dml.md) + - [Views](/views.md) + - [Partitioning](/partitioned-table.md) + - [Temporary Tables](/temporary-tables.md) + - [Cached Tables](/cached-tables.md) + - [FOREIGN KEY Constraints](/foreign-key.md) + - Character Set and Collation + - [Overview](/character-set-and-collation.md) + - [GBK](/character-set-gbk.md) + - Read Historical Data + - Use Stale Read (Recommended) + - [Usage Scenarios of Stale Read](/stale-read.md) + - [Perform Stale Read Using `As OF TIMESTAMP`](/as-of-timestamp.md) + - [Perform Stale Read Using `tidb_read_staleness`](/tidb-read-staleness.md) + - [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md) + - [Use the `tidb_snapshot` System Variable](/read-historical-data.md) + - System Tables + - `mysql` Schema + - [Overview](/mysql-schema/mysql-schema.md) + - [`user`](/mysql-schema/mysql-schema-user.md) + - INFORMATION_SCHEMA + - [Overview](/information-schema/information-schema.md) + - [`ANALYZE_STATUS`](/information-schema/information-schema-analyze-status.md) + - [`CHECK_CONSTRAINTS`](/information-schema/information-schema-check-constraints.md) + - [`CLIENT_ERRORS_SUMMARY_BY_HOST`](/information-schema/client-errors-summary-by-host.md) + - [`CLIENT_ERRORS_SUMMARY_BY_USER`](/information-schema/client-errors-summary-by-user.md) + - [`CLIENT_ERRORS_SUMMARY_GLOBAL`](/information-schema/client-errors-summary-global.md) + - [`CHARACTER_SETS`](/information-schema/information-schema-character-sets.md) + - [`COLLATIONS`](/information-schema/information-schema-collations.md) + - [`COLLATION_CHARACTER_SET_APPLICABILITY`](/information-schema/information-schema-collation-character-set-applicability.md) + - [`COLUMNS`](/information-schema/information-schema-columns.md) + - [`DATA_LOCK_WAITS`](/information-schema/information-schema-data-lock-waits.md) + - [`DDL_JOBS`](/information-schema/information-schema-ddl-jobs.md) + - [`DEADLOCKS`](/information-schema/information-schema-deadlocks.md) + - [`ENGINES`](/information-schema/information-schema-engines.md) + - [`KEYWORDS`](/information-schema/information-schema-keywords.md) + - [`KEY_COLUMN_USAGE`](/information-schema/information-schema-key-column-usage.md) + - [`MEMORY_USAGE`](/information-schema/information-schema-memory-usage.md) + - [`MEMORY_USAGE_OPS_HISTORY`](/information-schema/information-schema-memory-usage-ops-history.md) + - [`PARTITIONS`](/information-schema/information-schema-partitions.md) + - [`PROCESSLIST`](/information-schema/information-schema-processlist.md) + - [`REFERENTIAL_CONSTRAINTS`](/information-schema/information-schema-referential-constraints.md) + - [`SCHEMATA`](/information-schema/information-schema-schemata.md) + - [`SEQUENCES`](/information-schema/information-schema-sequences.md) + - [`SESSION_VARIABLES`](/information-schema/information-schema-session-variables.md) + - [`STATISTICS`](/information-schema/information-schema-statistics.md) + - [`TABLES`](/information-schema/information-schema-tables.md) + - [`TABLE_CONSTRAINTS`](/information-schema/information-schema-table-constraints.md) + - [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) + - [`TIDB_CHECK_CONSTRAINTS`](/information-schema/information-schema-tidb-check-constraints.md) + - [`TIDB_INDEXES`](/information-schema/information-schema-tidb-indexes.md) + - [`TIDB_INDEX_USAGE`](/information-schema/information-schema-tidb-index-usage.md) + - [`TIDB_TRX`](/information-schema/information-schema-tidb-trx.md) + - [`TIFLASH_REPLICA`](/information-schema/information-schema-tiflash-replica.md) + - [`TIFLASH_SEGMENTS`](/information-schema/information-schema-tiflash-segments.md) + - [`TIFLASH_TABLES`](/information-schema/information-schema-tiflash-tables.md) + - [`USER_ATTRIBUTES`](/information-schema/information-schema-user-attributes.md) + - [`USER_PRIVILEGES`](/information-schema/information-schema-user-privileges.md) + - [`VARIABLES_INFO`](/information-schema/information-schema-variables-info.md) + - [`VIEWS`](/information-schema/information-schema-views.md) + - PERFORMANCE_SCHEMA + - [Overview](/performance-schema/performance-schema.md) + - [`SESSION_CONNECT_ATTRS`](/performance-schema/performance-schema-session-connect-attrs.md) + - SYS + - [Overview](/sys-schema/sys-schema.md) + - [`schema_unused_indexes`](/sys-schema/sys-schema-unused-indexes.md) + - [Metadata Lock](/metadata-lock.md) + - [Use UUIDs](/best-practices/uuid.md) + - [TiDB Accelerated Table Creation](/accelerated-table-creation.md) +- API Reference ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/api-overview.md) + - v1beta1 + - [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing) + - [IAM](https://docs.pingcap.com/tidbcloud/api/v1beta1/iam) + - [MSP (Deprecated)](https://docs.pingcap.com/tidbcloud/api/v1beta1/msp) + - [v1beta](https://docs.pingcap.com/tidbcloud/api/v1beta) +- CLI Reference ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/cli-reference.md) + - auth + - [login](/tidb-cloud/ticloud-auth-login.md) + - [logout](/tidb-cloud/ticloud-auth-logout.md) + - [whoami](/tidb-cloud/ticloud-auth-whoami.md) + - serverless + - [capacity](/tidb-cloud/ticloud-serverless-capacity.md) + - [create](/tidb-cloud/ticloud-cluster-create.md) + - [delete](/tidb-cloud/ticloud-cluster-delete.md) + - [describe](/tidb-cloud/ticloud-cluster-describe.md) + - [list](/tidb-cloud/ticloud-cluster-list.md) + - [update](/tidb-cloud/ticloud-serverless-update.md) + - [spending-limit](/tidb-cloud/ticloud-serverless-spending-limit.md) + - [region](/tidb-cloud/ticloud-serverless-region.md) + - [shell](/tidb-cloud/ticloud-serverless-shell.md) + - branch + - [create](/tidb-cloud/ticloud-branch-create.md) + - [delete](/tidb-cloud/ticloud-branch-delete.md) + - [describe](/tidb-cloud/ticloud-branch-describe.md) + - [list](/tidb-cloud/ticloud-branch-list.md) + - [shell](/tidb-cloud/ticloud-branch-shell.md) + - import + - [cancel](/tidb-cloud/ticloud-import-cancel.md) + - [describe](/tidb-cloud/ticloud-import-describe.md) + - [list](/tidb-cloud/ticloud-import-list.md) + - [start](/tidb-cloud/ticloud-import-start.md) + - export + - [create](/tidb-cloud/ticloud-serverless-export-create.md) + - [describe](/tidb-cloud/ticloud-serverless-export-describe.md) + - [list](/tidb-cloud/ticloud-serverless-export-list.md) + - [cancel](/tidb-cloud/ticloud-serverless-export-cancel.md) + - [download](/tidb-cloud/ticloud-serverless-export-download.md) + - sql-user + - [create](/tidb-cloud/ticloud-serverless-sql-user-create.md) + - [delete](/tidb-cloud/ticloud-serverless-sql-user-delete.md) + - [list](/tidb-cloud/ticloud-serverless-sql-user-list.md) + - [update](/tidb-cloud/ticloud-serverless-sql-user-update.md) + - authorized-network + - [create](/tidb-cloud/ticloud-serverless-authorized-network-create.md) + - [delete](/tidb-cloud/ticloud-serverless-authorized-network-delete.md) + - [list](/tidb-cloud/ticloud-serverless-authorized-network-list.md) + - [update](/tidb-cloud/ticloud-serverless-authorized-network-update.md) + - [ai](/tidb-cloud/ticloud-ai.md) + - [completion](/tidb-cloud/ticloud-completion.md) + - config + - [create](/tidb-cloud/ticloud-config-create.md) + - [delete](/tidb-cloud/ticloud-config-delete.md) + - [describe](/tidb-cloud/ticloud-config-describe.md) + - [edit](/tidb-cloud/ticloud-config-edit.md) + - [list](/tidb-cloud/ticloud-config-list.md) + - [set](/tidb-cloud/ticloud-config-set.md) + - [use](/tidb-cloud/ticloud-config-use.md) + - project + - [list](/tidb-cloud/ticloud-project-list.md) + - [upgrade](/tidb-cloud/ticloud-upgrade.md) + - [help](/tidb-cloud/ticloud-help.md) +- General Reference + - TiDB Cluster Architecture + - [Overview](/tidb-architecture.md) + - [Storage](/tidb-storage.md) + - [Computing](/tidb-computing.md) + - [Scheduling](/tidb-scheduling.md) + - [TSO](/tso.md) + - Storage Engines + - TiKV + - [TiKV Overview](/tikv-overview.md) + - [RocksDB Overview](/storage-engine/rocksdb-overview.md) + - TiFlash + - [TiFlash Overview](/tiflash/tiflash-overview.md) + - [Spill to Disk](/tiflash/tiflash-spill-disk.md) + - TiDB Cloud Partner Web Console + - [TiDB Cloud Partners](/tidb-cloud/tidb-cloud-partners.md) + - [MSP Customer](/tidb-cloud/managed-service-provider-customer.md) + - [Reseller's Customer](/tidb-cloud/cppo-customer.md) + - [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md) + - [Limited SQL Features on TiDB Cloud](/tidb-cloud/limited-sql-features.md) + - [TiDB Limitations](/tidb-limitations.md) + - [System Variables](/system-variables.md) + - [Server Status Variables](/status-variables.md) + - [Table Filter](/table-filter.md) + - [URI Formats of External Storage Services](/external-storage-uri.md) + - [DDL Execution Principles and Best Practices](/ddl-introduction.md) + - [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md) + - [Notifications](/tidb-cloud/notifications.md) + - [Glossary](/tidb-cloud/tidb-cloud-glossary.md) +- Support Plan + - [Connected Care Overview](/tidb-cloud/connected-care-overview.md) + - [Connected Care Details](/tidb-cloud/connected-care-detail.md) + - Connected Care Support Service Features + - [Connected: AI Chat in IM](/tidb-cloud/connected-ai-chat-in-im.md) + - Connected: IM Ticket Creation and Update Subscription + - [Create Tickets and Subscribe to Ticket Updates via Slack](/tidb-cloud/connected-slack-ticket-creation.md) + - [Create Tickets and Subscribe to Ticket Updates via Lark](/tidb-cloud/connected-lark-ticket-creation.md) + - Connected: IM Interaction for Support Tickets + - [Interact with Support Tickets via Slack](/tidb-cloud/connected-slack-ticket-interaction.md) + - [Interact with Support Tickets via Lark](/tidb-cloud/connected-lark-ticket-interaction.md) + - [Get Support](/tidb-cloud/tidb-cloud-support.md) +- FAQs + - [TiDB Cloud FAQs](/tidb-cloud/tidb-cloud-faq.md) + +## RELEASES + +- Release Notes + - [2025](/tidb-cloud/tidb-cloud-release-notes.md) diff --git a/TOC-tidb-cloud-starter.md b/TOC-tidb-cloud-starter.md new file mode 100644 index 0000000000000..414d82feb58a6 --- /dev/null +++ b/TOC-tidb-cloud-starter.md @@ -0,0 +1,696 @@ + + + +# Table of Contents + +## GET STARTED + +- Why TiDB Cloud + - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) + - [MySQL Compatibility](/mysql-compatibility.md) +- Get Started with TiDB Cloud + - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) + - [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md) + - [Try Out HTAP](/tidb-cloud/tidb-cloud-htap-quickstart.md) + - [Try Out TiDB Cloud CLI](/tidb-cloud/get-started-with-cli.md) +- Key Concepts + - [Overview](/tidb-cloud/key-concepts.md) + - [Architecture](/tidb-cloud/architecture-concepts.md) + - [Database Schema](/tidb-cloud/database-schema-concepts.md) + - [Transactions](/tidb-cloud/transaction-concepts.md) + - [SQL](/tidb-cloud/sql-concepts.md) + - [AI Features](/tidb-cloud/ai-feature-concepts.md) + - [Data Service](/tidb-cloud/data-service-concepts.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Scalability](/tidb-cloud/scalability-concepts.md) + - [High Availability](/tidb-cloud/serverless-high-availability.md) + - [Monitoring](/tidb-cloud/monitoring-concepts.md) + - [Backup & Restore](/tidb-cloud/backup-and-restore-concepts.md) + - [Security](/tidb-cloud/security-concepts.md) + +## DEVELOP + +- Development Quick Start + - [Developer Guide Overview](/develop/dev-guide-overview.md) + - [Build a TiDB Cloud Cluster](/develop/dev-guide-build-cluster-in-cloud.md) + - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) +- Connect to TiDB Cloud + - GUI Database Tools + - [JetBrains DataGrip](/develop/dev-guide-gui-datagrip.md) + - [DBeaver](/develop/dev-guide-gui-dbeaver.md) + - [VS Code](/develop/dev-guide-gui-vscode-sqltools.md) + - [MySQL Workbench](/develop/dev-guide-gui-mysql-workbench.md) + - [Navicat](/develop/dev-guide-gui-navicat.md) + - [Choose Driver or ORM](/develop/dev-guide-choose-driver-or-orm.md) + - BI + - [Looker Studio](/tidb-cloud/dev-guide-bi-looker-studio.md) + - Java + - [JDBC](/develop/dev-guide-sample-application-java-jdbc.md) + - [MyBatis](/develop/dev-guide-sample-application-java-mybatis.md) + - [Hibernate](/develop/dev-guide-sample-application-java-hibernate.md) + - [Spring Boot](/develop/dev-guide-sample-application-java-spring-boot.md) + - [Connection Pools and Connection Parameters](/develop/dev-guide-connection-parameters.md) + - Go + - [Go-MySQL-Driver](/develop/dev-guide-sample-application-golang-sql-driver.md) + - [GORM](/develop/dev-guide-sample-application-golang-gorm.md) + - Python + - [mysqlclient](/develop/dev-guide-sample-application-python-mysqlclient.md) + - [MySQL Connector/Python](/develop/dev-guide-sample-application-python-mysql-connector.md) + - [PyMySQL](/develop/dev-guide-sample-application-python-pymysql.md) + - [SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md) + - [peewee](/develop/dev-guide-sample-application-python-peewee.md) + - [Django](/develop/dev-guide-sample-application-python-django.md) + - Node.js + - [node-mysql2](/develop/dev-guide-sample-application-nodejs-mysql2.md) + - [mysql.js](/develop/dev-guide-sample-application-nodejs-mysqljs.md) + - [Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) + - [Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) + - [TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md) + - [Next.js](/develop/dev-guide-sample-application-nextjs.md) + - [AWS Lambda](/develop/dev-guide-sample-application-aws-lambda.md) + - Ruby + - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md) + - [Rails](/develop/dev-guide-sample-application-ruby-rails.md) + - C# + - [C#](/develop/dev-guide-sample-application-cs.md) + - [WordPress](/tidb-cloud/dev-guide-wordpress.md) + - Serverless Driver ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [TiDB Cloud Serverless Driver](/tidb-cloud/serverless-driver.md) + - [Node.js Example](/tidb-cloud/serverless-driver-node-example.md) + - [Prisma Example](/tidb-cloud/serverless-driver-prisma-example.md) + - [Kysely Example](/tidb-cloud/serverless-driver-kysely-example.md) + - [Drizzle Example](/tidb-cloud/serverless-driver-drizzle-example.md) +- Development Reference + - Design Database Schema + - [Overview](/develop/dev-guide-schema-design-overview.md) + - [Create a Database](/develop/dev-guide-create-database.md) + - [Create a Table](/develop/dev-guide-create-table.md) + - [Create a Secondary Index](/develop/dev-guide-create-secondary-indexes.md) + - Write Data + - [Insert Data](/develop/dev-guide-insert-data.md) + - [Update Data](/develop/dev-guide-update-data.md) + - [Delete Data](/develop/dev-guide-delete-data.md) + - [Periodically Delete Expired Data Using TTL (Time to Live)](/time-to-live.md) + - [Prepared Statements](/develop/dev-guide-prepared-statement.md) + - Read Data + - [Query Data from a Single Table](/develop/dev-guide-get-data-from-single-table.md) + - [Multi-table Join Queries](/develop/dev-guide-join-tables.md) + - [Subquery](/develop/dev-guide-use-subqueries.md) + - [Paginate Results](/develop/dev-guide-paginate-results.md) + - [Views](/develop/dev-guide-use-views.md) + - [Temporary Tables](/develop/dev-guide-use-temporary-tables.md) + - [Common Table Expression](/develop/dev-guide-use-common-table-expression.md) + - Read Replica Data + - [Follower Read](/develop/dev-guide-use-follower-read.md) + - [Stale Read](/develop/dev-guide-use-stale-read.md) + - [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md) + - Transaction + - [Overview](/develop/dev-guide-transaction-overview.md) + - [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md) + - [Transaction Restraints](/develop/dev-guide-transaction-restraints.md) + - [Handle Transaction Errors](/develop/dev-guide-transaction-troubleshoot.md) + - Optimize + - [Overview](/develop/dev-guide-optimize-sql-overview.md) + - [SQL Performance Tuning](/develop/dev-guide-optimize-sql.md) + - [Best Practices for Performance Tuning](/develop/dev-guide-optimize-sql-best-practices.md) + - [Best Practices for Indexing](/develop/dev-guide-index-best-practice.md) + - Other Optimization Methods + - [Avoid Implicit Type Conversions](/develop/dev-guide-implicit-type-conversion.md) + - [Unique Serial Number Generation](/develop/dev-guide-unique-serial-number-generation.md) + - Troubleshoot + - [SQL or Transaction Issues](/develop/dev-guide-troubleshoot-overview.md) + - [Unstable Result Set](/develop/dev-guide-unstable-result-set.md) + - [Timeouts](/develop/dev-guide-timeouts-in-tidb.md) + - Development Guidelines + - [Object Naming Convention](/develop/dev-guide-object-naming-guidelines.md) + - [SQL Development Specifications](/develop/dev-guide-sql-development-specification.md) + - [Bookshop Example Application](/develop/dev-guide-bookshop-schema-design.md) + - Third-Party Support + - [Third-Party Tools Supported by TiDB](/develop/dev-guide-third-party-support.md) + - [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md) + +## GUIDES + +- Manage Cluster + - [Select Your Cluster Tier](/tidb-cloud/select-cluster-tier.md) + - Manage TiDB Cloud Clusters + - [Create a TiDB Cloud Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - Connect to Your TiDB Cloud Cluster + - [Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) + - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) + - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) + - Branch ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/branch-overview.md) + - [Manage Branches](/tidb-cloud/branch-manage.md) + - [GitHub Integration](/tidb-cloud/branch-github-integration.md) + - [Manage Spending Limit](/tidb-cloud/manage-serverless-spend-limit.md) + - [Back Up and Restore TiDB Cloud Data](/tidb-cloud/backup-and-restore-serverless.md) + - [Export Data from TiDB Cloud](/tidb-cloud/serverless-export.md) + - Use an HTAP Cluster with TiFlash + - [TiFlash Overview](/tiflash/tiflash-overview.md) + - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) + - [Read Data from TiFlash](/tiflash/use-tidb-to-read-tiflash.md) + - [Use MPP Mode](/tiflash/use-tiflash-mpp-mode.md) + - [Use FastScan](/tiflash/use-fastscan.md) + - [Supported Push-down Calculations](/tiflash/tiflash-supported-pushdown-calculations.md) + - [TiFlash Query Result Materialization](/tiflash/tiflash-results-materialization.md) + - [TiFlash Late Materialization](/tiflash/tiflash-late-materialization.md) + - [Compatibility](/tiflash/tiflash-compatibility.md) + - [Pipeline Execution Model](/tiflash/tiflash-pipeline-model.md) + - Monitor and Alert + - [Overview](/tidb-cloud/monitor-tidb-cluster.md) + - [Built-in Metrics](/tidb-cloud/built-in-monitoring.md) + - [Cluster Events](/tidb-cloud/tidb-cloud-events.md) + - Tune Performance + - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) + - [Analyze Performance](/tidb-cloud/tune-performance.md) + - SQL Tuning + - [Overview](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) + - Understanding the Query Execution Plan + - [Overview](/explain-overview.md) + - [`EXPLAIN` Walkthrough](/explain-walkthrough.md) + - [Indexes](/explain-indexes.md) + - [Joins](/explain-joins.md) + - [MPP Queries](/explain-mpp.md) + - [Subqueries](/explain-subqueries.md) + - [Aggregation](/explain-aggregation.md) + - [Views](/explain-views.md) + - [Partitions](/explain-partitions.md) + - [Index Merge](/explain-index-merge.md) + - SQL Optimization Process + - [Overview](/sql-optimization-concepts.md) + - Logic Optimization + - [Overview](/sql-logical-optimization.md) + - [Subquery Related Optimizations](/subquery-optimization.md) + - [Column Pruning](/column-pruning.md) + - [Decorrelation of Correlated Subquery](/correlated-subquery-optimization.md) + - [Eliminate Max/Min](/max-min-eliminate.md) + - [Predicates Push Down](/predicate-push-down.md) + - [Partition Pruning](/partition-pruning.md) + - [TopN and Limit Push Down](/topn-limit-push-down.md) + - [Join Reorder](/join-reorder.md) + - [Derive TopN or Limit from Window Functions](/derive-topn-from-window.md) + - Physical Optimization + - [Overview](/sql-physical-optimization.md) + - [Index Selection](/choose-index.md) + - [Statistics](/statistics.md) + - [Extended Statistics](/extended-statistics.md) + - [Wrong Index Solution](/wrong-index-solution.md) + - [Distinct Optimization](/agg-distinct-optimization.md) + - [Cost Model](/cost-model.md) + - [Runtime Filter](/runtime-filter.md) + - [Prepared Execution Plan Cache](/sql-prepared-plan-cache.md) + - [Non-Prepared Execution Plan Cache](/sql-non-prepared-plan-cache.md) + - Control Execution Plans + - [Overview](/control-execution-plan.md) + - [Optimizer Hints](/optimizer-hints.md) + - [SQL Plan Management](/sql-plan-management.md) + - [The Blocklist of Optimization Rules and Expression Pushdown](/blocklist-control-plan.md) + - [Optimizer Fix Controls](/optimizer-fix-controls.md) + - [TiKV Follower Read](/follower-read.md) + - [Coprocessor Cache](/coprocessor-cache.md) + - Garbage Collection (GC) + - [Overview](/garbage-collection-overview.md) + - [Configuration](/garbage-collection-configuration.md) + - [Tune TiFlash Performance](/tiflash/tune-tiflash-performance.md) + - [Upgrade a TiDB Cluster](/tidb-cloud/upgrade-tidb-cluster.md) + - [Delete a TiDB Cluster](/tidb-cloud/delete-tidb-cluster.md) +- Migrate or Import Data + - [Overview](/tidb-cloud/tidb-cloud-migration-overview.md) + - Migrate Data into TiDB Cloud + - [Migrate and Merge MySQL Shards of Large Datasets](/tidb-cloud/migrate-sql-shards.md) + - [Migrate from Amazon RDS for Oracle Using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md) + - Import Data into TiDB Cloud + - [Import Sample Data](/tidb-cloud/import-sample-data-serverless.md) + - [Import Local Files](/tidb-cloud/tidb-cloud-import-local-files.md) + - [Import CSV Files from Cloud Storage](/tidb-cloud/import-csv-files-serverless.md) + - [Import Parquet Files from Cloud Storage](/tidb-cloud/import-parquet-files-serverless.md) + - [Import with MySQL CLI](/tidb-cloud/import-with-mysql-cli-serverless.md) + - Reference + - [Configure External Storage Access for TiDB Cloud](/tidb-cloud/serverless-external-storage.md) + - [Naming Conventions for Data Import](/tidb-cloud/naming-conventions-for-data-import.md) + - [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md) + - [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md) + - [Connect AWS DMS to TiDB Cloud clusters](/tidb-cloud/tidb-cloud-connect-aws-dms.md) +- Explore Data + - [Chat2Query in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [SQL Proxy Account](/tidb-cloud/sql-proxy-account.md) +- Vector Search ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/vector-search/vector-search-overview.md) + - Get Started + - [Get Started with SQL](/vector-search/vector-search-get-started-using-sql.md) + - [Get Started with Python](/vector-search/vector-search-get-started-using-python.md) + - Integrations + - [Overview](/vector-search/vector-search-integration-overview.md) + - AI Frameworks + - [LlamaIndex](/vector-search/vector-search-integrate-with-llamaindex.md) + - [Langchain](/vector-search/vector-search-integrate-with-langchain.md) + - AI Services + - [Amazon Bedrock](/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md) + - Embedding Models/Services + - [Jina AI](/vector-search/vector-search-integrate-with-jinaai-embedding.md) + - ORM Libraries + - [SQLAlchemy](/vector-search/vector-search-integrate-with-sqlalchemy.md) + - [peewee](/vector-search/vector-search-integrate-with-peewee.md) + - [Django ORM](/vector-search/vector-search-integrate-with-django-orm.md) + - Reference + - [Vector Data Types](/vector-search/vector-search-data-types.md) + - [Vector Functions and Operators](/vector-search/vector-search-functions-and-operators.md) + - [Vector Index](/vector-search/vector-search-index.md) + - [Improve Performance](/vector-search/vector-search-improve-performance.md) + - [Limitations](/vector-search/vector-search-limitations.md) +- Data Service ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/data-service-overview.md) + - [Get Started](/tidb-cloud/data-service-get-started.md) + - Chat2Query API + - [Get Started](/tidb-cloud/use-chat2query-api.md) + - [Start Multi-round Chat2Query](/tidb-cloud/use-chat2query-sessions.md) + - [Use Knowledge Bases](/tidb-cloud/use-chat2query-knowledge.md) + - [Manage Data App](/tidb-cloud/data-service-manage-data-app.md) + - [Manage Endpoint](/tidb-cloud/data-service-manage-endpoint.md) + - [API Key](/tidb-cloud/data-service-api-key.md) + - [Custom Domain](/tidb-cloud/data-service-custom-domain.md) + - [Integrations](/tidb-cloud/data-service-integrations.md) + - [Run in Postman](/tidb-cloud/data-service-postman-integration.md) + - [Deploy Automatically with GitHub](/tidb-cloud/data-service-manage-github-connection.md) + - [Use OpenAPI Specification with Next.js](/tidb-cloud/data-service-oas-with-nextjs.md) + - [Data App Configuration Files](/tidb-cloud/data-service-app-config-files.md) + - [Response and Status Code](/tidb-cloud/data-service-response-and-status-code.md) +- Security + - Identity Access Control + - [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) + - [Standard SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md) + - [Organization SSO Authentication](/tidb-cloud/tidb-cloud-org-sso-authentication.md) + - [Identity Access Management](/tidb-cloud/manage-user-access.md) + - [OAuth 2.0](/tidb-cloud/oauth2.md) + - Network Access Control + - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [Connect via Private Endpoint with Alibaba Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) + - [Configure Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md) + - [TLS Connections to TiDB Cloud](/tidb-cloud/secure-connections-to-serverless-clusters.md) + - Audit Management + - [Console Audit Logging](/tidb-cloud/tidb-cloud-console-auditing.md) +- Billing + - [Invoices](/tidb-cloud/tidb-cloud-billing.md#invoices) + - [Billing Details](/tidb-cloud/tidb-cloud-billing.md#billing-details) + - [Cost Explorer](/tidb-cloud/tidb-cloud-billing.md#cost-explorer) + - [Billing Profile](/tidb-cloud/tidb-cloud-billing.md#billing-profile) + - [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) + - [Payment Method Setting](/tidb-cloud/tidb-cloud-billing.md#payment-method) + - [Billing from Cloud Provider Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-cloud-provider-marketplace) + - [Manage Budgets](/tidb-cloud/tidb-cloud-budget.md) +- Integrations + - [Airbyte](/tidb-cloud/integrate-tidbcloud-with-airbyte.md) + - [Amazon AppFlow](/develop/dev-guide-aws-appflow-integration.md) + - [AWS Lambda](/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md) + - [Cloudflare](/tidb-cloud/integrate-tidbcloud-with-cloudflare.md) + - [dbt](/tidb-cloud/integrate-tidbcloud-with-dbt.md) + - [Gitpod](/develop/dev-guide-playground-gitpod.md) + - [n8n](/tidb-cloud/integrate-tidbcloud-with-n8n.md) + - [Netlify](/tidb-cloud/integrate-tidbcloud-with-netlify.md) + - [ProxySQL](/develop/dev-guide-proxysql-integration.md) + - Terraform + - [Terraform Integration Overview](/tidb-cloud/terraform-tidbcloud-provider-overview.md) + - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) + - [Use the `tidbcloud_serverless_cluster` Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md) + - [Use the `tidbcloud_serverless_branch` Resource](/tidb-cloud/terraform-use-serverless-branch-resource.md) + - [Use the `tidbcloud_serverless_export` Resource](/tidb-cloud/terraform-use-serverless-export-resource.md) + - [Use the `tidbcloud_sql_user` Resource](/tidb-cloud/terraform-use-sql-user-resource.md) + - [Use the `tidbcloud_import` Resource](/tidb-cloud/terraform-use-import-resource.md) + - [Migrate Cluster Resource](/tidb-cloud/terraform-migrate-cluster-resource.md) + - [Vercel](/tidb-cloud/integrate-tidbcloud-with-vercel.md) + - [Zapier](/tidb-cloud/integrate-tidbcloud-with-zapier.md) + +## REFERENCE + +- SQL Reference + - [Explore SQL with TiDB](/basic-sql-operations.md) + - SQL Language Structure and Syntax + - Attributes + - [AUTO_INCREMENT](/auto-increment.md) + - [AUTO_RANDOM](/auto-random.md) + - [SHARD_ROW_ID_BITS](/shard-row-id-bits.md) + - [Literal Values](/literal-values.md) + - [Schema Object Names](/schema-object-names.md) + - [Keywords and Reserved Words](/keywords.md) + - [User-Defined Variables](/user-defined-variables.md) + - [Expression Syntax](/expression-syntax.md) + - [Comment Syntax](/comment-syntax.md) + - SQL Statements + - [Overview](/sql-statements/sql-statement-overview.md) + - [`ADMIN`](/sql-statements/sql-statement-admin.md) + - [`ADMIN CANCEL DDL`](/sql-statements/sql-statement-admin-cancel-ddl.md) + - [`ADMIN CHECKSUM TABLE`](/sql-statements/sql-statement-admin-checksum-table.md) + - [`ADMIN CHECK [TABLE|INDEX]`](/sql-statements/sql-statement-admin-check-table-index.md) + - [`ADMIN CLEANUP INDEX`](/sql-statements/sql-statement-admin-cleanup.md) + - [`ADMIN PAUSE DDL`](/sql-statements/sql-statement-admin-pause-ddl.md) + - [`ADMIN RECOVER INDEX`](/sql-statements/sql-statement-admin-recover.md) + - [`ADMIN RESUME DDL`](/sql-statements/sql-statement-admin-resume-ddl.md) + - [`ADMIN SHOW DDL [JOBS|JOB QUERIES]`](/sql-statements/sql-statement-admin-show-ddl.md) + - [`ALTER DATABASE`](/sql-statements/sql-statement-alter-database.md) + - [`ALTER INSTANCE`](/sql-statements/sql-statement-alter-instance.md) + - [`ALTER SEQUENCE`](/sql-statements/sql-statement-alter-sequence.md) + - `ALTER TABLE` + - [Overview](/sql-statements/sql-statement-alter-table.md) + - [`ADD COLUMN`](/sql-statements/sql-statement-add-column.md) + - [`ADD INDEX`](/sql-statements/sql-statement-add-index.md) + - [`ALTER INDEX`](/sql-statements/sql-statement-alter-index.md) + - [`CHANGE COLUMN`](/sql-statements/sql-statement-change-column.md) + - [`COMPACT`](/sql-statements/sql-statement-alter-table-compact.md) + - [`DROP COLUMN`](/sql-statements/sql-statement-drop-column.md) + - [`DROP INDEX`](/sql-statements/sql-statement-drop-index.md) + - [`MODIFY COLUMN`](/sql-statements/sql-statement-modify-column.md) + - [`RENAME INDEX`](/sql-statements/sql-statement-rename-index.md) + - [`ALTER USER`](/sql-statements/sql-statement-alter-user.md) + - [`ANALYZE TABLE`](/sql-statements/sql-statement-analyze-table.md) + - [`BATCH`](/sql-statements/sql-statement-batch.md) + - [`BEGIN`](/sql-statements/sql-statement-begin.md) + - [`CANCEL IMPORT JOB`](/sql-statements/sql-statement-cancel-import-job.md) + - [`COMMIT`](/sql-statements/sql-statement-commit.md) + - [`CREATE [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-create-binding.md) + - [`CREATE DATABASE`](/sql-statements/sql-statement-create-database.md) + - [`CREATE INDEX`](/sql-statements/sql-statement-create-index.md) + - [`CREATE ROLE`](/sql-statements/sql-statement-create-role.md) + - [`CREATE SEQUENCE`](/sql-statements/sql-statement-create-sequence.md) + - [`CREATE TABLE LIKE`](/sql-statements/sql-statement-create-table-like.md) + - [`CREATE TABLE`](/sql-statements/sql-statement-create-table.md) + - [`CREATE USER`](/sql-statements/sql-statement-create-user.md) + - [`CREATE VIEW`](/sql-statements/sql-statement-create-view.md) + - [`DEALLOCATE`](/sql-statements/sql-statement-deallocate.md) + - [`DELETE`](/sql-statements/sql-statement-delete.md) + - [`DESC`](/sql-statements/sql-statement-desc.md) + - [`DESCRIBE`](/sql-statements/sql-statement-describe.md) + - [`DO`](/sql-statements/sql-statement-do.md) + - [`DROP [GLOBAL|SESSION] BINDING`](/sql-statements/sql-statement-drop-binding.md) + - [`DROP DATABASE`](/sql-statements/sql-statement-drop-database.md) + - [`DROP ROLE`](/sql-statements/sql-statement-drop-role.md) + - [`DROP SEQUENCE`](/sql-statements/sql-statement-drop-sequence.md) + - [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) + - [`DROP TABLE`](/sql-statements/sql-statement-drop-table.md) + - [`DROP USER`](/sql-statements/sql-statement-drop-user.md) + - [`DROP VIEW`](/sql-statements/sql-statement-drop-view.md) + - [`EXECUTE`](/sql-statements/sql-statement-execute.md) + - [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md) + - [`EXPLAIN`](/sql-statements/sql-statement-explain.md) + - [`FLASHBACK CLUSTER`](/sql-statements/sql-statement-flashback-cluster.md) + - [`FLASHBACK DATABASE`](/sql-statements/sql-statement-flashback-database.md) + - [`FLASHBACK TABLE`](/sql-statements/sql-statement-flashback-table.md) + - [`FLUSH PRIVILEGES`](/sql-statements/sql-statement-flush-privileges.md) + - [`FLUSH STATUS`](/sql-statements/sql-statement-flush-status.md) + - [`FLUSH TABLES`](/sql-statements/sql-statement-flush-tables.md) + - [`GRANT `](/sql-statements/sql-statement-grant-privileges.md) + - [`GRANT `](/sql-statements/sql-statement-grant-role.md) + - [`IMPORT INTO`](/sql-statements/sql-statement-import-into.md) + - [`INSERT`](/sql-statements/sql-statement-insert.md) + - [`KILL [TIDB]`](/sql-statements/sql-statement-kill.md) + - [`LOAD DATA`](/sql-statements/sql-statement-load-data.md) + - [`LOCK STATS`](/sql-statements/sql-statement-lock-stats.md) + - [`LOCK TABLES` and `UNLOCK TABLES`](/sql-statements/sql-statement-lock-tables-and-unlock-tables.md) + - [`PREPARE`](/sql-statements/sql-statement-prepare.md) + - [`RECOVER TABLE`](/sql-statements/sql-statement-recover-table.md) + - [`RENAME TABLE`](/sql-statements/sql-statement-rename-table.md) + - [`RENAME USER`](/sql-statements/sql-statement-rename-user.md) + - [`REPLACE`](/sql-statements/sql-statement-replace.md) + - [`REVOKE `](/sql-statements/sql-statement-revoke-privileges.md) + - [`REVOKE `](/sql-statements/sql-statement-revoke-role.md) + - [`ROLLBACK`](/sql-statements/sql-statement-rollback.md) + - [`SAVEPOINT`](/sql-statements/sql-statement-savepoint.md) + - [`SELECT`](/sql-statements/sql-statement-select.md) + - [`SET DEFAULT ROLE`](/sql-statements/sql-statement-set-default-role.md) + - [`SET [NAMES|CHARACTER SET]`](/sql-statements/sql-statement-set-names.md) + - [`SET PASSWORD`](/sql-statements/sql-statement-set-password.md) + - [`SET ROLE`](/sql-statements/sql-statement-set-role.md) + - [`SET TRANSACTION`](/sql-statements/sql-statement-set-transaction.md) + - [`SET [GLOBAL|SESSION] `](/sql-statements/sql-statement-set-variable.md) + - [`SHOW ANALYZE STATUS`](/sql-statements/sql-statement-show-analyze-status.md) + - [`SHOW [GLOBAL|SESSION] BINDINGS`](/sql-statements/sql-statement-show-bindings.md) + - [`SHOW BUILTINS`](/sql-statements/sql-statement-show-builtins.md) + - [`SHOW CHARACTER SET`](/sql-statements/sql-statement-show-character-set.md) + - [`SHOW COLLATION`](/sql-statements/sql-statement-show-collation.md) + - [`SHOW COLUMN_STATS_USAGE`](/sql-statements/sql-statement-show-column-stats-usage.md) + - [`SHOW COLUMNS FROM`](/sql-statements/sql-statement-show-columns-from.md) + - [`SHOW CREATE DATABASE`](/sql-statements/sql-statement-show-create-database.md) + - [`SHOW CREATE SEQUENCE`](/sql-statements/sql-statement-show-create-sequence.md) + - [`SHOW CREATE TABLE`](/sql-statements/sql-statement-show-create-table.md) + - [`SHOW CREATE USER`](/sql-statements/sql-statement-show-create-user.md) + - [`SHOW DATABASES`](/sql-statements/sql-statement-show-databases.md) + - [`SHOW ENGINES`](/sql-statements/sql-statement-show-engines.md) + - [`SHOW ERRORS`](/sql-statements/sql-statement-show-errors.md) + - [`SHOW FIELDS FROM`](/sql-statements/sql-statement-show-fields-from.md) + - [`SHOW GRANTS`](/sql-statements/sql-statement-show-grants.md) + - [`SHOW IMPORT JOB`](/sql-statements/sql-statement-show-import-job.md) + - [`SHOW INDEXES [FROM|IN]`](/sql-statements/sql-statement-show-indexes.md) + - [`SHOW MASTER STATUS`](/sql-statements/sql-statement-show-master-status.md) + - [`SHOW PRIVILEGES`](/sql-statements/sql-statement-show-privileges.md) + - [`SHOW PROCESSLIST`](/sql-statements/sql-statement-show-processlist.md) + - [`SHOW PROFILES`](/sql-statements/sql-statement-show-profiles.md) + - [`SHOW SCHEMAS`](/sql-statements/sql-statement-show-schemas.md) + - [`SHOW STATS_BUCKETS`](/sql-statements/sql-statement-show-stats-buckets.md) + - [`SHOW STATS_HEALTHY`](/sql-statements/sql-statement-show-stats-healthy.md) + - [`SHOW STATS_HISTOGRAMS`](/sql-statements/sql-statement-show-stats-histograms.md) + - [`SHOW STATS_LOCKED`](/sql-statements/sql-statement-show-stats-locked.md) + - [`SHOW STATS_META`](/sql-statements/sql-statement-show-stats-meta.md) + - [`SHOW STATS_TOPN`](/sql-statements/sql-statement-show-stats-topn.md) + - [`SHOW STATUS`](/sql-statements/sql-statement-show-status.md) + - [`SHOW TABLE NEXT_ROW_ID`](/sql-statements/sql-statement-show-table-next-rowid.md) + - [`SHOW TABLE STATUS`](/sql-statements/sql-statement-show-table-status.md) + - [`SHOW TABLES`](/sql-statements/sql-statement-show-tables.md) + - [`SHOW [GLOBAL|SESSION] VARIABLES`](/sql-statements/sql-statement-show-variables.md) + - [`SHOW WARNINGS`](/sql-statements/sql-statement-show-warnings.md) + - [`START TRANSACTION`](/sql-statements/sql-statement-start-transaction.md) + - [`TABLE`](/sql-statements/sql-statement-table.md) + - [`TRACE`](/sql-statements/sql-statement-trace.md) + - [`TRUNCATE`](/sql-statements/sql-statement-truncate.md) + - [`UNLOCK STATS`](/sql-statements/sql-statement-unlock-stats.md) + - [`UPDATE`](/sql-statements/sql-statement-update.md) + - [`USE`](/sql-statements/sql-statement-use.md) + - [`WITH`](/sql-statements/sql-statement-with.md) + - Data Types + - [Overview](/data-type-overview.md) + - [Default Values](/data-type-default-values.md) + - [Numeric Types](/data-type-numeric.md) + - [Date and Time Types](/data-type-date-and-time.md) + - [String Types](/data-type-string.md) + - [JSON Type](/data-type-json.md) + - Functions and Operators + - [Overview](/functions-and-operators/functions-and-operators-overview.md) + - [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md) + - [Operators](/functions-and-operators/operators.md) + - [Control Flow Functions](/functions-and-operators/control-flow-functions.md) + - [String Functions](/functions-and-operators/string-functions.md) + - [Numeric Functions and Operators](/functions-and-operators/numeric-functions-and-operators.md) + - [Date and Time Functions](/functions-and-operators/date-and-time-functions.md) + - [Bit Functions and Operators](/functions-and-operators/bit-functions-and-operators.md) + - [Cast Functions and Operators](/functions-and-operators/cast-functions-and-operators.md) + - [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md) + - [Locking Functions](/functions-and-operators/locking-functions.md) + - [Information Functions](/functions-and-operators/information-functions.md) + - JSON Functions + - [Overview](/functions-and-operators/json-functions.md) + - [Functions That Create JSON](/functions-and-operators/json-functions/json-functions-create.md) + - [Functions That Search JSON](/functions-and-operators/json-functions/json-functions-search.md) + - [Functions That Modify JSON](/functions-and-operators/json-functions/json-functions-modify.md) + - [Functions That Return JSON](/functions-and-operators/json-functions/json-functions-return.md) + - [JSON Utility Functions](/functions-and-operators/json-functions/json-functions-utility.md) + - [Functions That Aggregate JSON](/functions-and-operators/json-functions/json-functions-aggregate.md) + - [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md) + - [GROUP BY Modifiers](/functions-and-operators/group-by-modifier.md) + - [Window Functions](/functions-and-operators/window-functions.md) + - [Miscellaneous Functions](/functions-and-operators/miscellaneous-functions.md) + - [Precision Math](/functions-and-operators/precision-math.md) + - [Set Operations](/functions-and-operators/set-operators.md) + - [Sequence Functions](/functions-and-operators/sequence-functions.md) + - [List of Expressions for Pushdown](/functions-and-operators/expressions-pushed-down.md) + - [TiDB Specific Functions](/functions-and-operators/tidb-functions.md) + - [Clustered Indexes](/clustered-indexes.md) + - [Constraints](/constraints.md) + - [Generated Columns](/generated-columns.md) + - [SQL Mode](/sql-mode.md) + - [Table Attributes](/table-attributes.md) + - Transactions + - [Overview](/transaction-overview.md) + - [Isolation Levels](/transaction-isolation-levels.md) + - [Optimistic Transactions](/optimistic-transaction.md) + - [Pessimistic Transactions](/pessimistic-transaction.md) + - [Non-Transactional DML Statements](/non-transactional-dml.md) + - [Views](/views.md) + - [Partitioning](/partitioned-table.md) + - [Temporary Tables](/temporary-tables.md) + - [Cached Tables](/cached-tables.md) + - [FOREIGN KEY Constraints](/foreign-key.md) + - Character Set and Collation + - [Overview](/character-set-and-collation.md) + - [GBK](/character-set-gbk.md) + - Read Historical Data + - Use Stale Read (Recommended) + - [Usage Scenarios of Stale Read](/stale-read.md) + - [Perform Stale Read Using `As OF TIMESTAMP`](/as-of-timestamp.md) + - [Perform Stale Read Using `tidb_read_staleness`](/tidb-read-staleness.md) + - [Perform Stale Read Using `tidb_external_ts`](/tidb-external-ts.md) + - [Use the `tidb_snapshot` System Variable](/read-historical-data.md) + - System Tables + - `mysql` Schema + - [Overview](/mysql-schema/mysql-schema.md) + - [`user`](/mysql-schema/mysql-schema-user.md) + - INFORMATION_SCHEMA + - [Overview](/information-schema/information-schema.md) + - [`ANALYZE_STATUS`](/information-schema/information-schema-analyze-status.md) + - [`CHECK_CONSTRAINTS`](/information-schema/information-schema-check-constraints.md) + - [`CLIENT_ERRORS_SUMMARY_BY_HOST`](/information-schema/client-errors-summary-by-host.md) + - [`CLIENT_ERRORS_SUMMARY_BY_USER`](/information-schema/client-errors-summary-by-user.md) + - [`CLIENT_ERRORS_SUMMARY_GLOBAL`](/information-schema/client-errors-summary-global.md) + - [`CHARACTER_SETS`](/information-schema/information-schema-character-sets.md) + - [`COLLATIONS`](/information-schema/information-schema-collations.md) + - [`COLLATION_CHARACTER_SET_APPLICABILITY`](/information-schema/information-schema-collation-character-set-applicability.md) + - [`COLUMNS`](/information-schema/information-schema-columns.md) + - [`DATA_LOCK_WAITS`](/information-schema/information-schema-data-lock-waits.md) + - [`DDL_JOBS`](/information-schema/information-schema-ddl-jobs.md) + - [`DEADLOCKS`](/information-schema/information-schema-deadlocks.md) + - [`ENGINES`](/information-schema/information-schema-engines.md) + - [`KEYWORDS`](/information-schema/information-schema-keywords.md) + - [`KEY_COLUMN_USAGE`](/information-schema/information-schema-key-column-usage.md) + - [`MEMORY_USAGE`](/information-schema/information-schema-memory-usage.md) + - [`MEMORY_USAGE_OPS_HISTORY`](/information-schema/information-schema-memory-usage-ops-history.md) + - [`PARTITIONS`](/information-schema/information-schema-partitions.md) + - [`PROCESSLIST`](/information-schema/information-schema-processlist.md) + - [`REFERENTIAL_CONSTRAINTS`](/information-schema/information-schema-referential-constraints.md) + - [`SCHEMATA`](/information-schema/information-schema-schemata.md) + - [`SEQUENCES`](/information-schema/information-schema-sequences.md) + - [`SESSION_VARIABLES`](/information-schema/information-schema-session-variables.md) + - [`STATISTICS`](/information-schema/information-schema-statistics.md) + - [`TABLES`](/information-schema/information-schema-tables.md) + - [`TABLE_CONSTRAINTS`](/information-schema/information-schema-table-constraints.md) + - [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) + - [`TIDB_CHECK_CONSTRAINTS`](/information-schema/information-schema-tidb-check-constraints.md) + - [`TIDB_INDEXES`](/information-schema/information-schema-tidb-indexes.md) + - [`TIDB_INDEX_USAGE`](/information-schema/information-schema-tidb-index-usage.md) + - [`TIDB_TRX`](/information-schema/information-schema-tidb-trx.md) + - [`TIFLASH_REPLICA`](/information-schema/information-schema-tiflash-replica.md) + - [`TIFLASH_SEGMENTS`](/information-schema/information-schema-tiflash-segments.md) + - [`TIFLASH_TABLES`](/information-schema/information-schema-tiflash-tables.md) + - [`USER_ATTRIBUTES`](/information-schema/information-schema-user-attributes.md) + - [`USER_PRIVILEGES`](/information-schema/information-schema-user-privileges.md) + - [`VARIABLES_INFO`](/information-schema/information-schema-variables-info.md) + - [`VIEWS`](/information-schema/information-schema-views.md) + - PERFORMANCE_SCHEMA + - [Overview](/performance-schema/performance-schema.md) + - [`SESSION_CONNECT_ATTRS`](/performance-schema/performance-schema-session-connect-attrs.md) + - SYS + - [Overview](/sys-schema/sys-schema.md) + - [`schema_unused_indexes`](/sys-schema/sys-schema-unused-indexes.md) + - [Metadata Lock](/metadata-lock.md) + - [Use UUIDs](/best-practices/uuid.md) + - [TiDB Accelerated Table Creation](/accelerated-table-creation.md) +- API Reference ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/api-overview.md) + - v1beta1 + - [Billing](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing) + - [IAM](https://docs.pingcap.com/tidbcloud/api/v1beta1/iam) + - [MSP (Deprecated)](https://docs.pingcap.com/tidbcloud/api/v1beta1/msp) + - [v1beta](https://docs.pingcap.com/tidbcloud/api/v1beta) +- CLI Reference ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Overview](/tidb-cloud/cli-reference.md) + - auth + - [login](/tidb-cloud/ticloud-auth-login.md) + - [logout](/tidb-cloud/ticloud-auth-logout.md) + - [whoami](/tidb-cloud/ticloud-auth-whoami.md) + - serverless + - [capacity](/tidb-cloud/ticloud-serverless-capacity.md) + - [create](/tidb-cloud/ticloud-cluster-create.md) + - [delete](/tidb-cloud/ticloud-cluster-delete.md) + - [describe](/tidb-cloud/ticloud-cluster-describe.md) + - [list](/tidb-cloud/ticloud-cluster-list.md) + - [update](/tidb-cloud/ticloud-serverless-update.md) + - [spending-limit](/tidb-cloud/ticloud-serverless-spending-limit.md) + - [region](/tidb-cloud/ticloud-serverless-region.md) + - [shell](/tidb-cloud/ticloud-serverless-shell.md) + - branch + - [create](/tidb-cloud/ticloud-branch-create.md) + - [delete](/tidb-cloud/ticloud-branch-delete.md) + - [describe](/tidb-cloud/ticloud-branch-describe.md) + - [list](/tidb-cloud/ticloud-branch-list.md) + - [shell](/tidb-cloud/ticloud-branch-shell.md) + - import + - [cancel](/tidb-cloud/ticloud-import-cancel.md) + - [describe](/tidb-cloud/ticloud-import-describe.md) + - [list](/tidb-cloud/ticloud-import-list.md) + - [start](/tidb-cloud/ticloud-import-start.md) + - export + - [create](/tidb-cloud/ticloud-serverless-export-create.md) + - [describe](/tidb-cloud/ticloud-serverless-export-describe.md) + - [list](/tidb-cloud/ticloud-serverless-export-list.md) + - [cancel](/tidb-cloud/ticloud-serverless-export-cancel.md) + - [download](/tidb-cloud/ticloud-serverless-export-download.md) + - sql-user + - [create](/tidb-cloud/ticloud-serverless-sql-user-create.md) + - [delete](/tidb-cloud/ticloud-serverless-sql-user-delete.md) + - [list](/tidb-cloud/ticloud-serverless-sql-user-list.md) + - [update](/tidb-cloud/ticloud-serverless-sql-user-update.md) + - authorized-network + - [create](/tidb-cloud/ticloud-serverless-authorized-network-create.md) + - [delete](/tidb-cloud/ticloud-serverless-authorized-network-delete.md) + - [list](/tidb-cloud/ticloud-serverless-authorized-network-list.md) + - [update](/tidb-cloud/ticloud-serverless-authorized-network-update.md) + - [ai](/tidb-cloud/ticloud-ai.md) + - [completion](/tidb-cloud/ticloud-completion.md) + - config + - [create](/tidb-cloud/ticloud-config-create.md) + - [delete](/tidb-cloud/ticloud-config-delete.md) + - [describe](/tidb-cloud/ticloud-config-describe.md) + - [edit](/tidb-cloud/ticloud-config-edit.md) + - [list](/tidb-cloud/ticloud-config-list.md) + - [set](/tidb-cloud/ticloud-config-set.md) + - [use](/tidb-cloud/ticloud-config-use.md) + - project + - [list](/tidb-cloud/ticloud-project-list.md) + - [upgrade](/tidb-cloud/ticloud-upgrade.md) + - [help](/tidb-cloud/ticloud-help.md) +- General Reference + - TiDB Cluster Architecture + - [Overview](/tidb-architecture.md) + - [Storage](/tidb-storage.md) + - [Computing](/tidb-computing.md) + - [Scheduling](/tidb-scheduling.md) + - [TSO](/tso.md) + - Storage Engines + - TiKV + - [TiKV Overview](/tikv-overview.md) + - [RocksDB Overview](/storage-engine/rocksdb-overview.md) + - TiFlash + - [TiFlash Overview](/tiflash/tiflash-overview.md) + - [Spill to Disk](/tiflash/tiflash-spill-disk.md) + - TiDB Cloud Partner Web Console + - [TiDB Cloud Partners](/tidb-cloud/tidb-cloud-partners.md) + - [MSP Customer](/tidb-cloud/managed-service-provider-customer.md) + - [Reseller's Customer](/tidb-cloud/cppo-customer.md) + - [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md) + - [Limited SQL Features on TiDB Cloud](/tidb-cloud/limited-sql-features.md) + - [TiDB Limitations](/tidb-limitations.md) + - [System Variables](/system-variables.md) + - [Server Status Variables](/status-variables.md) + - [Table Filter](/table-filter.md) + - [URI Formats of External Storage Services](/external-storage-uri.md) + - [DDL Execution Principles and Best Practices](/ddl-introduction.md) + - [Troubleshoot Inconsistency Between Data and Indexes](/troubleshoot-data-inconsistency-errors.md) + - [Notifications](/tidb-cloud/notifications.md) + - [Glossary](/tidb-cloud/tidb-cloud-glossary.md) +- Support Plan + - [Connected Care Overview](/tidb-cloud/connected-care-overview.md) + - [Connected Care Details](/tidb-cloud/connected-care-detail.md) + - Connected Care Support Service Features + - [Connected: AI Chat in IM](/tidb-cloud/connected-ai-chat-in-im.md) + - Connected: IM Ticket Creation and Update Subscription + - [Create Tickets and Subscribe to Ticket Updates via Slack](/tidb-cloud/connected-slack-ticket-creation.md) + - [Create Tickets and Subscribe to Ticket Updates via Lark](/tidb-cloud/connected-lark-ticket-creation.md) + - Connected: IM Interaction for Support Tickets + - [Interact with Support Tickets via Slack](/tidb-cloud/connected-slack-ticket-interaction.md) + - [Interact with Support Tickets via Lark](/tidb-cloud/connected-lark-ticket-interaction.md) + - [Get Support](/tidb-cloud/tidb-cloud-support.md) +- FAQs + - [TiDB Cloud FAQs](/tidb-cloud/tidb-cloud-faq.md) + - [{{{ .starter }}} FAQs](/tidb-cloud/serverless-faqs.md) + +## RELEASES + +- Release Notes + - [2025](/tidb-cloud/tidb-cloud-release-notes.md) diff --git a/TOC-tidb-cloud.md b/TOC-tidb-cloud.md index 62ffe7946cf40..b3d249e8b7d25 100644 --- a/TOC-tidb-cloud.md +++ b/TOC-tidb-cloud.md @@ -9,10 +9,9 @@ - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) - [MySQL Compatibility](/mysql-compatibility.md) - Get Started with TiDB Cloud - - [Try Out {{{ .starter }}}](/tidb-cloud/tidb-cloud-quickstart.md) + - [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md) - [Try Out TiDB + AI](/vector-search/vector-search-get-started-using-python.md) - [Try Out HTAP](/tidb-cloud/tidb-cloud-htap-quickstart.md) - - [Try Out TiDB Cloud CLI](/tidb-cloud/get-started-with-cli.md) - [Perform a PoC](/tidb-cloud/tidb-cloud-poc.md) - Key Concepts - [Overview](/tidb-cloud/key-concepts.md) @@ -23,9 +22,7 @@ - [AI Features](/tidb-cloud/ai-feature-concepts.md) - [Data Service](/tidb-cloud/data-service-concepts.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - [Scalability](/tidb-cloud/scalability-concepts.md) - - High Availability - - [High Availability in {{{ .starter }}}](/tidb-cloud/serverless-high-availability.md) - - [High Availability in TiDB Cloud Dedicated](/tidb-cloud/high-availability-with-multi-az.md) + - [High Availability](/tidb-cloud/high-availability-with-multi-az.md) - [Monitoring](/tidb-cloud/monitoring-concepts.md) - [Data Streaming](/tidb-cloud/data-streaming-concepts.md) - [Backup & Restore](/tidb-cloud/backup-and-restore-concepts.md) @@ -35,7 +32,7 @@ - Development Quick Start - [Developer Guide Overview](/develop/dev-guide-overview.md) - - [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md) + - [Build a TiDB Cloud Cluster](/develop/dev-guide-build-cluster-in-cloud.md) - [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md) - Connect to TiDB Cloud - GUI Database Tools @@ -69,20 +66,12 @@ - [Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) - [Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) - [TypeORM](/develop/dev-guide-sample-application-nodejs-typeorm.md) - - [Next.js](/develop/dev-guide-sample-application-nextjs.md) - - [AWS Lambda](/develop/dev-guide-sample-application-aws-lambda.md) - Ruby - [mysql2](/develop/dev-guide-sample-application-ruby-mysql2.md) - [Rails](/develop/dev-guide-sample-application-ruby-rails.md) - C# - [C#](/develop/dev-guide-sample-application-cs.md) - [WordPress](/tidb-cloud/dev-guide-wordpress.md) - - Serverless Driver ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - - [{{{ .starter }}} Driver](/tidb-cloud/serverless-driver.md) - - [Node.js Example](/tidb-cloud/serverless-driver-node-example.md) - - [Prisma Example](/tidb-cloud/serverless-driver-prisma-example.md) - - [Kysely Example](/tidb-cloud/serverless-driver-kysely-example.md) - - [Drizzle Example](/tidb-cloud/serverless-driver-drizzle-example.md) - Development Reference - Design Database Schema - [Overview](/develop/dev-guide-schema-design-overview.md) @@ -136,36 +125,22 @@ - Manage Cluster - Plan Your Cluster - - [Select Your Cluster Tier](/tidb-cloud/select-cluster-tier.md) + - [Select Your Cluster Plan](/tidb-cloud/select-cluster-tier.md) - [Determine Your TiDB Size](/tidb-cloud/size-your-cluster.md) - [TiDB Cloud Performance Reference](/tidb-cloud/tidb-cloud-performance-reference.md) - - Manage {{{ .starter }}} Clusters - - [Create a {{{ .starter }}} Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - - Connect to Your {{{ .starter }}} Cluster - - [Connection Overview](/tidb-cloud/connect-to-tidb-cluster-serverless.md) - - [Connect via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) - - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) - - Branch ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - - [Overview](/tidb-cloud/branch-overview.md) - - [Manage Branches](/tidb-cloud/branch-manage.md) - - [GitHub Integration](/tidb-cloud/branch-github-integration.md) - - [Manage Spending Limit](/tidb-cloud/manage-serverless-spend-limit.md) - - [Back Up and Restore {{{ .starter }}} Data](/tidb-cloud/backup-and-restore-serverless.md) - - [Export Data from {{{ .starter }}}](/tidb-cloud/serverless-export.md) - - Manage TiDB Cloud Dedicated Clusters - - [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) - - Connect to Your TiDB Cloud Dedicated Cluster - - [Connection Method Overview](/tidb-cloud/connect-to-tidb-cluster.md) - - [Connect via Public Connection](/tidb-cloud/connect-via-standard-connection.md) - - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md) - - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) - - [Connect via Private Endpoint with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) - - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) - - [Connect via SQL Shell](/tidb-cloud/connect-via-sql-shell.md) - - [Scale a TiDB Cloud Dedicated Cluster](/tidb-cloud/scale-tidb-cluster.md) - - [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md) - - [Pause or Resume a TiDB Cloud Dedicated Cluster](/tidb-cloud/pause-or-resume-tidb-cluster.md) - - [Configure Maintenance Window](/tidb-cloud/configure-maintenance-window.md) + - [Create a TiDB Cloud Dedicated Cluster](/tidb-cloud/create-tidb-cluster.md) + - Connect to Your TiDB Cloud Dedicated Cluster + - [Connection Method Overview](/tidb-cloud/connect-to-tidb-cluster.md) + - [Connect via Public Connection](/tidb-cloud/connect-via-standard-connection.md) + - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md) + - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) + - [Connect via Private Endpoint with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) + - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) + - [Connect via SQL Shell](/tidb-cloud/connect-via-sql-shell.md) + - [Scale a TiDB Cloud Dedicated Cluster](/tidb-cloud/scale-tidb-cluster.md) + - [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md) + - [Pause or Resume a TiDB Cloud Dedicated Cluster](/tidb-cloud/pause-or-resume-tidb-cluster.md) + - [Configure Maintenance Window](/tidb-cloud/configure-maintenance-window.md) - Use an HTAP Cluster with TiFlash - [TiFlash Overview](/tiflash/tiflash-overview.md) - [Create TiFlash Replicas](/tiflash/create-tiflash-replicas.md) @@ -191,8 +166,8 @@ - Tune Performance - [Overview](/tidb-cloud/tidb-cloud-tune-performance-overview.md) - Analyze Performance - - [Use the Diagnosis Tab](/tidb-cloud/tune-performance.md) - - [Use Index Insight](/tidb-cloud/index-insight.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) + - [Use the Diagnosis Page](/tidb-cloud/tune-performance.md) + - [Use Index Insight](/tidb-cloud/index-insight.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - [Use Statement Summary Tables](/statement-summary-tables.md) - SQL Tuning - [Overview](/tidb-cloud/tidb-cloud-sql-tuning-overview.md) @@ -268,15 +243,8 @@ - [Import CSV Files from Cloud Storage](/tidb-cloud/import-csv-files.md) - [Import Parquet Files from Cloud Storage](/tidb-cloud/import-parquet-files.md) - [Import with MySQL CLI](/tidb-cloud/import-with-mysql-cli.md) - - Import Data into {{{ .starter }}} - - [Import Sample Data](/tidb-cloud/import-sample-data-serverless.md) - - [Import Local Files](/tidb-cloud/tidb-cloud-import-local-files.md) - - [Import CSV Files from Cloud Storage](/tidb-cloud/import-csv-files-serverless.md) - - [Import Parquet Files from Cloud Storage](/tidb-cloud/import-parquet-files-serverless.md) - - [Import with MySQL CLI](/tidb-cloud/import-with-mysql-cli-serverless.md) - Reference - [Configure External Storage Access for TiDB Cloud Dedicated](/tidb-cloud/dedicated-external-storage.md) - - [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md) - [Naming Conventions for Data Import](/tidb-cloud/naming-conventions-for-data-import.md) - [CSV Configurations for Importing Data](/tidb-cloud/csv-config-for-import-data.md) - [Troubleshoot Access Denied Errors during Data Import from Amazon S3](/tidb-cloud/troubleshoot-import-access-denied-error.md) @@ -355,17 +323,12 @@ - [Identity Access Management](/tidb-cloud/manage-user-access.md) - [OAuth 2.0](/tidb-cloud/oauth2.md) - Network Access Control - - {{{ .starter }}} - - [Connect via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) - - [Configure Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md) - - [TLS Connections to {{{ .starter }}}](/tidb-cloud/secure-connections-to-serverless-clusters.md) - - TiDB Cloud Dedicated - - [Configure an IP Access List](/tidb-cloud/configure-ip-access-list.md) - - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md) - - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) - - [Connect via Private Endpoint with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) - - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) - - [TLS Connections to TiDB Cloud Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md) + - [Configure an IP Access List](/tidb-cloud/configure-ip-access-list.md) + - [Connect via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md) + - [Connect via Private Endpoint with Azure](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md) + - [Connect via Private Endpoint with Google Cloud](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) + - [Connect via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) + - [TLS Connections to TiDB Cloud Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md) - Data Access Control - [Encryption at Rest Using Customer-Managed Encryption Keys](/tidb-cloud/tidb-cloud-encrypt-cmek.md) - [User-Controlled Log Redaction](/tidb-cloud/tidb-cloud-log-redaction.md) @@ -373,7 +336,6 @@ - [Configure Cluster Password Settings](/tidb-cloud/configure-security-settings.md) - Audit Management - [TiDB Cloud Dedicated Database Audit Logging](/tidb-cloud/tidb-cloud-auditing.md) - - [{{{ .starter }}} Database Audit Logging](/tidb-cloud/serverless-audit-logging.md) ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - [Console Audit Logging](/tidb-cloud/tidb-cloud-console-auditing.md) - Billing - [Invoices](/tidb-cloud/tidb-cloud-billing.md#invoices) @@ -382,7 +344,7 @@ - [Billing Profile](/tidb-cloud/tidb-cloud-billing.md#billing-profile) - [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) - [Payment Method Setting](/tidb-cloud/tidb-cloud-billing.md#payment-method) - - [Billing from AWS, Azure, or Google Cloud Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-aws-marketplace-azure-marketplace-or-google-cloud-marketplace) + - [Billing from Cloud Provider Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-cloud-provider-marketplace) - [Billing for Changefeed](/tidb-cloud/tidb-cloud-billing-ticdc-rcu.md) - [Billing for Data Migration](/tidb-cloud/tidb-cloud-billing-dm.md) - [Billing for Recovery Groups](/tidb-cloud/tidb-cloud-billing-recovery-group.md) @@ -403,18 +365,15 @@ - Terraform - [Terraform Integration Overview](/tidb-cloud/terraform-tidbcloud-provider-overview.md) - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) - - [Use TiDB Cloud Dedicated Cluster Resource](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) - - [Use TiDB Cloud Dedicated Private Endpoint Connection Resource](/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md) - - [Use TiDB Cloud Dedicated VPC Peering Resource](/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md) - - [Use TiDB Cloud Dedicated Network Container Resource](/tidb-cloud/terraform-use-dedicated-network-container-resource.md) - - [Use {{{ .starter }}} Cluster Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md) - - [Use {{{ .starter }}} Branch Resource](/tidb-cloud/terraform-use-serverless-branch-resource.md) - - [Use {{{ .starter }}} Export Resource](/tidb-cloud/terraform-use-serverless-export-resource.md) - - [Use SQL User Resource](/tidb-cloud/terraform-use-sql-user-resource.md) - - [Use Cluster Resource (Deprecated)](/tidb-cloud/terraform-use-cluster-resource.md) - - [Use Backup Resource](/tidb-cloud/terraform-use-backup-resource.md) - - [Use Restore Resource](/tidb-cloud/terraform-use-restore-resource.md) - - [Use Import Resource](/tidb-cloud/terraform-use-import-resource.md) + - [Use the `tidbcloud_dedicated_cluster` Resource](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) + - [Use the `tidbcloud_dedicated_private_endpoint_connection` Resource](/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md) + - [Use the `tidbcloud_dedicated_vpc_peering` Resource](/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md) + - [Use the `tidbcloud_dedicated_network_container` Resource](/tidb-cloud/terraform-use-dedicated-network-container-resource.md) + - [Use the `tidbcloud_sql_user` Resource](/tidb-cloud/terraform-use-sql-user-resource.md) + - [Use the `tidbcloud_cluster` Resource (Deprecated)](/tidb-cloud/terraform-use-cluster-resource.md) + - [Use the `tidbcloud_backup` Resource](/tidb-cloud/terraform-use-backup-resource.md) + - [Use the `tidbcloud_restore` Resource](/tidb-cloud/terraform-use-restore-resource.md) + - [Use the `tidbcloud_import` Resource](/tidb-cloud/terraform-use-import-resource.md) - [Migrate Cluster Resource](/tidb-cloud/terraform-migrate-cluster-resource.md) - [Vercel](/tidb-cloud/integrate-tidbcloud-with-vercel.md) - [Zapier](/tidb-cloud/integrate-tidbcloud-with-zapier.md) @@ -726,73 +685,6 @@ - [IAM](https://docs.pingcap.com/tidbcloud/api/v1beta1/iam) - [MSP (Deprecated)](https://docs.pingcap.com/tidbcloud/api/v1beta1/msp) - [v1beta](https://docs.pingcap.com/tidbcloud/api/v1beta) -- CLI Reference ![BETA](/media/tidb-cloud/blank_transparent_placeholder.png) - - [Overview](/tidb-cloud/cli-reference.md) - - auth - - [login](/tidb-cloud/ticloud-auth-login.md) - - [logout](/tidb-cloud/ticloud-auth-logout.md) - - [whoami](/tidb-cloud/ticloud-auth-whoami.md) - - serverless - - [create](/tidb-cloud/ticloud-cluster-create.md) - - [delete](/tidb-cloud/ticloud-cluster-delete.md) - - [describe](/tidb-cloud/ticloud-cluster-describe.md) - - [list](/tidb-cloud/ticloud-cluster-list.md) - - [update](/tidb-cloud/ticloud-serverless-update.md) - - [spending-limit](/tidb-cloud/ticloud-serverless-spending-limit.md) - - [region](/tidb-cloud/ticloud-serverless-region.md) - - [shell](/tidb-cloud/ticloud-serverless-shell.md) - - branch - - [create](/tidb-cloud/ticloud-branch-create.md) - - [delete](/tidb-cloud/ticloud-branch-delete.md) - - [describe](/tidb-cloud/ticloud-branch-describe.md) - - [list](/tidb-cloud/ticloud-branch-list.md) - - [shell](/tidb-cloud/ticloud-branch-shell.md) - - import - - [cancel](/tidb-cloud/ticloud-import-cancel.md) - - [describe](/tidb-cloud/ticloud-import-describe.md) - - [list](/tidb-cloud/ticloud-import-list.md) - - [start](/tidb-cloud/ticloud-import-start.md) - - export - - [create](/tidb-cloud/ticloud-serverless-export-create.md) - - [describe](/tidb-cloud/ticloud-serverless-export-describe.md) - - [list](/tidb-cloud/ticloud-serverless-export-list.md) - - [cancel](/tidb-cloud/ticloud-serverless-export-cancel.md) - - [download](/tidb-cloud/ticloud-serverless-export-download.md) - - sql-user - - [create](/tidb-cloud/ticloud-serverless-sql-user-create.md) - - [delete](/tidb-cloud/ticloud-serverless-sql-user-delete.md) - - [list](/tidb-cloud/ticloud-serverless-sql-user-list.md) - - [update](/tidb-cloud/ticloud-serverless-sql-user-update.md) - - audit-log - - [config](/tidb-cloud/ticloud-auditlog-config.md) - - [describe](/tidb-cloud/ticloud-auditlog-describe.md) - - [download](/tidb-cloud/ticloud-auditlog-download.md) - - filter-rule - - [create](/tidb-cloud/ticloud-auditlog-filter-create.md) - - [delete](/tidb-cloud/ticloud-auditlog-filter-delete.md) - - [describe](/tidb-cloud/ticloud-auditlog-filter-describe.md) - - [list](/tidb-cloud/ticloud-auditlog-filter-list.md) - - [template](/tidb-cloud/ticloud-auditlog-filter-template.md) - - [update](/tidb-cloud/ticloud-auditlog-filter-update.md) - - authorized-network - - [create](/tidb-cloud/ticloud-serverless-authorized-network-create.md) - - [delete](/tidb-cloud/ticloud-serverless-authorized-network-delete.md) - - [list](/tidb-cloud/ticloud-serverless-authorized-network-list.md) - - [update](/tidb-cloud/ticloud-serverless-authorized-network-update.md) - - [ai](/tidb-cloud/ticloud-ai.md) - - [completion](/tidb-cloud/ticloud-completion.md) - - config - - [create](/tidb-cloud/ticloud-config-create.md) - - [delete](/tidb-cloud/ticloud-config-delete.md) - - [describe](/tidb-cloud/ticloud-config-describe.md) - - [edit](/tidb-cloud/ticloud-config-edit.md) - - [list](/tidb-cloud/ticloud-config-list.md) - - [set](/tidb-cloud/ticloud-config-set.md) - - [use](/tidb-cloud/ticloud-config-use.md) - - project - - [list](/tidb-cloud/ticloud-project-list.md) - - [upgrade](/tidb-cloud/ticloud-upgrade.md) - - [help](/tidb-cloud/ticloud-help.md) - General Reference - TiDB Cluster Architecture - [Overview](/tidb-architecture.md) @@ -815,7 +707,6 @@ - [Introduction](/tidb-distributed-execution-framework.md) - [TiDB Global Sort](/tidb-global-sort.md) - [TiDB Cloud Dedicated Limitations and Quotas](/tidb-cloud/limitations-and-quotas.md) - - [{{{ .starter }}} Limitations](/tidb-cloud/serverless-limitations.md) - [Limited SQL Features on TiDB Cloud](/tidb-cloud/limited-sql-features.md) - [TiDB Limitations](/tidb-limitations.md) - Benchmarks @@ -862,7 +753,6 @@ - [Get Support](/tidb-cloud/tidb-cloud-support.md) - FAQs - [TiDB Cloud FAQs](/tidb-cloud/tidb-cloud-faq.md) - - [{{{ .starter }}} FAQs](/tidb-cloud/serverless-faqs.md) ## RELEASES diff --git a/develop/dev-guide-build-cluster-in-cloud.md b/develop/dev-guide-build-cluster-in-cloud.md index e37c632a2728a..07aeb62284f37 100644 --- a/develop/dev-guide-build-cluster-in-cloud.md +++ b/develop/dev-guide-build-cluster-in-cloud.md @@ -9,7 +9,7 @@ summary: Learn how to build a {{{ .starter }}} cluster in TiDB Cloud and connect -This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a {{{ .starter }}} cluster, connect to it, and run a sample application on it. +This document walks you through the quickest way to get started with TiDB. You will use [TiDB Cloud](https://www.pingcap.com/tidb-cloud) to create a {{{ .starter }}} (formerly Serverless) cluster, connect to it, and run a sample application on it. If you need to run TiDB on your local machine, see [Starting TiDB Locally](/quick-start-with-tidb.md). @@ -29,7 +29,7 @@ This document walks you through the quickest way to get started with TiDB Cloud. 3. On the [**Clusters**](https://tidbcloud.com/console/clusters) page, click **Create Cluster**. -4. On the **Create Cluster** page, **Serverless** is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster. +4. On the **Create Cluster** page, **Starter** is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster. 5. Click **Create** to create a {{{ .starter }}} cluster. diff --git a/develop/dev-guide-gui-datagrip.md b/develop/dev-guide-gui-datagrip.md index 908358df31983..dedf061777b52 100644 --- a/develop/dev-guide-gui-datagrip.md +++ b/develop/dev-guide-gui-datagrip.md @@ -9,7 +9,7 @@ TiDB is a MySQL-compatible database, and [JetBrains DataGrip](https://www.jetbra > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. You can use DataGrip in two ways: @@ -47,7 +47,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-gui-dbeaver.md b/develop/dev-guide-gui-dbeaver.md index d3cb2b14d3032..327538168e834 100644 --- a/develop/dev-guide-gui-dbeaver.md +++ b/develop/dev-guide-gui-dbeaver.md @@ -11,7 +11,7 @@ In this tutorial, you can learn how to connect to your TiDB cluster using DBeave > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -42,7 +42,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-gui-mysql-workbench.md b/develop/dev-guide-gui-mysql-workbench.md index 5825b345ea7a5..cfdf810d7bb32 100644 --- a/develop/dev-guide-gui-mysql-workbench.md +++ b/develop/dev-guide-gui-mysql-workbench.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to connect to your TiDB cluster using MySQL > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -47,7 +47,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you have selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-gui-navicat.md b/develop/dev-guide-gui-navicat.md index 1c76b93d99b1e..f757be6f87dfd 100644 --- a/develop/dev-guide-gui-navicat.md +++ b/develop/dev-guide-gui-navicat.md @@ -11,7 +11,7 @@ In this tutorial, you can learn how to connect to your TiDB cluster using Navica > **Note:** > -> This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -43,7 +43,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you have selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-gui-vscode-sqltools.md b/develop/dev-guide-gui-vscode-sqltools.md index 172391b85e2e6..66206847af020 100644 --- a/develop/dev-guide-gui-vscode-sqltools.md +++ b/develop/dev-guide-gui-vscode-sqltools.md @@ -11,7 +11,7 @@ In this tutorial, you can learn how to connect to your TiDB cluster using Visual > **Note:** > -> - This tutorial is compatible with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> - This tutorial is compatible with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. > - This tutorial also works with Visual Studio Code Remote Development environments, such as [GitHub Codespaces](https://github.com/features/codespaces), [Visual Studio Code Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers), and [Visual Studio Code WSL](https://code.visualstudio.com/docs/remote/wsl). ## Prerequisites @@ -47,7 +47,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you have selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-aws-lambda.md b/develop/dev-guide-sample-application-aws-lambda.md index bcd049a588331..e844834dbb634 100644 --- a/develop/dev-guide-sample-application-aws-lambda.md +++ b/develop/dev-guide-sample-application-aws-lambda.md @@ -16,7 +16,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 in AWS Lambda Functio > **Note** > -> This tutorial works with {{{ .starter }}} and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, and TiDB Self-Managed. ## Prerequisites @@ -79,7 +79,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-golang-gorm.md b/develop/dev-guide-sample-application-golang-gorm.md index 47fa580d5efed..fc45bb66ac81c 100644 --- a/develop/dev-guide-sample-application-golang-gorm.md +++ b/develop/dev-guide-sample-application-golang-gorm.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and GORM to accomplish the follo > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -60,7 +60,7 @@ cd tidb-golang-gorm-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-golang-sql-driver.md b/develop/dev-guide-sample-application-golang-sql-driver.md index 30e09365f3b94..4cdc07f613177 100644 --- a/develop/dev-guide-sample-application-golang-sql-driver.md +++ b/develop/dev-guide-sample-application-golang-sql-driver.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Go-MySQL-Driver to accomplis > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -60,7 +60,7 @@ cd tidb-golang-sql-driver-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -199,7 +199,7 @@ func openDB(driverName string, runnable func(db *sql.DB)) { } ``` -When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB cluster. {{{ .starter }}} requires a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. +When using this function, you need to replace `${tidb_host}`, `${tidb_port}`, `${tidb_user}`, `${tidb_password}`, and `${tidb_db_name}` with the actual values of your TiDB cluster. {{{ .starter }}} and {{{ .essential }}} require a secure connection. Therefore, you need to set the value of `${use_ssl}` to `true`. ### Insert data diff --git a/develop/dev-guide-sample-application-java-hibernate.md b/develop/dev-guide-sample-application-java-hibernate.md index 89e1edd34b7b3..5af9a10b3191e 100644 --- a/develop/dev-guide-sample-application-java-hibernate.md +++ b/develop/dev-guide-sample-application-java-hibernate.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Hibernate to accomplish the > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -61,7 +61,7 @@ cd tidb-java-hibernate-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-java-jdbc.md b/develop/dev-guide-sample-application-java-jdbc.md index 0105c1983ce4a..2de789c41ac10 100644 --- a/develop/dev-guide-sample-application-java-jdbc.md +++ b/develop/dev-guide-sample-application-java-jdbc.md @@ -17,7 +17,7 @@ In this tutorial, you can learn how to use TiDB and JDBC to accomplish the follo > **Note:** > -> - This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> - This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. > - Starting from TiDB v7.4, if `connectionCollation` is not configured, and `characterEncoding` is either not configured or set to `UTF-8` in the JDBC URL, the collation used in a JDBC connection depends on the JDBC driver version. For more information, see [Collation used in JDBC connections](/faq/sql-faq.md#collation-used-in-jdbc-connections). @@ -26,7 +26,7 @@ In this tutorial, you can learn how to use TiDB and JDBC to accomplish the follo > **Note:** > -> - This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> - This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. > - Starting from TiDB v7.4, if `connectionCollation` is not configured, and `characterEncoding` is either not configured or set to `UTF-8` in the JDBC URL, the collation used in a JDBC connection depends on the JDBC driver version. For more information, see [Collation used in JDBC connections](https://docs.pingcap.com/tidb/stable/sql-faq#collation-used-in-jdbc-connections). @@ -52,7 +52,7 @@ To complete this tutorial, you need: > **Note:** > -> For security considerations, it is recommended that you use `VERIFY_IDENTITY` to establish TLS connections to TiDB clusters when connecting over the internet. Both {{{ .starter }}} and TiDB Cloud Dedicated use Subject Alternative Name (SAN) certificates, which require MySQL Connector/J version to be greater than or equal to [8.0.22](https://dev.mysql.com/doc/relnotes/connector-j/en/news-8-0-22.html). +> For security considerations, it is recommended that you use `VERIFY_IDENTITY` to establish TLS connections to TiDB clusters when connecting over the internet. {{{ .starter }}}, {{{ .essential }}}, and TiDB Cloud Dedicated use Subject Alternative Name (SAN) certificates, which require MySQL Connector/J version to be greater than or equal to [8.0.22](https://dev.mysql.com/doc/relnotes/connector-j/en/news-8-0-22.html). **If you don't have a TiDB cluster, you can create one as follows:** @@ -79,7 +79,7 @@ cd tidb-java-jdbc-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-java-mybatis.md b/develop/dev-guide-sample-application-java-mybatis.md index 297bbcd000048..97547a0aa9d18 100644 --- a/develop/dev-guide-sample-application-java-mybatis.md +++ b/develop/dev-guide-sample-application-java-mybatis.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and MyBatis to accomplish the fo > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -61,7 +61,7 @@ cd tidb-java-mybatis-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-java-spring-boot.md b/develop/dev-guide-sample-application-java-spring-boot.md index 60166ce6a56f2..7222b33382aab 100644 --- a/develop/dev-guide-sample-application-java-spring-boot.md +++ b/develop/dev-guide-sample-application-java-spring-boot.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB along with [Spring Data JPA](htt > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -61,7 +61,7 @@ cd tidb-java-springboot-jpa-quickstart Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-nextjs.md b/develop/dev-guide-sample-application-nextjs.md index e0802c81e7c37..aa22bc13b525c 100644 --- a/develop/dev-guide-sample-application-nextjs.md +++ b/develop/dev-guide-sample-application-nextjs.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 in Next.js to accompl > **Note** > -> This tutorial works with {{{ .starter }}} and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, and TiDB Self-Managed. ## Prerequisites @@ -73,7 +73,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele -
+
1. Navigate to the [**Clusters** page](https://tidbcloud.com/console/clusters), and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-nodejs-mysql2.md b/develop/dev-guide-sample-application-nodejs-mysql2.md index e843d0726b034..2967a1d7593aa 100644 --- a/develop/dev-guide-sample-application-nodejs-mysql2.md +++ b/develop/dev-guide-sample-application-nodejs-mysql2.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and node-mysql2 to accomplish th > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -77,7 +77,7 @@ npm install mysql2 dotenv --save Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -246,7 +246,7 @@ void main(); > **Note** > -> For {{{ .starter }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}}. +> For {{{ .starter }}} and {{{ .essential }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}}. ### Insert data diff --git a/develop/dev-guide-sample-application-nodejs-mysqljs.md b/develop/dev-guide-sample-application-nodejs-mysqljs.md index 90e4dfa8777ac..ebc1043ab0082 100644 --- a/develop/dev-guide-sample-application-nodejs-mysqljs.md +++ b/develop/dev-guide-sample-application-nodejs-mysqljs.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and mysql.js driver to accomplis > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -77,7 +77,7 @@ npm install mysql dotenv --save Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -242,7 +242,7 @@ conn.end(); > **Note** > -> For {{{ .starter }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}}. +> For {{{ .starter }}} and {{{ .essential }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}}. ### Insert data diff --git a/develop/dev-guide-sample-application-nodejs-prisma.md b/develop/dev-guide-sample-application-nodejs-prisma.md index 80b5701afb973..073d684506678 100644 --- a/develop/dev-guide-sample-application-nodejs-prisma.md +++ b/develop/dev-guide-sample-application-nodejs-prisma.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Prisma to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -77,7 +77,7 @@ npm install prisma typescript ts-node @types/node --save-dev Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-nodejs-sequelize.md b/develop/dev-guide-sample-application-nodejs-sequelize.md index afc4ba3904de5..bf8c042bb1ebf 100644 --- a/develop/dev-guide-sample-application-nodejs-sequelize.md +++ b/develop/dev-guide-sample-application-nodejs-sequelize.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Sequelize to accomplish the > **Note** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -73,7 +73,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-nodejs-typeorm.md b/develop/dev-guide-sample-application-nodejs-typeorm.md index 55fd3b40f8c5e..c43b3d9cb664f 100644 --- a/develop/dev-guide-sample-application-nodejs-typeorm.md +++ b/develop/dev-guide-sample-application-nodejs-typeorm.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and TypeORM to accomplish the fo > **Note** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -85,7 +85,7 @@ npm install @types/node ts-node typescript --save-dev Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -119,7 +119,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele > **Note** > - > For {{{ .starter }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. + > For {{{ .starter }}} and {{{ .essential }}}, you **MUST** enable TLS connection via `TIDB_ENABLE_SSL` when using public endpoint. 7. Save the `.env` file. @@ -276,9 +276,9 @@ export const AppDataSource = new DataSource({ > **Note** > -> For {{{ .starter }}}, you MUST enable TLS connection when using public endpoint. In this sample code, please set up the environment variable `TIDB_ENABLE_SSL` in the `.env` file to `true`. +> For {{{ .starter }}} and {{{ .essential }}}, you MUST enable TLS connection when using public endpoint. In this sample code, please set up the environment variable `TIDB_ENABLE_SSL` in the `.env` file to `true`. > -> However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}}. +> However, you **don't** have to specify an SSL CA certificate via `TIDB_CA_PATH`, because Node.js uses the built-in [Mozilla CA certificate](https://wiki.mozilla.org/CA/Included_Certificates) by default, which is trusted by {{{ .starter }}} and {{{ .essential }}}. ### Insert data diff --git a/develop/dev-guide-sample-application-python-django.md b/develop/dev-guide-sample-application-python-django.md index 1b88310d22689..60560dd16631a 100644 --- a/develop/dev-guide-sample-application-python-django.md +++ b/develop/dev-guide-sample-application-python-django.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Django to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. ## Prerequisites @@ -78,7 +78,7 @@ For more information, refer to [django-tidb repository](https://github.com/pingc Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-python-mysql-connector.md b/develop/dev-guide-sample-application-python-mysql-connector.md index 8d8c6ee24e61c..f4fd3202ac625 100644 --- a/develop/dev-guide-sample-application-python-mysql-connector.md +++ b/develop/dev-guide-sample-application-python-mysql-connector.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and MySQL Connector/Python to ac > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. ## Prerequisites @@ -68,7 +68,7 @@ pip install -r requirements.txt Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-python-mysqlclient.md b/develop/dev-guide-sample-application-python-mysqlclient.md index a8e17e36f5cf0..4ef648fa74432 100644 --- a/develop/dev-guide-sample-application-python-mysqlclient.md +++ b/develop/dev-guide-sample-application-python-mysqlclient.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and mysqlclient to accomplish th > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -70,7 +70,7 @@ If you encounter installation issues, refer to the [mysqlclient official documen Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-python-peewee.md b/develop/dev-guide-sample-application-python-peewee.md index fc3f76786c72c..7ba54b1ae3253 100644 --- a/develop/dev-guide-sample-application-python-peewee.md +++ b/develop/dev-guide-sample-application-python-peewee.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and peewee to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. ## Prerequisites @@ -72,7 +72,7 @@ peewee is an ORM library that works with multiple databases. It provides a high- Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-python-pymysql.md b/develop/dev-guide-sample-application-python-pymysql.md index f1f7876d11e6a..bb686aabbc68b 100644 --- a/develop/dev-guide-sample-application-python-pymysql.md +++ b/develop/dev-guide-sample-application-python-pymysql.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and PyMySQL to accomplish the fo > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. ## Prerequisites @@ -68,7 +68,7 @@ pip install -r requirements.txt Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/develop/dev-guide-sample-application-python-sqlalchemy.md b/develop/dev-guide-sample-application-python-sqlalchemy.md index 2823758a6e846..9b9e42892051e 100644 --- a/develop/dev-guide-sample-application-python-sqlalchemy.md +++ b/develop/dev-guide-sample-application-python-sqlalchemy.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and SQLAlchemy to accomplish the > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters. ## Prerequisites @@ -74,7 +74,7 @@ You can also use other database drivers, such as [mysqlclient](https://github.co Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
> **Note:** > diff --git a/develop/dev-guide-sample-application-ruby-mysql2.md b/develop/dev-guide-sample-application-ruby-mysql2.md index e12b0e58059e6..0019e6f3dc0b8 100644 --- a/develop/dev-guide-sample-application-ruby-mysql2.md +++ b/develop/dev-guide-sample-application-ruby-mysql2.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and mysql2 to accomplish the fol > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -78,7 +78,7 @@ bundle add mysql2 dotenv Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -112,7 +112,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele > **Note** > - > For {{{ .starter }}}, TLS connection **MUST** be enabled via `DATABASE_ENABLE_SSL` when using public endpoint. + > For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), TLS connection **MUST** be enabled via `DATABASE_ENABLE_SSL` when using public endpoint. 7. Save the `.env` file. @@ -231,7 +231,7 @@ client = Mysql2::Client.new(options) > **Note** > -> For {{{ .starter }}}, TLS connection **MUST** be enabled via `DATABASE_ENABLE_SSL` when using public endpoint, but you **don't** have to specify an SSL CA certificate via `DATABASE_SSL_CA`, because mysql2 gem will search for existing CA certificates in a particular order until a file is discovered. +> For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), TLS connection **MUST** be enabled via `DATABASE_ENABLE_SSL` when using public endpoint, but you **don't** have to specify an SSL CA certificate via `DATABASE_SSL_CA`, because mysql2 gem will search for existing CA certificates in a particular order until a file is discovered. ### Insert data diff --git a/develop/dev-guide-sample-application-ruby-rails.md b/develop/dev-guide-sample-application-ruby-rails.md index a496ecbadfe70..d2eccedafe49e 100644 --- a/develop/dev-guide-sample-application-ruby-rails.md +++ b/develop/dev-guide-sample-application-ruby-rails.md @@ -15,7 +15,7 @@ In this tutorial, you can learn how to use TiDB and Rails to accomplish the foll > **Note:** > -> This tutorial works with {{{ .starter }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. +> This tutorial works with {{{ .starter }}}, {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed. ## Prerequisites @@ -78,7 +78,7 @@ bundle add mysql2 dotenv Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -102,7 +102,7 @@ Connect to your TiDB cluster depending on the TiDB deployment option you've sele > **Note** > - > For {{{ .starter }}}, TLS connection **MUST** be enabled with the `ssl_mode=verify_identity` query parameter when using public endpoint. + > For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), TLS connection **MUST** be enabled with the `ssl_mode=verify_identity` query parameter when using public endpoint. 7. Save the `.env` file. @@ -225,7 +225,7 @@ production: > **Note** > -> For {{{ .starter }}}, TLS connection **MUST** be enabled via setting the `ssl_mode` query parameter to `verify_identity` in `DATABASE_URL` when using public endpoint, but you **don't** have to specify an SSL CA certificate via `DATABASE_URL`, because mysql2 gem will search for existing CA certificates in a particular order until a file is discovered. +> For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), TLS connection **MUST** be enabled via setting the `ssl_mode` query parameter to `verify_identity` in `DATABASE_URL` when using public endpoint, but you **don't** have to specify an SSL CA certificate via `DATABASE_URL`, because mysql2 gem will search for existing CA certificates in a particular order until a file is discovered. ### Insert data diff --git a/functions-and-operators/json-functions/json-functions-validate.md b/functions-and-operators/json-functions/json-functions-validate.md index 850c5022d6e02..3f233c798f0c2 100644 --- a/functions-and-operators/json-functions/json-functions-validate.md +++ b/functions-and-operators/json-functions/json-functions-validate.md @@ -9,7 +9,7 @@ This document describes JSON functions that validate JSON documents. > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## [JSON_SCHEMA_VALID()](https://dev.mysql.com/doc/refman/8.0/en/json-validation-functions.html#function_json-schema-valid) diff --git a/functions-and-operators/miscellaneous-functions.md b/functions-and-operators/miscellaneous-functions.md index 239c0bdf90f27..7e8e6d099070f 100644 --- a/functions-and-operators/miscellaneous-functions.md +++ b/functions-and-operators/miscellaneous-functions.md @@ -25,7 +25,7 @@ TiDB supports most of the [miscellaneous functions](https://dev.mysql.com/doc/re | [`IS_IPV6()`](#is_ipv6) | Whether argument is an IPv6 address | | [`IS_UUID()`](#is_uuid) | Whether argument is an UUID | | [`NAME_CONST()`](#name_const) | Can be used to rename a column name | -| [`SLEEP()`](#sleep) | Sleep for a number of seconds. Note that for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, the `SLEEP()` function has a limitation wherein it can only support a maximum sleep time of 300 seconds. | +| [`SLEEP()`](#sleep) | Sleep for a number of seconds. Note that for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters, the `SLEEP()` function has a limitation wherein it can only support a maximum sleep time of 300 seconds. | | [`UUID()`](#uuid) | Return a Universal Unique Identifier (UUID) | | [`UUID_TO_BIN()`](#uuid_to_bin) | Convert UUID from text format to binary format | | [`VALUES()`](#values) | Defines the values to be used during an INSERT | diff --git a/index-advisor.md b/index-advisor.md index 9f71978a2d5ba..4bd0b098f5469 100644 --- a/index-advisor.md +++ b/index-advisor.md @@ -9,7 +9,7 @@ In v8.5.0, TiDB introduces the Index Advisor feature, which helps optimize your > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The Index Advisor analyzes queries to identify indexable columns from clauses such as `WHERE`, `GROUP BY`, and `ORDER BY`. Then, it generates index candidates and estimates their performance benefits using hypothetical indexes. TiDB uses a genetic search algorithm to select the optimal set of indexes starting with single-column indexes and iteratively exploring multi-column indexes, leveraging a "What-If" analysis to evaluate potential indexes based on their impact on optimizer plan costs. The advisor recommends indexes when they reduce the overall cost compared to executing queries without them. diff --git a/information-schema/information-schema-cluster-info.md b/information-schema/information-schema-cluster-info.md index 768dc9fe9ee81..5ce19d06928fb 100644 --- a/information-schema/information-schema-cluster-info.md +++ b/information-schema/information-schema-cluster-info.md @@ -9,7 +9,7 @@ The `CLUSTER_INFO` cluster topology table provides the current topology informat > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. {{< copyable "sql" >}} diff --git a/information-schema/information-schema-placement-policies.md b/information-schema/information-schema-placement-policies.md index c3eaa7b7d3028..f29a57bbb1d35 100644 --- a/information-schema/information-schema-placement-policies.md +++ b/information-schema/information-schema-placement-policies.md @@ -9,7 +9,7 @@ The `PLACEMENT_POLICIES` table provides information on all placement policies. F > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. {{< copyable "sql" >}} diff --git a/information-schema/information-schema-resource-groups.md b/information-schema/information-schema-resource-groups.md index 17b1992fa6d29..9d85810dd3e3a 100644 --- a/information-schema/information-schema-resource-groups.md +++ b/information-schema/information-schema-resource-groups.md @@ -9,7 +9,7 @@ The `RESOURCE_GROUPS` table shows the information about all resource groups. For > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE information_schema; diff --git a/information-schema/information-schema-runaway-watches.md b/information-schema/information-schema-runaway-watches.md index 3f1ca2c04b413..798c6f815c549 100644 --- a/information-schema/information-schema-runaway-watches.md +++ b/information-schema/information-schema-runaway-watches.md @@ -9,7 +9,7 @@ The `RUNAWAY_WATCHES` table shows the watch list of runaway queries that consume > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-slow-query.md b/information-schema/information-schema-slow-query.md index ad51ad0620cbb..438222c03e669 100644 --- a/information-schema/information-schema-slow-query.md +++ b/information-schema/information-schema-slow-query.md @@ -19,7 +19,7 @@ The `SLOW_QUERY` table provides the slow query information of the current node, > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. @@ -131,7 +131,7 @@ The `CLUSTER_SLOW_QUERY` table provides the slow query information of all nodes > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. diff --git a/information-schema/information-schema-tidb-hot-regions-history.md b/information-schema/information-schema-tidb-hot-regions-history.md index db1ccc6d1d02c..93e48b5931158 100644 --- a/information-schema/information-schema-tidb-hot-regions-history.md +++ b/information-schema/information-schema-tidb-hot-regions-history.md @@ -9,7 +9,7 @@ The `TIDB_HOT_REGIONS_HISTORY` table provides information about history hot Regi > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. diff --git a/information-schema/information-schema-tidb-servers-info.md b/information-schema/information-schema-tidb-servers-info.md index dd606e4fe6c19..fc52172cc1f7d 100644 --- a/information-schema/information-schema-tidb-servers-info.md +++ b/information-schema/information-schema-tidb-servers-info.md @@ -9,7 +9,7 @@ The `TIDB_SERVERS_INFO` table provides information about TiDB servers in the TiD > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-region-peers.md b/information-schema/information-schema-tikv-region-peers.md index 05a541f27cc64..c3d77043a27c2 100644 --- a/information-schema/information-schema-tikv-region-peers.md +++ b/information-schema/information-schema-tikv-region-peers.md @@ -9,7 +9,7 @@ The `TIKV_REGION_PEERS` table shows detailed information of a single Region node > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-region-status.md b/information-schema/information-schema-tikv-region-status.md index 48f12b48c78ef..8c224e60b6d2e 100644 --- a/information-schema/information-schema-tikv-region-status.md +++ b/information-schema/information-schema-tikv-region-status.md @@ -9,7 +9,7 @@ The `TIKV_REGION_STATUS` table shows some basic information of TiKV Regions via > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema-tikv-store-status.md b/information-schema/information-schema-tikv-store-status.md index d0c9581820870..10f935a6569bf 100644 --- a/information-schema/information-schema-tikv-store-status.md +++ b/information-schema/information-schema-tikv-store-status.md @@ -9,7 +9,7 @@ The `TIKV_STORE_STATUS` table shows some basic information of TiKV nodes via PD' > **Note:** > -> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql USE INFORMATION_SCHEMA; diff --git a/information-schema/information-schema.md b/information-schema/information-schema.md index bc9d503cec7f9..8d4ddd9c35ab5 100644 --- a/information-schema/information-schema.md +++ b/information-schema/information-schema.md @@ -113,15 +113,15 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`CLUSTER_CONFIG`](/information-schema/information-schema-cluster-config.md) | Provides details about configuration settings for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_DEADLOCKS` | Provides a cluster-level view of the `DEADLOCKS` table. | | [`CLUSTER_HARDWARE`](/information-schema/information-schema-cluster-hardware.md) | Provides details on the underlying physical hardware discovered on each TiDB component. This table is not applicable to TiDB Cloud. | -| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | [`CLUSTER_LOAD`](/information-schema/information-schema-cluster-load.md) | Provides current load information for TiDB servers in the cluster. This table is not applicable to TiDB Cloud. | | [`CLUSTER_LOG`](/information-schema/information-schema-cluster-log.md) | Provides a log for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE` | Provides a cluster-level view of the `MEMORY_USAGE` table. | | `CLUSTER_MEMORY_USAGE_OPS_HISTORY` | Provides a cluster-level view of the `MEMORY_USAGE_OPS_HISTORY` table. | | `CLUSTER_PROCESSLIST` | Provides a cluster-level view of the `PROCESSLIST` table. | -| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | `CLUSTER_TIDB_INDEX_USAGE` | Provides a cluster-level view of the `TIDB_INDEX_USAGE` table. | | `CLUSTER_TIDB_TRX` | Provides a cluster-level view of the `TIDB_TRX` table. | | [`CLUSTER_SYSTEMINFO`](/information-schema/information-schema-cluster-systeminfo.md) | Provides details about kernel parameter configuration for servers in the cluster. This table is not applicable to TiDB Cloud. | @@ -136,11 +136,11 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`METRICS_SUMMARY`](/information-schema/information-schema-metrics-summary.md) | A summary of metrics extracted from Prometheus. This table is not applicable to TiDB Cloud. | | `METRICS_SUMMARY_BY_LABEL` | See `METRICS_SUMMARY` table. This table is not applicable to TiDB Cloud. | | [`METRICS_TABLES`](/information-schema/information-schema-metrics-tables.md) | Provides the PromQL definitions for tables in `METRICS_SCHEMA`. This table is not applicable to TiDB Cloud. | -| [`PLACEMENT_POLICIES`](/information-schema/information-schema-placement-policies.md) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| [`PLACEMENT_POLICIES`](/information-schema/information-schema-placement-policies.md) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | [`SEQUENCES`](/information-schema/information-schema-sequences.md) | The TiDB implementation of sequences is based on MariaDB. | -| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) | Provides details about table sizes in storage. | | [`TIDB_HOT_REGIONS`](/information-schema/information-schema-tidb-hot-regions.md) | Provides statistics about which regions are hot. | | [`TIDB_HOT_REGIONS_HISTORY`](/information-schema/information-schema-tidb-hot-regions-history.md) | Provides history statistics about which Regions are hot. | @@ -166,15 +166,15 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`CLUSTER_CONFIG`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-config) | Provides details about configuration settings for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_DEADLOCKS` | Provides a cluster-level view of the `DEADLOCKS` table. | | [`CLUSTER_HARDWARE`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-hardware) | Provides details on the underlying physical hardware discovered on each TiDB component. This table is not applicable to TiDB Cloud. | -| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| [`CLUSTER_INFO`](/information-schema/information-schema-cluster-info.md) | Provides details on the current cluster topology. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | [`CLUSTER_LOAD`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-load) | Provides current load information for TiDB servers in the cluster. This table is not applicable to TiDB Cloud. | | [`CLUSTER_LOG`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-log) | Provides a log for the entire TiDB cluster. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE` | Provides a cluster-level view of the `MEMORY_USAGE` table. This table is not applicable to TiDB Cloud. | | `CLUSTER_MEMORY_USAGE_OPS_HISTORY` | Provides a cluster-level view of the `MEMORY_USAGE_OPS_HISTORY` table. This table is not applicable to TiDB Cloud. | | `CLUSTER_PROCESSLIST` | Provides a cluster-level view of the `PROCESSLIST` table. | -| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| `CLUSTER_SLOW_QUERY` | Provides a cluster-level view of the `SLOW_QUERY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_STATEMENTS_SUMMARY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| `CLUSTER_STATEMENTS_SUMMARY_HISTORY` | Provides a cluster-level view of the `STATEMENTS_SUMMARY_HISTORY` table. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | `CLUSTER_TIDB_TRX` | Provides a cluster-level view of the `TIDB_TRX` table. | | [`CLUSTER_SYSTEMINFO`](https://docs.pingcap.com/tidb/stable/information-schema-cluster-systeminfo) | Provides details about kernel parameter configuration for servers in the cluster. This table is not applicable to TiDB Cloud. | | [`DATA_LOCK_WAITS`](/information-schema/information-schema-data-lock-waits.md) | Provides the lock-waiting information on the TiKV server. | @@ -188,11 +188,11 @@ Many `INFORMATION_SCHEMA` tables have a corresponding `SHOW` statement. The bene | [`METRICS_SUMMARY`](https://docs.pingcap.com/tidb/stable/information-schema-metrics-summary) | A summary of metrics extracted from Prometheus. This table is not applicable to TiDB Cloud. | | `METRICS_SUMMARY_BY_LABEL` | See `METRICS_SUMMARY` table. This table is not applicable to TiDB Cloud. | | [`METRICS_TABLES`](https://docs.pingcap.com/tidb/stable/information-schema-metrics-tables) | Provides the PromQL definitions for tables in `METRICS_SCHEMA`. This table is not applicable to TiDB Cloud. | -| [`PLACEMENT_POLICIES`](https://docs.pingcap.com/tidb/stable/information-schema-placement-policies) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | +| [`PLACEMENT_POLICIES`](https://docs.pingcap.com/tidb/stable/information-schema-placement-policies) | Provides information on all placement policies. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | | [`SEQUENCES`](/information-schema/information-schema-sequences.md) | The TiDB implementation of sequences is based on MariaDB. | -| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. | -| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters.| +| [`SLOW_QUERY`](/information-schema/information-schema-slow-query.md) | Provides information on slow queries on the current TiDB server. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`STATEMENTS_SUMMARY`](/statement-summary-tables.md) | Similar to performance_schema statement summary in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. | +| [`STATEMENTS_SUMMARY_HISTORY`](/statement-summary-tables.md) | Similar to performance_schema statement summary history in MySQL. This table is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters.| | [`TABLE_STORAGE_STATS`](/information-schema/information-schema-table-storage-stats.md) | Provides details about table sizes in storage. | | [`TIDB_HOT_REGIONS`](https://docs.pingcap.com/tidb/stable/information-schema-tidb-hot-regions) | Provides statistics about which regions are hot. This table is not applicable to TiDB Cloud. | | [`TIDB_HOT_REGIONS_HISTORY`](/information-schema/information-schema-tidb-hot-regions-history.md) | Provides history statistics about which Regions are hot. | diff --git a/media/tidb-cloud/regional-high-avaliability-alibaba-cloud.png b/media/tidb-cloud/regional-high-avaliability-alibaba-cloud.png new file mode 100644 index 0000000000000..3cab81f5ab46d Binary files /dev/null and b/media/tidb-cloud/regional-high-avaliability-alibaba-cloud.png differ diff --git a/media/tidb-cloud/serverless-regional-high-avaliability-aws.png b/media/tidb-cloud/serverless-regional-high-avaliability-aws.png deleted file mode 100644 index 368373b69bef2..0000000000000 Binary files a/media/tidb-cloud/serverless-regional-high-avaliability-aws.png and /dev/null differ diff --git a/media/tidb-cloud/serverless-zonal-high-avaliability-aws.png b/media/tidb-cloud/serverless-zonal-high-avaliability-aws.png deleted file mode 100644 index 2a2d5739640c6..0000000000000 Binary files a/media/tidb-cloud/serverless-zonal-high-avaliability-aws.png and /dev/null differ diff --git a/media/tidb-cloud/zonal-high-avaliability-alibaba-cloud.png b/media/tidb-cloud/zonal-high-avaliability-alibaba-cloud.png new file mode 100644 index 0000000000000..e5e49c20bbd83 Binary files /dev/null and b/media/tidb-cloud/zonal-high-avaliability-alibaba-cloud.png differ diff --git a/media/tidb-cloud/zonal-high-avaliability-aws.png b/media/tidb-cloud/zonal-high-avaliability-aws.png new file mode 100644 index 0000000000000..93a3fc0cb7761 Binary files /dev/null and b/media/tidb-cloud/zonal-high-avaliability-aws.png differ diff --git a/placement-rules-in-sql.md b/placement-rules-in-sql.md index 92a98d8f75287..ee0658768b030 100644 --- a/placement-rules-in-sql.md +++ b/placement-rules-in-sql.md @@ -15,7 +15,7 @@ This feature can fulfill the following use cases: > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Overview diff --git a/schema-cache.md b/schema-cache.md index 75397f7994da6..29aaec97ab73c 100644 --- a/schema-cache.md +++ b/schema-cache.md @@ -9,7 +9,7 @@ In some multi-tenant scenarios, there might be hundreds of thousands or even mil > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Configure schema cache diff --git a/scripts/concatMdByToc.js b/scripts/concatMdByToc.js index 0d8d9dbbe4fcc..aef3c1c7da628 100644 --- a/scripts/concatMdByToc.js +++ b/scripts/concatMdByToc.js @@ -126,7 +126,7 @@ const main = () => { let mergedStr = ""; fileList.forEach((filePath) => { - mergedStr += `${handleSingleMd(`.${filePath}`)}\n\n`; + mergedStr += `${handleSingleMd(`./${filePath}`)}\n\n`; }); const variables = JSON.parse( diff --git a/scripts/filterCloudDoc.js b/scripts/filterCloudDoc.js index 8211fcc0e1d38..6661002398883 100644 --- a/scripts/filterCloudDoc.js +++ b/scripts/filterCloudDoc.js @@ -1,5 +1,5 @@ import { - getAllMdList, + getAllCloudMdList, copySingleFileSync, copyFileWithCustomContentSync, copyDirectoryWithCustomContentSync, @@ -25,9 +25,9 @@ const extractFilefromList = ( }; const main = () => { - const filteredLinkList = getAllMdList("TOC-tidb-cloud.md"); + const allFilePaths = getAllCloudMdList(); - extractFilefromList(filteredLinkList, ".", "./tmp"); + extractFilefromList(allFilePaths, "./", "./tmp"); copySingleFileSync("TOC-tidb-cloud.md", "./tmp/TOC.md"); copyDirectoryWithCustomContentSync( "./tidb-cloud/", diff --git a/scripts/filterCloudInitFiles.js b/scripts/filterCloudInitFiles.js new file mode 100644 index 0000000000000..06cc7781862f9 --- /dev/null +++ b/scripts/filterCloudInitFiles.js @@ -0,0 +1,69 @@ +import * as fs from "fs"; +import path from "path"; +import { getAllCloudMdList } from "./utils.js"; + +const allFilePaths = getAllCloudMdList(); + +// Set to store filtered file paths +const filePaths = new Set(); + +// Filter the file paths +for (const filePath of allFilePaths) { + // Skip external links (starting with http/https) + if (filePath.startsWith("http")) { + continue; + } + + // Skip anchor links (starting with #) + if (filePath.startsWith("#")) { + continue; + } + + // Skip files in tidb-cloud folder + if (cleanPath.startsWith("tidb-cloud/")) { + continue; + } + + filePaths.add(cleanPath); +} + +// Create tmp directory if it doesn't exist +const tmpDir = "tmp"; +if (!fs.existsSync(tmpDir)) { + fs.mkdirSync(tmpDir, { recursive: true }); +} + +// Copy files to tmp directory +let copiedCount = 0; +let skippedCount = 0; + +for (const filePath of filePaths) { + const sourcePath = filePath; + const targetPath = path.join(tmpDir, filePath); + + // Create target directory if it doesn't exist + const targetDir = path.dirname(targetPath); + if (!fs.existsSync(targetDir)) { + fs.mkdirSync(targetDir, { recursive: true }); + } + + // Check if source file exists + if (fs.existsSync(sourcePath)) { + try { + fs.copyFileSync(sourcePath, targetPath); + console.log(`✓ Copied: ${filePath}`); + copiedCount++; + } catch (error) { + console.error(`✗ Error copying ${filePath}: ${error.message}`); + } + } else { + console.log(`⚠ Skipped (not found): ${filePath}`); + skippedCount++; + } +} + +console.log(`\nSummary:`); +console.log(`- Total files referenced: ${filePaths.size}`); +console.log(`- Files copied: ${copiedCount}`); +console.log(`- Files skipped: ${skippedCount}`); +console.log(`- Files copied to: ${tmpDir}/`); diff --git a/scripts/filterNonCloudDoc.js b/scripts/filterNonCloudDoc.js index aae0eda35766e..768a5281200cc 100644 --- a/scripts/filterNonCloudDoc.js +++ b/scripts/filterNonCloudDoc.js @@ -3,6 +3,7 @@ import { copySingleFileSync, copyFileWithCustomContentSync, removeCustomContent, + CLOUD_TOC_LIST, } from "./utils.js"; const contentHandler = (content = "") => { @@ -17,7 +18,7 @@ const extractFilefromList = ( fileList.forEach((filePath = "") => { if ( filePath.includes(`/tidb-cloud/`) || - filePath.includes(`TOC-tidb-cloud.md`) + CLOUD_TOC_LIST.some((tocFile) => filePath.includes(tocFile)) ) { return; } diff --git a/scripts/filterUpdateFiles.js b/scripts/filterUpdateFiles.js index 844c6c82ee748..b3ce37df9e604 100644 --- a/scripts/filterUpdateFiles.js +++ b/scripts/filterUpdateFiles.js @@ -2,6 +2,7 @@ import * as fs from "fs"; import path from "path"; import axios from "axios"; import { Octokit } from "octokit"; +import { CLOUD_TOC_LIST, getAllCloudMdList } from "./utils.js"; const GH_TOKEN = process.env.GH_TOKEN || ""; @@ -92,68 +93,29 @@ const deleteFile = (targetFile) => { } }; -// read toc file and parse the file paths -const parseTOCFile = (tocPath) => { - try { - if (!fs.existsSync(tocPath)) { - console.log(`TOC file not found: ${tocPath}`); - return new Set(); - } - - const content = fs.readFileSync(tocPath, "utf8"); - const filePaths = new Set(); - - // use regex to match the file paths in markdown links - // match [text](path) format - const linkRegex = /\[([^\]]+)\]\(([^)]+)\)/g; - let match; - - while ((match = linkRegex.exec(content)) !== null) { - const link = match[2]; - // only process links ending with .md - if (link.endsWith(".md")) { - // remove ./ or / at the beginning to ensure path consistency - const normalizedPath = link.replace(/^\.?\//, ""); - filePaths.add(normalizedPath); - } - } - - console.log(`Found ${filePaths.size} files in TOC: ${tocPath}`); - if (filePaths.size > 0) { - console.log( - "Files in TOC:", - Array.from(filePaths).slice(0, 5).join(", "), - filePaths.size > 5 ? `... and ${filePaths.size - 5} more` : "" - ); - } - return filePaths; - } catch (error) { - console.error(`Error parsing TOC file ${tocPath}:`, error); - return new Set(); - } -}; - // get the file list from the toc file const getCloudTOCFiles = () => { - // check ./tmp/TOC-tidb-cloud.md first - const tmpTocPath = "./tmp/TOC-tidb-cloud.md"; - const localTocPath = "TOC-tidb-cloud.md"; + const tmpTocFiles = getAllCloudMdList([ + "./tmp/TOC-tidb-cloud.md", + "./tmp/TOC-tidb-cloud-starter.md", + "./tmp/TOC-tidb-cloud-essential.md", + ]); + const tocFiles = getAllCloudMdList(CLOUD_TOC_LIST); - let tocFiles = parseTOCFile(tmpTocPath); + // Convert to Set + const tmpTocFilesSet = new Set(tmpTocFiles); + const tocFilesSet = new Set(tocFiles); - // if not found in /tmp, check the current directory - if (tocFiles.size === 0) { - console.log(`No files found in ${tmpTocPath}, trying ${localTocPath}`); - tocFiles = parseTOCFile(localTocPath); - } + // Use tmpTocFiles if not empty, otherwise use tocFiles + const finalTocFiles = tmpTocFilesSet.size > 0 ? tmpTocFilesSet : tocFilesSet; - if (tocFiles.size === 0) { + if (finalTocFiles.size === 0) { console.log( "Warning: No TOC file found or no files in TOC. All .md files will be processed." ); } - return tocFiles; + return finalTocFiles; }; // filter the files in tmp directory by the toc file diff --git a/scripts/utils.js b/scripts/utils.js index 2a727cb5acbbf..9d2160321604a 100644 --- a/scripts/utils.js +++ b/scripts/utils.js @@ -59,13 +59,34 @@ const filterLink = (srcList = []) => { }; export const getAllMdList = (tocFile) => { + if (!fs.existsSync(tocFile)) { + console.log(`TOC file not found: ${tocFile}`); + return []; + } + const tocFileContent = fs.readFileSync(tocFile); const mdAst = generateMdAstFromFile(tocFileContent); const linkList = extractLinkNodeFromAst(mdAst); - const filteredLinkList = filterLink(linkList); + const filteredLinkList = filterLink(linkList).map((link) => + link.replace(/^\.?\//, "") + ); return filteredLinkList; }; +export const CLOUD_TOC_LIST = [ + "TOC-tidb-cloud.md", + "TOC-tidb-cloud-essential.md", + "TOC-tidb-cloud-starter.md", +]; + +export const getAllCloudMdList = (tocFiles = CLOUD_TOC_LIST) => { + // Get all MD files from multiple TOCs and deduplicate + const allFilteredLinkLists = tocFiles.map((tocFile) => getAllMdList(tocFile)); + const flattenedList = allFilteredLinkLists.flat(); + const allFilePaths = [...new Set(flattenedList)]; // Deduplicate + return allFilePaths; +}; + const checkDestDir = (destPath) => { const dir = path.dirname(destPath); diff --git a/sql-statements/sql-statement-admin-alter-ddl.md b/sql-statements/sql-statement-admin-alter-ddl.md index 41af54e9e4526..0222e7c047caf 100644 --- a/sql-statements/sql-statement-admin-alter-ddl.md +++ b/sql-statements/sql-statement-admin-alter-ddl.md @@ -7,7 +7,7 @@ summary: An overview of the usage of `ADMIN ALTER DDL JOBS` for the TiDB databas > **Note:** > -> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Currently, this feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The `ADMIN ALTER DDL JOBS` statement allows you to modify the parameter of a single running DDL job. For example: diff --git a/sql-statements/sql-statement-admin.md b/sql-statements/sql-statement-admin.md index 6bdc15b9fb579..6fa9ae91496ab 100644 --- a/sql-statements/sql-statement-admin.md +++ b/sql-statements/sql-statement-admin.md @@ -58,7 +58,7 @@ The above statement is used to reload the blocklist of logic optimization rules. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql ADMIN PLUGINS ENABLE plugin_name [, plugin_name] ...; @@ -132,7 +132,7 @@ The above statement is used to view the details of some special columns of a tab > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ```sql ADMIN SHOW SLOW RECENT N; diff --git a/sql-statements/sql-statement-alter-instance.md b/sql-statements/sql-statement-alter-instance.md index 590bfb0f386ba..5ca5ab6417ebe 100644 --- a/sql-statements/sql-statement-alter-instance.md +++ b/sql-statements/sql-statement-alter-instance.md @@ -9,7 +9,7 @@ The `ALTER INSTANCE` statement is used to make changes to a single TiDB instance > **Note:** > -> [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) can automatically refresh the TLS certificate, so this feature is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) can automatically refresh the TLS certificate, so this feature is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## RELOAD TLS diff --git a/sql-statements/sql-statement-alter-placement-policy.md b/sql-statements/sql-statement-alter-placement-policy.md index 4679e09b8749c..a611ce8fba5e1 100644 --- a/sql-statements/sql-statement-alter-placement-policy.md +++ b/sql-statements/sql-statement-alter-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of ALTER PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. `ALTER PLACEMENT POLICY` _replaces_ the previous policy with the new definition. It does not _merge_ the old policy with the new one. In the following example, `FOLLOWERS=4` is lost when the `ALTER PLACEMENT POLICY` is executed: diff --git a/sql-statements/sql-statement-alter-range.md b/sql-statements/sql-statement-alter-range.md index 8efba9f85d0aa..0140037ae2e25 100644 --- a/sql-statements/sql-statement-alter-range.md +++ b/sql-statements/sql-statement-alter-range.md @@ -9,7 +9,7 @@ Currently, the `ALTER RANGE` statement can only be used to modify the range of a > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-alter-resource-group.md b/sql-statements/sql-statement-alter-resource-group.md index e3d355d36cfc2..7867298f492dc 100644 --- a/sql-statements/sql-statement-alter-resource-group.md +++ b/sql-statements/sql-statement-alter-resource-group.md @@ -9,7 +9,7 @@ The `ALTER RESOURCE GROUP` statement is used to modify a resource group in a dat > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-backup.md b/sql-statements/sql-statement-backup.md index 379e36804390e..69f827493f2ce 100644 --- a/sql-statements/sql-statement-backup.md +++ b/sql-statements/sql-statement-backup.md @@ -10,7 +10,7 @@ This statement is used to perform a distributed backup of the TiDB cluster. > **Warning:** > > - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. -> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The `BACKUP` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview) does, except that the backup process is driven by TiDB itself rather than a separate BR tool. All benefits and warnings of BR also apply to this statement. diff --git a/sql-statements/sql-statement-create-placement-policy.md b/sql-statements/sql-statement-create-placement-policy.md index 0bb6c6d1ac634..32cb0bc26375d 100644 --- a/sql-statements/sql-statement-create-placement-policy.md +++ b/sql-statements/sql-statement-create-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of CREATE PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-create-resource-group.md b/sql-statements/sql-statement-create-resource-group.md index 7ece74028bf85..8610c334312fc 100644 --- a/sql-statements/sql-statement-create-resource-group.md +++ b/sql-statements/sql-statement-create-resource-group.md @@ -9,7 +9,7 @@ You can use the `CREATE RESOURCE GROUP` statement to create a resource group. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-drop-placement-policy.md b/sql-statements/sql-statement-drop-placement-policy.md index 8e7f85443ee93..12deacecb36e8 100644 --- a/sql-statements/sql-statement-drop-placement-policy.md +++ b/sql-statements/sql-statement-drop-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of ALTER PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-drop-resource-group.md b/sql-statements/sql-statement-drop-resource-group.md index 7f3d7bdebccfc..2d794a08de019 100644 --- a/sql-statements/sql-statement-drop-resource-group.md +++ b/sql-statements/sql-statement-drop-resource-group.md @@ -9,7 +9,7 @@ You can use the `DROP RESOURCE GROUP` statement to drop a resource group. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-flashback-cluster.md b/sql-statements/sql-statement-flashback-cluster.md index 7836a817eda98..e00160cd64be0 100644 --- a/sql-statements/sql-statement-flashback-cluster.md +++ b/sql-statements/sql-statement-flashback-cluster.md @@ -11,7 +11,7 @@ Starting from v6.5.6, v7.1.3, v7.5.1, and v7.6.0, TiDB introduces the `FLASHBACK > **Warning:** > -> The `FLASHBACK CLUSTER TO [TIMESTAMP|TSO]` syntax is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. To avoid unexpected results, do not execute this statement on {{{ .starter }}} clusters. +> The `FLASHBACK CLUSTER TO [TIMESTAMP|TSO]` syntax is not applicable to [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. To avoid unexpected results, do not execute this statement on {{{ .starter }}} and {{{ .essential }}} clusters. > **Warning:** > diff --git a/sql-statements/sql-statement-import-into.md b/sql-statements/sql-statement-import-into.md index 4fcf3880b528c..7dcd4cec8c878 100644 --- a/sql-statements/sql-statement-import-into.md +++ b/sql-statements/sql-statement-import-into.md @@ -161,7 +161,7 @@ The supported options are described as follows: ## `IMPORT INTO ... FROM FILE` usage -For TiDB Self-Managed, `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3, GCS, and the TiDB local storage. For [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3 and GCS. For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3 and Alibaba Cloud OSS. +For TiDB Self-Managed, `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3, GCS, and the TiDB local storage. For [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3 and GCS. For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), `IMPORT INTO ... FROM FILE` supports importing data from files stored in Amazon S3 and Alibaba Cloud OSS. - For data files stored in Amazon S3 or GCS, `IMPORT INTO ... FROM FILE` supports running in the [TiDB Distributed eXecution Framework (DXF)](/tidb-distributed-execution-framework.md). @@ -189,7 +189,7 @@ For TiDB Self-Managed, `IMPORT INTO ... FROM FILE` supports importing data from > **Note:** > -> Global Sort is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Global Sort is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. `IMPORT INTO ... FROM FILE` splits the data import job of a source data file into multiple sub-jobs, each sub-job independently encoding and sorting data before importing. If the encoded KV ranges of these sub-jobs have significant overlap (to learn how TiDB encodes data to KV, see [TiDB computing](/tidb-computing.md)), TiKV needs to keep compaction during import, leading to a decrease in import performance and stability. diff --git a/sql-statements/sql-statement-load-data.md b/sql-statements/sql-statement-load-data.md index 157bbe911272e..876dfaf97a41c 100644 --- a/sql-statements/sql-statement-load-data.md +++ b/sql-statements/sql-statement-load-data.md @@ -20,7 +20,7 @@ Starting from TiDB v7.0.0, the `LOAD DATA` SQL statement supports the following > **Note:** > -> For the `LOAD DATA INFILE` statement, TiDB Cloud Dedicated supports `LOAD DATA LOCAL INFILE`, and `LOAD DATA INFILE` from Amazon S3 or Google Cloud Storage, while {{{ .starter }}} only supports `LOAD DATA LOCAL INFILE`. +> For the `LOAD DATA INFILE` statement, TiDB Cloud Dedicated supports `LOAD DATA LOCAL INFILE`, and `LOAD DATA INFILE` from Amazon S3 or Google Cloud Storage, while [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) only support `LOAD DATA LOCAL INFILE`. @@ -45,7 +45,7 @@ Fields ::= You can use `LOCAL` to specify data files on the client to be imported, where the file parameter must be the file system path on the client. -If you are using TiDB Cloud, to use the `LOAD DATA` statement to load local data files, you need to add the `--local-infile` option to the connection string when you connect to TiDB Cloud. +If you are using TiDB Cloud, to use the `LOAD DATA` statement to load local data files, you need to add the `--local-infile` option to the connection string when you connect to TiDB Cloud. - The following is an example connection string for {{{ .starter }}}: diff --git a/sql-statements/sql-statement-load-stats.md b/sql-statements/sql-statement-load-stats.md index 3c00a964f0473..07d0667f37a49 100644 --- a/sql-statements/sql-statement-load-stats.md +++ b/sql-statements/sql-statement-load-stats.md @@ -9,7 +9,7 @@ The `LOAD STATS` statement is used to load the statistics into TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-lock-tables-and-unlock-tables.md b/sql-statements/sql-statement-lock-tables-and-unlock-tables.md index 695144347b1e3..6c0c8c705fa13 100644 --- a/sql-statements/sql-statement-lock-tables-and-unlock-tables.md +++ b/sql-statements/sql-statement-lock-tables-and-unlock-tables.md @@ -23,7 +23,7 @@ A table lock protects against reads or writes by other sessions. A session that > > - For TiDB Self-Managed, to enable the table locks feature, you need to set [`enable-table-lock`](https://docs.pingcap.com/tidb/stable/tidb-configuration-file#enable-table-lock-new-in-v400) to `true` in the configuration files of all TiDB instances. > - For TiDB Cloud Dedicated, to enable the table locks feature, you need to contact [TiDB Cloud Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support) to set [`enable-table-lock`](https://docs.pingcap.com/tidb/stable/tidb-configuration-file#enable-table-lock-new-in-v400) to `true`. -> - For {{{ .starter }}}, setting [`enable-table-lock`](https://docs.pingcap.com/tidb/stable/tidb-configuration-file#enable-table-lock-new-in-v400) to `true` is not supported. +> - For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), setting [`enable-table-lock`](https://docs.pingcap.com/tidb/stable/tidb-configuration-file#enable-table-lock-new-in-v400) to `true` is not supported. ## Synopsis diff --git a/sql-statements/sql-statement-query-watch.md b/sql-statements/sql-statement-query-watch.md index f36746e88ee43..4803d9a78844b 100644 --- a/sql-statements/sql-statement-query-watch.md +++ b/sql-statements/sql-statement-query-watch.md @@ -9,7 +9,7 @@ The `QUERY WATCH` statement is used to manually manage the watch list of runaway > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-restore.md b/sql-statements/sql-statement-restore.md index 64e9f4b3a46b4..18751f129488e 100644 --- a/sql-statements/sql-statement-restore.md +++ b/sql-statements/sql-statement-restore.md @@ -10,7 +10,7 @@ This statement performs a distributed restore from a backup archive previously p > **Warning:** > > - This feature is experimental. It is not recommended that you use it in the production environment. This feature might be changed or removed without prior notice. If you find a bug, you can report an [issue](https://github.com/pingcap/tidb/issues) on GitHub. -> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> - This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The `RESTORE` statement uses the same engine as the [BR tool](https://docs.pingcap.com/tidb/stable/backup-and-restore-overview), except that the restore process is driven by TiDB itself rather than a separate BR tool. All benefits and caveats of BR also apply here. In particular, **`RESTORE` is currently not ACID-compliant**. Before running `RESTORE`, ensure that the following requirements are met: diff --git a/sql-statements/sql-statement-set-resource-group.md b/sql-statements/sql-statement-set-resource-group.md index e05e716c8214a..7294d374553dc 100644 --- a/sql-statements/sql-statement-set-resource-group.md +++ b/sql-statements/sql-statement-set-resource-group.md @@ -9,7 +9,7 @@ summary: An overview of the usage of SET RESOURCE GROUP in the TiDB database. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-show-backups.md b/sql-statements/sql-statement-show-backups.md index 9e949f72627c5..0d4e26592d4dd 100644 --- a/sql-statements/sql-statement-show-backups.md +++ b/sql-statements/sql-statement-show-backups.md @@ -13,7 +13,7 @@ Use `SHOW BACKUPS` to query `BACKUP` tasks and use `SHOW RESTORES` to query `RES > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. Backups and restores that were started with the `br` commandline tool are not shown. diff --git a/sql-statements/sql-statement-show-create-placement-policy.md b/sql-statements/sql-statement-show-create-placement-policy.md index 3766d6466d554..1e5a77a5e7d81 100644 --- a/sql-statements/sql-statement-show-create-placement-policy.md +++ b/sql-statements/sql-statement-show-create-placement-policy.md @@ -9,7 +9,7 @@ summary: The usage of SHOW CREATE PLACEMENT POLICY in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-show-create-resource-group.md b/sql-statements/sql-statement-show-create-resource-group.md index 72eb6a84ac0ad..f3d7456c04679 100644 --- a/sql-statements/sql-statement-show-create-resource-group.md +++ b/sql-statements/sql-statement-show-create-resource-group.md @@ -9,7 +9,7 @@ You can use the `SHOW CREATE RESOURCE GROUP` statement to view the current defin > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-show-placement-for.md b/sql-statements/sql-statement-show-placement-for.md index 2850c3195f557..4b6b3007455f5 100644 --- a/sql-statements/sql-statement-show-placement-for.md +++ b/sql-statements/sql-statement-show-placement-for.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT FOR in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The statement returns a result set in which the `Scheduling_State` field indicates the current progress that the Placement Driver (PD) has made in scheduling the placement: diff --git a/sql-statements/sql-statement-show-placement-labels.md b/sql-statements/sql-statement-show-placement-labels.md index 980359ee64c47..39c8b92422b8f 100644 --- a/sql-statements/sql-statement-show-placement-labels.md +++ b/sql-statements/sql-statement-show-placement-labels.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT LABELS in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-show-placement.md b/sql-statements/sql-statement-show-placement.md index d2dd4040ef771..38c49a1aa0099 100644 --- a/sql-statements/sql-statement-show-placement.md +++ b/sql-statements/sql-statement-show-placement.md @@ -9,7 +9,7 @@ summary: The usage of SHOW PLACEMENT in TiDB. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. The statement returns a result set in which the `Scheduling_State` field indicates the current progress that the Placement Driver (PD) has made in scheduling the placement: diff --git a/sql-statements/sql-statement-show-plugins.md b/sql-statements/sql-statement-show-plugins.md index f480e0c3e0523..79ad48f7243a4 100644 --- a/sql-statements/sql-statement-show-plugins.md +++ b/sql-statements/sql-statement-show-plugins.md @@ -9,7 +9,7 @@ summary: An overview of the usage of SHOW PLUGINS for the TiDB database. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/sql-statements/sql-statement-show-table-regions.md b/sql-statements/sql-statement-show-table-regions.md index 8bf1dd87bd695..b97b01ce04212 100644 --- a/sql-statements/sql-statement-show-table-regions.md +++ b/sql-statements/sql-statement-show-table-regions.md @@ -9,7 +9,7 @@ The `SHOW TABLE REGIONS` statement is used to show the Region information of a t > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Syntax diff --git a/sql-statements/sql-statement-split-region.md b/sql-statements/sql-statement-split-region.md index ba10bc13080d6..458f942729a68 100644 --- a/sql-statements/sql-statement-split-region.md +++ b/sql-statements/sql-statement-split-region.md @@ -13,7 +13,7 @@ To solve the hotspot problem in the above scenario, TiDB introduces the pre-spli > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Synopsis diff --git a/statement-summary-tables.md b/statement-summary-tables.md index 9289f7b940309..91180f0e65379 100644 --- a/statement-summary-tables.md +++ b/statement-summary-tables.md @@ -17,7 +17,7 @@ Therefore, starting from v4.0.0-rc.1, TiDB provides system tables in `informatio > **Note:** > -> The preceding tables are not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> The preceding tables are not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. This document details these tables and introduces how to use them to troubleshoot SQL performance issues. diff --git a/statistics.md b/statistics.md index 049c660ce5561..18b23df776db1 100644 --- a/statistics.md +++ b/statistics.md @@ -460,7 +460,7 @@ You can run the [`DROP STATS`](/sql-statements/sql-statement-drop-stats.md) stat > **Note:** > -> Loading statistics is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> Loading statistics is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. By default, depending on the size of column statistics, TiDB loads statistics differently as follows: diff --git a/system-variables.md b/system-variables.md index 1f6b006501fde..86a17249b26b0 100644 --- a/system-variables.md +++ b/system-variables.md @@ -391,7 +391,7 @@ mysql> SELECT * FROM t1; > **Note:** > -> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). @@ -592,7 +592,7 @@ This variable is an alias for [`last_insert_id`](#last_insert_id). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -645,7 +645,7 @@ This variable is an alias for [`last_insert_id`](#last_insert_id). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -790,7 +790,7 @@ mysql> SHOW GLOBAL VARIABLES LIKE 'max_prepared_stmt_count'; > **Note:** > -> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: No, only applicable to the current TiDB instance that you are connecting to. @@ -802,7 +802,7 @@ mysql> SHOW GLOBAL VARIABLES LIKE 'max_prepared_stmt_count'; > **Note:** > -> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is not supported on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: No, only applicable to the current TiDB instance that you are connecting to. @@ -849,7 +849,7 @@ mysql> SHOW GLOBAL VARIABLES LIKE 'max_prepared_stmt_count'; - Persists to cluster: Yes - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Boolean -- Default value: `OFF` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `ON` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Default value: `OFF` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `ON` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) @@ -871,7 +871,7 @@ mysql> SHOW GLOBAL VARIABLES LIKE 'max_prepared_stmt_count'; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -1398,7 +1398,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION - Persists to cluster: No @@ -1578,7 +1578,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -1594,7 +1594,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > > - If you are using a [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated) cluster, to improve the speed for index creation using this variable, make sure that your TiDB cluster is hosted on AWS and your TiDB node size is at least 8 vCPU. -> - For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters, this variable is read-only. +> - For [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters, this variable is read-only. - Scope: GLOBAL - Persists to cluster: Yes @@ -1654,7 +1654,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -1668,7 +1668,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -1682,7 +1682,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -1700,7 +1700,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -1728,7 +1728,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -1854,7 +1854,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -1886,7 +1886,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -1904,7 +1904,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -1992,7 +1992,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: No, only applicable to the current TiDB instance that you are connecting to. @@ -2135,7 +2135,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -2225,7 +2225,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -2307,7 +2307,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -2631,7 +2631,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -2695,7 +2695,7 @@ mysql> SELECT job_info FROM mysql.analyze_jobs ORDER BY end_time DESC LIMIT 1; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -2805,7 +2805,7 @@ Query OK, 0 rows affected (0.09 sec) > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3028,7 +3028,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3048,7 +3048,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3064,7 +3064,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Duration - Default value: `10m0s` -- Range: `[10m0s, 8760h0m0s]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[10m0s, 168h0m0s]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Range: `[10m0s, 8760h0m0s]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[10m0s, 168h0m0s]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - The time limit during which data is retained for each GC, in the format of Go Duration. When a GC happens, the current time minus this value is the safe point. > **Note:** @@ -3078,7 +3078,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3093,7 +3093,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3111,7 +3111,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3206,7 +3206,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3241,7 +3241,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -3254,7 +3254,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -3520,7 +3520,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): Yes @@ -3621,7 +3621,7 @@ For a system upgraded to v5.0 from an earlier version, if you have not modified > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: No, only applicable to the current TiDB instance that you are connecting to. @@ -4941,7 +4941,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -5258,7 +5258,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -5298,7 +5298,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5316,7 +5316,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5329,7 +5329,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5395,7 +5395,7 @@ SHOW WARNINGS; > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5553,7 +5553,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -5700,7 +5700,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5714,7 +5714,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5727,7 +5727,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5753,7 +5753,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5775,7 +5775,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5848,7 +5848,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -5951,7 +5951,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6006,7 +6006,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6019,7 +6019,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6032,7 +6032,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6045,7 +6045,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6058,7 +6058,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6071,7 +6071,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6084,7 +6084,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6097,7 +6097,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6110,7 +6110,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: GLOBAL - Persists to cluster: Yes @@ -6188,7 +6188,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes @@ -6213,7 +6213,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6228,7 +6228,7 @@ For details, see [Identify Slow Queries](/identify-slow-queries.md). > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6421,7 +6421,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No @@ -6456,7 +6456,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA > **Note:** > -> This variable is always enabled for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is always enabled for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential). - Scope: GLOBAL - Persists to cluster: Yes @@ -6472,7 +6472,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Integer - Default value: `8` -- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[8, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[8, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - This variable is a check item in the password complexity check. It checks whether the password length is sufficient. By default, the minimum password length is `8`. This variable takes effect only when [`validate_password.enable`](#validate_passwordenable-new-in-v650) is enabled. - The value of this variable must not be smaller than the expression: `validate_password.number_count + validate_password.special_char_count + (2 * validate_password.mixed_case_count)`. - If you change the value of `validate_password.number_count`, `validate_password.special_char_count`, or `validate_password.mixed_case_count` such that the expression value is larger than `validate_password.length`, the value of `validate_password.length` is automatically changed to match the expression value. @@ -6484,7 +6484,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Integer - Default value: `1` -- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - This variable is a check item in the password complexity check. It checks whether the password contains sufficient uppercase and lowercase letters. This variable takes effect only when [`validate_password.enable`](#validate_passwordenable-new-in-v650) is enabled and [`validate_password.policy`](#validate_passwordpolicy-new-in-v650) is set to `1` (MEDIUM) or larger. - Neither the number of uppercase letters nor the number of lowercase letters in the password can be fewer than the value of `validate_password.mixed_case_count`. For example, when the variable is set to `1`, the password must contain at least one uppercase letter and one lowercase letter. @@ -6495,7 +6495,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Integer - Default value: `1` -- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - This variable is a check item in the password complexity check. It checks whether the password contains sufficient numbers. This variable takes effect only when [`validate_password.enable`](#password_reuse_interval-new-in-v650) is enabled and [`validate_password.policy`](#validate_passwordpolicy-new-in-v650) is set to `1` (MEDIUM) or larger. ### validate_password.policy New in v6.5.0 @@ -6505,7 +6505,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Enumeration - Default value: `1` -- Value options: `0`, `1`, and `2` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated); `1` and `2` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Value options: `0`, `1`, and `2` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated); `1` and `2` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - This variable controls the policy for the password complexity check. This variable takes effect only when [`validate_password.enable`](#password_reuse_interval-new-in-v650) is enabled. The value of this variable determines whether other `validate-password` variables take effect in the password complexity check, except for `validate_password.check_user_name`. - This value of this variable can be `0`, `1`, or `2` (corresponds to LOW, MEDIUM, or STRONG). Different policy levels have different checks: - 0 or LOW: password length. @@ -6519,7 +6519,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA - Applies to hint [SET_VAR](/optimizer-hints.md#set_varvar_namevar_value): No - Type: Integer - Default value: `1` -- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) +- Range: `[0, 2147483647]` for TiDB Self-Managed and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated), `[1, 2147483647]` for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) - This variable is a check item in the password complexity check. It checks whether the password contains sufficient special characters. This variable takes effect only when [`validate_password.enable`](#password_reuse_interval-new-in-v650) is enabled and [`validate_password.policy`](#validate_passwordpolicy-new-in-v650) is set to `1` (MEDIUM) or larger. ### version @@ -6554,7 +6554,7 @@ Internally, the TiDB parser transforms the `SET TRANSACTION ISOLATION LEVEL [REA > **Note:** > -> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless). +> This variable is read-only for [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. - Scope: SESSION | GLOBAL - Persists to cluster: Yes diff --git a/tidb-cloud/architecture-concepts.md b/tidb-cloud/architecture-concepts.md index 3ed8464564dd3..4829e6f696390 100644 --- a/tidb-cloud/architecture-concepts.md +++ b/tidb-cloud/architecture-concepts.md @@ -5,23 +5,41 @@ summary: Learn about architecture concepts for TiDB Cloud. # Architecture -TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to AWS, Azure, and Google Cloud. +TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings the flexibility and power of [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source HTAP (Hybrid Transactional and Analytical Processing) database, to AWS, Azure, Google Cloud, and Alibaba Cloud. TiDB is MySQL-compatible, making it easy to migrate and work with existing applications, while offering seamless scalability to handle everything from small workloads to massive, high-performance clusters. It supports both transactional (OLTP) and analytical (OLAP) workloads in one system, simplifying operations and enabling real-time insights. -TiDB Cloud provides two deployment options: **TiDB Cloud** **Serverless**, for auto-scaling, cost-efficient workloads, and **TiDB Cloud Dedicated**, for enterprise-grade applications with dedicated resources and advanced capabilities. TiDB Cloud makes it easy to scale your database, handle complex management tasks, and stay focused on developing reliable, high-performing applications. +TiDB Cloud makes it easy to scale your database, handle complex management tasks, and stay focused on developing reliable, high-performing applications. + +- For AWS, TiDB Cloud provides **{{{ .starter }}}** for auto-scaling, cost-efficient workloads, and **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities. +- For Google Cloud and Azure, TiDB Cloud provides **{{{ .dedicated }}}** for enterprise-grade applications with dedicated resources and advanced capabilities. +- For Alibaba Cloud, TiDB Cloud provides **{{{ .starter }}}** for auto-scaling, cost-efficient workloads and **{{{ .essential }}}** for production-ready workloads with provisioned capacity. ## {{{ .starter }}} -{{{ .starter }}} is a fully managed serverless solution that provides HTAP capabilities similar to traditional TiDB, while offering auto-scaling to alleviate users' burdens related to capacity planning and management complexities. It includes a free tier for basic usage, with consumption-based billing for any usage that exceeds the free limits. {{{ .starter }}} offers two types of high availability to address varying operational requirements. +{{{ .starter }}} (formerly Serverless) is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database. + +The Starter cluster plan is ideal for those who are getting started with TiDB Cloud. It provides developers and small teams with the following features: + +- **No cost**: This plan is completely free, with no credit card required to get started. +- **Storage**: Provides an initial 5 GiB of row-based storage and 5 GiB of columnar storage. +- **Request Units**: Includes 50 million [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit) for database operations. + +## {{{ .essential }}} + +For applications experiencing growing workloads and needing scalability in real time, the Essential cluster plan provides the flexibility and performance to keep pace with your business growth with the following features: -By default, clusters utilizing the Zonal High Availability option have all components located within the same availability zone, which results in lower network latency. +- **Enhanced capabilities**: includes all capabilities of the Starter plan, along with the capacity to handle larger and more complex workloads, as well as advanced security features. +- **Automatic scaling**: automatically adjusts storage and computing resources to efficiently meet changing workload demands. +- **High availability**: built-in fault tolerance and redundancy ensure your applications remain available and resilient, even during infrastructure failures. +- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs) of the compute resources, offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. -![{{{ .starter }}} zonal high availability](/media/tidb-cloud/serverless-zonal-high-avaliability-aws.png) +{{{ .essential }}} offers two types of high availability to address varying operational requirements. -For applications that require maximum infrastructure isolation and redundancy, the Regional High Availability option distributes nodes across multiple availability zones. +- By default, clusters utilizing the Zonal High Availability option have all components located within the same availability zone, which results in lower network latency. +- For applications that require maximum infrastructure isolation and redundancy, the Regional High Availability option distributes nodes across multiple availability zones. -![{{{ .starter }}} regional high availability](/media/tidb-cloud/serverless-regional-high-avaliability-aws.png) +For more information, see [High Availability in {{{ .starter }}} and Essential](/tidb-cloud/serverless-high-availability.md). ## TiDB Cloud Dedicated @@ -33,11 +51,11 @@ Built on isolated cloud resources such as VPCs, VMs, managed Kubernetes services ## TiDB Cloud console -The [TiDB Cloud console](https://tidbcloud.com/) is the web-based management interface for both {{{ .starter }}} and TiDB Cloud Dedicated. It provides tools to manage clusters, import or migrate data, monitor performance metrics, configure backups, set up security controls, and integrate with other cloud services, all from a single, user-friendly platform. +The [TiDB Cloud console](https://tidbcloud.com/) is the web-based management interface for TiDB Cloud clusters. It provides tools to manage clusters, import or migrate data, monitor performance metrics, configure backups, set up security controls, and integrate with other cloud services, all from a single, user-friendly platform. ## TiDB Cloud CLI (Beta) -The TiDB Cloud CLI, `ticloud`, allows you to manage {{{ .starter }}} and TiDB Cloud Dedicated directly from your terminal with simple commands. You can perform tasks such as: +The TiDB Cloud CLI, `ticloud`, allows you to manage TiDB Cloud clusters directly from your terminal with simple commands. You can perform tasks such as: - Creating, deleting, and listing clusters. - Importing data into clusters. @@ -56,7 +74,7 @@ For more information, see [TiDB Cloud API Overview](/tidb-cloud/api-overview.md) In TiDB Cloud, each cluster consists of TiDB, TiKV, and TiFlash nodes. - In a TiDB Cloud Dedicated cluster, you can fully manage the number and size of your dedicated TiDB, TiKV, and TiFlash nodes according to your performance requirements. For more information, see [Scalability](/tidb-cloud/scalability-concepts.md). -- In a {{{ .starter }}} cluster, the number and size of TiDB, TiKV, and TiFlash nodes are automatically managed. This ensures seamless scaling, eliminating the need for users to handle node configuration or management tasks. +- In a {{{ .starter }}} or {{{ .essential }}} cluster, the number and size of TiDB, TiKV, and TiFlash nodes are automatically managed. This ensures seamless scaling, eliminating the need for users to handle node configuration or management tasks. ### TiDB node diff --git a/tidb-cloud/backup-and-restore-concepts.md b/tidb-cloud/backup-and-restore-concepts.md index 30266b7f65652..7a9ce7c9d5788 100644 --- a/tidb-cloud/backup-and-restore-concepts.md +++ b/tidb-cloud/backup-and-restore-concepts.md @@ -9,11 +9,11 @@ TiDB Cloud Backup & Restore features are designed to safeguard your data and ens ## Automatic backup -For both {{{ .starter }}} and TiDB Cloud Dedicated clusters, snapshot backups are taken automatically by default and stored according to your backup retention policy. +For TiDB Cloud clusters, snapshot backups are taken automatically by default and stored according to your backup retention policy. For more information, see the following: -- [Automatic backups for {{{ .starter }}} clusters](/tidb-cloud/backup-and-restore-serverless.md#automatic-backups) +- [Automatic backups for {{{ .starter }}} and {{{ .essential }}} clusters](/tidb-cloud/backup-and-restore-serverless.md#automatic-backups) - [Automatic backups for TiDB Cloud Dedicated clusters](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) ## Manual backup @@ -38,5 +38,6 @@ Point-in-time Restore is a feature that enables you to restore data of any point If you want to perform Point-in-time Restore, note the following: -- For {{{ .starter }}} clusters, Point-in-time Restore is available only for scalable clusters and not available for free clusters. For more information, see [Restore mode](/tidb-cloud/backup-and-restore-serverless.md#restore-mode). +- For {{{ .starter }}} clusters, Point-in-time Restore is not available. +- For {{{ .essential }}} clusters, you can restore to any time within the last 14 days. For more information, see [Restore mode](/tidb-cloud/backup-and-restore-serverless.md#restore-mode). - For TiDB Cloud Dedicated clusters, you need to [enable PITR](/tidb-cloud/backup-and-restore.md#turn-on-point-in-time-restore) in advance. diff --git a/tidb-cloud/backup-and-restore-serverless.md b/tidb-cloud/backup-and-restore-serverless.md index 26457914323d2..091e01bf52e77 100644 --- a/tidb-cloud/backup-and-restore-serverless.md +++ b/tidb-cloud/backup-and-restore-serverless.md @@ -1,16 +1,16 @@ --- -title: Back Up and Restore {{{ .starter }}} Data -summary: Learn how to back up and restore your {{{ .starter }}} cluster. +title: Back Up and Restore Data on {{{ .starter }}} or Essential +summary: Learn how to back up and restore your {{{ .starter }}} or {{{ .essential }}} clusters. aliases: ['/tidbcloud/restore-deleted-tidb-cluster'] --- -# Back Up and Restore {{{ .starter }}} Data +# Back Up and Restore Data on {{{ .starter }}} or Essential -This document describes how to back up and restore your {{{ .starter }}} cluster data on TiDB Cloud. +This document describes how to back up and restore your data on {{{ .starter }}} or {{{ .essential }}} clusters. > **Tip:** > -> To learn how to back up and restore TiDB Cloud Dedicated cluster data, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md). +> To learn how to back up and restore data on TiDB Cloud Dedicated clusters, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md). ## View the Backup page @@ -24,30 +24,30 @@ This document describes how to back up and restore your {{{ .starter }}} cluster ## Automatic backups -{{{ .starter }}} automatically backs up your cluster data, allowing you to restore data from a backup snapshot to minimize data loss in the event of a disaster. +TiDB Cloud automatically backs up your cluster data, allowing you to restore data from a backup snapshot to minimize data loss in the event of a disaster. ### Learn about the backup setting -Automatic backup settings vary between free clusters and scalable clusters, as shown in the following table: +Automatic backup settings vary between {{{ .starter }}} clusters and {{{ .essential }}} clusters, as shown in the following table: -| Backup setting | Free clusters | Scalable clusters | -|------------------|--------------|------------------| -| Backup Cycle | Daily | Daily | -| Backup Retention | 1 day | 14 days | -| Backup Time | Fixed time | Configurable | +| Backup setting | {{{ .starter }}} clusters | {{{ .essential }}} clusters | +|------------------|----------------------------|----------------------------| +| Backup Cycle | Daily | Daily | +| Backup Retention | 1 day | 14 days | +| Backup Time | Fixed time | Configurable | - **Backup Cycle** is the frequency at which backups are taken. - **Backup Retention** is the duration for which backups are retained. Expired backups cannot be restored. - + - **Backup Time** is the time when the backup starts to be scheduled. Note that the final backup time might fall behind the configured backup time. - - - Free clusters: the backup time is a randomly fixed time. - - Scalable clusters: you can configure the backup time to every half an hour. The default value is a randomly fixed time. + + - {{{ .starter }}} clusters: the backup time is a randomly fixed time. + - {{{ .essential }}} clusters: you can configure the backup time to every half an hour. The default value is a randomly fixed time. ### Configure the backup setting -To set the backup time for a scalable cluster, perform the following steps: +To set the backup time for a {{{ .essential }}} cluster, perform the following steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. @@ -59,22 +59,22 @@ To set the backup time for a scalable cluster, perform the following steps: ## Restore -{{{ .starter }}} clusters offer restore functionality to help recover data in case of accidental loss or corruption. +TiDB Cloud clusters offer restore functionality to help recover data in case of accidental loss or corruption. ### Restore mode -{{{ .starter }}} supports snapshot restore and point-in-time restore for your cluster. +TiDB Cloud supports snapshot restore and point-in-time restore for your cluster. - **Snapshot Restore**: restores your cluster from a specific backup snapshot. - **Point-in-Time Restore (beta)**: restores your cluster to a specific time. - - Free clusters: not supported. - - Scalable clusters: restores to any time within the last 14 days, but not before the cluster creation time or after the current time minus one minute. + - {{{ .starter }}} clusters: not supported. + - {{{ .essential }}} clusters: restores to any time within the last 14 days, but not before the cluster creation time or after the current time minus one minute. ### Restore destination -{{{ .starter }}} supports restoring in-place and restoring to a new cluster. +TiDB Cloud supports restoring in-place and restoring to a new cluster. **In-place restore** @@ -101,7 +101,7 @@ If the data is corrupted after a canceled restore and cannot be recovered, conta ### Perform the restore -To restore your {{{ .starter }}} cluster, follow these steps: +To restore your TiDB Cloud cluster, follow these steps: 1. Navigate to the [**Backup**](#view-the-backup-page) page of your cluster. @@ -120,7 +120,7 @@ To restore your {{{ .starter }}} cluster, follow these steps:
- To restore to a specific point in time for a scalable cluster, take the following steps: + To restore to a specific point in time for a {{{ .essential }}} cluster, take the following steps: 1. Click **Point-in-Time Restore**. 2. Select the date and time you want to restore to. @@ -138,7 +138,9 @@ To restore your {{{ .starter }}} cluster, follow these steps: 1. Click **Restore to a New Cluster**. 2. Enter a name for the new cluster. 3. Choose the cluster plan for the new cluster. - 4. If you choose a scalable cluster, set a monthly spending limit, and then configure advanced settings as needed. Otherwise, skip this step. + + - If you choose a {{{ .starter }}} cluster and need more resources than the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota), set a monthly spending limit. + - If you choose a {{{ .essential }}} cluster, set the minimum RCU and maximum RCU, and then configure advanced settings as needed.
@@ -155,5 +157,5 @@ Once the restore process begins, the cluster status changes to **Restoring**. Th ## Limitations - If a TiFlash replica is enabled, it will be unavailable for a period after the restore, because the data needs to be rebuilt in TiFlash. -- Manual backups are not supported for {{{ .starter }}} clusters. +- Manual backups are not supported for {{{ .starter }}} and {{{ .essential }}} clusters. - Clusters with more than 1 TiB of data do not support restoring to new clusters by default. Contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) for assistance with larger datasets. diff --git a/tidb-cloud/backup-and-restore.md b/tidb-cloud/backup-and-restore.md index a95e633efe165..a6d4f26fe8554 100644 --- a/tidb-cloud/backup-and-restore.md +++ b/tidb-cloud/backup-and-restore.md @@ -10,7 +10,7 @@ This document describes how to back up and restore your TiDB Cloud Dedicated clu > **Tip** > -> To learn how to back up and restore {{{ .starter }}} cluster data, see [Back Up and Restore {{{ .starter }}} Data](/tidb-cloud/backup-and-restore-serverless.md). +> To learn how to back up and restore data on {{{ .starter }}} or {{{ .essential }}} clusters, see [Back Up and Restore Data on {{{ .starter }}} or Essential](/tidb-cloud/backup-and-restore-serverless.md). ## Limitations diff --git a/tidb-cloud/branch-github-integration.md b/tidb-cloud/branch-github-integration.md index 88b952835f8cc..785592d9cdc1d 100644 --- a/tidb-cloud/branch-github-integration.md +++ b/tidb-cloud/branch-github-integration.md @@ -1,21 +1,21 @@ --- -title: Integrate {{{ .starter }}} Branching (Beta) with GitHub -summary: Learn how to integrate the {{{ .starter }}} branching feature with GitHub. +title: Integrate TiDB Cloud Branching (Beta) with GitHub +summary: Learn how to integrate the TiDB Cloud Branching feature with GitHub. --- -# Integrate {{{ .starter }}} Branching (Beta) with GitHub +# Integrate TiDB Cloud Branching (Beta) with GitHub > **Note:** > -> The integration is built upon [{{{ .starter }}} branching](/tidb-cloud/branch-overview.md). Make sure that you are familiar with {{{ .starter }}} branching before reading this document. +> The integration is built upon [TiDB Cloud Branching](/tidb-cloud/branch-overview.md). Make sure that you are familiar with TiDB Cloud Branching before reading this document. -If you use GitHub for application development, you can integrate {{{ .starter }}} branching into your GitHub CI/CD pipeline, which lets you automatically test your pull requests with branches without affecting the production database. +If you use GitHub for application development, you can integrate TiDB Cloud Branching into your GitHub CI/CD pipeline, which lets you automatically test your pull requests with branches without affecting the production database. -In the integration process, you will be prompted to install the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App. The app can automatically manage {{{ .starter }}} branches according to pull requests in your GitHub repository. For example, when you create a pull request, the app will create a corresponding branch for your {{{ .starter }}} cluster, in which you can work on new features or bug fixes in isolation without affecting the production database. +In the integration process, you will be prompted to install the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App. The app can automatically manage branches of your {{{ .starter }}} or {{{ .essential }}} cluster according to pull requests in your GitHub repository. For example, when you create a pull request, the app will create a corresponding branch for your cluster, in which you can work on new features or bug fixes in isolation without affecting the production database. This document covers the following topics: -1. How to integrate {{{ .starter }}} branching with GitHub +1. How to integrate TiDB Cloud Branching with GitHub 2. How does the TiDB Cloud Branching app work 3. How to build a branching-based CI workflow to test every pull request using branches rather than the production cluster @@ -25,13 +25,13 @@ Before the integration, make sure that you have the following: - A GitHub account - A GitHub repository for your application -- A [{{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- A [{{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) -## Integrate {{{ .starter }}} branching with your GitHub repository {#integrate-branching-with-your-github-repository} +## Integrate TiDB Cloud Branching with your GitHub repository {#integrate-branching-with-your-github-repository} -To integrate {{{ .starter }}} branching with your GitHub repository, take the following steps: +To integrate TiDB Cloud Branching with your GitHub repository, take the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. @@ -48,18 +48,18 @@ To integrate {{{ .starter }}} branching with your GitHub repository, take the fo 5. Select your target repository in the **GitHub Repository** drop-down list. If the list is long, you can search the repository by typing the name. -6. Click **Connect** to connect between your {{{ .starter }}} cluster and your GitHub repository. +6. Click **Connect** to connect between your cluster and your GitHub repository. ## TiDB Cloud Branching app behaviors -After you connect your {{{ .starter }}} cluster to your GitHub repository, for each pull request in this repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App can automatically manage its corresponding {{{ .starter }}} branch. The following lists the default behaviors for pull request changes: +After you connect your {{{ .starter }}} or {{{ .essential }}} cluster to your GitHub repository, for each pull request in this repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App can automatically manage its corresponding branch for your cluster. The following lists the default behaviors for pull request changes: | Pull request changes | TiDB Cloud Branching app behaviors | |------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Create a pull request | When you create a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for your {{{ .starter }}} cluster. When `branch.mode` is set to `reset`, the branch name follows the `${github_branch_name}_${pr_id}` format. When `branch.mode` is set to `reserve`, the branch name follows the `${github_branch_name}_${pr_id}_${commit_sha}` format. Note that the number of branches has a [limit](/tidb-cloud/branch-overview.md#limitations-and-quotas). | -| Push new commits to a pull request | When `branch.mode` is set to `reset`, every time you push a new commit to a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app resets the {{{ .starter }}} branch. When `branch.mode` is set to `reserve`, the app creates a new branch for the latest commit. | +| Create a pull request | When you create a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for your cluster. When `branch.mode` is set to `reset`, the branch name follows the `${github_branch_name}_${pr_id}` format. When `branch.mode` is set to `reserve`, the branch name follows the `${github_branch_name}_${pr_id}_${commit_sha}` format. Note that the number of branches has a [limit](/tidb-cloud/branch-overview.md#limitations-and-quotas). | +| Push new commits to a pull request | When `branch.mode` is set to `reset`, every time you push a new commit to a pull request in the repository, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app resets the branch. When `branch.mode` is set to `reserve`, the app creates a new branch for the latest commit. | | Close or merge a pull request | When you close or merge a pull request, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app deletes the branch for this pull request. | | Reopen a pull request | When you reopen a pull request, the [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) app creates a branch for the lasted commit of the pull request. | @@ -113,7 +113,7 @@ github: **Type:** boolean. **Default:** `true`. -If it is set to `false`, the TiDB Cloud Branching app will not delete the {{{ .starter }}} branch when a pull request is closed or merged. +If it is set to `false`, the TiDB Cloud Branching app will not delete the branch for your {{{ .starter }}} or {{{ .essential }}} cluster when a pull request is closed or merged. ```yaml github: @@ -123,17 +123,17 @@ github: ## Create a branching CI workflow -One of the best practices for using branches is to create a branching CI workflow. With the workflow, you can test your code using a {{{ .starter }}} branch instead of using the production cluster before merging the pull request. You can find a live demo [here](https://github.com/shiyuhang0/tidbcloud-branch-gorm-example). +One of the best practices for using branches is to create a branching CI workflow. With the workflow, you can test your code using a branch of your cluster instead of using the production cluster before merging the pull request. You can find a live demo [here](https://github.com/shiyuhang0/tidbcloud-branch-gorm-example). Here are the main steps to create the workflow: -1. [Integrate {{{ .starter }}} branching with your GitHub repository](#integrate-branching-with-your-github-repository). +1. [Integrate TiDB Cloud Branching with your GitHub repository](#integrate-branching-with-your-github-repository). 2. Get the branch connection information. - You can use the [wait-for-tidbcloud-branch](https://github.com/tidbcloud/wait-for-tidbcloud-branch) action to wait for the readiness of the {{{ .starter }}} branch and get the connection information of the branch. + You can use the [wait-for-tidbcloud-branch](https://github.com/tidbcloud/wait-for-tidbcloud-branch) action to wait for the readiness of the branch and get the connection information of the branch. - Example usage: + Taking the branch of a {{{ .starter }}} cluster as an example: ```yaml steps: diff --git a/tidb-cloud/branch-manage.md b/tidb-cloud/branch-manage.md index cc2d2b05f20ed..c0b8f59b06e29 100644 --- a/tidb-cloud/branch-manage.md +++ b/tidb-cloud/branch-manage.md @@ -1,11 +1,11 @@ --- -title: Manage {{{ .starter }}} Branches -summary: Learn How to manage {{{ .starter }}} branches. +title: Manage TiDB Cloud Branches +summary: Learn How to manage TiDB Cloud branches. --- -# Manage {{{ .starter }}} Branches +# Manage TiDB Cloud Branches -This document describes how to manage {{{ .starter }}} branches using the [TiDB Cloud console](https://tidbcloud.com). To manage it using the TiDB Cloud CLI, see [`ticloud branch`](/tidb-cloud/ticloud-branch-create.md). +This document describes how to manage branches of your {{{ .starter }}} or {{{ .essential }}} cluster using the [TiDB Cloud console](https://tidbcloud.com). To manage it using the TiDB Cloud CLI, see [`ticloud branch`](/tidb-cloud/ticloud-branch-create.md). ## Required access @@ -18,11 +18,11 @@ For more information about permissions, see [User roles](/tidb-cloud/manage-user > **Note:** > -> You can only create branches for {{{ .starter }}} clusters that are created after July 5, 2023. See [Limitations and quotas](/tidb-cloud/branch-overview.md#limitations-and-quotas) for more limitations. +> You can only create branches for {{{ .starter }}} or {{{ .essential }}} clusters that are created after July 5, 2023. See [Limitations and quotas](/tidb-cloud/branch-overview.md#limitations-and-quotas) for more limitations. To create a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the upper-right corner of the **Branches** page, click **Create Branch**. A dialog is displayed. @@ -44,7 +44,7 @@ Depending on the data size in your cluster, the branch creation will be complete To view branches for your cluster, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. The branch list of the cluster is displayed in the right pane. @@ -53,7 +53,7 @@ To view branches for your cluster, perform the following steps: To connect to a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be connected, click **...** in the **Action** column. 4. Click **Connect** in the drop-down list. The dialog for the connection information is displayed. @@ -62,7 +62,7 @@ To connect to a branch, perform the following steps: Alternatively, you can get the connection string from the cluster overview page: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Connect** in the upper-right corner. 3. Select the branch you want to connect to in the `Branch` drop-down list. 4. Click **Generate Password** or **Reset Password** to create or reset the root password. @@ -72,7 +72,7 @@ Alternatively, you can get the connection string from the cluster overview page: To delete a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be deleted, click **...** in the **Action** column. 4. Click **Delete** in the drop-down list. @@ -88,7 +88,7 @@ Resetting a branch synchronizes it with the latest data from its parent. To reset a branch, perform the following steps: -1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} cluster to go to its overview page. +1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your target {{{ .starter }}} or {{{ .essential }}} cluster to go to its overview page. 2. Click **Branches** in the left navigation pane. 3. In the row of your target branch to be reset, click **...** in the **Action** column. 4. Click **Reset** in the drop-down list. @@ -96,4 +96,4 @@ To reset a branch, perform the following steps: ## What's next -- [Integrate {{{ .starter }}} branching into your GitHub CI/CD pipeline](/tidb-cloud/branch-github-integration.md) +- [Integrate TiDB Cloud Branching into your GitHub CI/CD pipeline](/tidb-cloud/branch-github-integration.md) diff --git a/tidb-cloud/branch-overview.md b/tidb-cloud/branch-overview.md index 0031b53d2c2a8..daf960d0aa078 100644 --- a/tidb-cloud/branch-overview.md +++ b/tidb-cloud/branch-overview.md @@ -1,19 +1,23 @@ --- -title: {{{ .starter }}} Branching (Beta) Overview -summary: Learn the concept of {{{ .starter }}} branches. +title: TiDB Cloud Branching (Beta) Overview +summary: Learn the concept of TiDB Cloud branches. --- -# {{{ .starter }}} Branching (Beta) Overview +# TiDB Cloud Branching (Beta) Overview -TiDB Cloud lets you create branches for {{{ .starter }}} clusters. A branch for a cluster is a separate instance that contains a diverged copy of data from the original cluster. It provides an isolated environment, allowing you to experiment freely without worrying about affecting the original cluster. +TiDB Cloud lets you create branches for {{{ .starter }}} and {{{ .essential }}} clusters. A branch for a cluster is a separate instance that contains a diverged copy of data from the original cluster. It provides an isolated environment, allowing you to experiment freely without worrying about affecting the original cluster. -With {{{ .starter }}} branches, developers can work in parallel, iterate rapidly on new features, troubleshoot issues without affecting the production database, and easily revert changes if needed. This feature streamlines the development and deployment process while ensuring a high level of stability and reliability for the production database. +With branches, developers can work in parallel, iterate rapidly on new features, troubleshoot issues without affecting the production database, and easily revert changes if needed. This feature streamlines the development and deployment process while ensuring a high level of stability and reliability for the production database. + +> **Note:** +> +> Currently, TiDB Cloud Branching is in beta and is not available on TiDB Cloud Dedicated clusters. ## Implementations When a branch for a cluster is created, the data in the branch diverges from the original cluster or its parent branch at a specific point in time. This means that subsequent changes made in either the parent or the branch will not be synchronized with each other. -To ensure fast and seamless branch creation, {{{ .starter }}} uses a copy-on-write technique for sharing data between the original cluster and its branches. This process usually completes within a few minutes and is imperceptible to users, ensuring that it does not affect the performance of your original cluster. +To ensure fast and seamless branch creation, TiDB Cloud uses a copy-on-write technique for sharing data between the original cluster and its branches. This process usually completes within a few minutes and is imperceptible to users, ensuring that it does not affect the performance of your original cluster. ## Scenarios @@ -33,18 +37,18 @@ You can create branches easily and quickly to get isolated data environments. Br ## Limitations and quotas -Currently, {{{ .starter }}} branches are in beta and free of charge. +Currently, TiDB Cloud branches are in beta and free of charge. -- For each organization in TiDB Cloud, you can create a maximum of five {{{ .starter }}} branches by default across all the clusters. The branches of a cluster will be created in the same region as the cluster, and you cannot create branches for a throttled cluster or a cluster larger than 100 GiB. +- For each organization in TiDB Cloud, you can create a maximum of five branches by default across all the clusters. The branches of a cluster will be created in the same region as the cluster, and you cannot create branches for a throttled cluster or a cluster larger than 100 GiB. -- For each branch of a free cluster, 10 GiB storage is allowed. For each branch of a scalable cluster, 100 GiB storage is allowed. Once the storage is reached, the read and write operations on this branch will be throttled until you reduce the storage. +- For each branch of a free cluster, 10 GiB storage is allowed. For each branch of a cluster with spending limit > 0, 100 GiB storage is allowed. Once the storage is reached, the read and write operations on this branch will be throttled until you reduce the storage. - If your cluster has tables with TiFlash replicas, these replicas will be temporarily unavailable in the new branch after you create it, because TiFlash needs to rebuild the replica data. - When [creating a branch](/tidb-cloud/branch-manage.md#create-a-branch) from a specific point in time: - - For branches of a free cluster, you can select any time within the last 24 hours. - - For branches of a scalable cluster, you can select any time within the last 14 days. + - For a free {{{ .starter }}} cluster, you can select any time within the last 24 hours. + - For a {{{ .starter }}} (with spending limit > 0) or {{{ .essential }}} cluster, you can select any time within the last 14 days. If you need more quotas, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). diff --git a/tidb-cloud/built-in-monitoring.md b/tidb-cloud/built-in-monitoring.md index f8226b79aa02e..3bd0337f43ee4 100644 --- a/tidb-cloud/built-in-monitoring.md +++ b/tidb-cloud/built-in-monitoring.md @@ -21,7 +21,7 @@ To view the metrics on the **Metrics** page, take the following steps: ## Metrics retention policy -For TiDB Cloud Dedicated clusters and {{{ .starter }}} clusters, the metrics data is kept for 7 days. +For TiDB Cloud clusters, the metrics data is kept for 7 days. ## Metrics for TiDB Cloud Dedicated clusters @@ -79,9 +79,9 @@ The following sections illustrate the metrics on the **Metrics** page for TiDB C | TiFlash IO MBps | node-write, node-read | The total bytes of read and write in each TiFlash node. | | TiFlash Storage Usage | node, limit | The storage usage statistics or upper limit of each TiFlash node. | -## Metrics for {{{ .starter }}} clusters +## Metrics for {{{ .starter }}} and Essential clusters -The **Metrics** page provides two tabs for metrics of {{{ .starter }}} clusters: +The **Metrics** page provides two tabs for metrics of {{{ .starter }}} and {{{ .essential }}} clusters: - **Cluster Status**: displays the cluster-level main metrics. - **Database Status**: displays the database-level main metrics. @@ -95,11 +95,11 @@ The following table illustrates the cluster-level main metrics under the **Clust | Request Units | RU per second | The Request Unit (RU) is a unit of measurement used to track the resource consumption of a query or transaction. In addition to queries that you run, Request Units can be consumed by background activities, so when the QPS is 0, the Request Units per second might not be zero. | | Used Storage Size | Row-based storage, Columnar storage | The size of the row store and the size of the column store. | | Query Per Second | All, {SQL type} | The number of SQL statements executed per second, which are collected by SQL types, such as `SELECT`, `INSERT`, and `UPDATE`. | -| Average Query Duration | All, {SQL type} | The duration from receiving a request from the client to the {{{ .starter }}} cluster until the cluster executes the request and returns the result to the client. | +| Average Query Duration | All, {SQL type} | The duration from receiving a request from the client to the {{{ .starter }}} or {{{ .essential }}} cluster until the cluster executes the request and returns the result to the client. | | Failed Query | All | The number of SQL statement execution errors per second. | | Transaction Per Second | All | The number of transactions executed per second. | | Average Transaction Duration | All | The average execution duration of transactions. | -| Total Connection | All | The number of connections to the {{{ .starter }}} cluster. | +| Total Connection | All | The number of connections to the {{{ .starter }}} or {{{ .essential }}} cluster. | ### Database Status diff --git a/tidb-cloud/changefeed-overview.md b/tidb-cloud/changefeed-overview.md index e805c826ea2a6..f25b0bed3b704 100644 --- a/tidb-cloud/changefeed-overview.md +++ b/tidb-cloud/changefeed-overview.md @@ -11,7 +11,7 @@ TiDB Cloud changefeed helps you stream data from TiDB Cloud to other data servic > > - Currently, TiDB Cloud only allows up to 100 changefeeds per cluster. > - Currently, TiDB Cloud only allows up to 100 table filter rules per changefeed. -> - For [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless), the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. ## View the Changefeed page diff --git a/tidb-cloud/changefeed-sink-to-apache-kafka.md b/tidb-cloud/changefeed-sink-to-apache-kafka.md index eff70c964b9f1..213d1e1f05935 100644 --- a/tidb-cloud/changefeed-sink-to-apache-kafka.md +++ b/tidb-cloud/changefeed-sink-to-apache-kafka.md @@ -10,7 +10,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > > - To use the changefeed feature, make sure that your TiDB Cloud Dedicated cluster version is v6.1.3 or later. -> - For [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless), the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-apache-pulsar.md b/tidb-cloud/changefeed-sink-to-apache-pulsar.md index a3f297afa7c0e..f00ff4f62adc7 100644 --- a/tidb-cloud/changefeed-sink-to-apache-pulsar.md +++ b/tidb-cloud/changefeed-sink-to-apache-pulsar.md @@ -10,7 +10,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > > - To replicate data to Apache Pulsar using the changefeed feature, make sure that your TiDB Cloud Dedicated cluster version is v7.5.1 or later. -> - For [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless), the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-cloud-storage.md b/tidb-cloud/changefeed-sink-to-cloud-storage.md index 437b32e1cc6c0..a0895e648f585 100644 --- a/tidb-cloud/changefeed-sink-to-cloud-storage.md +++ b/tidb-cloud/changefeed-sink-to-cloud-storage.md @@ -10,7 +10,7 @@ This document describes how to create a changefeed to stream data from TiDB Clou > **Note:** > > - To stream data to cloud storage, make sure that your TiDB cluster version is v7.1.1 or later. To upgrade your TiDB Cloud Dedicated cluster to v7.1.1 or later, [contact TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). -> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-mysql.md b/tidb-cloud/changefeed-sink-to-mysql.md index 1de276849de95..41f318c0e270e 100644 --- a/tidb-cloud/changefeed-sink-to-mysql.md +++ b/tidb-cloud/changefeed-sink-to-mysql.md @@ -10,7 +10,7 @@ This document describes how to stream data from TiDB Cloud to MySQL using the ** > **Note:** > > - To use the changefeed feature, make sure that your TiDB Cloud Dedicated cluster version is v6.1.3 or later. -> - For [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless), the changefeed feature is unavailable. +> - For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters, the changefeed feature is unavailable. ## Restrictions diff --git a/tidb-cloud/changefeed-sink-to-tidb-cloud.md b/tidb-cloud/changefeed-sink-to-tidb-cloud.md index 633093e16d6e8..49418616d4a29 100644 --- a/tidb-cloud/changefeed-sink-to-tidb-cloud.md +++ b/tidb-cloud/changefeed-sink-to-tidb-cloud.md @@ -1,11 +1,11 @@ --- title: Sink to TiDB Cloud -summary: This document explains how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} cluster. There are restrictions on the number of changefeeds and regions available for the feature. Prerequisites include extending tidb_gc_life_time, backing up data, and obtaining the start position of TiDB Cloud sink. To create a TiDB Cloud sink, navigate to the cluster overview page, establish the connection, customize table and event filters, fill in the start replication position, specify the changefeed specification, review the configuration, and create the sink. Finally, restore tidb_gc_life_time to its original value. +summary: This document explains how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster. There are restrictions on the number of changefeeds and regions available for the feature. Prerequisites include extending tidb_gc_life_time, backing up data, and obtaining the start position of TiDB Cloud sink. To create a TiDB Cloud sink, navigate to the cluster overview page, establish the connection, customize table and event filters, fill in the start replication position, specify the changefeed specification, review the configuration, and create the sink. Finally, restore tidb_gc_life_time to its original value. --- # Sink to TiDB Cloud -This document describes how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} cluster. +This document describes how to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster. > **Note:** > @@ -23,14 +23,14 @@ This document describes how to stream data from a TiDB Cloud Dedicated cluster t - AWS Singapore (ap-southeast-1) - AWS Tokyo (ap-northeast-1) -- The source TiDB Cloud Dedicated cluster and the destination {{{ .starter }}} cluster must be in the same project and the same region. -- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} cluster, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. +- The source TiDB Cloud Dedicated cluster and the destination {{{ .starter }}} or {{{ .essential }}} cluster must be in the same project and the same region. +- The **Sink to TiDB Cloud** feature only supports network connection via private endpoints. When you create a changefeed to stream data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster, TiDB Cloud will automatically set up the private endpoint connection between the two clusters. ## Prerequisites -The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} cluster after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). +The **Sink to TiDB Cloud** connector can only sink incremental data from a TiDB Cloud Dedicated cluster to a {{{ .starter }}} or {{{ .essential }}} cluster after a certain [TSO](https://docs.pingcap.com/tidb/stable/glossary#tso). -Before creating a changefeed, you need to export existing data from the source TiDB Cloud Dedicated cluster and load the data to the destination {{{ .starter }}} cluster. +Before creating a changefeed, you need to export existing data from the source TiDB Cloud Dedicated cluster and load the data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. 1. Extend the [tidb_gc_life_time](https://docs.pingcap.com/tidb/stable/system-variables#tidb_gc_life_time-new-in-v50) to be longer than the total time of the following two operations, so that historical data during the time is not garbage collected by TiDB. @@ -43,7 +43,7 @@ Before creating a changefeed, you need to export existing data from the source T SET GLOBAL tidb_gc_life_time = '720h'; ``` -2. Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data from your TiDB Cloud Dedicated cluster, then use [{{{ .starter }}} Import](/tidb-cloud/import-csv-files-serverless.md) to load data to the destination {{{ .starter }}} cluster. +2. Use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data from your TiDB Cloud Dedicated cluster, then use [the import feature](/tidb-cloud/import-csv-files-serverless.md) to load data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. 3. From the [exported files of Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview#format-of-exported-files), get the start position of TiDB Cloud sink from the metadata file: @@ -59,13 +59,13 @@ Before creating a changefeed, you need to export existing data from the source T ## Create a TiDB Cloud sink -After completing the prerequisites, you can sink your data to the destination {{{ .starter }}} cluster. +After completing the prerequisites, you can sink your data to the destination {{{ .starter }}} or {{{ .essential }}} cluster. 1. Navigate to the cluster overview page of the target TiDB cluster, and then click **Data** > **Changefeed** in the left navigation pane. 2. Click **Create Changefeed**, and select **TiDB Cloud** as the destination. -3. In the **TiDB Cloud Connection** area, select the destination {{{ .starter }}} cluster, and then fill in the user name and password of the destination cluster. +3. In the **TiDB Cloud Connection** area, select the destination {{{ .starter }}} or {{{ .essential }}} cluster, and then fill in the user name and password of the destination cluster. 4. Click **Next** to establish the connection between the two TiDB clusters and test whether the changefeed can connect them successfully: diff --git a/tidb-cloud/cli-reference.md b/tidb-cloud/cli-reference.md index e48ed24c88ebd..32ecc1aee0432 100644 --- a/tidb-cloud/cli-reference.md +++ b/tidb-cloud/cli-reference.md @@ -24,12 +24,12 @@ To use the `ticloud` CLI in your terminal, run `ticloud [command] [subcommand]`. | Command | Subcommand | Description | |-----------------------|-----------------------------------------------------------------------|------------------------------------------------| | auth | login, logout, whoami | Login and logout | -| serverless (alias: s) | create, delete, describe, list, update, spending-limit, region, shell | Manage {{{ .starter }}} clusters | -| serverless branch | create, delete, describe, list, shell | Manage {{{ .starter }}} branches | -| serverless import | cancel, describe, list, start | Manage {{{ .starter }}} import tasks | -| serverless export | create, describe, list, cancel, download | Manage {{{ .starter }}} export tasks | -| serverless sql-user | create, list, delete, update | Manage {{{ .starter }}} SQL users | -| serverless audit-log | config, describe, filter-rule (alias: filter), download | Manage {{{ .starter }}} database audit logging | +| serverless (alias: s) | create, delete, describe, list, update, spending-limit, region, shell | Manage {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless branch | create, delete, describe, list, shell | Manage branches for your {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless import | cancel, describe, list, start | Manage import tasks for your {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless export | create, describe, list, cancel, download | Manage export tasks for your {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless sql-user | create, list, delete, update | Manage SQL users for your {{{ .starter }}} or {{{ .essential }}} cluster | +| serverless audit-log | config, describe, filter-rule (alias: filter), download | Manage database audit logging for your {{{ .starter }}} or {{{ .essential }}} cluster | | ai | - | Chat with TiDB Bot | | completion | bash, fish, powershell, zsh | Generate completion script for specified shell | | config | create, delete, describe, edit, list, set, use | Configure user profiles | diff --git a/tidb-cloud/configure-ip-access-list.md b/tidb-cloud/configure-ip-access-list.md index 9e47b7baa1cad..e9ebd2256107f 100644 --- a/tidb-cloud/configure-ip-access-list.md +++ b/tidb-cloud/configure-ip-access-list.md @@ -9,7 +9,7 @@ For each TiDB Cloud Dedicated cluster in TiDB Cloud, you can configure an IP acc > **Note:** > -> This document applies to [**TiDB Cloud Dedicated**](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). For instructions on configuring an IP access list for **{{{ .starter }}}**, see [Configure {{{ .starter }}} Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). +> This document applies to [**TiDB Cloud Dedicated**](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). For instructions on configuring an IP access list for **{{{ .starter }}}** or **{{{ .essential }}}**, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). To configure an IP access list for your TiDB Cloud Dedicated cluster, take the following steps: diff --git a/tidb-cloud/configure-security-settings.md b/tidb-cloud/configure-security-settings.md index 404507cabd33a..3ccb82e4a5aa5 100644 --- a/tidb-cloud/configure-security-settings.md +++ b/tidb-cloud/configure-security-settings.md @@ -9,7 +9,7 @@ For TiDB Cloud Dedicated clusters, you can configure the root password and allow > **Note:** > -> For {{{ .starter }}} clusters, this document is inapplicable and you can refer to [TLS Connection to {{{ .starter }}}](/tidb-cloud/secure-connections-to-serverless-clusters.md) instead. +> For {{{ .starter }}} or {{{ .essential }}} clusters, this document is inapplicable and you can refer to [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md) instead. 1. In the TiDB Cloud console, navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project. diff --git a/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md b/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md index 4ea13042bb2c2..2c899def81f67 100644 --- a/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md +++ b/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md @@ -1,23 +1,23 @@ --- -title: Configure {{{ .starter }}} Firewall Rules for Public Endpoints -summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} cluster securely. +title: Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints +summary: Learn how to configure and manage firewall rules with public access to your {{{ .starter }}} or {{{ .essential }}} cluster securely. --- -# Configure {{{ .starter }}} Firewall Rules for Public Endpoints +# Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints -This document describes the public connectivity option for {{{ .starter }}}. You will learn key concepts for securely managing a {{{ .starter }}} cluster accessible via the internet. +This document describes the public connectivity option for {{{ .starter }}} and {{{ .essential }}} clusters. You will learn key concepts for securely managing a cluster accessible via the internet. > **Note:** > -> This document applies to **{{{ .starter }}}**. For instructions on configuring an IP access list for **TiDB Cloud Dedicated**, see [Configure an IP Access List for TiDB Cloud Dedicated](/tidb-cloud/configure-ip-access-list.md). +> This document applies to **{{{ .starter }}}** and **{{{ .essential }}}**. For instructions on configuring an IP access list for **TiDB Cloud Dedicated**, see [Configure an IP Access List for TiDB Cloud Dedicated](/tidb-cloud/configure-ip-access-list.md). ## Public endpoints -Configuring public access on your {{{ .starter }}} cluster allows the cluster access through a public endpoint. That is, the cluster is accessible through the internet. The public endpoint is a publicly resolvable DNS address. The term "authorized network" refers to a range of IP addresses you choose to permit access to your cluster. These permissions are enforced through **firewall rules**. +Configuring public access on your cluster allows the cluster access through a public endpoint. That is, the cluster is accessible through the internet. The public endpoint is a publicly resolvable DNS address. The term "authorized network" refers to a range of IP addresses you choose to permit access to your cluster. These permissions are enforced through **firewall rules**. ### Characteristics of public access -- Only specified IP addresses can access {{{ .starter }}}. +- Only specified IP addresses can access your cluster. - By default, all IP addresses (`0.0.0.0 - 255.255.255.255`) are allowed. - You can update allowed IP addresses after cluster creation. - Your cluster has a publicly resolvable DNS name. @@ -31,15 +31,15 @@ You can create a maximum of 200 IP firewall rules. ### Allow AWS access -You can enable access from **all AWS IP addresses** by referring to the official [AWS IP address list](https://docs.aws.amazon.com/vpc/latest/userguide/aws-ip-ranges.html). +If your {{{ .starter }}} cluster is hosted on AWS, you can enable access from **all AWS IP addresses** by referring to the official [AWS IP address list](https://docs.aws.amazon.com/vpc/latest/userguide/aws-ip-ranges.html). TiDB Cloud regularly updates this list and uses the reserved IP address **169.254.65.87** to represent all AWS IP addresses. ## Create and manage a firewall rule -This section describes how to manage firewall rules for a {{{ .starter }}} cluster. With a public endpoint, the connections to the {{{ .starter }}} cluster are restricted to the IP addresses specified in the firewall rules. +This section describes how to manage firewall rules for a {{{ .starter }}} or {{{ .essential }}} cluster. With a public endpoint, the connections to your cluster are restricted to the IP addresses specified in the firewall rules. -To add firewall rules to a {{{ .starter }}} cluster, take the following steps: +To add firewall rules to a {{{ .starter }}} or {{{ .essential }}} cluster, take the following steps: 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -51,8 +51,8 @@ To add firewall rules to a {{{ .starter }}} cluster, take the following steps: > > In some situations, the IP address observed by the TiDB Cloud console differs from the IP address used when accessing the internet. Therefore, you might need to change the start and end IP addresses to make the rule function as expected. You can use a search engine or other online tool to check your own IP address. For example, search for "what is my IP." -4. Click **Add rule** to add more address ranges. In the displayed window, you can specify a single IP address or a range of IP addresses. If you want to limit the rule to a single IP address, type the same IP address in the **Start IP Address** and **End IP Address** fields. Opening the firewall enables administrators, users, and applications to access any database on your {{{ .starter }}} cluster to which they have valid credentials. Click **Submit** to add the firewall rule. +4. Click **Add rule** to add more address ranges. In the displayed window, you can specify a single IP address or a range of IP addresses. If you want to limit the rule to a single IP address, type the same IP address in the **Start IP Address** and **End IP Address** fields. Opening the firewall enables administrators, users, and applications to access any database on your cluster to which they have valid credentials. Click **Submit** to add the firewall rule. ## What's next -- [Connect to {{{ .starter }}} via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) \ No newline at end of file +- [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) \ No newline at end of file diff --git a/tidb-cloud/connect-to-tidb-cluster-serverless.md b/tidb-cloud/connect-to-tidb-cluster-serverless.md index ebf3fc2a6bbba..f38134683130b 100644 --- a/tidb-cloud/connect-to-tidb-cluster-serverless.md +++ b/tidb-cloud/connect-to-tidb-cluster-serverless.md @@ -1,11 +1,11 @@ --- -title: Connect to Your {{{ .starter }}} Cluster -summary: Learn how to connect to your {{{ .starter }}} cluster via different methods. +title: Connect to Your {{{ .starter }}} or Essential Cluster +summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via different methods. --- -# Connect to Your {{{ .starter }}} Cluster +# Connect to Your {{{ .starter }}} or Essential Cluster -This document describes how to connect to your {{{ .starter }}} cluster. +This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster. > **Tip:** > @@ -13,19 +13,19 @@ This document describes how to connect to your {{{ .starter }}} cluster. ## Connection methods -After your {{{ .starter }}} cluster is created on TiDB Cloud, you can connect to it via one of the following methods: +After your {{{ .starter }}} or {{{ .essential }}} cluster is created on TiDB Cloud, you can connect to it via one of the following methods: - Direct connections - Direct connections mean the MySQL native connection system over TCP. You can connect to your {{{ .starter }}} cluster using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). + Direct connections mean the MySQL native connection system over TCP. You can connect to your cluster using any tool that supports MySQL connection, such as [MySQL client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). - [Data Service (beta)](/tidb-cloud/data-service-overview.md) - TiDB Cloud provides a Data Service feature that enables you to connect to your {{{ .starter }}} cluster via an HTTPS request using a custom API endpoint. Unlike direct connections, Data Service accesses {{{ .starter }}} data via a RESTful API rather than raw SQL. + TiDB Cloud provides a Data Service feature that enables you to connect to your {{{ .starter }}} cluster hosted on AWS via an HTTPS request using a custom API endpoint. Unlike direct connections, Data Service accesses your cluster data via a RESTful API rather than raw SQL. - [Serverless Driver (beta)](/tidb-cloud/serverless-driver.md) - TiDB Cloud provides a serverless driver for JavaScript, which allows you to connect to your {{{ .starter }}} cluster in edge environments with the same experience as direct connections. + TiDB Cloud provides a serverless driver for JavaScript, which allows you to connect to your {{{ .starter }}} or {{{ .essential }}} cluster in edge environments with the same experience as direct connections. In the preceding connection methods, you can choose your desired one based on your needs: @@ -37,7 +37,7 @@ In the preceding connection methods, you can choose your desired one based on yo ## Network -There are two network connection types for {{{ .starter }}}: +There are two network connection types for {{{ .starter }}} and {{{ .essential }}}: - [Private endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) (recommended) @@ -47,14 +47,14 @@ There are two network connection types for {{{ .starter }}}: The standard connection exposes a public endpoint, so you can connect to your TiDB cluster via a SQL client from your laptop. - {{{ .starter }}} requires [TLS connections](/tidb-cloud/secure-connections-to-serverless-clusters.md), which ensures the security of data transmission from your applications to TiDB clusters. + {{{ .starter }}} and {{{ .essential }}} require [TLS connections](/tidb-cloud/secure-connections-to-serverless-clusters.md), which ensures the security of data transmission from your applications to TiDB clusters. The following table shows the network you can use in different connection methods: | Connection method | Network | Description | |----------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------| | Direct connections | Public or private endpoint | Direct connections can be made via both public and private endpoints. | -| Data Service (beta) | / | Accessing {{{ .starter }}} via Data Service (beta) does not need to specify the network type. | +| Data Service (beta) | / | Accessing {{{ .starter }}} hosted on AWS via Data Service (beta) does not need to specify the network type. | | Serverless Driver (beta) | Public endpoint | Serverless Driver only supports connections via public endpoint. | ## What's next diff --git a/tidb-cloud/connect-to-tidb-cluster.md b/tidb-cloud/connect-to-tidb-cluster.md index f67f9b672dec2..36180d7333285 100644 --- a/tidb-cloud/connect-to-tidb-cluster.md +++ b/tidb-cloud/connect-to-tidb-cluster.md @@ -9,7 +9,7 @@ This document introduces the methods to connect to your TiDB Cloud Dedicated clu > **Tip:** > -> To learn how to connect to a {{{ .starter }}} cluster, see [Connect to Your {{{ .starter }}} Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster, see [Connect to Your {{{ .starter }}} or Essential Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). After your TiDB Cloud Dedicated cluster is created on TiDB Cloud, you can connect to it via one of the following methods: diff --git a/tidb-cloud/connect-via-sql-shell.md b/tidb-cloud/connect-via-sql-shell.md index 6cebfbe44f725..cea0c7d662cb3 100644 --- a/tidb-cloud/connect-via-sql-shell.md +++ b/tidb-cloud/connect-via-sql-shell.md @@ -9,7 +9,7 @@ In TiDB Cloud SQL Shell, you can try TiDB SQL, test out TiDB's compatibility wit > **Note:** > -> You cannot connect to [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) using SQL Shell. To connect to your {{{ .starter }}} cluster, see [Connect to {{{ .starter }}} clusters](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +> You cannot connect to [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) using SQL Shell. To connect to your {{{ .starter }}} or {{{ .essential }}} cluster, see [Connect to {{{ .starter }}} or Essential Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). To connect to your TiDB cluster using SQL shell, perform the following steps: diff --git a/tidb-cloud/connect-via-standard-connection-serverless.md b/tidb-cloud/connect-via-standard-connection-serverless.md index 382e4424d1f24..ecce16f91091e 100644 --- a/tidb-cloud/connect-via-standard-connection-serverless.md +++ b/tidb-cloud/connect-via-standard-connection-serverless.md @@ -1,11 +1,11 @@ --- -title: Connect to {{{ .starter }}} via Public Endpoint -summary: Learn how to connect to your {{{ .starter }}} cluster via public endpoint. +title: Connect to {{{ .starter }}} or Essential via Public Endpoint +summary: Learn how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via public endpoint. --- -# Connect to {{{ .starter }}} via Public Endpoint +# Connect to {{{ .starter }}} or Essential via Public Endpoint -This document describes how to connect to your {{{ .starter }}} cluster via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint. +This document describes how to connect to your {{{ .starter }}} or {{{ .essential }}} cluster via a public endpoint, using a SQL client from your computer, as well as how to disable a public endpoint. ## Connect via a public endpoint @@ -13,7 +13,7 @@ This document describes how to connect to your {{{ .starter }}} cluster via a pu > > To learn how to connect to a TiDB Cloud Dedicated cluster via public endpoint, see [Connect to TiDB Cloud Dedicated via Public Connection](/tidb-cloud/connect-via-standard-connection.md). -To connect to a {{{ .starter }}} cluster via public endpoint, take the following steps: +To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public endpoint, take the following steps: 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. @@ -23,10 +23,13 @@ To connect to a {{{ .starter }}} cluster via public endpoint, take the following > **Note:** > - > - Keeping the connection type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to {{{ .starter }}}](/tidb-cloud/secure-connections-to-serverless-clusters.md). - > - If you choose **Private Endpoint** in the **Connection Type** drop-down list, it means that the connection is via private endpoint. For more information, see [Connect to {{{ .starter }}} via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). + > - Keeping the connection type as `Public` means the connection is via standard TLS connection. For more information, see [TLS Connection to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md). + > - If you choose **Private Endpoint** in the **Connection Type** drop-down list, it means that the connection is via private endpoint. For more information, see the following documents: + > + > - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + > - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) -4. {{{ .starter }}} lets you create [branches](/tidb-cloud/branch-overview.md) for your cluster. After a branch is created, you can choose to connect to the branch via the **Branch** drop-down list. `main` represents the cluster itself. +4. TiDB Cloud lets you create [branches](/tidb-cloud/branch-overview.md) for your {{{ .starter }}} or {{{ .essential }}} cluster. After a branch is created, you can choose to connect to the branch via the **Branch** drop-down list. `main` represents the cluster itself. 5. If you have not set a password yet, click **Generate Password** to generate a random password. The generated password will not show again, so save your password in a secure location. @@ -34,12 +37,12 @@ To connect to a {{{ .starter }}} cluster via public endpoint, take the following > **Note:** > - > When you connect to a {{{ .starter }}} cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). - > Your client IP must be in the allowed IP rules of the public endpoint of your cluster. For more information, see [Configure {{{ .starter }}} Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). + > When you connect to a {{{ .starter }}} or {{{ .essential }}} cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). + > Your client IP must be in the allowed IP rules of the public endpoint of your cluster. For more information, see [Configure {{{ .starter }}} or Essential Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). ## Disable a public endpoint -If you do not need to use a public endpoint of a {{{ .starter }}} cluster, you can disable it to prevent connections from the internet: +If you do not need to use a public endpoint of a {{{ .starter }}} or {{{ .essential }}} cluster, you can disable it to prevent connections from the internet: 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/tidb-cloud/connect-via-standard-connection.md b/tidb-cloud/connect-via-standard-connection.md index 6c430e5c5e6d7..63e190a8c0261 100644 --- a/tidb-cloud/connect-via-standard-connection.md +++ b/tidb-cloud/connect-via-standard-connection.md @@ -9,7 +9,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > **Tip:** > -> To learn how to connect to a {{{ .starter }}} cluster via public connection, see [Connect to {{{ .starter }}} via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). +> To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via public connection, see [Connect to {{{ .starter }}} or Essential via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md). ## Prerequisite: Configure IP access list diff --git a/tidb-cloud/create-tidb-cluster-serverless.md b/tidb-cloud/create-tidb-cluster-serverless.md index ce6a20224984b..64489faa6f784 100644 --- a/tidb-cloud/create-tidb-cluster-serverless.md +++ b/tidb-cloud/create-tidb-cluster-serverless.md @@ -1,11 +1,11 @@ --- -title: Create a {{{ .starter }}} Cluster -summary: Learn how to create your {{{ .starter }}} cluster. +title: Create a {{{ .starter }}} or Essential Cluster +summary: Learn how to create a {{{ .starter }}} or {{{ .essential }}} cluster. --- -# Create a {{{ .starter }}} Cluster +# Create a {{{ .starter }}} or Essential Cluster -This document describes how to create a {{{ .starter }}} cluster in the [TiDB Cloud console](https://tidbcloud.com/). +This document describes how to create a {{{ .starter }}} or {{{ .essential }}} cluster in the [TiDB Cloud console](https://tidbcloud.com/). > **Tip:** > @@ -19,26 +19,40 @@ If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/sign - For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. - For Azure Marketplace users, you can also sign up through Azure Marketplace. To do that, search for `TiDB Cloud` in [Azure Marketplace](https://azuremarketplace.microsoft.com), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. - For Google Cloud Marketplace users, you can also sign up through Google Cloud Marketplace. To do that, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- For Alibaba Cloud Marketplace users, you can also sign up through Alibaba Cloud Marketplace. To do that, search for `TiDB Cloud` in [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. ## Steps -If you are in the `Organization Owner` or the `Project Owner` role, you can create a {{{ .starter }}} cluster as follows: +If you are in the `Organization Owner` or the `Project Owner` role, you can create a {{{ .starter }}} or {{{ .essential }}} cluster as follows: 1. Log in to the [TiDB Cloud console](https://tidbcloud.com/), and then navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page. 2. Click **Create Cluster**. -3. On the **Create Cluster** page, **Serverless** is selected by default. +3. Select a cluster plan and the cloud provider. -4. The cloud provider of {{{ .starter }}} is AWS. You can select an AWS region where you want to host your cluster. + - For AWS, you can start with a **Starter** cluster. + - For Alibaba Cloud, you can start with a **Starter** cluster and later upgrade to an **Essential** cluster as your needs grow. + + For more information, see [cluster plans](/tidb-cloud/select-cluster-tier.md). + +4. Select a region where you want to host your cluster. 5. Update the default cluster name if necessary. -6. Select a cluster plan. {{{ .starter }}} provides two [cluster plans](/tidb-cloud/select-cluster-tier.md#cluster-plans): **Free Cluster** and **Scalable Cluster**. You can start with a free cluster and later upgrade to a scalable cluster as your needs grow. To create a scalable cluster, you need to specify a **Monthly Spending Limit** and add a credit card. +6. Update the capacity of the cluster. + + - **Starter** plan: + + - You can update the spending limit for your cluster. If the spending limit is set to 0, the cluster remains in the free tier. If the spending limit is greater than 0, you need to add a credit card before creating the cluster. + + - By default, each organization can create up to five [free Starter clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). To create additional Starter clusters, you must add a credit card and specify a spending limit. + + - **Essential** plan: + + - You must specify both a minimum and maximum number of Request Capacity Units (RCUs) for your cluster. - > **Note:** - > - > For each organization in TiDB Cloud, you can create a maximum of five [free clusters](/tidb-cloud/select-cluster-tier.md#free-cluster-plan) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and create [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan) for the usage. + - RCUs represent the compute resources provisioned for your workload. TiDB Cloud automatically scales your cluster within this range based on demand. 7. Click **Create**. @@ -46,7 +60,7 @@ If you are in the `Organization Owner` or the `Project Owner` role, you can crea ## What's next -After your cluster is created, follow the instructions in [Connect to {{{ .starter }}} via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) to create a password for your cluster. +After your cluster is created, follow the instructions in [Connect to TiDB Cloud via Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) to create a password for your cluster. > **Note:** > diff --git a/tidb-cloud/create-tidb-cluster.md b/tidb-cloud/create-tidb-cluster.md index 4b0fa328e2c3c..65e1d6dcaf7fe 100644 --- a/tidb-cloud/create-tidb-cluster.md +++ b/tidb-cloud/create-tidb-cluster.md @@ -9,7 +9,7 @@ This tutorial guides you through signing up and creating a TiDB Cloud Dedicated > **Tip:** > -> To learn how to create a {{{ .starter }}} cluster, see [Create a {{{ .starter }}} Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +> To learn how to create a {{{ .starter }}} or {{{ .essential }}} cluster, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). ## Before you begin diff --git a/tidb-cloud/data-service-get-started.md b/tidb-cloud/data-service-get-started.md index 856e6719bdf83..5804f51ce04d6 100644 --- a/tidb-cloud/data-service-get-started.md +++ b/tidb-cloud/data-service-get-started.md @@ -17,7 +17,11 @@ This document introduces how to quickly get started with TiDB Cloud Data Service ## Before you begin -Before creating a Data App, make sure that you have created a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster. If you do not have one, follow the steps in [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. +Before creating a Data App, make sure that you have created a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md) cluster hosted on AWS. If you do not have one, follow the steps in [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) to create one. + +> **Note:** +> +> Data Service is available only for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md) clusters hosted on AWS. To use Data Service in TiDB Cloud Dedicated clusters, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). ## Get started with a sample Data App diff --git a/tidb-cloud/data-service-oas-with-nextjs.md b/tidb-cloud/data-service-oas-with-nextjs.md index 135d890e0adc5..f06f3071f1429 100644 --- a/tidb-cloud/data-service-oas-with-nextjs.md +++ b/tidb-cloud/data-service-oas-with-nextjs.md @@ -11,7 +11,7 @@ This document introduces how to use the OpenAPI Specification of a [Data App](/t Before using OpenAPI Specification with Next.js, make sure that you have the following: -- A TiDB cluster. For more information, see [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). +- A TiDB cluster. For more information, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). - [Node.js](https://nodejs.org/en/download) - [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) - [yarn](https://yarnpkg.com/getting-started/install) diff --git a/tidb-cloud/data-service-overview.md b/tidb-cloud/data-service-overview.md index d77b7ef9b4887..ef3a47cb572d6 100644 --- a/tidb-cloud/data-service-overview.md +++ b/tidb-cloud/data-service-overview.md @@ -11,7 +11,7 @@ Data Service enables you to access TiDB Cloud data via an HTTPS request using a > **Note:** > -> Data Service is available for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. To use Data Service in TiDB Cloud Dedicated clusters, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). +> Data Service is available only for TiDB Cloud Starter (formerly Serverless) hosted on AWS. To use Data Service in TiDB Cloud Dedicated clusters, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md). An endpoint in Data Service is a web API that you can customize to execute SQL statements. You can specify parameters for your SQL statements, such as the value used in the `WHERE` clause. When a client calls an endpoint and provides values for the parameters in a request URL, the endpoint executes the corresponding SQL statement with the provided parameters and returns the results as part of the HTTP response. diff --git a/tidb-cloud/dedicated-external-storage.md b/tidb-cloud/dedicated-external-storage.md index 9b4df63d9199d..cc2bf955e0271 100644 --- a/tidb-cloud/dedicated-external-storage.md +++ b/tidb-cloud/dedicated-external-storage.md @@ -8,7 +8,7 @@ aliases: ['/tidb-cloud/config-s3-and-gcs-access'] If your source data is stored in Amazon S3 buckets, Azure Blob Storage containers, or Google Cloud Storage (GCS) buckets, before importing or migrating the data to TiDB Cloud, you need to configure cross-account access to the buckets. This document describes how to do this for TiDB Cloud Dedicated clusters. -If you need to configure these external storages for {{{ .starter }}} clusters, see [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md). +If you need to configure these external storages for {{{ .starter }}} or {{{ .essential }}} clusters, see [Configure External Storage Access for {{{ .starter }}} or Essential](/tidb-cloud/serverless-external-storage.md). ## Configure Amazon S3 access diff --git a/tidb-cloud/_index.md b/tidb-cloud/dedicated/_index.md similarity index 92% rename from tidb-cloud/_index.md rename to tidb-cloud/dedicated/_index.md index 252ce43157635..7895d8796038f 100644 --- a/tidb-cloud/_index.md +++ b/tidb-cloud/dedicated/_index.md @@ -26,8 +26,6 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings [Try Out HTAP](https://docs.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart) -[Try Out TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli) - [Proof of Concept](https://docs.pingcap.com/tidbcloud/tidb-cloud-poc) @@ -60,17 +58,13 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings [Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview) -[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli) - [Import Sample Data](https://docs.pingcap.com/tidbcloud/import-sample-data) -[From MySQL](https://docs.pingcap.com/tidbcloud/migrate-data-into-tidb) - -[From Amazon Aurora MySQL](https://docs.pingcap.com/tidbcloud/migrate-from-aurora-bulk-import) +[From MySQL](https://docs.pingcap.com/tidbcloud/migrate-from-mysql-using-data-migration/) [From Amazon RDS for Oracle](https://docs.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms) @@ -80,8 +74,6 @@ summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings [From Apache Parquet Files](https://docs.pingcap.com/tidbcloud/import-csv-files) -[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli) - diff --git a/tidb-cloud/delete-tidb-cluster.md b/tidb-cloud/delete-tidb-cluster.md index 3c5046c3aff60..5f9208c79b689 100644 --- a/tidb-cloud/delete-tidb-cluster.md +++ b/tidb-cloud/delete-tidb-cluster.md @@ -26,7 +26,7 @@ You can delete a cluster at any time by performing the following steps: > **Note:** > - > [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) do not support restoring data after the deletion. If you want to delete a {{{ .starter }}} cluster and restore its data in the future, see [Export Data from {{{ .starter }}}](/tidb-cloud/serverless-export.md) to export your data as a backup. + > [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters do not support restoring data after the deletion. If you want to delete a {{{ .starter }}} or {{{ .essential }}} cluster and restore its data in the future, see [Export Data from {{{ .starter }}} or Essential](/tidb-cloud/serverless-export.md) to export your data as a backup. 5. Click **I understand, delete it**. diff --git a/tidb-cloud/dev-guide-bi-looker-studio.md b/tidb-cloud/dev-guide-bi-looker-studio.md index 7d52aa8e48627..112a12fd72365 100644 --- a/tidb-cloud/dev-guide-bi-looker-studio.md +++ b/tidb-cloud/dev-guide-bi-looker-studio.md @@ -1,20 +1,20 @@ --- -title: Connect to {{{ .starter }}} with Looker Studio -summary: Learn how to connect to {{{ .starter }}} using Looker Studio. +title: Connect to TiDB Cloud with Looker Studio +summary: Learn how to connect to TiDB Cloud using Looker Studio. --- -# Connect to {{{ .starter }}} with Looker Studio +# Connect to TiDB Cloud with Looker Studio -TiDB is a MySQL-compatible database, {{{ .starter }}} is a fully managed TiDB offering, and [Looker Studio](https://lookerstudio.google.com/) is a free web-based BI tool that can visualize data from various sources. +TiDB is a MySQL-compatible database, TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings TiDB to your cloud, and [Looker Studio](https://lookerstudio.google.com/) is a free web-based BI tool that can visualize data from various sources. -In this tutorial, you can learn how to connect to your {{{ .starter }}} cluster with Looker Studio. +This tutorial takes a {{{ .starter }}} cluster as an example to show you how to connect to TiDB Cloud with Looker Studio. > **Note:** > -> Most steps in this tutorial work with TiDB Cloud Dedicated as well. However, for TiDB Cloud Dedicated, you need to note the following: -> -> - Import your dataset following [Import data from files to TiDB Cloud](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud). -> - Get the connection information for your cluster following [Connect to TiDB Cloud Dedicated](/tidb-cloud/connect-via-standard-connection.md). When connecting to TiDB Cloud Dedicated, you need to allow access from `142.251.74.0/23`. For more information about connections from Looker Studio, see [Looker Studio documentation](https://support.google.com/looker-studio/answer/7088031#zippy=%2Cin-this-article). +> - In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. +> - Most steps in this tutorial work with TiDB Cloud Dedicated as well. However, for TiDB Cloud Dedicated, you need to note the following: +> - Import your dataset following [Import data from files to TiDB Cloud](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud). +> - Get the connection information for your cluster following [Connect to TiDB Cloud Dedicated](/tidb-cloud/connect-via-standard-connection.md). When connecting to TiDB Cloud Dedicated, you need to allow access from `142.251.74.0/23`. For more information about connections from Looker Studio, see [Looker Studio documentation](https://support.google.com/looker-studio/answer/7088031#zippy=%2Cin-this-article). ## Prerequisites diff --git a/tidb-cloud/dev-guide-wordpress.md b/tidb-cloud/dev-guide-wordpress.md index 41cd63670546f..3cfdf6c81d9d6 100644 --- a/tidb-cloud/dev-guide-wordpress.md +++ b/tidb-cloud/dev-guide-wordpress.md @@ -11,7 +11,7 @@ In this tutorial, you can learn how to use {{{ .starter }}} to run WordPress for > **Note:** > -> In addition to {{{ .starter }}}, this tutorial works with TiDB Cloud Dedicated and TiDB Self-Managed clusters as well. However, it is highly recommended to run WordPress with {{{ .starter }}} for cost efficiency. +> In addition to {{{ .starter }}}, this tutorial works with {{{ .essential }}}, TiDB Cloud Dedicated, and TiDB Self-Managed clusters as well. However, it is highly recommended to run WordPress with {{{ .starter }}} for cost efficiency. ## Prerequisites diff --git a/tidb-cloud/essential/_index.md b/tidb-cloud/essential/_index.md new file mode 100644 index 0000000000000..41be28d5e9392 --- /dev/null +++ b/tidb-cloud/essential/_index.md @@ -0,0 +1,140 @@ +--- +title: TiDB Cloud Documentation +hide_sidebar: true +hide_commit: true +summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud. It offers guides, samples, and references for learning, trying, developing, maintaining, migrating, monitoring, tuning, securing, billing, integrating, and referencing. +--- + + + + + +[Why TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=essential) + +[Key Concepts](https://docs.pingcap.com/tidbcloud/key-concepts/?plan=essential) + +[FAQ](https://docs.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=essential) + + + + + +[Try Out TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=essential) + +[Try Out TiDB + AI](https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=essential) + +[Try Out HTAP](https://docs.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=essential) + +[Try Out TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=essential) + + + + + +[Developer Guide Overview](https://docs.pingcap.com/tidbcloud/dev-guide-overview/?plan=essential) + +[Quick Start](https://docs.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=essential) + +[Example Application](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=essential) + + + + + +[Create a Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster-serverless/?plan=essential) + +[Connect to a Cluster](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster-serverless/?plan=essential) + +[Use an HTAP Cluster](https://docs.pingcap.com/tidbcloud/tiflash-overview/?plan=essential) + +[Back Up and Restore Data](https://docs.pingcap.com/tidbcloud/backup-and-restore-serverless/?plan=essential) + +[Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview/?plan=essential) + +[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=essential) + + + + + +[From Amazon RDS for Oracle](https://docs.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=essential) + +[Import Sample Data](https://docs.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=essential) + +[Import CSV Files](https://docs.pingcap.com/tidbcloud/import-csv-files-serverless/?plan=essential) + +[Import Parquet Files](https://docs.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=essential) + +[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli-serverless/?plan=essential) + + + + + +[Status and Metrics](https://docs.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=essential) + +[Built-in Monitoring](https://docs.pingcap.com/tidbcloud/built-in-monitoring/?plan=essential) + + + + + +[Tuning Overview](https://docs.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=essential) + +[Analyze Performance](https://docs.pingcap.com/tidbcloud/tune-performance/?plan=essential) + +[Tune SQL Performance](https://docs.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=essential) + +[Tune TiFlash Performance](https://docs.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=essential) + + + + + +[Password Authentication](https://docs.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=essential) + +[User Roles](https://docs.pingcap.com/tidbcloud/manage-user-access#user-roles/?plan=essential) + +[Manage User Profiles](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-user-profiles/?plan=essential) + +[Manage organization access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-organization-access/?plan=essential) + +[Manage project access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-project-access/?plan=essential) + +[Configure Firewall Rules for Public Endpoints](https://docs.pingcap.com/tidbcloud/configure-serverless-firewall-rules-for-public-endpoints/?plan=essential) + + + + + +[Pricing](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#pricing-for-starter/?plan=essential) + +[Invoices](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#invoices/?plan=essential) + +[Credits](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#credits/?plan=essential) + + + + + +[Airbyte](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=essential) + +[Zapier](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=essential) + +[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=essential) + +[Terraform](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=essential) + +[Amazon AppFlow](https://docs.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=essential) + + + + + +[SQL Reference](https://docs.pingcap.com/tidbcloud/basic-sql-operations/?plan=essential) + +[System Variables](https://docs.pingcap.com/tidbcloud/system-variables/?plan=essential) + + + + diff --git a/tidb-cloud/explore-data-with-chat2query.md b/tidb-cloud/explore-data-with-chat2query.md index 603d15c78c266..31bc436e61ed1 100644 --- a/tidb-cloud/explore-data-with-chat2query.md +++ b/tidb-cloud/explore-data-with-chat2query.md @@ -21,7 +21,7 @@ The recommended use cases of SQL Editor are as follows: - SQL queries generated by the AI might not be 100% accurate, and you might need to refine them. - SQL Editor is only supported for TiDB clusters that are v6.5.0 or later and hosted on AWS. -- SQL Editor is available by default for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. To use SQL Editor and Chat2Query on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +- SQL Editor is available only for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters hosted on AWS. To use SQL Editor and Chat2Query on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Access SQL Editor diff --git a/tidb-cloud/import-csv-files-serverless.md b/tidb-cloud/import-csv-files-serverless.md index babf43f1b988b..8b8b55abdbc94 100644 --- a/tidb-cloud/import-csv-files-serverless.md +++ b/tidb-cloud/import-csv-files-serverless.md @@ -1,27 +1,31 @@ --- -title: Import CSV Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}} -summary: Learn how to import CSV files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}}. +title: Import CSV Files from Cloud Storage into {{{ .starter }}} or Essential +summary: Learn how to import CSV files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}} or {{{ .essential }}}. --- -# Import CSV Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}} +# Import CSV Files from Cloud Storage into {{{ .starter }}} or Essential -This document describes how to import CSV files from Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}}. +This document describes how to import CSV files from Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}} or {{{ .essential }}}. + +> **Note:** +> +> For TiDB Cloud Dedicated, see [Import CSV Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-csv-files.md). ## Limitations -- To ensure data consistency, {{{ .starter }}} allows to import CSV files into empty tables only. To import data into an existing table that already contains data, you can use {{{ .starter }}} to import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. +- To ensure data consistency, TiDB Cloud allows to import CSV files into empty tables only. To import data into an existing table that already contains data, you can import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. ## Step 1. Prepare the CSV files 1. If a CSV file is larger than 256 MB, consider splitting it into smaller files, each with a size around 256 MB. - {{{ .starter }}} supports importing very large CSV files but performs best with multiple input files around 256 MB in size. This is because {{{ .starter }}} can process multiple files in parallel, which can greatly improve the import speed. + TiDB Cloud supports importing very large CSV files but performs best with multiple input files around 256 MB in size. This is because TiDB Cloud can process multiple files in parallel, which can greatly improve the import speed. 2. Name the CSV files as follows: - If a CSV file contains all data of an entire table, name the file in the `${db_name}.${table_name}.csv` format, which maps to the `${db_name}.${table_name}` table when you import the data. - If the data of one table is separated into multiple CSV files, append a numeric suffix to these CSV files. For example, `${db_name}.${table_name}.000001.csv` and `${db_name}.${table_name}.000002.csv`. The numeric suffixes can be inconsecutive but must be in ascending order. You also need to add extra zeros before the number to ensure all the suffixes are in the same length. - - {{{ .starter }}} supports importing compressed files in the following formats: `.gzip`, `.gz`, `.zstd`, `.zst` and `.snappy`. If you want to import compressed CSV files, name the files in the `${db_name}.${table_name}.${suffix}.csv.${compress}` format, in which `${suffix}` is optional and can be any integer such as '000001'. For example, if you want to import the `trips.000001.csv.gz` file to the `bikeshare.trips` table, you need to rename the file as `bikeshare.trips.000001.csv.gz`. + - TiDB Cloud supports importing compressed files in the following formats: `.gzip`, `.gz`, `.zstd`, `.zst` and `.snappy`. If you want to import compressed CSV files, name the files in the `${db_name}.${table_name}.${suffix}.csv.${compress}` format, in which `${suffix}` is optional and can be any integer such as '000001'. For example, if you want to import the `trips.000001.csv.gz` file to the `bikeshare.trips` table, you need to rename the file as `bikeshare.trips.000001.csv.gz`. > **Note:** > @@ -31,9 +35,9 @@ This document describes how to import CSV files from Amazon Simple Storage Servi ## Step 2. Create the target table schemas -Because CSV files do not contain schema information, before importing data from CSV files into {{{ .starter }}}, you need to create the table schemas using either of the following methods: +Because CSV files do not contain schema information, before importing data from CSV files into TiDB Cloud, you need to create the table schemas using either of the following methods: -- Method 1: In {{{ .starter }}}, create the target databases and tables for your source data. +- Method 1: In TiDB Cloud, create the target databases and tables for your source data. - Method 2: In the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the CSV files are located, create the target table schema files for your source data as follows: @@ -41,9 +45,9 @@ Because CSV files do not contain schema information, before importing data from If your CSV files follow the naming rules in [Step 1](#step-1-prepare-the-csv-files), the database schema files are optional for the data import. Otherwise, the database schema files are mandatory. - Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, {{{ .starter }}} will create the `${db_name}` database to store your data when you import the data. + Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, TiDB Cloud will create the `${db_name}` database to store your data when you import the data. - For example, if you create a `mydb-scehma-create.sql` file that contains the following statement, {{{ .starter }}} will create the `mydb` database when you import the data. + For example, if you create a `mydb-scehma-create.sql` file that contains the following statement, TiDB Cloud will create the `mydb` database when you import the data. ```sql CREATE DATABASE mydb; @@ -51,11 +55,11 @@ Because CSV files do not contain schema information, before importing data from 2. Create table schema files for your source data. - If you do not include the table schema files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the CSV files are located, {{{ .starter }}} will not create the corresponding tables for you when you import the data. + If you do not include the table schema files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the CSV files are located, TiDB Cloud will not create the corresponding tables for you when you import the data. - Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, {{{ .starter }}} will create the `${db_table}` table in the `${db_name}` database when you import the data. + Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, TiDB Cloud will create the `${db_table}` table in the `${db_name}` database when you import the data. - For example, if you create a `mydb.mytable-schema.sql` file that contains the following statement, {{{ .starter }}} will create the `mytable` table in the `mydb` database when you import the data. + For example, if you create a `mydb.mytable-schema.sql` file that contains the following statement, TiDB Cloud will create the `mytable` table in the `mydb` database when you import the data. ```sql CREATE TABLE mytable ( @@ -70,21 +74,21 @@ Because CSV files do not contain schema information, before importing data from ## Step 3. Configure cross-account access -To allow {{{ .starter }}} to access the CSV files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: +To allow TiDB Cloud to access the CSV files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: -- If your CSV files are located in Amazon S3, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access). +- If your CSV files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access) for your cluster. You can use either an AWS access key or a Role ARN to access your bucket. Once finished, make a note of the access key (including the access key ID and secret access key) or the Role ARN value as you will need it in [Step 4](#step-4-import-csv-files). -- If your CSV files are located in GCS, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-gcs-access). +- If your CSV files are located in GCS, [configure GCS access](/tidb-cloud/serverless-external-storage.md#configure-gcs-access) for your cluster. -- If your CSV files are located in Azure Blob Storage, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access). +- If your CSV files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access) for your cluster. -- If your CSV files are located in Alibaba Cloud Object Storage Service (OSS), [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-alibaba-cloud-object-storage-service-oss-access). +- If your CSV files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/serverless-external-storage.md#configure-alibaba-cloud-object-storage-service-oss-access) for your cluster. ## Step 4. Import CSV files -To import the CSV files to {{{ .starter }}}, take the following steps: +To import the CSV files to {{{ .starter }}} or {{{ .essential }}}, take the following steps:
@@ -295,7 +299,7 @@ To import the CSV files to {{{ .starter }}}, take the following steps: -When you run an import task, if any unsupported or invalid conversions are detected, {{{ .starter }}} terminates the import job automatically and reports an importing error. +When you run an import task, if any unsupported or invalid conversions are detected, TiDB Cloud terminates the import job automatically and reports an importing error. If you get an importing error, do the following: diff --git a/tidb-cloud/import-parquet-files-serverless.md b/tidb-cloud/import-parquet-files-serverless.md index 1cdeef827cc8e..c7bbab4895568 100644 --- a/tidb-cloud/import-parquet-files-serverless.md +++ b/tidb-cloud/import-parquet-files-serverless.md @@ -1,22 +1,23 @@ --- -title: Import Apache Parquet Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}} -summary: Learn how to import Apache Parquet files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}}. +title: Import Apache Parquet Files from Cloud Storage into {{{ .starter }}} or Essential +summary: Learn how to import Apache Parquet files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}} or {{{ .essential }}}. --- -# Import Apache Parquet Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}} +# Import Apache Parquet Files from Cloud Storage into {{{ .starter }}} or Essential -You can import both uncompressed and Snappy compressed [Apache Parquet](https://parquet.apache.org/) format data files to {{{ .starter }}}. This document describes how to import Parquet files from Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}}. +You can import both uncompressed and Snappy compressed [Apache Parquet](https://parquet.apache.org/) format data files to {{{ .starter }}} or {{{ .essential }}}. This document describes how to import Parquet files from Amazon Simple Storage Service (Amazon S3), Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud Object Storage Service (OSS) into {{{ .starter }}} or {{{ .essential }}}. > **Note:** > -> - {{{ .starter }}} only supports importing Parquet files into empty tables. To import data into an existing table that already contains data, you can use {{{ .starter }}} to import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. +> - For TiDB Cloud Dedicated, see [Import Parquet Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-parquet-files.md). +> - TiDB Cloud only supports importing Parquet files into empty tables. To import data into an existing table that already contains data, you can import the data into a temporary empty table by following this document, and then use the `INSERT SELECT` statement to copy the data to the target existing table. > - The Snappy compressed file must be in the [official Snappy format](https://github.com/google/snappy). Other variants of Snappy compression are not supported. ## Step 1. Prepare the Parquet files > **Note:** > -> Currently, {{{ .starter }}} does not support importing Parquet files that contain any of the following data types. If Parquet files to be imported contain such data types, you need to first regenerate the Parquet files using the [supported data types](#supported-data-types) (for example, `STRING`). Alternatively, you could use a service such as AWS Glue to transform data types easily. +> Currently, TiDB Cloud does not support importing Parquet files that contain any of the following data types. If Parquet files to be imported contain such data types, you need to first regenerate the Parquet files using the [supported data types](#supported-data-types) (for example, `STRING`). Alternatively, you could use a service such as AWS Glue to transform data types easily. > > - `LIST` > - `NEST STRUCT` @@ -26,7 +27,7 @@ You can import both uncompressed and Snappy compressed [Apache Parquet](https:// 1. If a Parquet file is larger than 256 MB, consider splitting it into smaller files, each with a size around 256 MB. - {{{ .starter }}} supports importing very large Parquet files but performs best with multiple input files around 256 MB in size. This is because {{{ .starter }}} can process multiple files in parallel, which can greatly improve the import speed. + TiDB Cloud supports importing very large Parquet files but performs best with multiple input files around 256 MB in size. This is because TiDB Cloud can process multiple files in parallel, which can greatly improve the import speed. 2. Name the Parquet files as follows: @@ -39,9 +40,9 @@ You can import both uncompressed and Snappy compressed [Apache Parquet](https:// ## Step 2. Create the target table schemas -Because Parquet files do not contain schema information, before importing data from Parquet files into {{{ .starter }}}, you need to create the table schemas using either of the following methods: +Because Parquet files do not contain schema information, before importing data from Parquet files into TiDB Cloud, you need to create the table schemas using either of the following methods: -- Method 1: In {{{ .starter }}}, create the target databases and tables for your source data. +- Method 1: In TiDB Cloud, create the target databases and tables for your source data. - Method 2: In the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the Parquet files are located, create the target table schema files for your source data as follows: @@ -49,9 +50,9 @@ Because Parquet files do not contain schema information, before importing data f If your Parquet files follow the naming rules in [Step 1](#step-1-prepare-the-parquet-files), the database schema files are optional for the data import. Otherwise, the database schema files are mandatory. - Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, {{{ .starter }}} will create the `${db_name}` database to store your data when you import the data. + Each database schema file must be in the `${db_name}-schema-create.sql` format and contain a `CREATE DATABASE` DDL statement. With this file, TiDB Cloud will create the `${db_name}` database to store your data when you import the data. - For example, if you create a `mydb-scehma-create.sql` file that contains the following statement, {{{ .starter }}} will create the `mydb` database when you import the data. + For example, if you create a `mydb-scehma-create.sql` file that contains the following statement, TiDB Cloud will create the `mydb` database when you import the data. ```sql CREATE DATABASE mydb; @@ -59,11 +60,11 @@ Because Parquet files do not contain schema information, before importing data f 2. Create table schema files for your source data. - If you do not include the table schema files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the Parquet files are located, {{{ .starter }}} will not create the corresponding tables for you when you import the data. + If you do not include the table schema files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service directory where the Parquet files are located, TiDB Cloud will not create the corresponding tables for you when you import the data. - Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, {{{ .starter }}} will create the `${db_table}` table in the `${db_name}` database when you import the data. + Each table schema file must be in the `${db_name}.${table_name}-schema.sql` format and contain a `CREATE TABLE` DDL statement. With this file, TiDB Cloud will create the `${db_table}` table in the `${db_name}` database when you import the data. - For example, if you create a `mydb.mytable-schema.sql` file that contains the following statement, {{{ .starter }}} will create the `mytable` table in the `mydb` database when you import the data. + For example, if you create a `mydb.mytable-schema.sql` file that contains the following statement, TiDB Cloud will create the `mytable` table in the `mydb` database when you import the data. ```sql CREATE TABLE mytable ( @@ -78,21 +79,21 @@ Because Parquet files do not contain schema information, before importing data f ## Step 3. Configure cross-account access -To allow {{{ .starter }}} to access the Parquet files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: +To allow TiDB Cloud to access the Parquet files in the Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud Object Storage Service bucket, do one of the following: -- If your Parquet files are located in Amazon S3, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access). +- If your Parquet files are located in Amazon S3, [configure Amazon S3 access](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access) for your cluster. You can use either an AWS access key or a Role ARN to access your bucket. Once finished, make a note of the access key (including the access key ID and secret access key) or the Role ARN value as you will need it in [Step 4](#step-4-import-parquet-files). -- If your Parquet files are located in GCS, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-gcs-access). +- If your Parquet files are located in GCS, [configure GCS access](/tidb-cloud/serverless-external-storage.md#configure-gcs-access) for your cluster. -- If your Parquet files are located in Azure Blob Storage, [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access). +- If your Parquet files are located in Azure Blob Storage, [configure Azure Blob Storage access](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access) for your cluster. -- If your Parquet files are located in Alibaba Cloud Object Storage Service (OSS), [configure external storage access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-alibaba-cloud-object-storage-service-oss-access). +- If your Parquet files are located in Alibaba Cloud Object Storage Service (OSS), [configure Alibaba Cloud Object Storage Service (OSS) access](/tidb-cloud/serverless-external-storage.md#configure-alibaba-cloud-object-storage-service-oss-access) for your cluster. ## Step 4. Import Parquet files -To import the Parquet files to {{{ .starter }}}, take the following steps: +To import the Parquet files to {{{ .starter }}} or {{{ .essential }}}, take the following steps:
@@ -303,7 +304,7 @@ To import the Parquet files to {{{ .starter }}}, take the following steps: -When you run an import task, if any unsupported or invalid conversions are detected, {{{ .starter }}} terminates the import job automatically and reports an importing error. +When you run an import task, if any unsupported or invalid conversions are detected, TiDB Cloud terminates the import job automatically and reports an importing error. If you get an importing error, do the following: @@ -317,7 +318,7 @@ If you get an importing error, do the following: ## Supported data types -The following table lists the supported Parquet data types that can be imported to {{{ .starter }}}. +The following table lists the supported Parquet data types that can be imported to {{{ .starter }}} and {{{ .essential }}}. | Parquet Primitive Type | Parquet Logical Type | Types in TiDB or MySQL | |---|---|---| diff --git a/tidb-cloud/import-sample-data-serverless.md b/tidb-cloud/import-sample-data-serverless.md index 4033a77131d27..18d250cdce696 100644 --- a/tidb-cloud/import-sample-data-serverless.md +++ b/tidb-cloud/import-sample-data-serverless.md @@ -1,15 +1,15 @@ --- -title: Import Sample Data into {{{ .starter }}} -summary: Learn how to import sample data into {{{ .starter }}} via the UI. +title: Import Sample Data into {{{ .starter }}} or Essential +summary: Learn how to import sample data into {{{ .starter }}} or {{{ .essential }}} via the UI. --- -# Import Sample Data into {{{ .starter }}} +# Import Sample Data into {{{ .starter }}} or Essential -This document describes how to import the sample data into {{{ .starter }}} via the UI. The sample data used is the system data from Capital Bikeshare, released under the Capital Bikeshare Data License Agreement. Before importing the sample data, you need to have one TiDB cluster. +This document describes how to import the sample data into {{{ .starter }}} or {{{ .essential }}} via the UI. The sample data used is the system data from Capital Bikeshare, released under the Capital Bikeshare Data License Agreement. Before importing the sample data, you need to have one TiDB cluster. > **Note:** > -> {{{ .starter }}} currently only supports importing sample data from Amazon S3. +> The sample data used in this document is from Amazon S3. 1. Open the **Import** page for your target cluster. diff --git a/tidb-cloud/import-with-mysql-cli-serverless.md b/tidb-cloud/import-with-mysql-cli-serverless.md index b895c1420f909..5de46158802d9 100644 --- a/tidb-cloud/import-with-mysql-cli-serverless.md +++ b/tidb-cloud/import-with-mysql-cli-serverless.md @@ -1,20 +1,20 @@ --- -title: Import Data into {{{ .starter }}} via MySQL CLI -summary: Learn how to import Data into {{{ .starter }}} via MySQL CLI. +title: Import Data into {{{ .starter }}} or Essential via MySQL CLI +summary: Learn how to import Data into {{{ .starter }}} or {{{ .essential }}} via MySQL CLI. --- -# Import Data into {{{ .starter }}} via MySQL CLI +# Import Data into {{{ .starter }}} or Essential via MySQL CLI -This document describes how to import data into {{{ .starter }}} via the [MySQL Command-Line Client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). You can import data from an SQL file or a CSV file. The following sections provide step-by-step instructions for importing data from each type of file. +This document describes how to import data into {{{ .starter }}} or {{{ .essential }}} via the [MySQL Command-Line Client](https://dev.mysql.com/doc/refman/8.0/en/mysql.html). You can import data from an SQL file or a CSV file. The following sections provide step-by-step instructions for importing data from each type of file. ## Prerequisites -Before you can import data via MySQL CLI to {{{ .starter }}}, you need the following prerequisites: +Before you can import data via MySQL CLI to {{{ .starter }}} or {{{ .essential }}}, you need the following prerequisites: -- You have access to your {{{ .starter }}} cluster. If you do not have, create one following the instructions in [Build a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md). +- You have access to your {{{ .starter }}} or {{{ .essential }}} cluster. If you do not have, create one following the instructions in [Build a TiDB Cloud Cluster](/develop/dev-guide-build-cluster-in-cloud.md). - Install MySQL CLI on your local computer. -## Step 1. Connect to your {{{ .starter }}} cluster +## Step 1. Connect to your {{{ .starter }}} or {{{ .essential }}} cluster Connect to your TiDB cluster. diff --git a/tidb-cloud/integrate-tidbcloud-with-airbyte.md b/tidb-cloud/integrate-tidbcloud-with-airbyte.md index 44f6b918bd4cc..94de37b2e7d20 100644 --- a/tidb-cloud/integrate-tidbcloud-with-airbyte.md +++ b/tidb-cloud/integrate-tidbcloud-with-airbyte.md @@ -62,7 +62,7 @@ Conveniently, the steps are the same for setting TiDB as the source and the dest > > - TiDB Cloud supports TLS connection. You can choose your TLS protocols in **TLSv1.2** and **TLSv1.3**, for example, `enabledTLSProtocols=TLSv1.2`. > - If you want to disable TLS connection to TiDB Cloud via JDBC, you need to set useSSL to `false` in JDBC URL Params specifically and close SSL connection, for example, `useSSL=false`. - > - {{{ .starter }}} only supports TLS connections. + > - {{{ .starter }}} and {{{ .essential }}} only support TLS connections. 4. Click **Set up source** or **destination** to complete creating the connector. The following screenshot shows the configuration of TiDB as the source. diff --git a/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md b/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md index d91f912b9cba1..d119fd700c737 100644 --- a/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md +++ b/tidb-cloud/integrate-tidbcloud-with-aws-lambda.md @@ -7,6 +7,10 @@ summary: Introduce how to integrate {{{ .starter }}} with Amazon Lambda and Clou This document provides a step-by-step guide on how to use [AWS CloudFormation](https://aws.amazon.com/cloudformation/) to integrate [{{{ .starter }}}](https://www.pingcap.com/tidb-cloud/), a cloud-native distributed SQL database, with [AWS Lambda](https://aws.amazon.com/lambda/), a serverless and event-driven compute service. By integrating {{{ .starter }}} with Amazon Lambda, you can leverage the scalability and cost-efficiency of microservices through {{{ .starter }}} and AWS Lambda. AWS CloudFormation automates the creation and management of AWS resources, including Lambda functions, API Gateway, and Secrets Manager. +> **Note:** +> +> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. + ## Solution overview In this guide, you will create a fully functional online bookshop with the following components: diff --git a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md index 57643587ee5d0..8517167c94643 100644 --- a/tidb-cloud/integrate-tidbcloud-with-cloudflare.md +++ b/tidb-cloud/integrate-tidbcloud-with-cloudflare.md @@ -13,13 +13,14 @@ This document shows how to connect to Cloudflare Workers with TiDB Cloud serverl > **Note:** > -> TiDB Cloud serverless driver can only be used in {{{ .starter }}}. +> TiDB Cloud serverless driver can only be used in {{{ .starter }}} and {{{ .essential }}}. ## Before you begin Before you try the steps in this article, you need to prepare the following things: -- A TiDB Cloud account and a {{{ .starter }}} cluster on TiDB Cloud. For more details, see [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md#step-1-create-a-tidb-cluster). +- A [TiDB Cloud account](https://tidbcloud.com/signup). +- A {{{ .starter }}} or {{{ .essential }}} cluster. If you do not have one, see [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md). - A [Cloudflare Workers account](https://dash.cloudflare.com/login). - [npm](https://docs.npmjs.com/about-npm) is installed. diff --git a/tidb-cloud/integrate-tidbcloud-with-n8n.md b/tidb-cloud/integrate-tidbcloud-with-n8n.md index 4759f14b2160f..debe0979737a6 100644 --- a/tidb-cloud/integrate-tidbcloud-with-n8n.md +++ b/tidb-cloud/integrate-tidbcloud-with-n8n.md @@ -9,6 +9,10 @@ summary: Learn the use of TiDB Cloud node in n8n. This document introduces how to build an auto-workflow: create a {{{ .starter }}} cluster, gather Hacker News RSS, store it to TiDB and send a briefing email. +> **Note:** +> +> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. + ## Prerequisites: Get TiDB Cloud API key 1. In the [TiDB Cloud console](https://tidbcloud.com), switch to your target organization using the combo box in the upper-left corner. diff --git a/tidb-cloud/integrate-tidbcloud-with-netlify.md b/tidb-cloud/integrate-tidbcloud-with-netlify.md index fbbee603e1a17..03302312bada7 100644 --- a/tidb-cloud/integrate-tidbcloud-with-netlify.md +++ b/tidb-cloud/integrate-tidbcloud-with-netlify.md @@ -24,7 +24,7 @@ You are expected to have a Netlify account and CLI. If you do not have any, refe You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: -- [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) One TiDB Cloud cluster can connect to multiple Netlify sites. @@ -33,7 +33,7 @@ One TiDB Cloud cluster can connect to multiple Netlify sites. For TiDB Cloud Dedicated clusters, make sure that the traffic filter of the cluster allows all IP addresses (set to `0.0.0.0/0`) for connection. This is because Netlify deployments use dynamic IP addresses. -{{{ .starter }}} clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. +{{{ .starter }}} and {{{ .essential }}} clusters allow all IP addresses for connection by default, so you do not need to configure any traffic filter. ## Step 1. Get the example project and the connection string @@ -52,7 +52,7 @@ To help you get started quickly, TiDB Cloud provides a fullstack example app in ### Get the TiDB Cloud connection string -For a {{{ .starter }}} cluster, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). +For a {{{ .starter }}} or {{{ .essential }}} cluster, you can get the connection string either from [TiDB Cloud CLI](/tidb-cloud/cli-reference.md) or from [TiDB Cloud console](https://tidbcloud.com/). For a TiDB Cloud Dedicated cluster, you can get the connection string only from the TiDB Cloud console. diff --git a/tidb-cloud/integrate-tidbcloud-with-vercel.md b/tidb-cloud/integrate-tidbcloud-with-vercel.md index 08bdeb5663262..6f6ddf090d64a 100644 --- a/tidb-cloud/integrate-tidbcloud-with-vercel.md +++ b/tidb-cloud/integrate-tidbcloud-with-vercel.md @@ -38,11 +38,11 @@ One Vercel project can only connect to one TiDB Cloud cluster. To change the int You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to the following to create one: -- [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or {{{ .essential }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) > **Note:** > - > The TiDB Cloud Vercel integration supports creating {{{ .starter }}} clusters. You can also create one later during the integration process. + > The TiDB Cloud Vercel integration supports creating {{{ .starter }}} and {{{ .essential }}} clusters. You can also create one later during the integration process. - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) @@ -71,7 +71,7 @@ To connect via the TiDB Cloud Vercel integration, go to the [TiDB Cloud integrat > **Note:** > -> This method is only available for {{{ .starter }}} clusters. If you want to connect to a TiDB Cloud Dedicated cluster, use the [manual method](#connect-via-manually-setting-environment-variables). +> This method is only available for {{{ .starter }}} and {{{ .essential }}} clusters. If you want to connect to a TiDB Cloud Dedicated cluster, use the [manual method](#connect-via-manually-setting-environment-variables). ### Integration workflow @@ -89,7 +89,7 @@ The detailed steps are as follows: 1. Select your target Vercel projects and click **Next**. 2. Select your target TiDB Cloud organization and project. 3. Select **Cluster** as your connection type. - 4. Select your target TiDB Cloud cluster. If the **Cluster** drop-down list is empty or you want to select a new {{{ .starter }}} cluster, click **+ Create Cluster** in the list to create one. + 4. Select your target TiDB Cloud cluster. If the **Cluster** drop-down list is empty or you want to select a new {{{ .starter }}} or {{{ .essential }}} cluster, click **+ Create Cluster** in the list to create one. 5. Select the database that you want to connect to. If the **Database** drop-down list is empty or you want to select a new Database, click **+ Create Database** in the list to create one. 6. Select the framework that your Vercel projects are using. If the target framework is not listed, select **General**. Different frameworks determine different environment variables. 7. Choose whether to enable **Branching** to create new branches for preview environments. @@ -117,7 +117,7 @@ The detailed steps are as follows: DATABASE_URL ``` - **{{{ .starter }}} Driver** + **TiDB Cloud Serverless Driver** ``` DATABASE_URL @@ -165,22 +165,22 @@ If you have installed [TiDB Cloud Vercel integration](https://vercel.com/integra ![Vercel Integration Configuration Page](/media/tidb-cloud/vercel/integration-vercel-configuration-page.png) - When you remove a connection, the environment variables set by the integration workflow are removed from the Vercel project, too. However, this action does not affect the data of the {{{ .starter }}} cluster. + When you remove a connection, the environment variables set by the integration workflow are removed from the Vercel project, too. However, this action does not affect the data of your TiDB Cloud cluster. -### Connect with {{{ .starter }}} branching {#connect-with-branching} +### Connect with TiDB Cloud branching {#connect-with-branching} -Vercel's [Preview Deployments](https://vercel.com/docs/deployments/preview-deployments) feature allows you to preview changes to your app in a live deployment without merging those changes to your Git project's production branch. With [{{{ .starter }}} Branching](/tidb-cloud/branch-overview.md), you can create a new instance for each branch of your Vercel project. This allows you to preview app changes in a live deployment without affecting your production data. +Vercel's [Preview Deployments](https://vercel.com/docs/deployments/preview-deployments) feature allows you to preview changes to your app in a live deployment without merging those changes to your Git project's production branch. With [TiDB Cloud Branching](/tidb-cloud/branch-overview.md), you can create a new instance for each branch of your Vercel project. This allows you to preview app changes in a live deployment without affecting your production data. > **Note:** > -> Currently, {{{ .starter }}} branching only supports [Vercel projects associated with GitHub repositories](https://vercel.com/docs/deployments/git/vercel-for-github). +> Currently, TiDB Cloud Branching only supports [Vercel projects associated with GitHub repositories](https://vercel.com/docs/deployments/git/vercel-for-github). -To enable {{{ .starter }}} Branching, you need to ensure the following in the [TiDB Cloud Vercel integration workflow](#integration-workflow): +To enable TiDB Cloud Branching, you need to ensure the following in the [TiDB Cloud Vercel integration workflow](#integration-workflow): 1. Select **Cluster** as your connection type. 2. Enable **Branching** to create new branches for preview environments. -After you push changes to the Git repository, Vercel will trigger a preview deployment. TiDB Cloud integration will automatically create a {{{ .starter }}} branch for the Git branch and set environment variables. The detailed steps are as follows: +After you push changes to the Git repository, Vercel will trigger a preview deployment. TiDB Cloud integration will automatically create a branch of your TiDB Cloud cluster for the Git branch and set environment variables. The detailed steps are as follows: 1. Create a new branch in your Git repository. @@ -194,15 +194,15 @@ After you push changes to the Git repository, Vercel will trigger a preview depl ![Vercel Preview_Deployment](/media/tidb-cloud/vercel/vercel-preview-deployment.png) - 1. During the deployment, TiDB Cloud integration will automatically create a {{{ .starter }}} branch with the same name as the Git branch. If the {{{ .starter }}} branch already exists, TiDB Cloud integration will skip this step. + 1. During the deployment, TiDB Cloud integration will automatically create a branch for your cluster with the same name as the Git branch. If the branch already exists, TiDB Cloud integration will skip this step. ![TiDB_Cloud_Branch_Check](/media/tidb-cloud/vercel/tidbcloud-branch-check.png) - 2. After the {{{ .starter }}} branch is ready, TiDB Cloud integration will set environment variables in the preview deployment for the Vercel project. + 2. After the branch is ready, TiDB Cloud integration will set environment variables in the preview deployment for the Vercel project. ![Preview_Envs](/media/tidb-cloud/vercel/preview-envs.png) - 3. TiDB Cloud integration will also register a blocking check to wait for the {{{ .starter }}} branch to be ready. You can rerun the check manually. + 3. TiDB Cloud integration will also register a blocking check to wait for the branch to be ready. You can rerun the check manually. 4. After the check is passed, you can visit the preview deployment to see the changes. > **Note:** @@ -211,7 +211,7 @@ After you push changes to the Git repository, Vercel will trigger a preview depl > **Note:** > -> For each organization in TiDB Cloud, you can create a maximum of five {{{ .starter }}} branches by default. To avoid exceeding the limit, you can delete the {{{ .starter }}} branches that are no longer needed. For more information, see [Manage {{{ .starter }}} branches](/tidb-cloud/branch-manage.md). +> For each organization in TiDB Cloud, you can create a maximum of five branches for {{{ .starter }}} clusters by default. To avoid exceeding the limit, you can delete the branches of your cluster that are no longer needed. For more information, see [Manage TiDB Cloud branches](/tidb-cloud/branch-manage.md). ## Connect via manually setting environment variables @@ -226,7 +226,7 @@ After you push changes to the Git repository, Vercel will trigger a preview depl ![Vercel Environment Variables](/media/tidb-cloud/vercel/integration-vercel-environment-variables.png) -Here we use a Prisma application as an example. The following is a datasource setting in the Prisma schema file for a {{{ .starter }}} cluster: +Here we use a Prisma application and a {{{ .starter }}} cluster as an example. The following is a datasource setting in the Prisma schema file for a {{{ .starter }}} cluster: ``` datasource db { diff --git a/tidb-cloud/key-concepts.md b/tidb-cloud/key-concepts.md index 461629504023b..e92067db3ca78 100644 --- a/tidb-cloud/key-concepts.md +++ b/tidb-cloud/key-concepts.md @@ -37,9 +37,9 @@ TiDB Cloud Dedicated lets you adjust its compute and storage resources separatel ## High availability -TiDB Cloud ensures high availability in both {{{ .starter }}} and TiDB Cloud Dedicated clusters: +TiDB Cloud ensures high availability in {{{ .starter }}}, {{{ .essential }}}, and TiDB Cloud Dedicated clusters: -- [High Availability in {{{ .starter }}}](/tidb-cloud/serverless-high-availability.md) +- [High Availability in {{{ .starter }}} and Essential](/tidb-cloud/serverless-high-availability.md) - [High Availability in TiDB Cloud Dedicated](/tidb-cloud/high-availability-with-multi-az.md) ## Monitoring diff --git a/tidb-cloud/limited-sql-features.md b/tidb-cloud/limited-sql-features.md index 24cded4e3706d..4ec2108ccb907 100644 --- a/tidb-cloud/limited-sql-features.md +++ b/tidb-cloud/limited-sql-features.md @@ -5,13 +5,13 @@ summary: Learn about the limited SQL features on TiDB Cloud. # Limited SQL features on TiDB Cloud -TiDB Cloud works with almost all workloads that TiDB supports, but there are some feature differences between TiDB Self-Managed and TiDB Cloud Dedicated/Serverless. This document describes the limitations of SQL features on TiDB Cloud. We are constantly filling in the feature gaps between TiDB Self-Managed and TiDB Cloud Dedicated/Serverless. If you require these features or capabilities in the gap, [contact us](/tidb-cloud/tidb-cloud-support.md) for a feature request. +TiDB Cloud works with almost all workloads that TiDB supports, but there are some feature differences between TiDB Self-Managed and TiDB Cloud. This document describes the limitations of SQL features on TiDB Cloud. We are constantly filling in the feature gaps between TiDB Self-Managed and TiDB Cloud. If you require these features or capabilities in the gap, [contact us](/tidb-cloud/tidb-cloud-support.md) for a feature request. ## Statements ### Placement and range management -| Statement | TiDB Cloud Dedicated | {{{ .starter }}} | +| Statement | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-| | `ALTER PLACEMENT POLICY` | Supported | Not supported [^1] | | `CREATE PLACEMENT POLICY` | Supported | Not supported [^1] | @@ -25,7 +25,7 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som ### Resource groups -| Statement | TiDB Cloud Dedicated | {{{ .starter }}} | +| Statement | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-| | `ALTER RESOURCE GROUP` | Supported | Not supported [^2] | | `CALIBRATE RESOURCE` | Not supported | Not supported [^2] | @@ -36,18 +36,18 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som ### Others -| Statement | TiDB Cloud Dedicated | {{{ .starter }}} | +| Statement | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-| | `BACKUP` | Supported | Not supported [^3] | | `SHOW BACKUPS` | Supported | Not supported [^3] | | `RESTORE` | Supported | Not supported [^3] | | `SHOW RESTORES` | Supported | Not supported [^3] | -| `ADMIN RESET TELEMETRY_ID` | Supported | Telemetry is not supported on {{{ .starter }}}. | +| `ADMIN RESET TELEMETRY_ID` | Supported | Telemetry is not supported on {{{ .starter }}} or {{{ .essential }}}. | | `ADMIN SHOW TELEMETRY` | Not supported [^4] | Not supported [^4] | | `ADMIN SHOW SLOW` | Supported | Not supported [^5] | | `ADMIN PLUGINS ENABLE` | Supported | Not supported [^8] | | `ADMIN PLUGINS DISABLE` | Supported | Not supported [^8] | -| `ALTER INSTANCE RELOAD TLS` | Supported | {{{ .starter }}} automatically refreshes the TLS certificate. | +| `ALTER INSTANCE RELOAD TLS` | Supported | {{{ .starter }}} and {{{ .essential }}} automatically refresh the TLS certificate. | | `LOAD DATA INFILE` | Supports `LOAD DATA LOCAL INFILE`, and `LOAD DATA INFILE` from Amazon S3 or Google Cloud Storage | Only supports `LOAD DATA LOCAL INFILE` | | `CHANGE DRAINER` | Not supported [^7] | Not supported [^7] | | `CHANGE PUMP` | Not supported [^7] | Not supported [^7] | @@ -64,13 +64,13 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som ## Functions and operators -| Function and operator | TiDB Cloud Dedicated | {{{ .starter }}} | +| Function and operator | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-| | `SLEEP` | No Limitation | The [`SLEEP()` function](https://docs.pingcap.com/tidbcloud/miscellaneous-functions) has a limitation wherein it can only support a maximum sleep time of 300 seconds.| ## System tables -| Database | Table | TiDB Cloud Dedicated | {{{ .starter }}} | +| Database | Table | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-|:-| | `information_schema` | `ATTRIBUTES` | Supported | Not supported [^1] | | `information_schema` | `CLUSTER_CONFIG` | Not supported [^4] | Not supported [^4] | @@ -121,7 +121,7 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som ## System variables -| Variable | TiDB Cloud Dedicated | {{{ .starter }}} | +| Variable | TiDB Cloud Dedicated | {{{ .starter }}} and {{{ .essential }}} | |:-|:-|:-| | `datadir` | No limitation | Not supported [^1] | | `interactive_timeout` | No limitation | Read-only [^10] | @@ -217,26 +217,26 @@ TiDB Cloud works with almost all workloads that TiDB supports, but there are som | `validate_password.special_char_count` | No limitation | At least `1` [^9] | | `wait_timeout` | No limitation | Read-only [^10] | -[^1]: Configuring data placement is not supported on {{{ .starter }}}. +[^1]: Configuring data placement is not supported on {{{ .starter }}} or {{{ .essential }}}. -[^2]: Configuring resource groups is not supported on {{{ .starter }}}. +[^2]: Configuring resource groups is not supported on {{{ .starter }}} or {{{ .essential }}}. -[^3]: To perform [Back up and Restore](/tidb-cloud/backup-and-restore-serverless.md) operations on {{{ .starter }}}, you can use the TiDB Cloud console instead. +[^3]: To perform [Back up and Restore](/tidb-cloud/backup-and-restore-serverless.md) operations on {{{ .starter }}} or {{{ .essential }}}, you can use the TiDB Cloud console instead. [^4]: The feature is unavailable in [Security Enhanced Mode (SEM)](/system-variables.md#tidb_enable_enhanced_security). -[^5]: To track [Slow Query](/tidb-cloud/tune-performance.md#slow-query) on {{{ .starter }}}, you can use the TiDB Cloud console instead. +[^5]: To track [Slow Query](/tidb-cloud/tune-performance.md#slow-query) on {{{ .starter }}} or {{{ .essential }}}, you can use the TiDB Cloud console instead. -[^6]: To perform [Statement Analysis](/tidb-cloud/tune-performance.md#statement-analysis) on {{{ .starter }}}, you can use the TiDB Cloud console instead. +[^6]: To perform [Statement Analysis](/tidb-cloud/tune-performance.md#statement-analysis) on {{{ .starter }}} or {{{ .essential }}}, you can use the TiDB Cloud console instead. [^7]: Drainer and Pump are not supported on TiDB Cloud. -[^8]: Plugin is not supported on {{{ .starter }}}. +[^8]: Plugin is not supported on {{{ .starter }}} or {{{ .essential }}}. -[^9]: {{{ .starter }}} enforces strong password policy. +[^9]: {{{ .starter }}} and {{{ .essential }}} enforce strong password policy. -[^10]: The variable is read-only on {{{ .starter }}}. +[^10]: The variable is read-only on {{{ .starter }}} and {{{ .essential }}}. -[^11]: {{{ .starter }}} does not support downloading the file exported by `PLAN REPLAYER` through `${tidb-server-status-port}` as in the [example](https://docs.pingcap.com/tidb/stable/sql-plan-replayer#examples-of-exporting-cluster-information). Instead, {{{ .starter }}} generates a [presigned URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html) for you to download the file. Note that this URL remains valid for 10 hours after generation. +[^11]: {{{ .starter }}} and {{{ .essential }}} do not support downloading the file exported by `PLAN REPLAYER` through `${tidb-server-status-port}` as in the [example](https://docs.pingcap.com/tidb/stable/sql-plan-replayer#examples-of-exporting-cluster-information). Instead, {{{ .starter }}} and {{{ .essential }}} generate a [presigned URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html) for you to download the file. Note that this URL remains valid for 10 hours after generation. [^12]: Not supported. Enabling `require_secure_transport` for TiDB Cloud Dedicated clusters will result in SQL client connection failures. diff --git a/tidb-cloud/manage-serverless-spend-limit.md b/tidb-cloud/manage-serverless-spend-limit.md index 7ecedee031c22..9e7ecb098100f 100644 --- a/tidb-cloud/manage-serverless-spend-limit.md +++ b/tidb-cloud/manage-serverless-spend-limit.md @@ -1,17 +1,17 @@ --- -title: Manage Spending Limit for {{{ .starter }}} Scalable Clusters -summary: Learn how to manage spending limit for your {{{ .starter }}} scalable clusters. +title: Manage Spending Limit for {{{ .starter }}} Clusters +summary: Learn how to manage spending limit for your {{{ .starter }}} clusters. --- -# Manage Spending Limit for {{{ .starter }}} Scalable Clusters +# Manage Spending Limit for {{{ .starter }}} Clusters > **Note:** > -> The spending limit is only applicable to {{{ .starter }}} [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan). +> The spending limit is only applicable to {{{ .starter }}} clusters. -Spending limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your {{{ .starter }}} scalable clusters. +Spending limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that allows you to set a budget for your {{{ .starter }}} clusters. -For each organization in TiDB Cloud, you can create a maximum of five [free clusters](/tidb-cloud/select-cluster-tier.md#free-cluster-plan) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and create scalable clusters for the usage. But if you delete some of your previous clusters before creating more, the new cluster can still be created without a credit card. +For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and set a monthly spending limit for the usage. But if you delete some of your previous clusters before creating more, the new cluster can still be created without a credit card. ## Usage quota @@ -29,7 +29,7 @@ If you want to create a {{{ .starter }}} cluster with an additional quota, you c ## Update spending limit -For a {{{ .starter }}} free cluster, you can increase the usage quota by upgrading it to a scalable cluster. For an existing scalable cluster, you can adjust the monthly spending limit directly. +For a {{{ .starter }}} free cluster, you can increase the usage quota by setting a monthly spending limit when creating the cluster. For an existing cluster, you can adjust the monthly spending limit directly. To update the spending limit for a {{{ .starter }}} cluster, perform the following steps: @@ -39,9 +39,9 @@ To update the spending limit for a {{{ .starter }}} cluster, perform the followi > > You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters. -2. In the **Usage This Month** area, click **Upgrade to Scalable Cluster**. +2. In the **Capacity used this month** area, click **Set Spending Limit**. - To adjust the spending limit for an existing scalable cluster, click **Edit**. + If you have set the spending limit previously and want to update it, click **Edit**. 3. Edit the monthly spending limit as needed. If you have not added a payment method, you will need to add a credit card after editing the limit. -4. Click **Update Cluster Plan**. +4. Click **Update Spending Limit**. diff --git a/tidb-cloud/manage-user-access.md b/tidb-cloud/manage-user-access.md index b0cdc38f6ac9a..c372434194dd4 100644 --- a/tidb-cloud/manage-user-access.md +++ b/tidb-cloud/manage-user-access.md @@ -105,7 +105,7 @@ At the project level, TiDB Cloud defines three roles, in which `Project Owner` c | Manage [database audit logging](/tidb-cloud/tidb-cloud-auditing.md) of the project. | ✅ | ❌ | ❌ | ❌ | | Manage [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for all {{{ .starter }}} clusters in the project. | ✅ | ❌ | ❌ | ❌ | | Manage cluster operations in the project, such as cluster creation, modification, and deletion. | ✅ | ❌ | ❌ | ❌ | -| Manage branches for {{{ .starter }}} clusters in the project, such as branch creation, connection, and deletion. | ✅ | ❌ | ❌ | ❌ | +| Manage branches for {{{ .starter }}} and {{{ .essential }}} clusters in the project, such as branch creation, connection, and deletion. | ✅ | ❌ | ❌ | ❌ | | Manage [recovery groups](/tidb-cloud/recovery-group-overview.md) for TiDB Cloud Dedicated clusters in the project, such as recovery group creation and deletion. | ✅ | ❌ | ❌ | ❌ | | Manage cluster data such as data import, data backup and restore, and data migration. | ✅ | ✅ | ❌ | ❌ | | Manage [Data Service](/tidb-cloud/data-service-overview.md) for data read-only operations such as using or creating endpoints to read data. | ✅ | ✅ | ✅ | ❌ | diff --git a/tidb-cloud/migrate-from-mysql-using-aws-dms.md b/tidb-cloud/migrate-from-mysql-using-aws-dms.md index d554c741a1c59..8d2a859210e7a 100644 --- a/tidb-cloud/migrate-from-mysql-using-aws-dms.md +++ b/tidb-cloud/migrate-from-mysql-using-aws-dms.md @@ -181,8 +181,8 @@ If you encounter any issues or failures during the migration, you can check the ## See also -- If you want to learn more about how to connect AWS DMS to {{{ .starter }}} or TiDB Cloud Dedicated, see [Connect AWS DMS to TiDB Cloud clusters](/tidb-cloud/tidb-cloud-connect-aws-dms.md). +- If you want to learn more about how to connect AWS DMS to your TiDB Cloud cluster, see [Connect AWS DMS to TiDB Cloud clusters](/tidb-cloud/tidb-cloud-connect-aws-dms.md). - If you want to migrate from MySQL-compatible databases, such as Aurora MySQL and Amazon Relational Database Service (RDS), to TiDB Cloud, it is recommended to use [Data Migration on TiDB Cloud](/tidb-cloud/migrate-from-mysql-using-data-migration.md). -- If you want to migrate from Amazon RDS for Oracle to {{{ .starter }}} Using AWS DMS, see [Migrate from Amazon RDS for Oracle to {{{ .starter }}} Using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md). +- If you want to migrate from Amazon RDS for Oracle to TiDB Cloud using AWS DMS, see [Migrate from Amazon RDS for Oracle to TiDB Cloud using AWS DMS](/tidb-cloud/migrate-from-oracle-using-aws-dms.md). diff --git a/tidb-cloud/migrate-from-oracle-using-aws-dms.md b/tidb-cloud/migrate-from-oracle-using-aws-dms.md index 38713cb94cb83..6339fee66fe04 100644 --- a/tidb-cloud/migrate-from-oracle-using-aws-dms.md +++ b/tidb-cloud/migrate-from-oracle-using-aws-dms.md @@ -7,6 +7,10 @@ summary: Learn how to migrate data from Amazon RDS for Oracle into {{{ .starter This document describes a step-by-step example of how to migrate data from Amazon RDS for Oracle to [{{{ .starter }}}](https://tidbcloud.com/clusters/create-cluster) using AWS Database Migration Service (AWS DMS). +> **Tip:** +> +> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. + If you are interested in learning more about TiDB Cloud and AWS DMS, see the following: - [TiDB Cloud](https://docs.pingcap.com/tidbcloud/) diff --git a/tidb-cloud/migrate-sql-shards.md b/tidb-cloud/migrate-sql-shards.md index d8dd13e3f28a8..2068e23009a6a 100644 --- a/tidb-cloud/migrate-sql-shards.md +++ b/tidb-cloud/migrate-sql-shards.md @@ -189,7 +189,7 @@ After configuring the Amazon S3 access, you can perform the data import task in 3. On the **Import Data from Amazon S3** page, fill in the following information: - - **Import File Count**: for {{{ .starter }}}, select **Multiple files**. This field is not available in TiDB Cloud Dedicated. + - **Import File Count**: for {{{ .starter }}} or {{{ .essential }}}, select **Multiple files**. This field is not available in TiDB Cloud Dedicated. - **Included Schema Files**: select **No**. - **Data Format**: select **CSV**. - **Folder URI**: fill in the bucket URI of your source data. You can use the second-level directory corresponding to tables, `s3://dumpling-s3/store/sales/` in this example, so that TiDB Cloud can import and merge the data in all MySQL instances into `store.sales` in one go. diff --git a/tidb-cloud/monitor-datadog-integration.md b/tidb-cloud/monitor-datadog-integration.md index 42975be2770cf..0bd69d1d690e1 100644 --- a/tidb-cloud/monitor-datadog-integration.md +++ b/tidb-cloud/monitor-datadog-integration.md @@ -24,7 +24,7 @@ TiDB Cloud has supported Datadog integration (Beta) since March 04, 2022. Starti ## Limitation -- You cannot use the Datadog integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- You cannot use the Datadog integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters. - Datadog integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/monitor-new-relic-integration.md b/tidb-cloud/monitor-new-relic-integration.md index ee40e67faa1b7..273ff52783e4b 100644 --- a/tidb-cloud/monitor-new-relic-integration.md +++ b/tidb-cloud/monitor-new-relic-integration.md @@ -24,7 +24,7 @@ TiDB Cloud has supported New Relic integration (Beta) since April 11, 2023. Star ## Limitation -- You cannot use the New Relic integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- You cannot use the New Relic integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters. - New Relic integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/monitor-prometheus-and-grafana-integration.md b/tidb-cloud/monitor-prometheus-and-grafana-integration.md index cc9ca945eb7fd..9f1643bdbd01e 100644 --- a/tidb-cloud/monitor-prometheus-and-grafana-integration.md +++ b/tidb-cloud/monitor-prometheus-and-grafana-integration.md @@ -17,7 +17,7 @@ This document describes how to configure your Prometheus service to read key met ## Limitation -- You cannot use the Prometheus and Grafana integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- You cannot use the Prometheus and Grafana integration in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) clusters. - Prometheus and Grafana integrations are not available when the cluster status is **CREATING**, **RESTORING**, **PAUSED**, or **RESUMING**. diff --git a/tidb-cloud/notifications.md b/tidb-cloud/notifications.md index 275b3d01b039c..ae729d39d4231 100644 --- a/tidb-cloud/notifications.md +++ b/tidb-cloud/notifications.md @@ -39,11 +39,13 @@ The following table lists the notifications available in TiDB Cloud, along with | --- | --- | --- | | {{{ .starter }}} cluster creation | A [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster is created. | All project members | | {{{ .starter }}} cluster deletion | A {{{ .starter }}} cluster is deleted. | All project members | +| {{{ .essential }}} cluster creation | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster is created. | All project members | +| {{{ .essential }}} cluster deletion | A [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster is deleted. | All project members | | TiDB Cloud Dedicated cluster creation | A [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster is created. | All project members | | TiDB Cloud Dedicated cluster deletion | A TiDB Cloud Dedicated cluster is deleted. | All project members | | Organization Budget threshold alert | The organization [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Project Budget threshold alert | The project [budget threshold](/tidb-cloud/tidb-cloud-budget.md) is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | -| Serverless cluster spending limit threshold alert | The [spending limit threshold](/tidb-cloud/manage-serverless-spend-limit.md) for {{{ .starter }}} clusters in the organization is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | +| Starter cluster spending limit threshold alert | The [spending limit threshold](/tidb-cloud/manage-serverless-spend-limit.md) for {{{ .starter }}} clusters in the organization is reached. | `Organization Owner`, `Organization Billing Manager`, `Organization Billing Viewer`, and `Project Owner` | | Credits update | [Credits](/tidb-cloud/tidb-cloud-billing.md#credits) for the organization are applied, fully used, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Discount update | [Discounts](/tidb-cloud/tidb-cloud-billing.md#discounts) for the organization are applied, reclaimed, or expired. | `Organization Owner`, `Organization Billing Manager`, and `Organization Billing Viewer` | | Marketplace update | The organization has a subscription or unsubscription through a cloud provider marketplace. | All organization members | diff --git a/tidb-cloud/pause-or-resume-tidb-cluster.md b/tidb-cloud/pause-or-resume-tidb-cluster.md index 75c6322b0d46d..f4bc8b2d5787b 100644 --- a/tidb-cloud/pause-or-resume-tidb-cluster.md +++ b/tidb-cloud/pause-or-resume-tidb-cluster.md @@ -13,7 +13,7 @@ Comparing with backup and restore, pausing and resuming a cluster takes less tim > **Note:** > -> You cannot pause a [{{{ .starter }}} cluster](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). +> You cannot pause a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) or [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) cluster. ## Limitations diff --git a/tidb-cloud/release-notes-2022.md b/tidb-cloud/release-notes-2022.md index e279309a37fd2..0b27e5bcf2e65 100644 --- a/tidb-cloud/release-notes-2022.md +++ b/tidb-cloud/release-notes-2022.md @@ -110,7 +110,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c No matter whether you are new to TiDB Cloud or you already have a TiDB Cloud account, now you can link with your AWS or GCP billing account, which makes it easier to complete AWS or GCP Marketplace subscriptions. - For how to make the link, see [Billing from AWS Marketplace or Google Cloud Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-aws-marketplace-azure-marketplace-or-google-cloud-marketplace). + For how to make the link, see [Billing from Cloud Provider Marketplace](/tidb-cloud/tidb-cloud-billing.md#billing-from-cloud-provider-marketplace). ## November 22, 2022 diff --git a/tidb-cloud/release-notes-2023.md b/tidb-cloud/release-notes-2023.md index d4d5d3d75ba62..06183237dd302 100644 --- a/tidb-cloud/release-notes-2023.md +++ b/tidb-cloud/release-notes-2023.md @@ -17,11 +17,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Enhance the connection experience for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). +- Enhance the connection experience for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). - Refine the **Connect** dialog interface to offer {{{ .starter }}} users a smoother and more efficient connection experience. In addition, {{{ .starter }}} introduces more client types and allows you to select the desired branch for connection. + Refine the **Connect** dialog interface to offer TiDB Cloud Serverless users a smoother and more efficient connection experience. In addition, TiDB Cloud Serverless introduces more client types and allows you to select the desired branch for connection. - For more information, see [Connect to {{{ .starter }}}](/tidb-cloud/connect-via-standard-connection-serverless.md). + For more information, see [Connect to TiDB Cloud Serverless](/tidb-cloud/connect-via-standard-connection-serverless.md). ## November 28, 2023 @@ -35,11 +35,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports monitoring SQL statement RU costs. +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports monitoring SQL statement RU costs. - {{{ .starter }}} now provides detailed insights into each SQL statement's [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit). You can view both the **Total RU** and **Mean RU** costs per SQL statement. This feature helps you identify and analyze RU costs, offering opportunities for potential cost savings in your operations. + TiDB Cloud Serverless now provides detailed insights into each SQL statement's [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit). You can view both the **Total RU** and **Mean RU** costs per SQL statement. This feature helps you identify and analyze RU costs, offering opportunities for potential cost savings in your operations. - To check your SQL statement RU details, navigate to the **Diagnosis** page of [your {{{ .starter }}} cluster](https://tidbcloud.com/project/clusters) and then click the **SQL Statement** tab. + To check your SQL statement RU details, navigate to the **Diagnosis** page of [your TiDB Cloud Serverless cluster](https://tidbcloud.com/project/clusters) and then click the **SQL Statement** tab. ## November 21, 2023 @@ -122,9 +122,9 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support using {{{ .starter }}} branches in [Vercel Preview Deployments](https://vercel.com/docs/deployments/preview-deployments), with TiDB Cloud Vercel integration. +- Support using TiDB Cloud Serverless branches in [Vercel Preview Deployments](https://vercel.com/docs/deployments/preview-deployments), with TiDB Cloud Vercel integration. - For more information, see [Connect with {{{ .starter }}} branching](/tidb-cloud/integrate-tidbcloud-with-vercel.md#connect-with-branching). + For more information, see [Connect with TiDB Cloud Serverless branching](/tidb-cloud/integrate-tidbcloud-with-vercel.md#connect-with-branching). ## September 28, 2023 @@ -144,13 +144,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Release [TiDB Cloud serverless driver (beta)](/tidb-cloud/serverless-driver.md) for JavaScript. - TiDB Cloud serverless driver for JavaScript allows you to connect to your [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster over HTTPS. It is particularly useful in edge environments where TCP connections are limited, such as [Vercel Edge Function](https://vercel.com/docs/functions/edge-functions) and [Cloudflare Workers](https://workers.cloudflare.com/). + TiDB Cloud serverless driver for JavaScript allows you to connect to your [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster over HTTPS. It is particularly useful in edge environments where TCP connections are limited, such as [Vercel Edge Function](https://vercel.com/docs/functions/edge-functions) and [Cloudflare Workers](https://workers.cloudflare.com/). For more information, see [TiDB Cloud serverless driver (beta)](/tidb-cloud/serverless-driver.md). **Console changes** -- For [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, you can get an estimation of cost in the **Usage This Month** panel or while setting up the spending limit. +- For [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, you can get an estimation of cost in the **Usage This Month** panel or while setting up the spending limit. ## September 5, 2023 @@ -170,7 +170,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Introduce the **Events** page for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, which provides the records of main changes to your cluster. +- Introduce the **Events** page for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, which provides the records of main changes to your cluster. On this page, you can view the event history for the last 7 days and track important details such as the trigger time and the user who initiated an action. @@ -337,7 +337,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Optimize the Import feature in TiDB Cloud, aimed at enhancing the data import experience. The following improvements have been made: - - Unified Import entry for {{{ .starter }}}: consolidate the entries for importing data, allowing you to seamlessly switch between importing local files and importing files from Amazon S3. + - Unified Import entry for TiDB Cloud Serverless: consolidate the entries for importing data, allowing you to seamlessly switch between importing local files and importing files from Amazon S3. - Streamlined configuration: importing data from Amazon S3 now only requires a single step, saving time and effort. - Enhanced CSV configuration: the CSV configuration settings are now located under the file type option, making it easier for you to quickly configure the necessary parameters. - Enhanced target table selection: support choosing the desired target tables for data import by clicking checkboxes. This improvement eliminates the need for complex expressions and simplifies the target table selection. @@ -348,7 +348,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now is Generally Available. +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now is Generally Available. - Introduce TiDB Bot (beta), an OpenAI-powered chatbot that offers multi-language support, 24/7 real-time response, and integrated documentation access. @@ -360,13 +360,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c To use TiDB Bot, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com), and select **Ask TiDB Bot** to start a chat. -- Support [the branching feature (beta)](/tidb-cloud/branch-overview.md) for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Support [the branching feature (beta)](/tidb-cloud/branch-overview.md) for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. - TiDB Cloud lets you create branches for {{{ .starter }}} clusters. A branch for a cluster is a separate instance that contains a diverged copy of data from the original cluster. It provides an isolated environment, allowing you to connect to it and experiment freely without worrying about affecting the original cluster. + TiDB Cloud lets you create branches for TiDB Cloud Serverless clusters. A branch for a cluster is a separate instance that contains a diverged copy of data from the original cluster. It provides an isolated environment, allowing you to connect to it and experiment freely without worrying about affecting the original cluster. - You can create branches for {{{ .starter }}} clusters created after July 5, 2023 by using either [TiDB Cloud console](/tidb-cloud/branch-manage.md) or [TiDB Cloud CLI](/tidb-cloud/ticloud-branch-create.md). + You can create branches for TiDB Cloud Serverless clusters created after July 5, 2023 by using either [TiDB Cloud console](/tidb-cloud/branch-manage.md) or [TiDB Cloud CLI](/tidb-cloud/ticloud-branch-create.md). - If you use GitHub for application development, you can integrate {{{ .starter }}} branching into your GitHub CI/CD pipeline, which lets you automatically test your pull requests with branches without affecting the production database. For more information, see [Integrate {{{ .starter }}} Branching (Beta) with GitHub](/tidb-cloud/branch-github-integration.md). + If you use GitHub for application development, you can integrate TiDB Cloud Serverless branching into your GitHub CI/CD pipeline, which lets you automatically test your pull requests with branches without affecting the production database. For more information, see [Integrate TiDB Cloud Serverless Branching (Beta) with GitHub](/tidb-cloud/branch-github-integration.md). - Support weekly backup for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. For more information, see [Back up and restore TiDB Cloud Dedicated data](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup). @@ -374,15 +374,15 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Support point-in-time recovery (PITR) (beta) for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Support point-in-time recovery (PITR) (beta) for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. - You can now restore your {{{ .starter }}} cluster to any point in time within the last 90 days. This feature enhances the data recovery capability of {{{ .starter }}} clusters. For example, you can use PITR when data write errors occur and you want to restore the data to an earlier state. + You can now restore your TiDB Cloud Serverless cluster to any point in time within the last 90 days. This feature enhances the data recovery capability of TiDB Cloud Serverless clusters. For example, you can use PITR when data write errors occur and you want to restore the data to an earlier state. - For more information, see [Back up and restore {{{ .starter }}} data](/tidb-cloud/backup-and-restore-serverless.md#restore). + For more information, see [Back up and restore TiDB Cloud Serverless data](/tidb-cloud/backup-and-restore-serverless.md#restore). **Console changes** -- Enhance the **Usage This Month** panel on the cluster overview page for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters to provide a clearer view of your current resource usage. +- Enhance the **Usage This Month** panel on the cluster overview page for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters to provide a clearer view of your current resource usage. - Enhance the overall navigation experience by making the following changes: @@ -396,7 +396,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Remove the pre-built sample dataset for newly created [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Remove the pre-built sample dataset for newly created [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. ## June 20, 2023 @@ -420,7 +420,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Size your cluster](/tidb-cloud/size-your-cluster.md). -- Extend the [monitoring metrics retention period](/tidb-cloud/built-in-monitoring.md#metrics-retention-policy) for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from 3 days to 7 days. +- Extend the [monitoring metrics retention period](/tidb-cloud/built-in-monitoring.md#metrics-retention-policy) for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from 3 days to 7 days. By extending the metrics retention period, now you have access to more historical data. This helps you identify trends and patterns of the cluster for better decision-making and faster troubleshooting. @@ -480,7 +480,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - In our pursuit to simplify and clarify, we have updated the names of our products: - - "{{{ .starter }}} Tier" is now called "{{{ .starter }}}". + - "TiDB Cloud Serverless Tier" is now called "TiDB Cloud Serverless". - "TiDB Cloud Dedicated Tier" is now called "TiDB Cloud Dedicated". - "TiDB On-Premises" is now called "TiDB Self-Managed". @@ -586,7 +586,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c You can easily [monitor your cluster usage or increase your usage quota](/tidb-cloud/manage-serverless-spend-limit.md) in the **Usage This Month** area of your cluster **Overview** page. Once the free quota of a cluster is reached, the read and write operations on this cluster will be throttled until you increase the quota or the usage is reset upon the start of a new month. - For more information about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [{{{ .starter }}} Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). + For more information about the RU consumption of different resources (including read, write, SQL CPU, and network egress), the pricing details, and the throttled information, see [TiDB Cloud Serverless Tier Pricing Details](https://www.pingcap.com/tidb-cloud-serverless-pricing-details). - Support backup and restore for TiDB Cloud [Serverless Tier](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. diff --git a/tidb-cloud/release-notes-2024.md b/tidb-cloud/release-notes-2024.md index 57b049074c22b..624338f2cb62c 100644 --- a/tidb-cloud/release-notes-2024.md +++ b/tidb-cloud/release-notes-2024.md @@ -11,11 +11,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- {{{ .starter }}} backup and restore changes +- TiDB Cloud Serverless backup and restore changes - Support restoring data to a new cluster, providing greater flexibility and ensuring your current cluster's operations remain uninterrupted. - - Refine backup and restore strategies to align with your cluster plan. For more information, see [Back Up and Restore {{{ .starter }}} Data](/tidb-cloud/backup-and-restore-serverless.md#learn-about-the-backup-setting). + - Refine backup and restore strategies to align with your cluster plan. For more information, see [Back Up and Restore TiDB Cloud Serverless Data](/tidb-cloud/backup-and-restore-serverless.md#learn-about-the-backup-setting). - Apply the following compatibility policy to help you transition smoothly: @@ -38,7 +38,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Upgrade the default TiDB version of new [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters from [v7.5.4](https://docs.pingcap.com/tidb/v7.5/release-7.5.4) to [v8.1.1](https://docs.pingcap.com/tidb/stable/release-8.1.1). -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) reduces costs for large data writes by up to 80% for the following scenarios: +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) reduces costs for large data writes by up to 80% for the following scenarios: - When you perform write operations larger than 16 MiB in [autocommit mode](/transaction-overview.md#autocommit). - When you perform write operations larger than 16 MiB in [optimistic transaction model](/optimistic-transaction.md). @@ -50,7 +50,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- [{{{ .starter }}} branching (beta)](/tidb-cloud/branch-overview.md) introduces the following improvements to branch management: +- [TiDB Cloud Serverless branching (beta)](/tidb-cloud/branch-overview.md) introduces the following improvements to branch management: - **Flexible branch creation**: When creating a branch, you can select a specific cluster or branch as the parent and specify a precise point in time to use from the parent. This gives you precise control over the data in your branch. @@ -58,7 +58,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - **Improved GitHub integration**: The [TiDB Cloud Branching](https://github.com/apps/tidb-cloud-branching) GitHub App introduces the [`branch.mode`](/tidb-cloud/branch-github-integration.md#branchmode) parameter, which controls the behavior during pull request synchronization. In the default mode `reset`, the app resets the branch to match the latest changes in the pull request. - For more information, see [Manage {{{ .starter }}} Branches](/tidb-cloud/branch-manage.md) and [Integrate {{{ .starter }}} Branching (Beta) with GitHub](/tidb-cloud/branch-github-integration.md). + For more information, see [Manage TiDB Cloud Serverless Branches](/tidb-cloud/branch-manage.md) and [Integrate TiDB Cloud Serverless Branching (Beta) with GitHub](/tidb-cloud/branch-github-integration.md). ## November 12, 2024 @@ -110,8 +110,8 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c TiDB Cloud CLI provides the following new features: - - Support SQL user management for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters via [`ticloud serverless sql-user`](/tidb-cloud/ticloud-serverless-sql-user-create.md). - - Allow disabling the public endpoint for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters in [`ticloud serverless create`](/tidb-cloud/ticloud-cluster-create.md) and [`ticloud serverless update`](/tidb-cloud/ticloud-serverless-update.md). + - Support SQL user management for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters via [`ticloud serverless sql-user`](/tidb-cloud/ticloud-serverless-sql-user-create.md). + - Allow disabling the public endpoint for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters in [`ticloud serverless create`](/tidb-cloud/ticloud-cluster-create.md) and [`ticloud serverless update`](/tidb-cloud/ticloud-serverless-update.md). - Add the [`ticloud auth whoami`](/tidb-cloud/ticloud-auth-whoami.md) command to get information about the current user when using OAuth authentication. - Support `--sql`, `--where`, and `--filter` flags in [`ticloud serverless export create`](/tidb-cloud/ticloud-serverless-export-create.md) to choose source tables flexibly. - Support exporting data to CSV and Parquet files. @@ -144,11 +144,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Support exporting data from {{{ .starter }}} clusters using the [TiDB Cloud console](https://tidbcloud.com/). +- Support exporting data from TiDB Cloud Serverless clusters using the [TiDB Cloud console](https://tidbcloud.com/). - Previously, TiDB Cloud only supported exporting data using the [TiDB Cloud CLI](/tidb-cloud/cli-reference.md). Now, you can easily export data from {{{ .starter }}} clusters to local files and Amazon S3 in the [TiDB Cloud console](https://tidbcloud.com/). + Previously, TiDB Cloud only supported exporting data using the [TiDB Cloud CLI](/tidb-cloud/cli-reference.md). Now, you can easily export data from TiDB Cloud Serverless clusters to local files and Amazon S3 in the [TiDB Cloud console](https://tidbcloud.com/). - For more information, see [Export Data from {{{ .starter }}}](/tidb-cloud/serverless-export.md) and [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md). + For more information, see [Export Data from TiDB Cloud Serverless](/tidb-cloud/serverless-export.md) and [Configure External Storage Access for TiDB Cloud Serverless](/tidb-cloud/serverless-external-storage.md). - Enhance the connection experience for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. @@ -158,10 +158,10 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Connect to TiDB Cloud Dedicated](/tidb-cloud/connect-to-tidb-cluster.md). -- Enhance the data import experience for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters: +- Enhance the data import experience for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters: - Refine the layout of the **Import** page with a clearer layout. - - Unify the import steps for {{{ .starter }}} and TiDB Cloud Dedicated clusters. + - Unify the import steps for TiDB Cloud Serverless and TiDB Cloud Dedicated clusters. - Simplify the AWS Role ARN creation process for easier connection setup. For more information, see [Import data from files to TiDB Cloud](/tidb-cloud/tidb-cloud-migration-overview.md#import-data-from-files-to-tidb-cloud). @@ -240,7 +240,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports vector search (beta). +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports vector search (beta). The vector search (beta) feature provides an advanced search solution for performing semantic similarity searches across various data types, including documents, images, audio, and video. This feature enables developers to easily build scalable applications with generative artificial intelligence (AI) capabilities using familiar MySQL skills. Key features include: @@ -251,7 +251,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Vector search (beta) overview](/vector-search/vector-search-overview.md). -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now offers weekly email reports for organization owners. +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now offers weekly email reports for organization owners. These reports provide insights into the performance and activity of your clusters. By receiving automatic weekly updates, you can stay informed about your clusters and make data-driven decisions to optimize your clusters. @@ -294,13 +294,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Get started with recovery groups](/tidb-cloud/recovery-group-get-started.md). -- Introduce billing and metering (beta) for the [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) columnar storage [TiFlash](/tiflash/tiflash-overview.md). +- Introduce billing and metering (beta) for the [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) columnar storage [TiFlash](/tiflash/tiflash-overview.md). - Until June 30, 2024, columnar storage in {{{ .starter }}} clusters remains free with a 100% discount. After this date, each {{{ .starter }}} cluster will include a free quota of 5 GiB for columnar storage. Usage beyond the free quota will be charged. + Until June 30, 2024, columnar storage in TiDB Cloud Serverless clusters remains free with a 100% discount. After this date, each TiDB Cloud Serverless cluster will include a free quota of 5 GiB for columnar storage. Usage beyond the free quota will be charged. - For more information, see [{{{ .starter }}} pricing details](https://www.pingcap.com/tidb-serverless-pricing-details/#storage). + For more information, see [TiDB Cloud Serverless pricing details](https://www.pingcap.com/tidb-serverless-pricing-details/#storage). -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports [Time to live (TTL)](/time-to-live.md). +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) supports [Time to live (TTL)](/time-to-live.md). ## May 28, 2024 @@ -352,8 +352,8 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Introduce [TiDB Cloud CLI 1.0.0-beta.1](https://github.com/tidbcloud/tidbcloud-cli), built upon the new [TiDB Cloud API](/tidb-cloud/api-overview.md). The new CLI brings the following new features: - - [Export data from {{{ .starter }}} clusters](/tidb-cloud/serverless-export.md) - - [Import data from local storage into {{{ .starter }}} clusters](/tidb-cloud/ticloud-import-start.md) + - [Export data from TiDB Cloud Serverless clusters](/tidb-cloud/serverless-export.md) + - [Import data from local storage into TiDB Cloud Serverless clusters](/tidb-cloud/ticloud-import-start.md) - [Authenticate via OAuth](/tidb-cloud/ticloud-auth-login.md) - [Ask questions via TiDB Bot](/tidb-cloud/ticloud-ai.md) @@ -369,13 +369,13 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Introduce two service plans for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters: **Free** and **Scalable**. +- Introduce two service plans for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters: **Free** and **Scalable**. - To meet different user requirements, {{{ .starter }}} offers the free and scalable service plans. Whether you are just getting started or scaling to meet the increasing application demands, these plans provide the flexibility and capabilities you need. + To meet different user requirements, TiDB Cloud Serverless offers the free and scalable service plans. Whether you are just getting started or scaling to meet the increasing application demands, these plans provide the flexibility and capabilities you need. - For more information, see [Cluster plans](/tidb-cloud/select-cluster-tier.md#cluster-plans). + For more information, see [Cluster plans](/tidb-cloud/select-cluster-tier.md). -- Modify the throttling behavior for {{{ .starter }}} clusters upon reaching their usage quota. Now, once a cluster reaches its usage quota, it immediately denies any new connection attempts, thereby ensuring uninterrupted service for existing operations. +- Modify the throttling behavior for TiDB Cloud Serverless clusters upon reaching their usage quota. Now, once a cluster reaches its usage quota, it immediately denies any new connection attempts, thereby ensuring uninterrupted service for existing operations. For more information, see [Usage quota](/tidb-cloud/serverless-limitations.md#usage-quota). @@ -405,7 +405,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Upgrade the TiDB version of [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from [v6.6.0](https://docs.pingcap.com/tidb/v6.6/release-6.6.0) to [v7.1.3](https://docs.pingcap.com/tidb/v7.1/release-7.1.3). +- Upgrade the TiDB version of [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from [v6.6.0](https://docs.pingcap.com/tidb/v6.6/release-6.6.0) to [v7.1.3](https://docs.pingcap.com/tidb/v7.1/release-7.1.3). ## February 20, 2024 @@ -442,7 +442,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Set a CIDR for a region](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-cidr-for-a-region). -- {{{ .starter }}} users now have the capability to disable public endpoints for your clusters. +- TiDB Cloud Serverless users now have the capability to disable public endpoints for your clusters. For more information, see [Disable a Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md#disable-a-public-endpoint). diff --git a/tidb-cloud/scalability-concepts.md b/tidb-cloud/scalability-concepts.md index f7a24435fb1fa..a497aea1b8682 100644 --- a/tidb-cloud/scalability-concepts.md +++ b/tidb-cloud/scalability-concepts.md @@ -5,11 +5,11 @@ summary: Learn about scalability concepts for TiDB Cloud. # Scalability -TiDB Cloud Dedicated lets you adjust its compute and storage resources separately to match your data volume or workload changes. TiDB Cloud Dedicated can do scaling without any service disruption. This flexibility allows organizations to optimize their infrastructure costs while maintaining high performance and availability. +TiDB Cloud offers multiple deployment options with flexible scalability to meet the needs of different workloads. -> **Note:** -> -> [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) scales automatically based on your application's workload changes. However, you cannot manually scale a {{{ .starter }}} cluster. +- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) is ideal for prototyping, development, and early-stage workloads. It provides a simplified, cost-effective way to get started with TiDB Cloud, with automatic scaling built in. +- [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) is built for production workloads that require more robust scalability and predictable performance under growing traffic or data volume. +- TiDB Cloud Dedicated lets you adjust its compute and storage resources separately to match your data volume or workload changes. TiDB Cloud Dedicated can do scaling without any service disruption. This flexibility allows organizations to optimize their infrastructure costs while maintaining high performance and availability. > **Tip:** > diff --git a/tidb-cloud/scale-tidb-cluster.md b/tidb-cloud/scale-tidb-cluster.md index 623f7805cbd44..10fbbcf2172ac 100644 --- a/tidb-cloud/scale-tidb-cluster.md +++ b/tidb-cloud/scale-tidb-cluster.md @@ -7,7 +7,7 @@ summary: Learn how to scale your TiDB Cloud cluster. > **Note:** > -> - [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) scales automatically based on your application's workload changes. However, you cannot manually scale a {{{ .starter }}} cluster. +> - [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) and [{{{ .essential }}}](/tidb-cloud/select-cluster-tier.md#essential) scale automatically based on your application's workload changes. However, you cannot manually scale a {{{ .starter }}} or {{{ .essential }}} cluster. > - When a cluster is in the **MODIFYING** status, you cannot perform any new scaling operations on it. You can scale a TiDB cluster in the following dimensions: diff --git a/tidb-cloud/secure-connections-to-serverless-clusters.md b/tidb-cloud/secure-connections-to-serverless-clusters.md index 1a309b4ee01c5..d5ff993cd32ac 100644 --- a/tidb-cloud/secure-connections-to-serverless-clusters.md +++ b/tidb-cloud/secure-connections-to-serverless-clusters.md @@ -1,21 +1,25 @@ --- -title: TLS Connections to {{{ .starter }}} -summary: Introduce TLS connections in {{{ .starter }}}. +title: TLS Connections to {{{ .starter }}} or Essential +summary: Introduce TLS connections in {{{ .starter }}} and {{{ .essential }}}. aliases: ['/tidbcloud/secure-connections-to-serverless-tier-clusters'] --- -# TLS Connections to {{{ .starter }}} +# TLS Connections to {{{ .starter }}} or Essential -Establishing a secure TLS connection between your client and your {{{ .starter }}} cluster is one of the basic security practices for connecting to your databases. The server certificate for {{{ .starter }}} is issued by an independent third-party certificate provider. You can easily connect to your {{{ .starter }}} cluster without downloading a server-side digital certificate. +Establishing a secure TLS connection between your client and your {{{ .starter }}} or {{{ .essential }}} cluster is one of the basic security practices for connecting to your databases. The server certificate for TiDB Cloud is issued by an independent third-party certificate provider. You can easily connect to your TiDB Cloud cluster without downloading a server-side digital certificate. + +> **Note:** +> +> To learn how to establish TLS connections to TiDB Cloud Dedicated clusters, see [TLS Connections to TiDB Cloud Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md). ## Prerequisites - Log in to TiDB Cloud via [Password Authentication](/tidb-cloud/tidb-cloud-password-authentication.md) or [SSO Authentication](/tidb-cloud/tidb-cloud-sso-authentication.md). -- [Create a {{{ .starter }}} cluster](/tidb-cloud/tidb-cloud-quickstart.md). +- [Create a TiDB Cloud cluster](/tidb-cloud/tidb-cloud-quickstart.md). -## TLS connection to a {{{ .starter }}} cluster +## TLS connection to a TiDB Cloud cluster -In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your {{{ .starter }}} cluster as follows: +In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of different connection methods and connect to your TiDB Cloud cluster as follows: 1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page of your project, and then click the name of your cluster to go to its overview page. @@ -23,27 +27,27 @@ In the [TiDB Cloud console](https://tidbcloud.com/), you can get examples of dif 3. In the dialog, keep the default setting of the connection type as `Public`, and select your preferred connection method and operating system. -4. If you have not set a password yet, click **Generate Password** to generate a random password for your {{{ .starter }}} cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily. +4. If you have not set a password yet, click **Generate Password** to generate a random password for your cluster. The password will be automatically embedded in the sample connection string for connecting to your cluster easily. > **Note:** > > - The random password consists of 16 characters, including uppercase and lowercase letters, numbers, and special characters. > - After you close this dialog, the generated password will not show again, so you need to save the password in a secure location. If you forget it, you can click **Reset Password** in this dialog to reset it. - > - The {{{ .starter }}} cluster can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. + > - The TiDB Cloud cluster can be accessed through the internet. If you need to use the password elsewhere, it is recommended that you reset it to ensure database security. 5. Connect to your cluster with the connection string. > **Note:** > - > When you connect to a {{{ .starter }}} cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). + > When you connect to a TiDB Cloud cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see [User name prefix](/tidb-cloud/select-cluster-tier.md#user-name-prefix). ## Root certificate management ### Root certificate issuance and validity -{{{ .starter }}} uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and {{{ .starter }}} clusters. Once the {{{ .starter }}} certificate expires, it will be automatically rotated without affecting the normal operations of your cluster and the established TLS secure connection. +TiDB Cloud uses certificates from [Let's Encrypt](https://letsencrypt.org/) as a Certificate Authority (CA) for TLS connection between clients and TiDB Cloud clusters. Once the TiDB Cloud certificate expires, it will be automatically rotated without affecting the normal operations of your cluster and the established TLS secure connection. -If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to {{{ .starter }}} clusters without specifying the path of CA roots. However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a {{{ .starter }}} cluster in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. +If the client uses the system's root CA stores by default, such as Java and Go, you can easily connect securely to TiDB Cloud clusters without specifying the path of CA roots. However, some drivers and ORMs do not use the system root CA stores. In those cases, you need to configure the CA root path of the drivers or ORMs to your system root CA stores. For example, when you use [mysqlclient](https://github.com/PyMySQL/mysqlclient) to connect a TiDB Cloud cluster in Python on macOS, you need to set `ca: /etc/ssl/cert.pem` in the `ssl` argument. If you are using a GUI client, such as DBeaver, which does not accept a certificate file with multiple certificates inside, you must download the [ISRG Root X1](https://letsencrypt.org/certs/isrgrootx1.pem) certificate. @@ -86,22 +90,22 @@ In different operating systems, the default storage paths of the root certificat Windows does not offer a specific path to the CA root. Instead, it uses the [registry](https://learn.microsoft.com/en-us/windows-hardware/drivers/install/local-machine-and-current-user-certificate-stores) to store certificates. For this reason, to specify the CA root path on Windows, take the following steps: 1. Download the [ISRG Root X1 certificate](https://letsencrypt.org/certs/isrgrootx1.pem) and then save it in a path you prefer, such as ``. -2. Use the path (``) as your CA root path when you connect to a {{{ .starter }}} cluster. +2. Use the path (``) as your CA root path when you connect to a TiDB Cloud cluster. ## FAQs -### Which TLS versions are supported to connect to my {{{ .starter }}} cluster? +### Which TLS versions are supported to connect to my TiDB Cloud cluster? -For security reasons, {{{ .starter }}} only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. +For security reasons, TiDB Cloud only supports TLS 1.2 and TLS 1.3, and does not support TLS 1.0 and TLS 1.1 versions. See IETF [Deprecating TLS 1.0 and TLS 1.1](https://datatracker.ietf.org/doc/rfc8996/) for details. -### Is two-way TLS authentication between my connection client and {{{ .starter }}} supported? +### Is two-way TLS authentication between my connection client and TiDB Cloud supported? No. -{{{ .starter }}} only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your TiDB Cloud cluster certificate's private key while the cluster does not validate the client. +TiDB Cloud only supports one-way TLS authentication, which means your client uses the public key to verify the signature of your TiDB Cloud cluster certificate's private key while the cluster does not validate the client. -### Does {{{ .starter }}} have to configure TLS to establish a secure connection? +### Does TiDB Cloud have to configure TLS to establish a secure connection? -For standard connection, {{{ .starter }}} only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the {{{ .starter }}} cluster through the internet. +For standard connection, TiDB Cloud only allows TLS connections and prohibits non-SSL/TLS connections. The reason is that SSL/TLS is one of the most basic security measures for you to reduce the risk of data exposure to the internet when you connect to the TiDB Cloud cluster through the internet. For private endpoint connection, because it supports highly secure and one-way access to the TiDB Cloud service and does not expose your data to the public internet, configuring TLS is optional. diff --git a/tidb-cloud/security-concepts.md b/tidb-cloud/security-concepts.md index eead4fde7f24d..68b636ad04861 100644 --- a/tidb-cloud/security-concepts.md +++ b/tidb-cloud/security-concepts.md @@ -166,7 +166,7 @@ TiDB Cloud ensures secure cluster connectivity and data transmission through rob - Enables secure connectivity for SQL clients within your Virtual Private Cloud (VPC) to TiDB Cloud Dedicated clusters. -- Supported by [AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md), [Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md), and [Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md). +- Supported by [AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md), [Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md), [Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md), and [Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md). **Best practices:** Use private endpoints in production to minimize public exposure and review configurations regularly. @@ -174,7 +174,10 @@ TiDB Cloud ensures secure cluster connectivity and data transmission through rob - Encrypts communication between clients and servers to secure data transmission. -- Setup guides available for both [Serverless](/tidb-cloud/secure-connections-to-serverless-clusters.md) and [Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md) clusters. +- Setup guides: + + - [TLS Connections to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md) + - [TLS Connections to TiDB Cloud Dedicated](/tidb-cloud/tidb-cloud-tls-connect-to-dedicated.md) **Best practices:** Ensure TLS certificates are current and rotate them periodically. @@ -204,7 +207,7 @@ TiDB Cloud safeguards static data with advanced encryption capabilities, ensurin - Encrypts static data and backups with CMEK keys when enabled. -- For TiDB Cloud Dedicated clusters without CMEK, TiDB Cloud uses escrow keys; {{{ .starter }}} clusters rely exclusively on escrow keys. +- For TiDB Cloud Dedicated clusters without CMEK, TiDB Cloud uses escrow keys; {{{ .starter }}} and {{{ .essential }}} clusters rely exclusively on escrow keys. **Best practices:** diff --git a/tidb-cloud/select-cluster-tier.md b/tidb-cloud/select-cluster-tier.md index 9cd7eaeee5029..dc265425714b9 100644 --- a/tidb-cloud/select-cluster-tier.md +++ b/tidb-cloud/select-cluster-tier.md @@ -1,47 +1,36 @@ --- -title: Select Your Cluster Tier -summary: Learn how to select your cluster tier on TiDB Cloud. +title: Select Your Cluster Plan +summary: Learn how to select your cluster plan on TiDB Cloud. aliases: ['/tidbcloud/developer-tier-cluster'] --- -# Select Your Cluster Tier +# Select Your Cluster Plan -The cluster tier determines the throughput and performance of your cluster. +The cluster plan determines the throughput and performance of your cluster. -TiDB Cloud provides the following two options of cluster tiers. Before creating a cluster, you need to consider which option suits your need better. +TiDB Cloud provides the following options of cluster plans. Whether you are just getting started or scaling to meet the increasing application demands, these service plans provide the flexibility and capability you need. Before creating a cluster, you need to consider which option suits your need better. -- [TiDB Cloud Serverless](#tidb-cloud-serverless) +- [TiDB Cloud Serverless](#tidb-cloud-serverless) (now Starter) +- [{{{ .essential }}}](#essential) - [TiDB Cloud Dedicated](#tidb-cloud-dedicated) -## TiDB Cloud Serverless - - -TiDB Cloud Serverless is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free tier and consumption based billing once free limits are exceeded. - -### Cluster plans +> **Note:** +> +> Some of TiDB Cloud features are partially supported or not supported on {{{ .starter }}} and {{{ .essential }}}. See [{{{ .starter }}} and Essential Limitations](/tidb-cloud/serverless-limitations.md) for details. -{{{ .starter }}} offers two service plans to meet different user requirements. Whether you are just getting started or scaling to meet the increasing application demands, these service plans provide the flexibility and capability you need. +## TiDB Cloud Serverless -#### Free cluster plan +TiDB Cloud Serverless (now 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. The free cluster plan is ideal for those who are getting started with {{{ .starter }}}. It provides developers and small teams with the following essential features: - **No cost**: This plan is completely free, with no credit card required to get started. - **Storage**: Provides an initial 5 GiB of row-based storage and 5 GiB of columnar storage. - **Request Units**: Includes 50 million [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit) for database operations. -- **Easy upgrade**: Offers a smooth transition to the [scalable cluster plan](#scalable-cluster-plan) as your needs grow. - -#### Scalable cluster plan - -For applications experiencing growing workloads and needing scalability in real time, the scalable cluster plan provides the flexibility and performance to keep pace with your business growth with the following features: - -- **Enhanced capabilities**: Includes all capabilities of the free cluster plan, along with the capacity to handle larger and more complex workloads, as well as advanced security features. -- **Automatic scaling**: Automatically adjusts storage and computing resources to efficiently meet changing workload demands. -- **Predictable pricing**: Although this plan requires a credit card, you are only charged for the resources you use, ensuring cost-effective scalability. ### Usage quota -For each organization in TiDB Cloud, you can create a maximum of five [free clusters](#free-cluster-plan) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and create [scalable clusters](#scalable-cluster-plan) for the usage. +For each organization in TiDB Cloud, you can create a maximum of five free {{{ .starter }}} clusters by default. To create more {{{ .starter }}} clusters, you need to add a credit card and specify a spending limit. For the first five {{{ .starter }}} clusters in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: @@ -55,11 +44,20 @@ Once a cluster reaches its usage quota, it immediately denies any new connection 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-serverless-pricing-details). -### User name prefix +## {{{ .essential }}} {#essential} + +For applications experiencing growing workloads and needing scalability in real time, the Essential cluster plan provides the flexibility and performance to keep pace with your business growth with the following features: + +- **Enhanced capabilities**: includes all capabilities of the Starter plan, along with the capacity to handle larger and more complex workloads, as well as advanced security features. +- **Automatic scaling**: automatically adjusts storage and computing resources to efficiently meet changing workload demands. +- **High availability**: built-in fault tolerance and redundancy ensure your applications remain available and resilient, even during infrastructure failures. +- **Predictable pricing**: billed based on storage and Request Capacity Units (RCUs) of the compute resources, offering transparent, usage-based pricing that scales with your needs, so you only pay for what you use without surprises. + +## User name prefix -For each {{{ .starter }}} cluster, TiDB Cloud generates a unique prefix to distinguish it from other clusters. +For each {{{ .starter }}} or {{{ .essential }}} cluster, TiDB Cloud generates a unique prefix to distinguish it from other clusters. Whenever you use or set a database user name, you must include the prefix in the user name. For example, assume that the prefix of your cluster is `3pTAoNNegb47Uc8`. @@ -71,7 +69,7 @@ Whenever you use or set a database user name, you must include the prefix in the > **Note:** > - > {{{ .starter }}} requires TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-clusters.md#root-certificate-default-path). + > {{{ .starter }}} and {{{ .essential }}} require TLS connection. To find the CA root path on your system, see [Root certificate default path](/tidb-cloud/secure-connections-to-serverless-clusters.md#root-certificate-default-path). - To create a database user: @@ -85,10 +83,6 @@ To get the prefix for your cluster, take the following steps: 2. Click the name of your target cluster to go to its overview page, and then click **Connect** in the upper-right corner. A connection dialog is displayed. 3. In the dialog, get the prefix from the connection string. -### {{{ .starter }}} special terms and conditions - -Some of TiDB Cloud features are partially supported or not supported on {{{ .starter }}}. See [{{{ .starter }}} Limitations](/tidb-cloud/serverless-limitations.md) for details. - ## TiDB Cloud Dedicated TiDB Cloud Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). diff --git a/tidb-cloud/serverless-audit-logging.md b/tidb-cloud/serverless-audit-logging.md index a7d67155301de..5fb94cf7dabaf 100644 --- a/tidb-cloud/serverless-audit-logging.md +++ b/tidb-cloud/serverless-audit-logging.md @@ -1,15 +1,15 @@ --- -title: {{{ .starter }}} Database Audit Logging -summary: Learn about how to audit a {{{ .starter }}} cluster in TiDB Cloud. +title: Database Audit Logging for {{{ .starter }}} and Essential +summary: Learn about how to audit a {{{ .starter }}} or {{{ .essential }}} cluster in TiDB Cloud. --- -# {{{ .starter }}} Database Audit Logging (Beta) +# Database Audit Logging (Beta) for {{{ .starter }}} and Essential -{{{ .starter }}} provides you with a database audit logging feature to record a history of user access details (such as any SQL statements executed) in logs. +{{{ .starter }}} and {{{ .essential }}} provide you with a database audit logging feature to record a history of user access details (such as any SQL statements executed) in logs. > **Note:** > -> Currently, the database audit logging feature is only available upon request. To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com) and click **Request Support**. Then, fill in "Apply for {{{ .starter }}} database audit logging" in the **Description** field and click **Submit**. +> Currently, the database audit logging feature is only available upon request. To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com) and click **Request Support**. Then, fill in "Apply for {{{ .starter }}} or {{{ .essential }}} database audit logging" in the **Description** field and click **Submit**. To assess the effectiveness of user access policies and other information security measures of your organization, it is a security best practice to conduct a periodic analysis of the database audit logs. @@ -17,13 +17,13 @@ The audit logging feature is disabled by default. To audit a cluster, you need t ## Enable audit logging -To enable audit logging for a {{{ .starter }}} cluster, use the [TiDB Cloud CLI](/tidb-cloud/ticloud-auditlog-config.md). +To enable audit logging for a {{{ .starter }}} or {{{ .essential }}} cluster, use the [TiDB Cloud CLI](/tidb-cloud/ticloud-auditlog-config.md). ```shell ticloud serverless audit-log config -c --enabled ``` -To disable audit logging for a {{{ .starter }}} cluster, use the [TiDB Cloud CLI](/tidb-cloud/ticloud-auditlog-config.md). +To disable audit logging for a {{{ .starter }}} or {{{ .essential }}} cluster, use the [TiDB Cloud CLI](/tidb-cloud/ticloud-auditlog-config.md). ```shell ticloud serverless audit-log config -c --enabled=false @@ -110,7 +110,7 @@ ticloud serverless audit-log filter delete --cluster-id --name --unredacted ### Log file rotation -{{{ .starter }}} generates a new audit log file when either of the following conditions is met: +{{{ .starter }}} and {{{ .essential }}} generate a new audit log file when either of the following conditions is met: - The size of the current log file reaches 100 MiB. - One hour has passed since the previous log generation. Depending on the internal scheduling mechanism, log generation might be delayed by a few minutes. > **Note:** > -> Currently, Log file rotation settings are not configurable. {{{ .starter }}} automatically rotates the audit log files based on the preceding conditions. +> Currently, Log file rotation settings are not configurable. {{{ .starter }}} and {{{ .essential }}} automatically rotate the audit log files based on the preceding conditions. ## Access audit logging -{{{ .starter }}} audit logs are stored as readable text files named `YYYY-MM-DD-.log`. +{{{ .starter }}} and {{{ .essential }}} audit logs are stored as readable text files named `YYYY-MM-DD-.log`. Currently, audit logs are stored within TiDB Cloud for 365 days. After this period, logs are automatically deleted. > **Note:** > -> Contact [TiDB Cloud Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support) if you need to save audit logs in external storage (such as AWS S3, Azure Blob Storage, and Google Cloud Storage). +> Contact [TiDB Cloud Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support) if you need to save audit logs in external storage (such as Amazon S3, Azure Blob Storage, Google Cloud Storage, and Alibaba Cloud OSS). To view and download audit logs, use the [TiDB Cloud CLI](/tidb-cloud/ticloud-auditlog-download.md): @@ -160,7 +160,7 @@ ticloud serverless audit-log download --cluster-id --output-path **Note:** > -> {{{ .starter }}} does not guarantee sequential ordering of audit logs. The log file named `YYYY-MM-DD-.log` might contain the audit logs in previous days. +> {{{ .starter }}} and {{{ .essential }}} do not guarantee sequential ordering of audit logs. The log file named `YYYY-MM-DD-.log` might contain the audit logs in previous days. > If you want to retrieve all logs from a specific date (for example, January 1, 2025), specifying `--start-date 2025-01-01` and `--end-date 2025-01-02` usually works. But under extreme conditions, you might need to download all log files and order them by the `TIME` field. ## Audit logging fields @@ -227,4 +227,4 @@ When the event class is `AUDIT` or a subclass of `AUDIT`, the audit logs contain - Audit logging is only available via TiDB Cloud CLI at present. - Audit logs can only be stored in TiDB Cloud at present. -- {{{ .starter }}} does not guarantee the sequential order of audit logs, which means you might have to review all log files to view the latest events. To sort the logs chronologically, you can use the `TIME` field in the audit logs. +- {{{ .starter }}} and {{{ .essential }}} do not guarantee the sequential order of audit logs, which means you might have to review all log files to view the latest events. To sort the logs chronologically, you can use the `TIME` field in the audit logs. diff --git a/tidb-cloud/serverless-driver-drizzle-example.md b/tidb-cloud/serverless-driver-drizzle-example.md index 7a8df7250e966..d67c0037d9d9d 100644 --- a/tidb-cloud/serverless-driver-drizzle-example.md +++ b/tidb-cloud/serverless-driver-drizzle-example.md @@ -1,14 +1,18 @@ --- -title: {{{ .starter }}} Driver Drizzle Tutorial +title: TiDB Cloud Serverless Driver Drizzle Tutorial summary: Learn how to use TiDB Cloud serverless driver with Drizzle. --- -# {{{ .starter }}} Driver Drizzle Tutorial +# TiDB Cloud Serverless Driver Drizzle Tutorial [Drizzle ORM](https://orm.drizzle.team/) is a lightweight and performant TypeScript ORM with developer experience in mind. Starting from `drizzle-orm@0.31.2`, it supports [drizzle-orm/tidb-serverless](https://orm.drizzle.team/docs/get-started-mysql#tidb-serverless), enabling you to use Drizzle over HTTPS with [TiDB Cloud serverless driver](/tidb-cloud/serverless-driver.md). This tutorial describes how to use TiDB Cloud serverless driver with Drizzle in Node.js environments and edge environments. +> **Tip:** +> +> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. + ## Use Drizzle and TiDB Cloud serverless driver in Node.js environments This section describes how to use TiDB Cloud serverless driver with Drizzle in Node.js environments. diff --git a/tidb-cloud/serverless-driver-kysely-example.md b/tidb-cloud/serverless-driver-kysely-example.md index fdb8eaa6f2c37..03e0d3c69c0ae 100644 --- a/tidb-cloud/serverless-driver-kysely-example.md +++ b/tidb-cloud/serverless-driver-kysely-example.md @@ -1,9 +1,9 @@ --- -title: {{{ .starter }}} Driver Kysely Tutorial +title: TiDB Cloud Serverless Driver Kysely Tutorial summary: Learn how to use TiDB Cloud serverless driver with Kysely. --- -# {{{ .starter }}} Driver Kysely Tutorial +# TiDB Cloud Serverless Driver Kysely Tutorial [Kysely](https://kysely.dev/docs/intro) is a type-safe and autocompletion-friendly TypeScript SQL query builder. TiDB Cloud offers [@tidbcloud/kysely](https://github.com/tidbcloud/kysely), enabling you to use Kysely over HTTPS with [TiDB Cloud serverless driver](/tidb-cloud/serverless-driver.md). Compared with the traditional TCP way, [@tidbcloud/kysely](https://github.com/tidbcloud/kysely) brings the following benefits: diff --git a/tidb-cloud/serverless-driver-node-example.md b/tidb-cloud/serverless-driver-node-example.md index 545e83a5b35ae..c402ef2336bfd 100644 --- a/tidb-cloud/serverless-driver-node-example.md +++ b/tidb-cloud/serverless-driver-node-example.md @@ -1,15 +1,15 @@ --- -title: {{{ .starter }}} Driver Node.js Tutorial +title: TiDB Cloud Serverless Driver Node.js Tutorial summary: Learn how to use TiDB Cloud serverless driver in a local Node.js project. --- -# {{{ .starter }}} Driver Node.js Tutorial +# TiDB Cloud Serverless Driver Node.js Tutorial This tutorial describes how to use TiDB Cloud serverless driver in a local Node.js project. > **Note:** > -> - This tutorial is applicable to {{{ .starter }}} clusters only. +> - In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. > - To learn how to use TiDB Cloud serverless driver with Cloudflare Workers, Vercel Edge Functions, and Netlify Edge Functions, check out our [Insights into Automotive Sales](https://car-sales-insight.vercel.app/) and the [sample repository](https://github.com/tidbcloud/car-sales-insight). ## Before you begin diff --git a/tidb-cloud/serverless-driver-prisma-example.md b/tidb-cloud/serverless-driver-prisma-example.md index 6eb82b51e300b..f3963aea5e4e8 100644 --- a/tidb-cloud/serverless-driver-prisma-example.md +++ b/tidb-cloud/serverless-driver-prisma-example.md @@ -1,9 +1,9 @@ --- -title: {{{ .starter }}} Driver Prisma Tutorial +title: TiDB Cloud Serverless Driver Prisma Tutorial summary: Learn how to use TiDB Cloud serverless driver with Prisma ORM. --- -# {{{ .starter }}} Driver Prisma Tutorial +# TiDB Cloud Serverless Driver Prisma Tutorial [Prisma](https://www.prisma.io/docs) is an open source next-generation ORM (Object-Relational Mapping) that helps developers interact with their database in an intuitive, efficient, and safe way. TiDB Cloud offers [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter), enabling you to use [Prisma Client](https://www.prisma.io/docs/concepts/components/prisma-client) over HTTPS with [TiDB Cloud serverless driver](/tidb-cloud/serverless-driver.md). Compared with the traditional TCP way, [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter) brings the following benefits: @@ -12,6 +12,10 @@ summary: Learn how to use TiDB Cloud serverless driver with Prisma ORM. This tutorial describes how to use [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter) in serverless environments and edge environments. +> **Tip:** +> +> In addition to {{{ .starter }}} clusters, the steps in this document also work with {{{ .essential }}} clusters. + ## Install You need to install both [@tidbcloud/prisma-adapter](https://github.com/tidbcloud/prisma-adapter) and [TiDB Cloud serverless driver](/tidb-cloud/serverless-driver.md). You can install them using [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or your preferred package manager. diff --git a/tidb-cloud/serverless-driver.md b/tidb-cloud/serverless-driver.md index 1e07036f093dd..dfad76d54e93d 100644 --- a/tidb-cloud/serverless-driver.md +++ b/tidb-cloud/serverless-driver.md @@ -1,16 +1,20 @@ --- -title: {{{ .starter }}} Driver (Beta) -summary: Learn how to connect to {{{ .starter }}} from serverless and edge environments. +title: TiDB Cloud Serverless Driver (Beta) +summary: Learn how to connect to {{{ .starter }}} or {{{ .essential }}} from serverless and edge environments. aliases: ['/tidbcloud/serverless-driver-config'] --- -# {{{ .starter }}} Driver (Beta) +# TiDB Cloud Serverless Driver (Beta) -## Why use {{{ .starter }}} Driver (Beta) +> **Note:** +> +> The serverless driver is in beta and only applicable to {{{ .starter }}} or {{{ .essential }}} clusters. + +## Why use TiDB Cloud Serverless Driver (Beta) Traditional TCP-based MySQL drivers are not suitable for serverless functions due to their expectation of long-lived, persistent TCP connections, which contradict the short-lived nature of serverless functions. Moreover, in edge environments such as [Vercel Edge Functions](https://vercel.com/docs/functions/edge-functions) and [Cloudflare Workers](https://workers.cloudflare.com/), where comprehensive TCP support and full Node.js compatibility may be lacking, these drivers may not work at all. -[TiDB Cloud serverless driver (Beta)](https://github.com/tidbcloud/serverless-js) for JavaScript allows you to connect to your {{{ .starter }}} cluster over HTTP, which is generally supported by serverless environments. With it, it is now possible to connect to {{{ .starter }}} clusters from edge environments and reduce connection overhead with TCP while keeping the similar development experience of traditional TCP-based MySQL drivers. +[TiDB Cloud serverless driver (Beta)](https://github.com/tidbcloud/serverless-js) for JavaScript lets you to connect to your {{{ .starter }}} or {{{ .essential }}} cluster over HTTP, which is generally supported by serverless environments. With it, it is now possible to connect to {{{ .starter }}} or {{{ .essential }}} clusters from edge environments and reduce connection overhead with TCP while keeping the similar development experience of traditional TCP-based MySQL drivers. > **Note:** > @@ -26,11 +30,11 @@ npm install @tidbcloud/serverless ## Use the serverless driver -You can use the serverless driver to query data of a {{{ .starter }}} cluster or perform interactive transactions. +You can use the serverless driver to query data of a {{{ .starter }}} or {{{ .essential }}} cluster or perform interactive transactions. ### Query -To query data from a {{{ .starter }}} cluster, you need to create a connection first. Then you can use the connection to execute raw SQL queries. For example: +To query data from a {{{ .starter }}} or {{{ .essential }}} cluster, you need to create a connection first. Then you can use the connection to execute raw SQL queries. For example: ```ts import { connect } from '@tidbcloud/serverless' @@ -154,10 +158,10 @@ At the connection level, you can make the following configurations: | Name | Type | Default value | Description | |--------------|----------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `username` | string | N/A | Username of {{{ .starter }}} | -| `password` | string | N/A | Password of {{{ .starter }}} | -| `host` | string | N/A | Hostname of {{{ .starter }}} | -| `database` | string | `test` | Database of {{{ .starter }}} | +| `username` | string | N/A | Username of the cluster. | +| `password` | string | N/A | Password of the cluster. | +| `host` | string | N/A | Hostname of the cluster. | +| `database` | string | `test` | Database of the cluster. | | `url` | string | N/A | The URL for the database, in the `mysql://[username]:[password]@[host]/[database]` format, where `database` can be skipped if you intend to connect to the default database. | | `fetch` | function | global fetch | Custom fetch function. For example, you can use the `undici` fetch in node.js. | | `arrayMode` | bool | `false` | Whether to return results as arrays instead of objects. To get better performance, set it to `true`. | @@ -267,9 +271,9 @@ DDL is supported and the following SQL statements are supported: `SELECT`, `SHO ### Data type mapping -The type mapping between {{{ .starter }}} and Javascript is as follows: +The type mapping between TiDB and Javascript is as follows: -| {{{ .starter }}} type | Javascript type | +| TiDB data type | Javascript type | |----------------------|-----------------| | TINYINT | number | | UNSIGNED TINYINT | number | @@ -310,7 +314,7 @@ The type mapping between {{{ .starter }}} and Javascript is as follows: > **Note:** > -> Make sure to use the default `utf8mb4` character set in {{{ .starter }}} for the type conversion to JavaScript strings, because TiDB Cloud serverless driver uses the UTF-8 encoding to decode them to strings. +> Make sure to use the default `utf8mb4` character set in TiDB Cloud for the type conversion to JavaScript strings, because TiDB Cloud serverless driver uses the UTF-8 encoding to decode them to strings. > **Note:** > @@ -327,7 +331,10 @@ TiDB Cloud serverless driver has been integrated with the following ORMs: ## Pricing -The serverless driver itself is free, but accessing data with the driver generates [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit) and storage usage. The pricing follows the [{{{ .starter }}} pricing](https://www.pingcap.com/tidb-serverless-pricing-details/) model. +The serverless driver itself is free, but accessing data with the driver generates [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit) and storage usage. + +- For {{{ .starter }}} clusters, the pricing follows the [{{{ .starter }}} pricing](https://www.pingcap.com/tidb-serverless-pricing-details/) model. +- For {{{ .essential }}} clusters, the pricing follows the [{{{ .essential }}} pricing](/tidb-cloud/tidb-cloud-billing.md#pricing-for-essential) model. ## Limitations diff --git a/tidb-cloud/serverless-export.md b/tidb-cloud/serverless-export.md index 69a7f2de6e865..d3e72e59a6d67 100644 --- a/tidb-cloud/serverless-export.md +++ b/tidb-cloud/serverless-export.md @@ -1,15 +1,15 @@ --- -title: Export Data from {{{ .starter }}} -summary: Learn how to export data from {{{ .starter }}} clusters. +title: Export Data from {{{ .starter }}} or Essential +summary: Learn how to export data from {{{ .starter }}} or {{{ .essential }}} clusters. --- -# Export Data from {{{ .starter }}} +# Export Data from {{{ .starter }}} or Essential -{{{ .starter }}} Export (Beta) is a service that enables you to export data from a {{{ .starter }}} cluster to a local file or an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. +TiDB Cloud enables you to export data from a {{{ .starter }}} or Essential cluster to a local file or an external storage service. You can use the exported data for backup, migration, data analysis, or other purposes. -While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), {{{ .starter }}} Export offers a more convenient and efficient way to export data from a {{{ .starter }}} cluster. It brings the following benefits: +While you can also export data using tools such as [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) and TiDB [Dumpling](https://docs.pingcap.com/tidb/dev/dumpling-overview), the export feature provided by TiDB Cloud offers a more convenient and efficient way to export data from a cluster. It brings the following benefits: -- Convenience: the export service provides a simple and easy-to-use way to export data from a {{{ .starter }}} cluster, eliminating the need for additional tools or resources. +- Convenience: the export service provides a simple and easy-to-use way to export data from a cluster, eliminating the need for additional tools or resources. - Isolation: the export service uses separate computing resources, ensuring isolation from the resources used by your online services. - Consistency: the export service ensures the consistency of the exported data without causing locks, which does not affect your online services. @@ -35,7 +35,7 @@ You can export data to the following locations: ### A local file -To export data from a {{{ .starter }}} cluster to a local file, you need to export data [using the TiDB Cloud console](#export-data-to-a-local-file) or [using the TiDB Cloud CLI](/tidb-cloud/ticloud-serverless-export-create.md), and then download the exported data using the TiDB Cloud CLI. +To export data from a TiDB Cloud cluster to a local file, you need to export data [using the TiDB Cloud console](#export-data-to-a-local-file) or [using the TiDB Cloud CLI](/tidb-cloud/ticloud-serverless-export-create.md), and then download the exported data using the TiDB Cloud CLI. Exporting data to a local file has the following limitations: @@ -126,9 +126,9 @@ You can compress the exported Parquet data using the following algorithms: ### Data conversion -When exporting data to the Parquet format, the data conversion between {{{ .starter }}} and Parquet is as follows: +When exporting data to the Parquet format, the data conversion between TiDB and Parquet is as follows: -| {{{ .starter }}} Type | Parquest primitive type | Parquet logical type | +| TiDB data type | Parquest primitive type | Parquet logical type | |----------------------------|-------------------------|----------------------------------------------| | VARCHAR | BYTE_ARRAY | String(UTF8) | | TIME | BYTE_ARRAY | String(UTF8) | @@ -242,7 +242,7 @@ When exporting data to the Parquet format, the data conversion between {{{ .star - **Compression**: choose **Gzip**, **Snappy**, **Zstd**, or **None**. - **Folder URI**: enter the URI of the Amazon S3 with the `s3:////` format. - **Bucket Access**: choose one of the following access credentials and then fill in the credential information: - - **AWS Role ARN**: enter the role ARN that has the permission to access the bucket. It is recommended to create the role ARN with AWS CloudFormation. For more information, see [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access). + - **AWS Role ARN**: enter the role ARN that has the permission to access the bucket. It is recommended to create the role ARN with AWS CloudFormation. For more information, see [Configure Amazon S3 access](/tidb-cloud/serverless-external-storage.md#configure-amazon-s3-access). - **AWS Access Key**: enter the access key ID and access key secret that have the permission to access the bucket. 4. Click **Export**. @@ -323,7 +323,7 @@ ticloud serverless export create -c --target-type GCS --gcs.uri .blob.core.windows.net///` format. - - **SAS Token**: enter the SAS token that has the permission to access the container. It is recommended to create a SAS token with the [Azure ARM template](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/). For more information, see [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access). + - **SAS Token**: enter the SAS token that has the permission to access the container. It is recommended to create a SAS token with the [Azure ARM template](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/). For more information, see [Configure Azure Blob Storage access](/tidb-cloud/serverless-external-storage.md#configure-azure-blob-storage-access). 4. Click **Export**. @@ -416,12 +416,14 @@ ticloud serverless export cancel -c -e ## Export speed -The export speed depends on your [cluster plan](/tidb-cloud/select-cluster-tier.md#cluster-plans). For details, see the following table: +The export speed depends on your [cluster plan](/tidb-cloud/select-cluster-tier.md): -| Plan | Export speed | -|:-------------------|:-------------------| -| Free cluster plan | Up to 25 MiB/s | -| Scalable cluster plan | Up to 100 MiB/s | +- **{{{ .starter }}}**: + + - If the spending limit is set to 0, the export speed is up to 25 MiB/s. + - If the spending limit is greater than 0, the export speed is up to 100 MiB/s. + +- **{{{ .essential }}}**: up to 100 MiB/s. ## Pricing diff --git a/tidb-cloud/serverless-external-storage.md b/tidb-cloud/serverless-external-storage.md index ea3b6121e78ec..6666b73e83cb4 100644 --- a/tidb-cloud/serverless-external-storage.md +++ b/tidb-cloud/serverless-external-storage.md @@ -1,17 +1,17 @@ --- -title: Configure {{{ .starter }}} External Storage Access +title: Configure External Storage Access for {{{ .starter }}} or Essential summary: Learn how to configure Amazon Simple Storage Service (Amazon S3) access. --- -# Configure External Storage Access for {{{ .starter }}} +# Configure External Storage Access for {{{ .starter }}} or Essential -If you want to import data from or export data to an external storage in a {{{ .starter }}} cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} clusters. +If you want to import data from or export data to an external storage in a TiDB Cloud cluster, you need to configure cross-account access. This document describes how to configure access to an external storage for {{{ .starter }}} and {{{ .essential }}} clusters. If you need to configure these external storages for a TiDB Cloud Dedicated cluster, see [Configure External Storage Access for TiDB Cloud Dedicated](/tidb-cloud/dedicated-external-storage.md). ## Configure Amazon S3 access -To allow a {{{ .starter }}} cluster to access the source data in your Amazon S3 bucket, configure the bucket access for the cluster using either of the following methods: +To allow a TiDB Cloud cluster to access the source data in your Amazon S3 bucket, configure the bucket access for the cluster using either of the following methods: - [Use a Role ARN](#configure-amazon-s3-access-using-a-role-arn): use a Role ARN to access your Amazon S3 bucket. - [Use an AWS access key](#configure-amazon-s3-access-using-an-aws-access-key): use the access key of an IAM user to access your Amazon S3 bucket. @@ -79,10 +79,10 @@ If you have any trouble creating a role ARN with AWS CloudFormation, you can tak 4. On the **Create policy** page, click the **JSON** tab. - 5. Configure the policy in the policy text field according to your needs. The following is an example that you can use to export data from and import data into a {{{ .starter }}} cluster. + 5. Configure the policy in the policy text field according to your needs. The following is an example that you can use to export data from and import data into a TiDB Cloud cluster. - - Exporting data from a {{{ .starter }}} cluster needs the **s3:PutObject** and **s3:ListBucket** permissions. - - Importing data into a {{{ .starter }}} cluster needs the **s3:GetObject**, **s3:GetObjectVersion**, and **s3:ListBucket** permissions. + - Exporting data from a TiDB Cloud cluster needs the **s3:PutObject** and **s3:ListBucket** permissions. + - Importing data into a TiDB Cloud cluster needs the **s3:GetObject**, **s3:GetObjectVersion**, and **s3:ListBucket** permissions. ```json { @@ -180,7 +180,7 @@ Take the following steps to configure an access key: ## Configure GCS access -To allow a {{{ .starter }}} cluster to access your GCS bucket, you need to configure the GCS access for the bucket. You can use a service account key to configure the bucket access: +To allow a TiDB Cloud cluster to access your GCS bucket, you need to configure the GCS access for the bucket. You can use a service account key to configure the bucket access: Take the following steps to configure a service account key: @@ -191,8 +191,8 @@ Take the following steps to configure a service account key: 3. Click **CREATE AND CONTINUE** to create the service account. 4. In the `Grant this service account access to project`, choose the [IAM roles](https://cloud.google.com/iam/docs/understanding-roles) with the needed permission. - - Exporting data from a {{{ .starter }}} cluster needs a role with `storage.objects.create` permission. - - Importing data into a {{{ .starter }}} cluster needs a role with `storage.buckets.get`, `storage.objects.get`, and `storage.objects.list` permissions. + - Exporting data from a TiDB Cloud cluster needs a role with `storage.objects.create` permission. + - Importing data into a TiDB Cloud cluster needs a role with `storage.buckets.get`, `storage.objects.get`, and `storage.objects.list` permissions. 5. Click **Continue** to go to the next step. 6. Optional: In the `Grant users access to this service account`, choose members that need to [attach the service account to other resources](https://cloud.google.com/iam/docs/attach-service-accounts). @@ -204,11 +204,11 @@ Take the following steps to configure a service account key: ![service-account-key](/media/tidb-cloud/serverless-external-storage/gcs-service-account-key.png) -3. Choose the default `JSON` key type, and then click **CREATE** to download the Google Cloud credentials file. The file contains the service account key that you need to use when configuring the GCS access for the {{{ .starter }}} cluster. +3. Choose the default `JSON` key type, and then click **CREATE** to download the Google Cloud credentials file. The file contains the service account key that you need to use when configuring the GCS access for the TiDB Cloud cluster. ## Configure Azure Blob Storage access -To allow {{{ .starter }}} to access your Azure Blob container, you need to create a service SAS token for the container. +To allow TiDB Cloud to access your Azure Blob container, you need to create a service SAS token for the container. You can create a SAS token either using an [Azure ARM template](https://learn.microsoft.com/en-us/azure/azure-resource-manager/templates/overview) (recommended) or manual configuration. @@ -257,8 +257,8 @@ If you have any trouble creating a SAS token with the Azure ARM template, take t 2. In the **Allowed Resource types** section, choose **Container** and **Object**. 3. In the **Allowed permissions** section, choose the permission as needed. - - Exporting data from a {{{ .starter }}} cluster needs the **Read** and **Write** permissions. - - Importing data into a {{{ .starter }}} cluster needs the **Read** and **List** permissions. + - Exporting data from a TiDB Cloud cluster needs the **Read** and **Write** permissions. + - Importing data into a TiDB Cloud cluster needs the **Read** and **List** permissions. 4. Adjust **Start and expiry date/time** as needed. 5. You can keep the default values for other settings. @@ -271,7 +271,7 @@ If you have any trouble creating a SAS token with the Azure ARM template, take t ## Configure Alibaba Cloud Object Storage Service (OSS) access -To allow {{{ .starter }}} to access your Alibaba Cloud OSS bucket, you need to create an AccessKey pair for the bucket. +To allow TiDB Cloud to access your Alibaba Cloud OSS bucket, you need to create an AccessKey pair for the bucket. Take the following steps to configure an AccessKey pair: @@ -285,9 +285,9 @@ Take the following steps to configure an AccessKey pair: - In the **Service** section, select **Object Storage Service**. - In the **Action** section, select the permissions as needed. - To import data into a {{{ .starter }}} cluster, grant **oss:GetObject**, **oss:GetBucketInfo**, and **oss:ListObjects** permissions. + To import data into a TiDB Cloud cluster, grant **oss:GetObject**, **oss:GetBucketInfo**, and **oss:ListObjects** permissions. - To export data from a {{{ .starter }}} cluster, grant **oss:PutObject**, **oss:GetBucketInfo**, and **oss:ListBuckets** permissions. + To export data from a TiDB Cloud cluster, grant **oss:PutObject**, **oss:GetBucketInfo**, and **oss:ListBuckets** permissions. - In the **Resource** section, select the bucket and the objects in the bucket. diff --git a/tidb-cloud/serverless-faqs.md b/tidb-cloud/serverless-faqs.md index ae4f7b555bb90..8903b4a9e4b03 100644 --- a/tidb-cloud/serverless-faqs.md +++ b/tidb-cloud/serverless-faqs.md @@ -16,13 +16,28 @@ This document lists the most frequently asked questions about {{{ .starter }}}. {{{ .starter }}} offers the TiDB database with full HTAP capabilities for you and your organization. It is a fully managed, auto-scaling deployment of TiDB that lets you start using your database immediately, develop and run your application without caring about the underlying nodes, and automatically scale based on your application's workload changes. +### What is the relationship between TiDB Cloud Starter and TiDB Cloud Serverless? + +TiDB Cloud Starter is the new name for TiDB Cloud Serverless, effective August 12, 2025. + +Before it was renamed to Starter, the Serverless tier of TiDB Cloud served as the entry point for thousands of developers, providing a production-ready database that scales automatically, starts in seconds, and costs nothing until you exceed a generous free quota. + +While "serverless" accurately reflects how the service works behind the scenes, many first-time users found the term abstract and overloaded with different meanings. + +To make the purpose of this entry tier clearer, we’ve renamed it to Starter, the fastest way to begin building with TiDB Cloud. Everything you know about the Serverless tier remains the same: + +- A fully managed database with both row-based and columnar storage, ideal for hybrid OLTP and OLAP workloads. +- Automatic and request-driven scaling, no capacity planning or manual tuning required. +- Built-in vector search and full-text search to power GenAI retrieval, chatbots, and other AI applications. +- Always-free monthly quota for up to five clusters per organization (5 GiB row data + 5 GiB columnar data + 50 million [RUs](/tidb-cloud/tidb-cloud-glossary.md#request-unit) per cluster). + ### How do I get started with {{{ .starter }}}? -Get started with the 5-minute [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md). +Get started with the 5-minute [TiDB Cloud Quick Start](/tidb-cloud/tidb-cloud-quickstart.md) ### How many {{{ .starter }}} clusters can I create in TiDB Cloud? -For each organization in TiDB Cloud, you can create a maximum of five [free clusters](/tidb-cloud/select-cluster-tier.md#free-cluster-plan) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and create [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan) for the usage. +For each organization in TiDB Cloud, you can create a maximum of five [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters by default. To create more {{{ .starter }}} clusters, you need to add a credit card and set the [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. ### Are all TiDB Cloud features fully supported on {{{ .starter }}}? @@ -79,19 +94,19 @@ For the first five {{{ .starter }}} clusters in your organization, TiDB Cloud pr - Columnar storage: 5 GiB - [Request Units (RUs)](/tidb-cloud/tidb-cloud-glossary.md#request-unit): 50 million RUs per month -If you are using a scalable cluster, usage beyond the free quota will be charged. For a free cluster, once the free quota is reached, the read and write operations on this cluster will be throttled until you upgrade to a scalable cluster or the usage is reset upon the start of a new month. +If the monthly spending limit is set for a {{{ .starter }}} cluster, usage beyond the free quota will be charged. For a free cluster, once the free quota is reached, the read and write operations on this cluster will be throttled until you set a monthly spending limit or the usage is reset upon the start of a new month. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). ### What are the limitations of the free plan? -Under the free plan, cluster performance is limited due to non-scalable resources. This results in a restriction on memory allocation per query to 256 MiB and might cause observable bottlenecks in request units (RUs) per second. To maximize cluster performance and avoid these limitations, you can upgrade to a [scalable cluster](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan). +Under the free plan, cluster performance is limited due to non-scalable resources. This results in a restriction on memory allocation per query to 256 MiB and might cause observable bottlenecks in request units (RUs) per second. To maximize cluster performance and avoid these limitations, you can [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for your {{{ .starter }}} cluster. ### How can I estimate the number of RUs required by my workloads and plan my monthly budget? To get the RU consumption of individual SQL statements, you can use the [`EXPLAIN ANALYZE`](/sql-statements/sql-statement-explain-analyze.md#ru-request-unit-consumption) SQL statement. However, it is important to note that the RUs usage returned in `EXPLAIN ANALYZE` does not incorporate egress RUs, as egress usage is measured separately in the gateway, which is unknown to the TiDB server. -To get the RUs and storage used by your cluster, view the **Usage this month** pane on your cluster overview page. With your past resource usage data and real-time resource usage in this pane, you can track your cluster's resource consumption and estimate a reasonable spending limit. If the free quota cannot meet your requirement, you can upgrade to a [scalable cluster](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan) and edit the spending limit. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). +To get the RUs and storage used by your cluster, view the **Usage this month** pane on your cluster overview page. With your past resource usage data and real-time resource usage in this pane, you can track your cluster's resource consumption and estimate a reasonable spending limit. If the free quota cannot meet your requirement, you can edit the spending limit for additional resources. For more information, see [{{{ .starter }}} usage quota](/tidb-cloud/select-cluster-tier.md#usage-quota). ### How can I optimize my workload to minimize the number of RUs consumed? diff --git a/tidb-cloud/serverless-high-availability.md b/tidb-cloud/serverless-high-availability.md index 83a84cf569328..7a2f4652d0e70 100644 --- a/tidb-cloud/serverless-high-availability.md +++ b/tidb-cloud/serverless-high-availability.md @@ -1,19 +1,19 @@ --- -title: High Availability in {{{ .starter }}} -summary: Learn about the high availability architecture of {{{ .starter }}}. Discover Zonal and Regional High Availability options, automated backups, failover processes, and how TiDB ensures data durability and business continuity. +title: High Availability in {{{ .starter }}} and Essential +summary: Learn about the high availability architecture of {{{ .starter }}} and Essential. Discover Zonal and Regional High Availability options, automated backups, failover processes, and how TiDB ensures data durability and business continuity. --- -# High Availability in {{{ .starter }}} +# High Availability in {{{ .starter }}} and Essential -{{{ .starter }}} is designed with robust mechanisms to maintain high availability and data durability by default, preventing single points of failure and ensuring continuous service even in the face of disruptions. As a fully managed service based on the battle-tested TiDB Open Source product, it inherits TiDB's core high availability (HA) features and augments them with additional cloud-native capabilities. +TiDB Cloud is designed with robust mechanisms to maintain high availability and data durability by default, preventing single points of failure and ensuring continuous service even in the face of disruptions. As a fully managed service based on the battle-tested TiDB Open Source product, it inherits TiDB's core high availability (HA) features and augments them with additional cloud-native capabilities. ## Overview TiDB ensures high availability and data durability using the Raft consensus algorithm. This algorithm consistently replicates data changes across multiple nodes, allowing TiDB to handle read and write requests even in the event of node failures or network partitions. This approach provides both high data durability and fault tolerance. -{{{ .starter }}} extends these capabilities with two types of high availability to meet different operational requirements: +TiDB Cloud extends these capabilities with two types of high availability to meet different operational requirements: -- **Zonal high availability (default)**: This option places all nodes within a single availability zone, reducing network latency. It ensures high availability without requiring application-level redundancy across zones, making it suitable for applications that prioritize low latency within a single zone. Zonal high availability is available in all regions that support {{{ .starter }}}. For more information, see [Zonal high availability architecture](#zonal-high-availability-architecture). +- **Zonal high availability (default)**: This option places all nodes within a single availability zone, reducing network latency. It ensures high availability without requiring application-level redundancy across zones, making it suitable for applications that prioritize low latency within a single zone. Zonal high availability is available by default in all cloud regions that support {{{ .starter }}} or {{{ .essential }}}. For more information, see [Zonal high availability architecture](#zonal-high-availability-architecture). - **Regional high availability (beta)**: This option distributes nodes across multiple availability zones, offering maximum infrastructure isolation and redundancy. It provides the highest level of availability but requires application-level redundancy across zones. It is recommended to choose this option if you need maximum availability protection against infrastructure failures within a zone. Note that it increases latency and might incur cross-zone data transfer fees. This feature is available in selected regions with multi-availability zone support and can only be enabled during cluster creation. For more information, see [Regional high availability architecture](#regional-high-availability-architecture). @@ -21,11 +21,17 @@ TiDB ensures high availability and data durability using the Raft consensus algo > **Note:** > -> Zonal high availability is the default option and is available in all AWS regions that support {{{ .starter }}}. +> Zonal high availability is the default option and is available in all cloud regions that support {{{ .starter }}} or {{{ .essential }}}. When you create a cluster with the default zonal high availability, all components, including Gateway, TiDB, TiKV, and TiFlash compute/write nodes, run in the same availability zone. The placement of these components in the data plane offer infrastructure redundancy with virtual machine pools, which minimizes failover time and network latency due to colocation. -![{{{ .starter }}} zonal high availability](/media/tidb-cloud/serverless-zonal-high-avaliability-aws.png) +- The following diagram shows the architecture of zonal high availability on AWS: + + ![zonal high availability on AWS](/media/tidb-cloud/zonal-high-avaliability-aws.png) + +- The following diagram shows the architecture of zonal high availability on Alibaba Cloud: + + ![zonal high availability on Alibaba Cloud](/media/tidb-cloud/zonal-high-avaliability-alibaba-cloud.png) In zonal high availability architecture: @@ -35,13 +41,13 @@ In zonal high availability architecture: ### Failover process -{{{ .starter }}} ensures a transparent failover process for your applications. During a failover: +TiDB Cloud ensures a transparent failover process for your applications. During a failover: - A new replica is created to replace the failed one. -- Servers providing storage services recover local caches from persisted data on Amazon S3, restoring the system to a consistent state with the replicas. +- Servers providing storage services recover local caches from persisted data on Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider), restoring the system to a consistent state with the replicas. -In the storage layer, persisted data is regularly pushed to Amazon S3 for high durability. Moreover, immediate updates are not only replicated across multiple TiKV servers but also stored on the EBS of each server, which further replicates the data for additional durability. TiDB automatically resolves issues by backing off and retrying in milliseconds, ensuring the failover process remains seamless for client applications. +In the storage layer, persisted data is regularly pushed to Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider) for high durability. Moreover, immediate updates are not only replicated across multiple TiKV servers but also stored on the EBS of each server, which further replicates the data for additional durability. TiDB automatically resolves issues by backing off and retrying in milliseconds, ensuring the failover process remains seamless for client applications. The gateway and computing layers are stateless, so failover involves restarting them elsewhere immediately. Applications should implement retry logic for their connections. While the zonal setup provides high availability, it cannot handle an entire zone failure. If the zone becomes unavailable, downtime will occur until the zone and its dependent services are restored. @@ -51,10 +57,12 @@ When you create a cluster with regional high availability, critical OLTP (Online > **Note:** > -> - Regional high availability is currently in beta and only available in the AWS Tokyo (`ap-northeast-1`) region. -> - You can enable regional high availability only during cluster creation. +> - Regional high availability is currently in beta. +> - You can enable regional high availability when you create a {{{ .essential }}} cluster. + +The following diagram shows the architecture of regional high availability on Alibaba Cloud: -![{{{ .starter }}} regional high availability](/media/tidb-cloud/serverless-regional-high-avaliability-aws.png) +![regional high availability](/media/tidb-cloud/regional-high-avaliability-alibaba-cloud.png) In regional high availability architecture: @@ -66,7 +74,7 @@ In regional high availability architecture: In the rare event of a primary zone failure scenario, which could be caused by a natural disaster, configuration change, software issue, or hardware failure, critical OLTP workload components, including Gateway and TiDB, are automatically launched in the standby availability zone. Traffic is automatically redirected to the standby zone to ensure swift recovery and maintain business continuity. -{{{ .starter }}} minimizes service disruption and ensures business continuity during a primary zone failure by performing the following actions: +TiDB Cloud minimizes service disruption and ensures business continuity during a primary zone failure by performing the following actions: - Automatically create new replicas of Gateway and TiDB in the standby availability zone. - Use the elastic load balancer to detect active gateway replicas in the standby availability zone and redirect OLTP traffic from the failed primary zone. @@ -79,7 +87,7 @@ Applications are unaffected by failures in non-primary zones and remain unaware Database backups are essential for business continuity and disaster recovery, helping to protect your data from corruption or accidental deletion. With backups, you can restore your database to a specific point in time within the retention period, minimizing data loss and downtime. -{{{ .starter }}} provides robust automated backup mechanisms to ensure continuous data protection: +TiDB Cloud provides robust automated backup mechanisms to ensure continuous data protection: - **Daily full backups**: A full backup of your database is created once a day, capturing the entire database state. - **Continuous transaction log backups**: Transaction logs are backed up continuously, approximately every 5 minutes, though the exact frequency depends on database activity. @@ -88,14 +96,14 @@ These automated backups enable you to restore your database either from a full b > **Note:** > -> Automatic backups, including snapshot-based and continuous backups for Point-in-Time Recovery (PITR), are performed on Amazon S3, which provides regional-level high durability. +> Automatic backups, including snapshot-based and continuous backups for Point-in-Time Recovery (PITR), are performed on Amazon S3 or Alibaba Cloud OSS (depending on your cloud provider), which provides regional-level high durability. ## Impact on sessions during failures During a failure, ongoing transactions on the failed server might be interrupted. Although failover is transparent to applications, you must implement logic to handle recoverable failures during active transactions. Different failure scenarios are handled as follows: -- **TiDB failures**: If a TiDB instance fails, client connections are unaffected because {{{ .starter }}} automatically reroutes traffic through the gateway. While transactions on the failed TiDB instance might be interrupted, the system ensures that committed data is preserved, and new transactions are handled by another available TiDB instance. -- **Gateway failures**: If the Gateway fails, client connections are disrupted. However, {{{ .starter }}} gateways are stateless and can restart immediately in a new zone or server. Traffic is automatically redirected to the new gateway, minimizing downtime. +- **TiDB failures**: If a TiDB instance fails, client connections are unaffected because TiDB Cloud automatically reroutes traffic through the gateway. While transactions on the failed TiDB instance might be interrupted, the system ensures that committed data is preserved, and new transactions are handled by another available TiDB instance. +- **Gateway failures**: If the Gateway fails, client connections are disrupted. However, TiDB Cloud gateways are stateless and can restart immediately in a new zone or server. Traffic is automatically redirected to the new gateway, minimizing downtime. It is recommended to implement retry logic in your application to handle recoverable failures. For implementation details, refer to your driver or ORM documentation (for example, [JDBC](https://dev.mysql.com/doc/connector-j/en/connector-j-config-failover.html)). diff --git a/tidb-cloud/serverless-limitations.md b/tidb-cloud/serverless-limitations.md index f3eebfd00230d..8728aa989a610 100644 --- a/tidb-cloud/serverless-limitations.md +++ b/tidb-cloud/serverless-limitations.md @@ -1,16 +1,16 @@ --- -title: {{{ .starter }}} Limitations and Quotas +title: Limitations and Quotas of {{{ .starter }}} and Essential summary: Learn about the limitations of {{{ .starter }}}. aliases: ['/tidbcloud/serverless-tier-limitations'] --- -# {{{ .starter }}} Limitations and Quotas +# Limitations and Quotas of {{{ .starter }}} and Essential -{{{ .starter }}} works with almost all workloads that TiDB supports, but there are some feature differences between TiDB Self-Managed or TiDB Cloud Dedicated clusters and {{{ .starter }}} clusters. This document describes the limitations of {{{ .starter }}}. +{{{ .starter }}} and Essential work with almost all workloads that TiDB supports, but there are some feature differences compared with TiDB Self-Managed or TiDB Cloud Dedicated clusters. This document describes the limitations of {{{ .starter }}} and {{{ .essential }}}. -We are constantly filling in the feature gaps between {{{ .starter }}} and TiDB Cloud Dedicated. If you require these features or capabilities in the gap, use [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) or [contact us](https://www.pingcap.com/contact-us/?from=en) for a feature request. +We are constantly filling in the feature gaps between {{{ .starter }}}/Essential and TiDB Cloud Dedicated. If you require these features or capabilities in the gap, use [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) or [contact us](https://www.pingcap.com/contact-us/?from=en) for a feature request. ## Limitations @@ -20,12 +20,12 @@ We are constantly filling in the feature gaps between {{{ .starter }}} and TiDB ### Connection -- Only [Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to {{{ .starter }}} clusters.  +- Only [Public Endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md) and [Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) can be used. You cannot use [VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md) to connect to {{{ .starter }}} or {{{ .essential }}} clusters.  - No [IP Access list](/tidb-cloud/configure-ip-access-list.md) support. ### Encryption -- Data persisted in your {{{ .starter }}} cluster is encrypted using the encryption tool provided by the cloud provider that manages your cluster. For [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan), an optional second layer of encryption is available during the cluster creation process, providing an additional level of security beyond the default encryption at rest. +- Data persisted in your {{{ .starter }}} or {{{ .essential }}} cluster is encrypted using the encryption tool provided by the cloud provider that manages your cluster. For {{{ .starter }}} (with spending limit > 0) and {{{ .essential }}} clusters, an optional second layer of encryption is available during the cluster creation process, providing an additional level of security beyond the default encryption at rest. - Using [customer-managed encryption keys (CMEK)](/tidb-cloud/tidb-cloud-encrypt-cmek.md) is currently unavailable. ### Maintenance window @@ -41,16 +41,16 @@ We are constantly filling in the feature gaps between {{{ .starter }}} and TiDB ### Self-service upgrades -- {{{ .starter }}} is a fully managed deployment of TiDB. Major and minor version upgrades of {{{ .starter }}} are handled by TiDB Cloud and therefore cannot be initiated by users. +- {{{ .starter }}} and {{{ .essential }}} are fully managed deployments of TiDB. Major and minor version upgrades of {{{ .starter }}} and {{{ .essential }}} are handled by TiDB Cloud and therefore cannot be initiated by users. ### Stream data -- [Changefeed](/tidb-cloud/changefeed-overview.md) is not supported for {{{ .starter }}} currently. -- [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) is not supported for {{{ .starter }}} currently. +- [Changefeed](/tidb-cloud/changefeed-overview.md) is not supported for {{{ .starter }}} and {{{ .essential }}} currently. +- [Data Migration](/tidb-cloud/migrate-from-mysql-using-data-migration.md) is not supported for {{{ .starter }}} and {{{ .essential }}} currently. ### Time to live (TTL) -- In {{{ .starter }}}, the [`TTL_JOB_INTERVAL`](/time-to-live.md#ttl-job) attribute for a table is fixed at `15m` and cannot be modified. This means that {{{ .starter }}} schedules a background job every 15 minutes to clean up expired data. +- In {{{ .starter }}} and {{{ .essential }}}, the [`TTL_JOB_INTERVAL`](/time-to-live.md#ttl-job) attribute for a table is fixed at `15m` and cannot be modified. This means that {{{ .starter }}} and {{{ .essential }}} schedule a background job every 15 minutes to clean up expired data. ### Others @@ -59,9 +59,9 @@ We are constantly filling in the feature gaps between {{{ .starter }}} and TiDB ## Usage quota -For each organization in TiDB Cloud, you can create a maximum of five [free clusters](/tidb-cloud/select-cluster-tier.md#free-cluster-plan) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and create [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan) for the usage. +For each organization in TiDB Cloud, you can create a maximum of five [free {{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) by default. To create more {{{ .starter }}} clusters, you need to add a credit card and [set a monthly spending limit](/tidb-cloud/manage-serverless-spend-limit.md) for the usage. -For the first five {{{ .starter }}} clusters in your organization, whether they are free or scalable, TiDB Cloud provides a free usage quota for each of them as follows: +For the first five {{{ .starter }}} clusters in your organization, TiDB Cloud provides a free usage quota for each of them as follows: - Row-based storage: 5 GiB - Columnar storage: 5 GiB @@ -73,6 +73,6 @@ Once a cluster reaches its usage quota, it immediately denies any new connection 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-serverless-pricing-details). -If you want to create a {{{ .starter }}} cluster with an additional quota, you can select the scalable cluster plan and edit the spending limit on the cluster creation page. For more information, see [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +If you want to create a {{{ .starter }}} cluster with an additional quota, you can set the monthly spending limit on the cluster creation page. For more information, see [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). After creating a {{{ .starter }}} cluster, you can still check and edit the spending limit on your cluster overview page. For more information, see [Manage Spending Limit for {{{ .starter }}} Clusters](/tidb-cloud/manage-serverless-spend-limit.md). diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md b/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md new file mode 100644 index 0000000000000..3b402d4c6b9f3 --- /dev/null +++ b/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md @@ -0,0 +1,64 @@ +--- +title: Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint +summary: Learn how to connect to your TiDB Cloud cluster via Alibaba Cloud private endpoint. +--- + +# Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint + +This tutorial walks you through the steps to connect to your {{{ .starter }}} or Essential cluster via a private endpoint on Alibaba Cloud. Connecting through a private endpoint allows secure and private communication between your services and your TiDB Cloud cluster without using the public internet. + +> **Tip:** +> +> To learn how to connect to a {{{ .starter }}} or Essential cluster via AWS PrivateLink, see [Connect to TiDB Cloud via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). + +## Restrictions + +- Currently, {{{ .starter }}} and {{{ .essential }}} support private endpoint connections when the endpoint service is hosted on AWS or Alibaba Cloud. If the service is hosted on another cloud provider, the private endpoint is not applicable. +- Private endpoint connection across regions is not supported. + +## Set up a private endpoint with Alibaba Cloud + +To connect to your {{{ .starter }}} or {{{ .essential }}} cluster via a private endpoint, follow these steps: + +1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster) +2. [Create a private endpoint on Alibaba Cloud](#step-2-create-a-private-endpoint-on-alibaba-cloud) +3. [Connect to your TiDB cluster using the private endpoint](#step-3-connect-to-your-tidb-cluster-using-the-private-endpoint) + +### Step 1. Choose a TiDB cluster + +1. On the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, click the name of your target TiDB Cloud cluster to go to its overview page. +2. Click **Connect** in the upper-right corner. A connection dialog is displayed. +3. In the **Connection Type** drop-down list, select **Private Endpoint**. +4. Take a note of **Service Name**, **Availability Zone ID**, and **Region ID**. + +### Step 2. Create a private endpoint on Alibaba Cloud + +To use the Alibaba Cloud Management Console to create a VPC interface endpoint, perform the following steps: + +1. Sign in to the [Alibaba Cloud Management Console](https://account.alibabacloud.com/login/login.htm). +2. Navigate to **VPC** > **Endpoints**. +3. Under the **Interface Endpoints** tab, click **Create Endpoint**. +4. Fill out the endpoint information: + - **Region**: select the same region as your TiDB Cloud cluster. + - **Endpoint Name**: choose a name for the endpoint. + - **Endpoint Type**: select **Interface Endpoint**. + - **Endpoint Service**: select **Other Endpoint Services**. + +5. Paste the **Endpoint Service Name** you copied from TiDB Cloud. +6. Click **Verify**. A green check will appear if the service is valid. +7. Choose the **VPC**, **Security Group**, and **Zone** to use for the endpoint. +8. Click **OK** to create the endpoint. +9. Wait for the endpoint status to become **Active** and the connection status to become **Connected**. + +### Step 3: Connect to your TiDB cluster using the private endpoint + +After you have created the interface endpoint, go back to the TiDB Cloud console and take the following steps: + +1. On the [**Clusters**](https://{{{.console-url}}}/project/clusters) page, click the name of your target cluster to go to its overview page. +2. Click **Connect** in the upper-right corner. A connection dialog is displayed. +3. In the **Connection Type** drop-down list, select **Private Endpoint**. +4. In the **Connect With** drop-down list, select your preferred connection method. The corresponding connection string is displayed at the bottom of the dialog. + + For the host, go to the **Endpoint Details** page in Alibaba Cloud, and copy the **Domain Name of Endpoint Service** as your host. + +5. Connect to your cluster with the connection string. diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-azure.md b/tidb-cloud/set-up-private-endpoint-connections-on-azure.md index e8017b5572273..a8c52bd61624b 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-on-azure.md +++ b/tidb-cloud/set-up-private-endpoint-connections-on-azure.md @@ -11,7 +11,9 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md) -> - To learn how to connect to a {{{ .starter }}} cluster via private endpoint, see [Connect to {{{ .starter }}} via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see the following documents: +> - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) +> - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in an Azure virtual network via [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/private-link-overview), as if the service were in your own virtual network. You can create a private endpoint in your virtual network, and then connect to the TiDB Cloud service via the endpoint with permission. diff --git a/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md b/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md index a1ddddf91c7e1..73a417b7dc654 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md +++ b/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md @@ -11,7 +11,9 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with AWS, see [Connect to a TiDB Cloud Dedicated Cluster via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md). -> - To learn how to connect to a {{{ .starter }}} cluster via private endpoint, see [Connect to {{{ .starter }}} via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, see the following documents: +> - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) +> - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md) TiDB Cloud supports highly secure and one-way access to the TiDB Cloud service hosted in a Google Cloud VPC via [Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect). You can create an endpoint and use it to connect to the TiDB Cloud service . diff --git a/tidb-cloud/set-up-private-endpoint-connections-serverless.md b/tidb-cloud/set-up-private-endpoint-connections-serverless.md index 09357a3c40ac0..affe7d2efd43d 100644 --- a/tidb-cloud/set-up-private-endpoint-connections-serverless.md +++ b/tidb-cloud/set-up-private-endpoint-connections-serverless.md @@ -1,11 +1,11 @@ --- -title: Connect to {{{ .starter }}} via Private Endpoint +title: Connect to {{{ .starter }}} via AWS PrivateLink summary: Learn how to connect to your TiDB Cloud cluster via private endpoint. --- -# Connect to {{{ .starter }}} via Private Endpoint +# Connect to {{{ .starter }}} via AWS PrivateLink -This document describes how to connect to your {{{ .starter }}} cluster via private endpoint. +This document describes how to connect to your {{{ .starter }}} cluster via AWS PrivateLink. > **Tip:** > @@ -28,7 +28,7 @@ For more detailed definitions of the private endpoint and endpoint service, see ## Restrictions -- Currently, TiDB Cloud supports private endpoint connection to {{{ .starter }}} only when the endpoint service is hosted in AWS. If the service is hosted in Google Cloud, the private endpoint is not applicable. +- Currently, TiDB Cloud supports AWS PrivateLink connections to {{{ .starter }}} only when the endpoint service is hosted in AWS. If the service is hosted in other cloud providers, the AWS PrivateLink connection is not applicable. - Private endpoint connection across regions is not supported. ## Prerequisites diff --git a/tidb-cloud/set-up-private-endpoint-connections.md b/tidb-cloud/set-up-private-endpoint-connections.md index 9945cdf5568cf..f9b8197ffd18e 100644 --- a/tidb-cloud/set-up-private-endpoint-connections.md +++ b/tidb-cloud/set-up-private-endpoint-connections.md @@ -9,7 +9,7 @@ This document describes how to connect to your TiDB Cloud Dedicated cluster via > **Tip:** > -> - To learn how to connect to a {{{ .starter }}} cluster via private endpoint, see [Connect to {{{ .starter }}} via Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). +> - To learn how to connect to a {{{ .starter }}} cluster via AWS PrivateLink, see [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Azure, see [Connect to a TiDB Cloud Dedicated Cluster via Azure Private Link](/tidb-cloud/set-up-private-endpoint-connections-on-azure.md). > - To learn how to connect to a TiDB Cloud Dedicated cluster via private endpoint with Google Cloud, see [Connect to a TiDB Cloud Dedicated Cluster via Google Cloud Private Service Connect](/tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md). diff --git a/tidb-cloud/set-up-vpc-peering-connections.md b/tidb-cloud/set-up-vpc-peering-connections.md index b10cda279eaa7..36ec6f028b422 100644 --- a/tidb-cloud/set-up-vpc-peering-connections.md +++ b/tidb-cloud/set-up-vpc-peering-connections.md @@ -7,7 +7,7 @@ summary: Learn how to connect to TiDB Cloud Dedicated via VPC peering. > **Note:** > -> VPC peering connection is only available for TiDB Cloud Dedicated clusters hosted on AWS and Google Cloud. You cannot use VPC peering to connect to [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters hosted on Azure and [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +> VPC peering connection is only available for TiDB Cloud Dedicated clusters hosted on AWS and Google Cloud. To connect your application to TiDB Cloud via VPC peering, you need to set up [VPC peering](/tidb-cloud/tidb-cloud-glossary.md#vpc-peering) with TiDB Cloud. This document walks you through setting up VPC peering connections [on AWS](#set-up-vpc-peering-on-aws) and [on Google Cloud](#set-up-vpc-peering-on-google-cloud) and connecting to TiDB Cloud via a VPC peering. diff --git a/tidb-cloud/size-your-cluster.md b/tidb-cloud/size-your-cluster.md index f18753f2b6d34..6373fd2d83bdb 100644 --- a/tidb-cloud/size-your-cluster.md +++ b/tidb-cloud/size-your-cluster.md @@ -9,7 +9,7 @@ This document describes how to determine the size of a TiDB Cloud Dedicated clus > **Note:** > -> You cannot change the size of a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster. +> You cannot change the size of a {{{ .starter }}} or {{{ .essential }}} cluster. ## Size TiDB diff --git a/tidb-cloud/starter/_index.md b/tidb-cloud/starter/_index.md new file mode 100644 index 0000000000000..969c5fa9e31f3 --- /dev/null +++ b/tidb-cloud/starter/_index.md @@ -0,0 +1,140 @@ +--- +title: TiDB Cloud Documentation +hide_sidebar: true +hide_commit: true +summary: TiDB Cloud is a fully-managed Database-as-a-Service (DBaaS) that brings everything great about TiDB to your cloud. It offers guides, samples, and references for learning, trying, developing, maintaining, migrating, monitoring, tuning, securing, billing, integrating, and referencing. +--- + + + + + +[Why TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-intro/?plan=starter) + +[Key Concepts](https://docs.pingcap.com/tidbcloud/key-concepts/?plan=starter) + +[FAQ](https://docs.pingcap.com/tidbcloud/tidb-cloud-faq/?plan=starter) + + + + + +[Try Out TiDB Cloud](https://docs.pingcap.com/tidbcloud/tidb-cloud-quickstart/?plan=starter) + +[Try Out TiDB + AI](https://docs.pingcap.com/tidbcloud/vector-search-get-started-using-python/?plan=starter) + +[Try Out HTAP](https://docs.pingcap.com/tidbcloud/tidb-cloud-htap-quickstart/?plan=starter) + +[Try Out TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=starter) + + + + + +[Developer Guide Overview](https://docs.pingcap.com/tidbcloud/dev-guide-overview/?plan=starter) + +[Quick Start](https://docs.pingcap.com/tidbcloud/dev-guide-build-cluster-in-cloud/?plan=starter) + +[Example Application](https://docs.pingcap.com/tidbcloud/dev-guide-sample-application-spring-boot/?plan=starter) + + + + + +[Create a Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster-serverless/?plan=starter) + +[Connect to a Cluster](https://docs.pingcap.com/tidbcloud/connect-to-tidb-cluster-serverless/?plan=starter) + +[Use an HTAP Cluster](https://docs.pingcap.com/tidbcloud/tiflash-overview/?plan=starter) + +[Back Up and Restore Data](https://docs.pingcap.com/tidbcloud/backup-and-restore-serverless/?plan=starter) + +[Use API (Beta)](https://docs.pingcap.com/tidbcloud/api-overview/?plan=starter) + +[Use TiDB Cloud CLI](https://docs.pingcap.com/tidbcloud/get-started-with-cli/?plan=starter) + + + + + +[From Amazon RDS for Oracle](https://docs.pingcap.com/tidbcloud/migrate-from-oracle-using-aws-dms/?plan=starter) + +[Import Sample Data](https://docs.pingcap.com/tidbcloud/import-sample-data-serverless/?plan=starter) + +[Import CSV Files](https://docs.pingcap.com/tidbcloud/import-csv-files-serverless/?plan=starter) + +[Import Parquet Files](https://docs.pingcap.com/tidbcloud/import-parquet-files-serverless/?plan=starter) + +[With MySQL CLI](https://docs.pingcap.com/tidbcloud/import-with-mysql-cli-serverless/?plan=starter) + + + + + +[Status and Metrics](https://docs.pingcap.com/tidbcloud/monitor-tidb-cluster/?plan=starter) + +[Built-in Monitoring](https://docs.pingcap.com/tidbcloud/built-in-monitoring/?plan=starter) + + + + + +[Tuning Overview](https://docs.pingcap.com/tidbcloud/tidb-cloud-tune-performance-overview/?plan=starter) + +[Analyze Performance](https://docs.pingcap.com/tidbcloud/tune-performance/?plan=starter) + +[Tune SQL Performance](https://docs.pingcap.com/tidbcloud/tidb-cloud-sql-tuning-overview/?plan=starter) + +[Tune TiFlash Performance](https://docs.pingcap.com/tidbcloud/tune-tiflash-performance/?plan=starter) + + + + + +[Password Authentication](https://docs.pingcap.com/tidbcloud/tidb-cloud-password-authentication/?plan=starter) + +[User Roles](https://docs.pingcap.com/tidbcloud/manage-user-access#user-roles/?plan=starter) + +[Manage User Profiles](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-user-profiles/?plan=starter) + +[Manage organization access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-organization-access/?plan=starter) + +[Manage project access](https://docs.pingcap.com/tidbcloud/manage-user-access#manage-project-access/?plan=starter) + +[Configure Firewall Rules for Public Endpoints](https://docs.pingcap.com/tidbcloud/configure-serverless-firewall-rules-for-public-endpoints/?plan=starter) + + + + + +[Pricing](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#pricing-for-starter/?plan=starter) + +[Invoices](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#invoices/?plan=starter) + +[Credits](https://docs.pingcap.com/tidbcloud/tidb-cloud-billing#credits/?plan=starter) + + + + + +[Airbyte](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-airbyte/?plan=starter) + +[Zapier](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-zapier/?plan=starter) + +[Vercel](https://docs.pingcap.com/tidbcloud/integrate-tidbcloud-with-vercel/?plan=starter) + +[Terraform](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview/?plan=starter) + +[Amazon AppFlow](https://docs.pingcap.com/tidbcloud/dev-guide-aws-appflow-integration/?plan=starter) + + + + + +[SQL Reference](https://docs.pingcap.com/tidbcloud/basic-sql-operations/?plan=starter) + +[System Variables](https://docs.pingcap.com/tidbcloud/system-variables/?plan=starter) + + + + diff --git a/tidb-cloud/terraform-get-tidbcloud-provider.md b/tidb-cloud/terraform-get-tidbcloud-provider.md index b695d0c443372..519569464ea0c 100644 --- a/tidb-cloud/terraform-get-tidbcloud-provider.md +++ b/tidb-cloud/terraform-get-tidbcloud-provider.md @@ -126,4 +126,4 @@ Setting `sync` to `true` is recommended, but note that `sync` currently only wor ## Next step -Get started by managing a cluster with the [cluster resource](/tidb-cloud/terraform-use-cluster-resource.md). +Get started by managing a cluster with the [`tidbcloud_serverless_cluster`](/tidb-cloud/terraform-use-serverless-cluster-resource.md) or [`tidbcloud_dedicated_cluster`](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) resource. diff --git a/tidb-cloud/terraform-migrate-cluster-resource.md b/tidb-cloud/terraform-migrate-cluster-resource.md index f8e924f3d24b0..e75ed715e1a4e 100644 --- a/tidb-cloud/terraform-migrate-cluster-resource.md +++ b/tidb-cloud/terraform-migrate-cluster-resource.md @@ -41,7 +41,7 @@ terraform state rm ${your_target_cluster_resource} In your `.tf` file, find the configuration of your target cluster resource and delete the corresponding code. -## Step 4. Add an import block for the new serverless or dedicated cluster resource +## Step 4. Add an import block for the new cluster resource - If your target cluster is {{{ .starter }}}, add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the cluster ID you get from [Step 1](#step-1-identify-the-tidbcloud_cluster-resource-to-migrate): diff --git a/tidb-cloud/terraform-tidbcloud-provider-overview.md b/tidb-cloud/terraform-tidbcloud-provider-overview.md index b248bf10ac2d8..3c6128d285529 100644 --- a/tidb-cloud/terraform-tidbcloud-provider-overview.md +++ b/tidb-cloud/terraform-tidbcloud-provider-overview.md @@ -50,6 +50,7 @@ To get all the available configurations for the resources and data sources, see - [Learn more about Terraform](https://www.terraform.io/docs) - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) -- [Use Cluster Resource](/tidb-cloud/terraform-use-cluster-resource.md) -- [Use Backup Resource](/tidb-cloud/terraform-use-backup-resource.md) -- [Use Restore Resource](/tidb-cloud/terraform-use-restore-resource.md) \ No newline at end of file +- [Use the `tidbcloud_serverless_cluster` Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md) +- [Use the `tidbcloud_dedicated_cluster` Resource](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) +- [Use the `tidbcloud_backup` Resource](/tidb-cloud/terraform-use-backup-resource.md) +- [Use the `tidbcloud_restore` Resource](/tidb-cloud/terraform-use-restore-resource.md) \ No newline at end of file diff --git a/tidb-cloud/terraform-use-backup-resource.md b/tidb-cloud/terraform-use-backup-resource.md index eb4c28025016d..5ba7c3c9d9539 100644 --- a/tidb-cloud/terraform-use-backup-resource.md +++ b/tidb-cloud/terraform-use-backup-resource.md @@ -1,9 +1,9 @@ --- -title: Use Backup Resource -summary: Learn how to create a backup of a TiDB Cloud cluster using the backup resource. +title: Use the `tidbcloud_backup` Resource +summary: Learn how to create a backup of a TiDB Cloud cluster using the `tidbcloud_backup` resource. --- -# Use Backup Resource +# Use the `tidbcloud_backup` Resource You can learn how to create a backup of a TiDB Cloud cluster with the `tidbcloud_backup` resource in this document. @@ -15,9 +15,9 @@ The features of the `tidbcloud_backup` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature is unavailable to {{{ .starter }}} clusters. To use backup resources, make sure that you have created a TiDB Cloud Dedicated cluster. +- The backup and restore feature introduced in this document is unavailable to {{{ .starter }}} or {{{ .essential }}} clusters. To use `tidbcloud_backup` resources, make sure that you have created a TiDB Cloud Dedicated cluster. -## Create a backup with the backup resource +## Create a backup with the `tidbcloud_backup` resource 1. Create a directory for the backup and enter it. @@ -48,7 +48,7 @@ The features of the `tidbcloud_backup` resource include the following: You need to replace resource values (such as project ID and cluster ID) in the file with your own. - If you have maintained a cluster resource (for example, `example_cluster`) using Terraform, you can also configure the backup resource as follows, without specifying the actual project ID and cluster ID. + If you have maintained a cluster resource (for example, `example_cluster`) using Terraform, you can also configure the `tidbcloud_backup` resource as follows, without specifying the actual project ID and cluster ID. ``` resource "tidbcloud_backup" "example_backup" { @@ -147,7 +147,7 @@ The features of the `tidbcloud_backup` resource include the following: When the status turns to `SUCCESS`, it indicates that you have created a backup for your cluster. Pay attention that the backup cannot be updated after the creation. -Now, you have created a backup for the cluster. If you want to use the backup to restore the cluster, you can [use the restore resources](/tidb-cloud/terraform-use-restore-resource.md). +Now, you have created a backup for the cluster. If you want to use the backup to restore the cluster, you can [use the `tidbcloud_restore` resource](/tidb-cloud/terraform-use-restore-resource.md). ## Update a backup @@ -155,7 +155,7 @@ Backups cannot be updated. ## Delete a backup -To delete a backup, go to the backup directory where the corresponding `backup.tf` file is located, and then run the `terraform destroy` command to destroy the backup resource. +To delete a backup, go to the backup directory where the corresponding `backup.tf` file is located, and then run the `terraform destroy` command to destroy the `tidbcloud_backup` resource. ``` $ terraform destroy diff --git a/tidb-cloud/terraform-use-cluster-resource.md b/tidb-cloud/terraform-use-cluster-resource.md index 530fcb5940693..dda82b82dba80 100644 --- a/tidb-cloud/terraform-use-cluster-resource.md +++ b/tidb-cloud/terraform-use-cluster-resource.md @@ -1,13 +1,13 @@ --- -title: Use Cluster Resource (Deprecated) +title: Use the `tidbcloud_cluster` Resource (Deprecated) summary: Learn how to use the cluster resource to create and modify a TiDB Cloud cluster. --- -# Use Cluster Resource (Deprecated) +# Use the `tidbcloud_cluster` Resource (Deprecated) > **Warning:** > -> Starting from [TiDB Cloud Terraform Provider](https://registry.terraform.io/providers/tidbcloud/tidbcloud) v0.4.0, the `tidbcloud_cluster` resource is deprecated. It is recommended to use the `tidbcloud_dedicated_cluster` or `tidbcloud_serverless_cluster` resource instead. For more information, see [Use TiDB Cloud Dedicated Cluster Resource](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) or [Use {{{ .starter }}} Cluster Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md). +> Starting from [TiDB Cloud Terraform Provider](https://registry.terraform.io/providers/tidbcloud/tidbcloud) v0.4.0, the `tidbcloud_cluster` resource is deprecated. It is recommended to use the `tidbcloud_dedicated_cluster` or `tidbcloud_serverless_cluster` resource instead. For more information, see [Use the `tidbcloud_dedicated_cluster` Resource](/tidb-cloud/terraform-use-dedicated-cluster-resource.md) or [Use the `tidbcloud_serverless_cluster` Resource](/tidb-cloud/terraform-use-serverless-cluster-resource.md). You can learn how to manage a TiDB Cloud cluster with the `tidbcloud_cluster` resource in this document. @@ -834,13 +834,13 @@ You can pause a cluster when its status is `AVAILABLE` or resume a cluster when 6. Wait for a moment, then use the `terraform refersh` command to update the state. The status will be changed to `AVAILABLE` finally. -Now, you have created and managed a TiDB Cloud Dedicated cluster with Terraform. Next, you can try creating a backup of the cluster by our [backup resource](/tidb-cloud/terraform-use-backup-resource.md). +Now, you have created and managed a TiDB Cloud Dedicated cluster with Terraform. Next, you can try creating a backup of the cluster by the [`tidbcloud_backup`](/tidb-cloud/terraform-use-backup-resource.md) resource. ## Import a cluster For a TiDB cluster that is not managed by Terraform, you can use Terraform to manage it just by importing it. -For example, you can import a cluster that is not created by Terraform or import a cluster that is [created with the restore resource](/tidb-cloud/terraform-use-restore-resource.md#create-a-restore-task). +For example, you can import a cluster that is not created by Terraform or import a cluster that is [created with the `tidbcloud_restore` resource](/tidb-cloud/terraform-use-restore-resource.md#create-a-restore-task). 1. Create a `import_cluster.tf` file as follows: diff --git a/tidb-cloud/terraform-use-dedicated-cluster-resource.md b/tidb-cloud/terraform-use-dedicated-cluster-resource.md index fba189d1217c4..0705221a9b44e 100644 --- a/tidb-cloud/terraform-use-dedicated-cluster-resource.md +++ b/tidb-cloud/terraform-use-dedicated-cluster-resource.md @@ -1,9 +1,9 @@ --- -title: Use TiDB Cloud Dedicated Cluster Resource -summary: Learn how to use the TiDB Cloud Dedicated cluster resource to create and modify a TiDB Cloud Dedicated cluster. +title: Use the `tidbcloud_dedicated_cluster` Resource +summary: Learn how to use the `tidbcloud_dedicated_cluster` resource to create and modify a TiDB Cloud Dedicated cluster. --- -# Use TiDB Cloud Dedicated Cluster Resource +# Use the `tidbcloud_dedicated_cluster` Resource This document describes how to manage a [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster with the `tidbcloud_dedicated_cluster` resource. @@ -166,7 +166,7 @@ You can create a TiDB Cloud Dedicated cluster using the `tidbcloud_dedicated_clu Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the TiDB Cloud Dedicated cluster resource, set the resource type as `tidbcloud_dedicated_cluster`. + - To use the `tidbcloud_dedicated_cluster` resource, set the resource type as `tidbcloud_dedicated_cluster`. - For the resource name, you can define it as needed. For example, `example_cluster`. - For the resource details, you can configure them according to the Project ID and the TiDB Cloud Dedicated cluster specification information. - To get the TiDB Cloud Dedicated cluster specification information, see [tidbcloud_dedicated_cluster (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/dedicated_cluster). @@ -1054,7 +1054,7 @@ For a TiDB cluster that is not managed by Terraform, you can use Terraform to ma Import a cluster that is not created by Terraform as follows: -1. Add an import block for the new TiDB Cloud Dedicated cluster resource. +1. Add an import block for the new `tidbcloud_dedicated_cluster` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the cluster ID: @@ -1067,7 +1067,7 @@ Import a cluster that is not created by Terraform as follows: 2. Generate the new configuration file. - Generate the new configuration file for the new TiDB Cloud Dedicated cluster resource according to the import block: + Generate the new configuration file for the new `tidbcloud_dedicated_cluster` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-dedicated-network-container-resource.md b/tidb-cloud/terraform-use-dedicated-network-container-resource.md index 062f55ba35c17..d35361f026515 100644 --- a/tidb-cloud/terraform-use-dedicated-network-container-resource.md +++ b/tidb-cloud/terraform-use-dedicated-network-container-resource.md @@ -1,9 +1,9 @@ --- -title: Use TiDB Cloud Dedicated Network Container Resource -summary: Learn how to use the TiDB Cloud Dedicated network container resource to create and modify a TiDB Cloud Dedicated network container. +title: Use the `tidbcloud_dedicated_network_container` Resource +summary: Learn how to use the `tidbcloud_dedicated_network_container` resource to create and modify a TiDB Cloud Dedicated network container. --- -# Use TiDB Cloud Dedicated Network Container Resource +# Use the `tidbcloud_dedicated_network_container` Resource This document describes how to manage a [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) network container using the `tidbcloud_dedicated_network_container` resource. @@ -58,7 +58,7 @@ The following example shows how to create a TiDB Cloud Dedicated network contain Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the TiDB Cloud Dedicated network container resource, set the resource type as `tidbcloud_dedicated_network_container`. + - To use the `tidbcloud_dedicated_network_container` resource, set the resource type as `tidbcloud_dedicated_network_container`. - For the resource name, you can define it as needed, for example, `example`. - If you do not know how to get the values of the required arguments, see [Set a CIDR for a Region](/tidb-cloud/set-up-vpc-peering-connections.md#prerequisite-set-a-cidr-for-a-region). - For more information about the TiDB Cloud Dedicated network container specification, see [tidbcloud_dedicated_network_container (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/dedicated_network_container). @@ -142,7 +142,7 @@ For a TiDB Cloud Dedicated network container that is not managed by Terraform, y For example, you can import a network container that is not created by Terraform. -1. Add an import block for the new TiDB Cloud Dedicated network container resource. +1. Add an import block for the new `tidbcloud_dedicated_network_container` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,network_container_id`: @@ -155,7 +155,7 @@ For example, you can import a network container that is not created by Terraform 2. Generate the new configuration file. - Generate the new configuration file for the new TiDB Cloud Dedicated network container resource according to the import block: + Generate the new configuration file for the new `tidbcloud_dedicated_network_container` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md b/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md index 8e34ffefcb7a9..19fe6c2cca0ff 100644 --- a/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md +++ b/tidb-cloud/terraform-use-dedicated-private-endpoint-connection-resource.md @@ -1,9 +1,9 @@ --- -title: Use TiDB Cloud Dedicated Private Endpoint Connection Resource -summary: Learn how to use the TiDB Cloud Dedicated private endpoint connection resource to create and modify a TiDB Cloud Dedicated private endpoint connection. +title: Use `tidbcloud_dedicated_private_endpoint_connection` Resource +summary: Learn how to use the `tidbcloud_dedicated_private_endpoint_connection` resource to create and modify a TiDB Cloud Dedicated private endpoint connection. --- -# Use TiDB Cloud Dedicated Private Endpoint Connection Resource +# Use the `tidbcloud_dedicated_private_endpoint_connection` Resource This document describes how to manage a [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) private endpoint connection using the `tidbcloud_dedicated_private_endpoint_connection` resource. @@ -15,7 +15,7 @@ The features of the `tidbcloud_dedicated_private_endpoint_connection` resource i > **Note:** > -> TiDB Cloud Dedicated private endpoint connection resource cannot be modified. If you want to modify a TiDB Cloud Dedicated private endpoint connection, you need to delete the existing one, and then create a new one. +> The `tidbcloud_dedicated_private_endpoint_connection` resource cannot be modified. If you want to modify a TiDB Cloud Dedicated private endpoint connection, you need to delete the existing one, and then create a new one. ## Prerequisites @@ -55,7 +55,7 @@ The following example shows how to create a TiDB Cloud Dedicated private endpoin Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the TiDB Cloud Dedicated private endpoint connection resource, set the resource type as `tidbcloud_dedicated_private_endpoint_connection`. + - To use the `tidbcloud_dedicated_private_endpoint_connection` resource, set the resource type as `tidbcloud_dedicated_private_endpoint_connection`. - For the resource name, you can define it as needed. For example, `example`. - If you do not know how to get the values of the required arguments, see [Connect to a TiDB Cloud Dedicated Cluster via Private Endpoint with AWS](/tidb-cloud/set-up-private-endpoint-connections.md). - To get the TiDB Cloud Dedicated private endpoint connection specification information, see [tidbcloud_private_endpoint_connection (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/dedicated_private_endpoint_connection). @@ -148,7 +148,7 @@ The following example shows how to create a TiDB Cloud Dedicated private endpoin For a TiDB Cloud Dedicated private endpoint connection that is not managed by Terraform, you can start managing it with Terraform by importing it. -1. Add an import block for the new TiDB Cloud Dedicated private endpoint connection resource. +1. Add an import block for the new `tidbcloud_dedicated_private_endpoint_connection` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,dedicated_private_endpoint_connection_id`: @@ -161,7 +161,7 @@ For a TiDB Cloud Dedicated private endpoint connection that is not managed by Te 2. Generate the new configuration file. - Generate the new configuration file for the new TiDB Cloud Dedicated private endpoint connection resource according to the import block: + Generate the new configuration file for the new `tidbcloud_dedicated_private_endpoint_connection` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md b/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md index a0c9b5de2e366..726055a69338a 100644 --- a/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md +++ b/tidb-cloud/terraform-use-dedicated-vpc-peering-resource.md @@ -1,9 +1,9 @@ --- -title: Use TiDB Cloud Dedicated VPC Peering Resource -summary: Learn how to use the TiDB Cloud Dedicated VPC peering resource to create and modify a TiDB Cloud Dedicated VPC peering. +title: Use the `tidbcloud_dedicated_vpc_peering` Resource +summary: Learn how to use the `tidbcloud_dedicated_vpc_peering` resource to create and modify a TiDB Cloud Dedicated VPC peering. --- -# Use TiDB Cloud Dedicated VPC Peering Resource +# Use the `tidbcloud_dedicated_vpc_peering` Resource This document describes how to manage a [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) VPC peering with the `tidbcloud_dedicated_vpc_peering` resource. @@ -15,7 +15,7 @@ The features of the `tidbcloud_dedicated_vpc_peering` resource include the follo > **Note:** > -> TiDB Cloud Dedicated VPC peering resource cannot be modified. If you want to change the configuration of a TiDB Cloud Dedicated VPC peering, you need to delete the existing one, and then create a new one. +> The `tidbcloud_dedicated_vpc_peering` resource cannot be modified. If you want to change the configuration of a TiDB Cloud Dedicated VPC peering, you need to delete the existing one, and then create a new one. ## Prerequisites @@ -56,7 +56,7 @@ The following example shows how to create a TiDB Cloud Dedicated VPC peering. Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the TiDB Cloud Dedicated VPC peering resource, set the resource type as `tidbcloud_dedicated_vpc_peering`. + - To use the `tidbcloud_dedicated_vpc_peering` resource, set the resource type as `tidbcloud_dedicated_vpc_peering`. - For the resource name, you can define it as needed. For example, `example`. - If you do not know how to get the values of the required arguments, see [Connect to TiDB Cloud Dedicated via VPC Peering](/tidb-cloud/set-up-vpc-peering-connections.md). - To get the TiDB Cloud Dedicated VPC peering specification information, see [tidbcloud_dedicated_vpc_peering (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/dedicated_vpc_peering). @@ -150,7 +150,7 @@ For a TiDB Cloud Dedicated VPC peering that is not managed by Terraform, you can For example, you can import a VPC peering that is not created by Terraform. -1. Add an import block for the new TiDB Cloud Dedicated VPC peering resource. +1. Add an import block for the new `tidbcloud_dedicated_vpc_peering` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,vpc_peering_id`: @@ -163,7 +163,7 @@ For example, you can import a VPC peering that is not created by Terraform. 2. Generate the new configuration file. - Generate the new configuration file for the new TiDB Cloud Dedicated VPC peering resource according to the import block: + Generate the new configuration file for the new `tidbcloud_dedicated_vpc_peering` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-import-resource.md b/tidb-cloud/terraform-use-import-resource.md index 9de542273d2a0..164008b209e49 100644 --- a/tidb-cloud/terraform-use-import-resource.md +++ b/tidb-cloud/terraform-use-import-resource.md @@ -1,32 +1,34 @@ --- -title: Use Import Resource -summary: Learn how to manage the import task using the import resource. +title: Use the `tidbcloud_import` Resource +summary: Learn how to manage the import task using the `tidbcloud_import` resource. --- -# Use Import Resource +# Use the `tidbcloud_import` Resource You can learn how to import data to a TiDB Cloud cluster with the `tidbcloud_import` resource in this document. The features of the `tidbcloud_import` resource include the following: -- Create import tasks for {{{ .starter }}} and TiDB Cloud Dedicated clusters. +- Create import tasks for TiDB Cloud clusters. - Import data either from local disks or from Amazon S3 buckets. - Cancel ongoing import tasks. ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) or [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). +- Refer to one of the following documents to create a TiDB Cloud cluster: + - [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create and run an import task -You can manage either a local import task or an Amazon S3 import task using the import resource. +You can manage either a local import task or an Amazon S3 import task using the `tidbcloud_import` resource. ### Create and run a local import task > **Note:** > -> Importing local files is supported only for {{{ .starter }}} clusters, not for TiDB Cloud Dedicated clusters. +> Importing local files is supported only for {{{ .starter }}} or {{{ .essential }}} clusters, not for TiDB Cloud Dedicated clusters. 1. Create a CSV file for import. For example: @@ -253,7 +255,7 @@ Import tasks cannot be updated. ## Delete an import task -For Terraform, deleting an import task means canceling the corresponding import resource. +For Terraform, deleting an import task means canceling the corresponding `tidbcloud_import` resource. You cannot cancel a `COMPLETED` import task. Otherwise, you will get a `Delete Error` as in the following example: @@ -298,4 +300,4 @@ Destroy complete! Resources: 1 destroyed. ## Configurations -See [configuration documentation](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/import) to get all the available configurations for the import resource. +See [configuration documentation](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/import) to get all the available configurations for the `tidbcloud_import` resource. diff --git a/tidb-cloud/terraform-use-restore-resource.md b/tidb-cloud/terraform-use-restore-resource.md index ada09c10a1061..22ae8a74f230a 100644 --- a/tidb-cloud/terraform-use-restore-resource.md +++ b/tidb-cloud/terraform-use-restore-resource.md @@ -1,9 +1,9 @@ --- -title: Use Restore Resource -summary: Learn how to use restore resource. +title: Use the `tidbcloud_restore` Resource +summary: Learn how to use the `tidbcloud_restore` resource to create and modify a restore task. --- -# Use Restore Resource +# Use the `tidbcloud_restore` Resource You can learn how to manage a restore task with the `tidbcloud_restore` resource in this document. @@ -14,10 +14,10 @@ The features of the `tidbcloud_restore` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md). -- The backup and restore feature is unavailable for {{{ .starter }}} clusters. To use restore resources, make sure that you have created a TiDB Cloud Dedicated cluster. +- The backup and restore feature introduced in this document is unavailable for {{{ .starter }}} and {{{ .essential }}} clusters. To use `tidbcloud_restore` resources, make sure that you have created a TiDB Cloud Dedicated cluster. ## Create a restore task - + After creating a backup of a cluster, you can restore the cluster by creating a restore task with the `tidbcloud_restore` resource. > **Note:** diff --git a/tidb-cloud/terraform-use-serverless-branch-resource.md b/tidb-cloud/terraform-use-serverless-branch-resource.md index 26c725671c6a2..d55f55194e08d 100644 --- a/tidb-cloud/terraform-use-serverless-branch-resource.md +++ b/tidb-cloud/terraform-use-serverless-branch-resource.md @@ -1,9 +1,9 @@ --- -title: Use {{{ .starter }}} Branch Resource +title: Use `tidbcloud_serverless_branch` Resource summary: Learn how to use the serverless branch resource to create and modify a {{{ .starter }}} branch. --- -# Use {{{ .starter }}} Branch Resource +# Use the `tidbcloud_serverless_branch` Resource This document describes how to manage a [{{{ .starter }}} branch](/tidb-cloud/branch-manage.md) using the `tidbcloud_serverless_branch` resource. @@ -15,7 +15,7 @@ The features of the `tidbcloud_serverless_branch` resource include the following > **Note:** > -> {{{ .starter }}} branch resource cannot be modified. If you want to change the configuration of a serverless branch resource, you need to delete the existing one and create a new one. +> The `tidbcloud_serverless_branch` resource cannot be modified. If you want to change the configuration of a serverless branch resource, you need to delete the existing one and create a new one. ## Prerequisites @@ -164,7 +164,7 @@ For a {{{ .starter }}} branch that is not managed by Terraform, you can use Terr Import a {{{ .starter }}} branch that is not created by Terraform as follows: -1. Add an import block for the new {{{ .starter }}} branch resource. +1. Add an import block for the new `tidbcloud_serverless_branch` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,branch_id`: @@ -177,7 +177,7 @@ Import a {{{ .starter }}} branch that is not created by Terraform as follows: 2. Generate the new configuration file. - Generate the new configuration file for the new {{{ .starter }}} branch resource according to the import block: + Generate the new configuration file for the new `tidbcloud_serverless_branch` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-serverless-cluster-resource.md b/tidb-cloud/terraform-use-serverless-cluster-resource.md index 7573ab804f98a..1394c6656d62a 100644 --- a/tidb-cloud/terraform-use-serverless-cluster-resource.md +++ b/tidb-cloud/terraform-use-serverless-cluster-resource.md @@ -1,9 +1,9 @@ --- -title: Use {{{ .starter }}} Cluster Resource -summary: Learn how to use the {{{ .starter }}} cluster resource to create and modify a {{{ .starter }}} cluster. +title: Use the `tidbcloud_serverless_cluster` Resource +summary: Learn how to use the `tidbcloud_serverless_cluster` resource to create and modify a {{{ .starter }}} cluster. --- -# Use {{{ .starter }}} Cluster Resource +# Use the `tidbcloud_serverless_cluster` Resource This document describes how to manage a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) cluster with the `tidbcloud_serverless_cluster` resource. @@ -157,7 +157,7 @@ The following example shows how to create a {{{ .starter }}} cluster. Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the {{{ .starter }}} cluster resource, set the resource type as `tidbcloud_serverless_cluster`. + - To use the `tidbcloud_serverless_cluster` resource, set the resource type as `tidbcloud_serverless_cluster`. - For the resource name, you can define it as needed. For example, `example`. - For the resource details, you can configure them according to the Project ID and the {{{ .starter }}} cluster specification information. - To get the {{{ .starter }}} cluster specification information, see [tidbcloud_serverless_cluster (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/serverless_cluster). @@ -424,7 +424,7 @@ For a {{{ .starter }}} cluster that is not managed by Terraform, you can use Ter Import a {{{ .starter }}} cluster that is not created by Terraform as follows: -1. Add an import block for the new {{{ .starter }}} cluster resource. +1. Add an import block for the new `tidbcloud_serverless_cluster` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the cluster ID: @@ -437,7 +437,7 @@ Import a {{{ .starter }}} cluster that is not created by Terraform as follows: 2. Generate the new configuration file. - Generate the new configuration file for the new {{{ .starter }}} cluster resource according to the import block: + Generate the new configuration file for the new `tidbcloud_serverless_cluster` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf diff --git a/tidb-cloud/terraform-use-serverless-export-resource.md b/tidb-cloud/terraform-use-serverless-export-resource.md index 5df39a5e5e801..eb42ce74084bc 100644 --- a/tidb-cloud/terraform-use-serverless-export-resource.md +++ b/tidb-cloud/terraform-use-serverless-export-resource.md @@ -1,9 +1,9 @@ --- -title: Use {{{ .starter }}} Export Resource -summary: Learn how to use the {{{ .starter }}} export resource to create and modify a {{{ .starter }}} export task. +title: Use `tidbcloud_serverless_export` Resource +summary: Learn how to use the `tidbcloud_serverless_export` resource to create and modify a {{{ .starter }}} export task. --- -# Use {{{ .starter }}} Export Resource +# Use `tidbcloud_serverless_export` Resource This document describes how to manage a [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) data export task using the `tidbcloud_serverless_export` resource. @@ -15,7 +15,7 @@ The features of the `tidbcloud_serverless_export` resource include the following > **Note:** > -> {{{ .starter }}} export resource cannot be modified. If you want to change the configuration of a {{{ .starter }}} export resource, you need to delete the existing one, and then create a new one. +> The `tidbcloud_serverless_export` resource cannot be modified. If you want to change the configuration of the `tidbcloud_serverless_export` resource, you need to delete the existing one, and then create a new one. ## Prerequisites @@ -144,11 +144,11 @@ The following example shows how to create a {{{ .starter }}} data export task. ## Import a {{{ .starter }}} data export task -For a TiDB Serverless data export task that is not managed by Terraform, you can use Terraform to manage it just by importing it. +For a {{{ .starter }}} data export task that is not managed by Terraform, you can use Terraform to manage it just by importing it. Import a {{{ .starter }}} data export task that is not created by Terraform as follows: -1. Add an import block for the new {{{ .starter }}} export resource. +1. Add an import block for the new `tidbcloud_serverless_export` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,export_id`: diff --git a/tidb-cloud/terraform-use-sql-user-resource.md b/tidb-cloud/terraform-use-sql-user-resource.md index 9f6eb087ff08f..4cfea3afeaba8 100644 --- a/tidb-cloud/terraform-use-sql-user-resource.md +++ b/tidb-cloud/terraform-use-sql-user-resource.md @@ -1,9 +1,9 @@ --- -title: Use SQL User Resource -summary: Learn how to use the SQL user resource to create and modify a TiDB Cloud SQL user. +title: Use the `tidbcloud_sql_user` Resource +summary: Learn how to use the `tidbcloud_sql_user` resource to create and modify a TiDB Cloud SQL user. --- -# Use SQL User Resource +# Use the `tidbcloud_sql_user` Resource This document describes how to manage TiDB Cloud SQL users using the `tidbcloud_sql_user` resource. @@ -17,7 +17,9 @@ The features of the `tidbcloud_sql_user` resource include the following: ## Prerequisites - [Get TiDB Cloud Terraform Provider](/tidb-cloud/terraform-get-tidbcloud-provider.md) v0.4.0 or later. -- [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) or [a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md). +- Refer to one of the following documents to create a TiDB Cloud cluster: + - [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) + - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). ## Create a SQL user @@ -53,9 +55,9 @@ The following example shows how to create a TiDB Cloud SQL user. Use the `resource` block to define the resource of TiDB Cloud, including the resource type, resource name, and resource details. - - To use the SQL user resource, set the resource type as `tidbcloud_sql_user`. + - To use the `tidbcloud_sql_user` resource, set the resource type as `tidbcloud_sql_user`. - For the resource name, you can define it as needed. For example, `example`. - - For SQL users in the {{{ .starter }}} cluster, the `user_name` and builtin role `role_readonly` and `role_readwrite` must start with the user prefix, you can get the user prefix by running the `tidbcloud_serverless_cluster` data source. + - For SQL users in the {{{ .starter }}} or {{{ .essential }}} cluster, the `user_name` and builtin role `role_readonly` and `role_readwrite` must start with the user prefix, you can get the user prefix by running the `tidbcloud_serverless_cluster` data source. - To get the SQL user specification information, see [`tidbcloud_sql_user` (Resource)](https://registry.terraform.io/providers/tidbcloud/tidbcloud/latest/docs/resources/sql_user). 3. Run the `terraform apply` command. It is not recommended to use `terraform apply --auto-approve` when you apply a resource. @@ -201,7 +203,7 @@ For a TiDB Cloud SQL user that is not managed by Terraform, you can use Terrafor For example, you can import a SQL user that is not created by Terraform as follows: -1. Add an import block for the new SQL user resource +1. Add an import block for the new `tidbcloud_sql_user` resource. Add the following import block to your `.tf` file, replace `example` with a desired resource name, and replace `${id}` with the format of `cluster_id,user_name`: @@ -212,9 +214,9 @@ For example, you can import a SQL user that is not created by Terraform as follo } ``` -2. Generate the new configuration file +2. Generate the new configuration file. - Generate the new configuration file for the new SQL user resource according to the import block: + Generate the new configuration file for the new `tidbcloud_sql_user` resource according to the import block: ```shell terraform plan -generate-config-out=generated.tf @@ -224,7 +226,7 @@ For example, you can import a SQL user that is not created by Terraform as follo Then the `generated.tf` file is created in the current directory, which contains the configuration of the imported resource. But the provider will throw an error because the required argument `password` is not set. You can replace the value of `password` argument to the `tidbcloud_sql_user` resource in the generated configuration file. -3. Review and apply the generated configuration +3. Review and apply the generated configuration. Review the generated configuration file to ensure that it meets your needs. Optionally, you can move the contents of this file to your preferred location. diff --git a/tidb-cloud/ticloud-auditlog-config.md b/tidb-cloud/ticloud-auditlog-config.md index 7f870f432682a..2b2c88d0abd80 100644 --- a/tidb-cloud/ticloud-auditlog-config.md +++ b/tidb-cloud/ticloud-auditlog-config.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log config`. # ticloud serverless audit-log config -Configure the database audit logging for a {{{ .starter }}} cluster. +Configure the database audit logging for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log config [flags] diff --git a/tidb-cloud/ticloud-auditlog-describe.md b/tidb-cloud/ticloud-auditlog-describe.md index 188eeeffb79ed..34fed7e537a89 100644 --- a/tidb-cloud/ticloud-auditlog-describe.md +++ b/tidb-cloud/ticloud-auditlog-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log describe`. # ticloud serverless audit-log describe -Describe the database audit logging configuration for a {{{ .starter }}} cluster. +Describe the database audit logging configuration for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log describe [flags] diff --git a/tidb-cloud/ticloud-auditlog-download.md b/tidb-cloud/ticloud-auditlog-download.md index 5501c96048a38..9ac6a5f522938 100644 --- a/tidb-cloud/ticloud-auditlog-download.md +++ b/tidb-cloud/ticloud-auditlog-download.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log download`. # ticloud serverless audit-log download -Download the database audit logs from a {{{ .starter }}} cluster. +Download the database audit logs from a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log download [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-create.md b/tidb-cloud/ticloud-auditlog-filter-create.md index d0327e83ebb44..f52e858b1a8c0 100644 --- a/tidb-cloud/ticloud-auditlog-filter-create.md +++ b/tidb-cloud/ticloud-auditlog-filter-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule create`. # ticloud serverless audit-log filter-rule create -Create an audit log filter rule for a {{{ .starter }}} cluster. +Create an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule create [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-delete.md b/tidb-cloud/ticloud-auditlog-filter-delete.md index acb9a312dd6b4..62c84224a68ff 100644 --- a/tidb-cloud/ticloud-auditlog-filter-delete.md +++ b/tidb-cloud/ticloud-auditlog-filter-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule delete`. # ticloud serverless audit-log filter-rule delete -Delete an audit log filter rule for a {{{ .starter }}} cluster. +Delete an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule delete [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-describe.md b/tidb-cloud/ticloud-auditlog-filter-describe.md index 3d70cf1f01b8a..583a8c54bab95 100644 --- a/tidb-cloud/ticloud-auditlog-filter-describe.md +++ b/tidb-cloud/ticloud-auditlog-filter-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule describe`. # ticloud serverless audit-log filter-rule describe -Describe an audit log filter rule for a {{{ .starter }}} cluster. +Describe an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule describe [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-list.md b/tidb-cloud/ticloud-auditlog-filter-list.md index c5b0a20fd9abd..a56588e260cea 100644 --- a/tidb-cloud/ticloud-auditlog-filter-list.md +++ b/tidb-cloud/ticloud-auditlog-filter-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule list`. # ticloud serverless audit-log filter-rule list -List audit log filter rules for a {{{ .starter }}} cluster. +List audit log filter rules for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule list [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-template.md b/tidb-cloud/ticloud-auditlog-filter-template.md index 77367ffa0effb..cf6482a239b69 100644 --- a/tidb-cloud/ticloud-auditlog-filter-template.md +++ b/tidb-cloud/ticloud-auditlog-filter-template.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule template`. # ticloud serverless audit-log filter-rule template -Show audit log filter rule templates for a {{{ .starter }}} cluster. +Show audit log filter rule templates for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule template [flags] diff --git a/tidb-cloud/ticloud-auditlog-filter-update.md b/tidb-cloud/ticloud-auditlog-filter-update.md index 41d8b19a71d6e..376cd4760ea38 100644 --- a/tidb-cloud/ticloud-auditlog-filter-update.md +++ b/tidb-cloud/ticloud-auditlog-filter-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless audit-log filter-rule update`. # ticloud serverless audit-log filter-rule update -Update an audit log filter rule for a {{{ .starter }}} cluster. +Update an audit log filter rule for a {{{ .starter }}} or {{{ .essential }}} cluster. ```shell ticloud serverless audit-log filter-rule update [flags] diff --git a/tidb-cloud/ticloud-branch-create.md b/tidb-cloud/ticloud-branch-create.md index 8050f28eeb67e..6c0bf7ca5707e 100644 --- a/tidb-cloud/ticloud-branch-create.md +++ b/tidb-cloud/ticloud-branch-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch create`. # ticloud serverless branch create -Create a [branch](/tidb-cloud/branch-overview.md) for a {{{ .starter }}} cluster: +Create a [branch](/tidb-cloud/branch-overview.md) for a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless branch create [flags] @@ -13,13 +13,13 @@ ticloud serverless branch create [flags] ## Examples -Create a branch for a {{{ .starter }}} cluster in interactive mode: +Create a branch for a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless branch create ``` -Create a branch for a {{{ .starter }}} cluster in non-interactive mode: +Create a branch for a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless branch create --cluster-id --display-name diff --git a/tidb-cloud/ticloud-branch-delete.md b/tidb-cloud/ticloud-branch-delete.md index f6723d1590c8c..d1ad6e4b19c8e 100644 --- a/tidb-cloud/ticloud-branch-delete.md +++ b/tidb-cloud/ticloud-branch-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch delete`. # ticloud serverless branch delete -Delete a branch from your {{{ .starter }}} cluster: +Delete a branch from your {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless branch delete [flags] @@ -19,13 +19,13 @@ ticloud serverless branch rm [flags] ## Examples -Delete a {{{ .starter }}} branch in interactive mode: +Delete a branch in interactive mode: ```shell ticloud serverless branch delete ``` -Delete a {{{ .starter }}} branch in non-interactive mode: +Delete a branch in non-interactive mode: ```shell ticloud branch delete --branch-id --cluster-id diff --git a/tidb-cloud/ticloud-branch-describe.md b/tidb-cloud/ticloud-branch-describe.md index d37105c999ff3..911efdd04c349 100644 --- a/tidb-cloud/ticloud-branch-describe.md +++ b/tidb-cloud/ticloud-branch-describe.md @@ -19,13 +19,13 @@ ticloud serverless branch get [flags] ## Examples -Get branch information of a {{{ .starter }}} cluster in interactive mode: +Get branch information of a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless branch describe ``` -Get branch information of a {{{ .starter }}} cluster in non-interactive mode: +Get branch information of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless branch describe --branch-id --cluster-id diff --git a/tidb-cloud/ticloud-branch-list.md b/tidb-cloud/ticloud-branch-list.md index 9d4403f9e0763..fbf7d462a8a0f 100644 --- a/tidb-cloud/ticloud-branch-list.md +++ b/tidb-cloud/ticloud-branch-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless branch list`. # ticloud serverless branch list -List all branches for a {{{ .starter }}} cluster: +List all branches for a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless branch list [flags] @@ -19,19 +19,19 @@ ticloud serverless branch ls [flags] ## Examples -List all branches for a {{{ .starter }}} cluster in interactive mode: +List all branches for a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless branch list ``` -List all branches for a specific {{{ .starter }}} cluster in non-interactive mode: +List all branches for a specific {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless branch list -c ``` -List all branches for a specific {{{ .starter }}} cluster in the JSON format: +List all branches for a specific {{{ .starter }}} or {{{ .essential }}} cluster in the JSON format: ```shell ticloud serverless branch list -o json diff --git a/tidb-cloud/ticloud-branch-shell.md b/tidb-cloud/ticloud-branch-shell.md index e4fa15acdfa91..dd1dfb0255c8c 100644 --- a/tidb-cloud/ticloud-branch-shell.md +++ b/tidb-cloud/ticloud-branch-shell.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/ticloud-connect'] # ticloud serverless branch shell -Connect to a branch of a {{{ .starter }}} cluster: +Connect to a branch of a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless branch shell [flags] @@ -14,25 +14,25 @@ ticloud serverless branch shell [flags] ## Examples -Connect to a {{{ .starter }}} branch in interactive mode: +Connect to a branch in interactive mode: ```shell ticloud serverless branch shell ``` -Connect to a {{{ .starter }}} branch with the default user in non-interactive mode: +Connect to a branch with the default user in non-interactive mode: ```shell ticloud serverless branch shell -c -b ``` -Connect to a {{{ .starter }}} branch with the default user and password in non-interactive mode: +Connect to a branch with the default user and password in non-interactive mode: ```shell ticloud serverless branch shell -c -b --password ``` -Connect to a {{{ .starter }}} branch with a specific user and password in non-interactive mode: +Connect to a branch with a specific user and password in non-interactive mode: ```shell ticloud serverless branch shell -c -b -u --password diff --git a/tidb-cloud/ticloud-cluster-create.md b/tidb-cloud/ticloud-cluster-create.md index 3fc59b4a0a2d6..d3cdf415426e2 100644 --- a/tidb-cloud/ticloud-cluster-create.md +++ b/tidb-cloud/ticloud-cluster-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless create`. # ticloud serverless create -Create a {{{ .starter }}} cluster: +Create a TiDB Cloud cluster: ```shell ticloud serverless create [flags] @@ -13,13 +13,13 @@ ticloud serverless create [flags] ## Examples -Create a {{{ .starter }}} cluster in interactive mode: +Create a TiDB Cloud cluster in interactive mode: ```shell ticloud serverless create ``` -Create a {{{ .starter }}} cluster in non-interactive mode: +Create a TiDB Cloud cluster in non-interactive mode: ```shell ticloud serverless create --display-name --region @@ -29,7 +29,13 @@ Create a {{{ .starter }}} cluster with a spending limit in non-interactive mode: ```shell ticloud serverless create --display-name --region --spending-limit-monthly -``` +``` + +Create a {{{ .essential }}} cluster in non-interactive mode: + +```shell +ticloud serverless create --display-name --region --max-rcu --min-rcu +``` ## Flags @@ -40,9 +46,11 @@ In non-interactive mode, you need to manually enter the required flags. In inter | -n --display-name string | Specifies the name of the cluster to be created. | Yes | Only works in non-interactive mode. | | --spending-limit-monthly int | Specifies the maximum monthly spending limit in USD cents. | No | Only works in non-interactive mode. | | -p, --project-id string | Specifies the ID of the project, in which the cluster will be created. The default value is `default project`. | No | Only works in non-interactive mode. | -| -r, --region string | Specifies the name of cloud region. You can use "ticloud serverless region" to see all regions. | Yes | Only works in non-interactive mode. | -| --disable-public-endpoint | Disables the public endpoint. | No | Only works in non-interactive mode. | -| --encryption | Enables enhanced encryption at rest. | No | Only works in non-interactive mode. | +| -r, --region string | Specifies the name of the cloud region. You can view all available regions using the `ticloud serverless region` command. | Yes | Only works in non-interactive mode. | +| --disable-public-endpoint | Disables the public endpoint. Use this option if you want to prevent public access to the cluster. | No | Only works in non-interactive mode. | +| --encryption | Enables enhanced encryption at rest. | No | Only works in non-interactive mode. | +| --max-rcu int32 | Sets the maximum Request Capacity Units (RCUs) for the {{{ .essential }}} cluster, up to 100000. | No | Only works in non-interactive mode. | +| --min-rcu int32 | Sets the minimum Request Capacity Units (RCUs) for the {{{ .essential }}} cluster, at least 2000. | No | Only works in non-interactive mode. | | -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes | ## Inherited flags diff --git a/tidb-cloud/ticloud-cluster-delete.md b/tidb-cloud/ticloud-cluster-delete.md index 977cda526fd98..eea820c386fd1 100644 --- a/tidb-cloud/ticloud-cluster-delete.md +++ b/tidb-cloud/ticloud-cluster-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless delete`. # ticloud serverless delete -Delete a {{{ .starter }}} cluster from your project: +Delete a {{{ .starter }}} or {{{ .essential }}} cluster from your project: ```shell ticloud serverless delete [flags] @@ -19,13 +19,13 @@ ticloud serverless rm [flags] ## Examples -Delete a {{{ .starter }}} cluster in interactive mode: +Delete a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless delete ``` -Delete a {{{ .starter }}} cluster in non-interactive mode: +Delete a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless delete --cluster-id diff --git a/tidb-cloud/ticloud-cluster-describe.md b/tidb-cloud/ticloud-cluster-describe.md index 91029db4d3516..064d382aaef71 100644 --- a/tidb-cloud/ticloud-cluster-describe.md +++ b/tidb-cloud/ticloud-cluster-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless describe`. # ticloud serverless describe -Get information about a {{{ .starter }}} cluster (such as the cluster configurations and cluster status): +Get information about a {{{ .starter }}} or {{{ .essential }}} cluster (such as the cluster configurations and cluster status): ```shell ticloud serverless describe [flags] @@ -19,13 +19,13 @@ ticloud serverless get [flags] ## Examples -Get information about a {{{ .starter }}} cluster in interactive mode: +Get information about a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless describe ``` -Get information about a {{{ .starter }}} cluster in non-interactive mode: +Get information about a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless describe --cluster-id diff --git a/tidb-cloud/ticloud-cluster-list.md b/tidb-cloud/ticloud-cluster-list.md index 53b99eafa0610..01369bd28502e 100644 --- a/tidb-cloud/ticloud-cluster-list.md +++ b/tidb-cloud/ticloud-cluster-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless list`. # ticloud serverless list -List all {{{ .starter }}} clusters in a project: +List all {{{ .starter }}} and {{{ .essential }}} clusters in a project: ```shell ticloud serverless list [flags] @@ -19,19 +19,19 @@ ticloud serverless ls [flags] ## Examples -List all {{{ .starter }}} clusters in interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} clusters in interactive mode: ```shell ticloud serverless list ``` -List all {{{ .starter }}} clusters in a specified project in non-interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} clusters in a specified project in non-interactive mode: ```shell ticloud serverless list -p ``` -List all {{{ .starter }}} clusters in a specified project with the JSON format in non-interactive mode: +List all {{{ .starter }}} and {{{ .essential }}} clusters in a specified project with the JSON format in non-interactive mode: ```shell ticloud serverless list -p -o json diff --git a/tidb-cloud/ticloud-serverless-capacity.md b/tidb-cloud/ticloud-serverless-capacity.md new file mode 100644 index 0000000000000..d80f2f9584a6a --- /dev/null +++ b/tidb-cloud/ticloud-serverless-capacity.md @@ -0,0 +1,49 @@ +--- +title: ticloud serverless capacity +summary: The reference of `ticloud serverless capacity`. +--- + +# ticloud serverless capacity + +Set the capacity, in terms of maximum and minimum Request Capacity Units (RCUs), for a TiDB Cloud cluster. + +```shell +ticloud serverless capacity [flags] +``` + +## Examples + +Set capacity for a TiDB Cloud cluster in interactive mode: + +```shell + ticloud serverless capacity +``` + +Set capacity for a TiDB Cloud cluster in non-interactive mode: + +```shell +ticloud serverless capacity -c --max-rcu --min-rcu +``` + +## Flags + +In non-interactive mode, you need to manually enter the required flags. In interactive mode, you can just follow CLI prompts to fill them in. + +| Flag | Description | Required | Note | +|-------------------------|----------------------------------------------|----------|------------------------------------------------------| +| -c, --cluster-id string | Specifies the ID of the cluster. | Yes | Only works in non-interactive mode. | +| --max-rcu int32 | Specifies the maximum Request Capacity Units (RCUs) for the cluster, up to 100000. | No | Only works in non-interactive mode. | +| --min-rcu int32 | Specifies the minimum Request Capacity Units (RCUs) for the cluster, at least 2000. | No | Only works in non-interactive mode. | +| -h, --help | Shows help information for this command. | No | Works in both non-interactive and interactive modes. | + +## Inherited flags + +| Flag | Description | Required | Note | +|----------------------|------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------| +| --no-color | Disables color in output. | No | Only works in non-interactive mode. In interactive mode, disabling color might not work with some UI components. | +| -P, --profile string | Specifies the active [user profile](/tidb-cloud/cli-reference.md#user-profile) used in this command. | No | Works in both non-interactive and interactive modes. | +| -D, --debug | Enables debug mode. | No | Works in both non-interactive and interactive modes. | + +## Feedback + +If you have any questions or suggestions on the TiDB Cloud CLI, feel free to create an [issue](https://github.com/tidbcloud/tidbcloud-cli/issues/new/choose). Also, we welcome any contributions. diff --git a/tidb-cloud/ticloud-serverless-export-create.md b/tidb-cloud/ticloud-serverless-export-create.md index 3c9bbf97a6e11..33c49a605a31b 100644 --- a/tidb-cloud/ticloud-serverless-export-create.md +++ b/tidb-cloud/ticloud-serverless-export-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export create`. # ticloud serverless export create -Export data from a {{{ .starter }}} cluster: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless export create [flags] @@ -13,37 +13,37 @@ ticloud serverless export create [flags] ## Examples -Export data from a {{{ .starter }}} cluster in interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless export create ``` -Export data from a {{{ .starter }}} cluster to a local file in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to a local file in non-interactive mode: ```shell ticloud serverless export create -c --filter ``` -Export data from a {{{ .starter }}} cluster to Amazon S3 in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Amazon S3 in non-interactive mode: ```shell ticloud serverless export create -c --s3.uri --s3.access-key-id --s3.secret-access-key --filter ``` -Export data from a {{{ .starter }}} cluster to Google Cloud Storage in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Google Cloud Storage in non-interactive mode: ```shell ticloud serverless export create -c --gcs.uri --gcs.service-account-key --filter ``` -Export data from a {{{ .starter }}} cluster to Azure Blob Storage in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Azure Blob Storage in non-interactive mode: ```shell ticloud serverless export create -c --azblob.uri --azblob.sas-token --filter ``` -Export data from a {{{ .starter }}} cluster to Alibaba Cloud OSS in non-interactive mode: +Export data from a {{{ .starter }}} or {{{ .essential }}} cluster to Alibaba Cloud OSS in non-interactive mode: ```shell ticloud serverless export create -c --oss.uri --oss.access-key-id --oss.access-key-secret --filter diff --git a/tidb-cloud/ticloud-serverless-export-describe.md b/tidb-cloud/ticloud-serverless-export-describe.md index 066d0d5dff408..f707af6a057fa 100644 --- a/tidb-cloud/ticloud-serverless-export-describe.md +++ b/tidb-cloud/ticloud-serverless-export-describe.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export describe`. # ticloud serverless export describe -Get the export information of a {{{ .starter }}} cluster: +Get the export information of a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless export describe [flags] diff --git a/tidb-cloud/ticloud-serverless-export-download.md b/tidb-cloud/ticloud-serverless-export-download.md index 38c8e39c216a2..2b76002af71d9 100644 --- a/tidb-cloud/ticloud-serverless-export-download.md +++ b/tidb-cloud/ticloud-serverless-export-download.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export download`. # ticloud serverless export download -Download the exported data from a {{{ .starter }}} cluster to your local storage: +Download the exported data from a {{{ .starter }}} or {{{ .essential }}} cluster to your local storage: ```shell ticloud serverless export download [flags] diff --git a/tidb-cloud/ticloud-serverless-export-list.md b/tidb-cloud/ticloud-serverless-export-list.md index bf3251343aa29..c91b1d911ce8e 100644 --- a/tidb-cloud/ticloud-serverless-export-list.md +++ b/tidb-cloud/ticloud-serverless-export-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless export list`. # ticloud serverless export list -List data export tasks of {{{ .starter }}} clusters: +List data export tasks of {{{ .starter }}} and {{{ .essential }}} clusters: ```shell ticloud serverless export list [flags] diff --git a/tidb-cloud/ticloud-serverless-region.md b/tidb-cloud/ticloud-serverless-region.md index 33f2099266151..aa0b26088b792 100644 --- a/tidb-cloud/ticloud-serverless-region.md +++ b/tidb-cloud/ticloud-serverless-region.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/ticloud-serverless-regions'] # ticloud serverless region -List all available regions for {{{ .starter }}}: +List all available regions for {{{ .starter }}} and {{{ .essential }}}: ```shell ticloud serverless region [flags] @@ -14,13 +14,13 @@ ticloud serverless region [flags] ## Examples -List all available regions for {{{ .starter }}}: +List all available regions for {{{ .starter }}} and {{{ .essential }}}: ```shell ticloud serverless region ``` -List all available regions for {{{ .starter }}} clusters in the JSON format: +List all available regions for {{{ .starter }}} and {{{ .essential }}} in the JSON format: ```shell ticloud serverless region -o json diff --git a/tidb-cloud/ticloud-serverless-shell.md b/tidb-cloud/ticloud-serverless-shell.md index cbdb8698580b2..9a4581ca25eda 100644 --- a/tidb-cloud/ticloud-serverless-shell.md +++ b/tidb-cloud/ticloud-serverless-shell.md @@ -6,7 +6,7 @@ aliases: ['/tidbcloud/ticloud-connect'] # ticloud serverless shell -Connect to a {{{ .starter }}} cluster: +Connect to a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless shell [flags] @@ -14,25 +14,25 @@ ticloud serverless shell [flags] ## Examples -Connect to a {{{ .starter }}} cluster in interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless shell ``` -Connect to a {{{ .starter }}} cluster with the default user in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with the default user in non-interactive mode: ```shell ticloud serverless shell -c ``` -Connect to a {{{ .starter }}} cluster with the default user and password in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with the default user and password in non-interactive mode: ```shell ticloud serverless shell -c --password ``` -Connect to a {{{ .starter }}} cluster with a specific user and password in non-interactive mode: +Connect to a {{{ .starter }}} or {{{ .essential }}} cluster with a specific user and password in non-interactive mode: ```shell ticloud serverless shell -c -u --password diff --git a/tidb-cloud/ticloud-serverless-sql-user-create.md b/tidb-cloud/ticloud-serverless-sql-user-create.md index 96d4ae48737cf..626b636625194 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-create.md +++ b/tidb-cloud/ticloud-serverless-sql-user-create.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user create`. # ticloud serverless sql-user create -Create a {{{ .starter }}} SQL user: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless sql-user create [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user create [flags] ## Examples -Create a {{{ .starter }}} SQL user in interactive mode: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless sql-user create ``` -Create a {{{ .starter }}} SQL user in non-interactive mode: +Create a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless sql-user create --user --password --role --cluster-id diff --git a/tidb-cloud/ticloud-serverless-sql-user-delete.md b/tidb-cloud/ticloud-serverless-sql-user-delete.md index f47391d9e6d44..02dd114f65a2a 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-delete.md +++ b/tidb-cloud/ticloud-serverless-sql-user-delete.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user delete`. # ticloud serverless sql-user delete -Delete a {{{ .starter }}} SQL user: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless sql-user delete [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user delete [flags] ## Examples -Delete a {{{ .starter }}} SQL user in interactive mode: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless sql-user delete ``` -Delete a {{{ .starter }}} SQL user in non-interactive mode: +Delete a SQL user from a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless sql-user delete -c --user diff --git a/tidb-cloud/ticloud-serverless-sql-user-list.md b/tidb-cloud/ticloud-serverless-sql-user-list.md index 42e6a2edf8be8..e93312072d1fe 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-list.md +++ b/tidb-cloud/ticloud-serverless-sql-user-list.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user list`. # ticloud serverless sql-user list -List {{{ .starter }}} SQL users: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless sql-user list [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user list [flags] ## Examples -List {{{ .starter }}} SQL users in interactive mode: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless sql-user list ``` -List {{{ .starter }}} SQL users in non-interactive mode: +List SQL users in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless sql-user list -c diff --git a/tidb-cloud/ticloud-serverless-sql-user-update.md b/tidb-cloud/ticloud-serverless-sql-user-update.md index dffd1c2781fd9..f38fd1a35808f 100644 --- a/tidb-cloud/ticloud-serverless-sql-user-update.md +++ b/tidb-cloud/ticloud-serverless-sql-user-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless sql-user update`. # ticloud serverless sql-user update -Update a {{{ .starter }}} SQL user: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless sql-user update [flags] @@ -13,13 +13,13 @@ ticloud serverless sql-user update [flags] ## Examples -Update a {{{ .starter }}} SQL user in interactive mode: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless sql-user update ``` -Update a {{{ .starter }}} SQL user in non-interactive mode: +Update a SQL user in a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless sql-user update -c --user --password --role diff --git a/tidb-cloud/ticloud-serverless-update.md b/tidb-cloud/ticloud-serverless-update.md index 16f56d97daf63..6c32109f6f806 100644 --- a/tidb-cloud/ticloud-serverless-update.md +++ b/tidb-cloud/ticloud-serverless-update.md @@ -5,7 +5,7 @@ summary: The reference of `ticloud serverless update`. # ticloud serverless update -Update a {{{ .starter }}} cluster: +Update a {{{ .starter }}} or {{{ .essential }}} cluster: ```shell ticloud serverless update [flags] @@ -13,19 +13,19 @@ ticloud serverless update [flags] ## Examples -Update a {{{ .starter }}} cluster in interactive mode: +Update a {{{ .starter }}} or {{{ .essential }}} cluster in interactive mode: ```shell ticloud serverless update ``` -Update the name of a {{{ .starter }}} cluster in non-interactive mode: +Update the name of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode: ```shell ticloud serverless update -c --display-name ``` -Update labels of a {{{ .starter }}} cluster in non-interactive mode +Update labels of a {{{ .starter }}} or {{{ .essential }}} cluster in non-interactive mode ```shell ticloud serverless update -c --labels "{\"label1\":\"value1\"}" diff --git a/tidb-cloud/tidb-cloud-auditing.md b/tidb-cloud/tidb-cloud-auditing.md index 13ccea23989e4..450a0f677cd11 100644 --- a/tidb-cloud/tidb-cloud-auditing.md +++ b/tidb-cloud/tidb-cloud-auditing.md @@ -21,7 +21,7 @@ The audit logging feature is disabled by default. To audit a cluster, you need t ## Prerequisites -- You are using a TiDB Cloud Dedicated cluster. Audit logging is not available for {{{ .starter }}} clusters. +- You are using a TiDB Cloud Dedicated cluster. Audit logging is not available for {{{ .starter }}} or {{{ .essential }}} clusters. - You are in the `Organization Owner` or `Project Owner` role of your organization. Otherwise, you cannot see the database audit-related options in the TiDB Cloud console. For more information, see [User roles](/tidb-cloud/manage-user-access.md#user-roles). ## Enable audit logging diff --git a/tidb-cloud/tidb-cloud-billing.md b/tidb-cloud/tidb-cloud-billing.md index a271c2ecaaa9a..9ce383c7d9792 100644 --- a/tidb-cloud/tidb-cloud-billing.md +++ b/tidb-cloud/tidb-cloud-billing.md @@ -5,14 +5,45 @@ summary: Learn about TiDB Cloud billing. # TiDB Cloud Billing -> **Note:** +TiDB Cloud charges according to the resources that you consume. + +## Pricing + +### Pricing for TiDB Cloud Dedicated + +See [TiDB Cloud Dedicated Pricing Details](https://www.pingcap.com/tidb-dedicated-pricing-details/). + +### Pricing for {{{ .starter }}} (formerly Serverless) {#pricing-for-starter} + +See [TiDB Cloud Serverless Pricing Details](https://www.pingcap.com/tidb-serverless-pricing-details/). + +### Pricing for {{{ .essential }}} {#pricing-for-essential} + +> **Tip:** > -> [{{{ .starter }}} clusters](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) are free until May 31, 2023, with a 100% discount off. After that, usage beyond the [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota) will be charged. +> Currently, {{{ .essential }}} is in public preview on Alibaba Cloud and is only available in the Alibaba Cloud Singapore region. To request other regions on Alibaba Cloud, contact [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md#access-pingcap-help-center). + +For {{{ .essential }}}, you are charged based on the number of provisioned Request Capacity Units (RCUs), **not** on the actual usage by your application. + +A **Request Capacity Unit (RCU)** is a unit of measure used to represent the provisioned compute capacity for your {{{ .essential }}} cluster. One RCU provides a fixed amount of compute resources that can process a certain number of RUs per second. The number of RCUs you provision determines your cluster's baseline performance and throughput capacity. + +See the detailed pricing for each available Alibaba Cloud region below. + +| Resource | Singapore | +|----------|-----------| +| Compute (per RCU/month) | $0.24 | +| Row-based storage (per GiB/month) | $0.24 | +| Columnar storage (per GiB/month) | $0.06 | +| Row-based storage with dual-layer encryption (per GiB/month) | $0.36 | +| Columnar storage with dual-layer encryption (per GiB/month) | $0.09 | + +#### Throttling + +For {{{ .essential }}} clusters, the throttling policy is based on the provisioned Request Capacity Units (RCUs). When the workload exceeds the maximum RCU capacity, the cluster will automatically throttle incoming requests to maintain stability. Existing connections will experience throttling, but new connection attempts will be accepted as long as they don't exceed the maximum RCU limit. This ensures predictable performance while protecting the cluster from overload. -TiDB Cloud charges according to the resources that you consume. You can visit the following pages to get more information about the pricing. +#### Billing cycle -- [{{{ .starter }}} Pricing Details](https://www.pingcap.com/tidb-serverless-pricing-details/) -- [TiDB Cloud Dedicated Pricing Details](https://www.pingcap.com/tidb-dedicated-pricing-details/) +Each TiDB Cloud bill, corresponding to the previous month's usage, is finalized at the start of every new month. This finalized bill is charged to your default payment method, typically occurring between the 3rd and 9th day of the respective month. If your usage within the current month reaches or exceeds $500, an automatic charge will be initiated. Note that the billing cycle operates strictly in accordance with the UTC (+00:00) time zone. ## Invoices @@ -22,7 +53,7 @@ After you set up the payment method, TiDB Cloud will generate an invoice once yo > **Note:** > -> If you sign up for TiDB Cloud through [AWS Marketplace](https://aws.amazon.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/), or [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), you can pay through your AWS account, Azure account, or Google Cloud account directly but cannot add payment methods or download invoices in the TiDB Cloud console. +> If you sign up for TiDB Cloud through [AWS Marketplace](https://aws.amazon.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/), [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), or [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), you can pay through your AWS account, Azure account, Google Cloud account, or Alibaba Cloud account directly but cannot add payment methods or download invoices in the TiDB Cloud console. After you contact our sales for receiving an invoice on a monthly basis, TiDB Cloud will generate the invoice for the previous month at the beginning of each month. @@ -161,7 +192,7 @@ If you are in the `Organization Owner` or `Organization Billing Manager` role of > **Note:** > -> If you sign up for TiDB Cloud through [AWS Marketplace](https://aws.amazon.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/), or [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), you can pay through your AWS account, Azure account, or Google Cloud account directly but cannot add payment methods or download invoices in the TiDB Cloud console. +> If you sign up for TiDB Cloud through [AWS Marketplace](https://aws.amazon.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/), [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), or [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), you can pay through your AWS account, Azure account, Google Cloud account, or Alibaba Cloud account directly but cannot add payment methods or download invoices in the TiDB Cloud console. The fee is deducted from a bound credit card according to your cluster usage. To add a valid credit card, you can use either of the following methods: @@ -206,17 +237,18 @@ If you have agreed with our sales on a contract and received an email to review To learn more about contracts, feel free to [contact our sales](https://www.pingcap.com/contact-us/). -## Billing from AWS Marketplace, Azure Marketplace, or Google Cloud Marketplace +## Billing from cloud provider marketplace -If you are in the `Organization Owner` or `Organization Billing Manager` role of your organization, you can link your TiDB Cloud account to an AWS billing account, an Azure billing account, or a Google Cloud billing account. Otherwise, skip this section. +If you are in the `Organization Owner` or `Organization Billing Manager` role of your organization, you can link your TiDB Cloud account to the billing account of your cloud provider (AWS, Azure, Google Cloud, or Alibaba Cloud). Otherwise, skip this section. -If you are new to TiDB Cloud and do not have a TiDB Cloud account, you can sign up for a TiDB Cloud account through [AWS Marketplace](https://aws.amazon.com/marketplace), [Azure Marketplace](https://azuremarketplace.microsoft.com/), or [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), and pay for the usage via the AWS, Azure, or Google Cloud billing account. +If you are new to TiDB Cloud and do not have a TiDB Cloud account, you can sign up for a TiDB Cloud account through the marketplace of your cloud provider, and pay for the usage via the billing account of your cloud provider. -- To sign up through AWS Marketplace, search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. -- To sign up through Azure Marketplace, search for `TiDB Cloud` in [Azure Marketplace](https://azuremarketplace.microsoft.com), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. -- To sign up through Google Cloud Marketplace, search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- To sign up through [AWS Marketplace](https://aws.amazon.com/marketplace), search for `TiDB Cloud` in [AWS Marketplace](https://aws.amazon.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- To sign up through [Azure Marketplace](https://azuremarketplace.microsoft.com), search for `TiDB Cloud` in [Azure Marketplace](https://azuremarketplace.microsoft.com), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- To sign up through [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), search for `TiDB Cloud` in [Google Cloud Marketplace](https://console.cloud.google.com/marketplace), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. +- To sign up through [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), search for `TiDB Cloud` in [Alibaba Cloud Marketplace](https://marketplace.alibabacloud.com/), subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account. -If you already have a TiDB Cloud account and you want to pay for the usage via your AWS or Google Cloud billing account, you can link your TiDB Cloud account to your AWS or Google Cloud billing account. +If you already have a TiDB Cloud account and you want to pay for the usage via your AWS, Azure, Google Cloud, or Alibaba Cloud billing account, you can link your TiDB Cloud account to your AWS, Azure, Google Cloud, or Alibaba Cloud billing account.
@@ -289,5 +321,27 @@ To link your TiDB Cloud account to a Google Cloud billing account, take the foll > > If your organization already has a payment method in TiDB Cloud, the existing payment method for this organization will be replaced by the newly added Google Cloud billing account. +
+ +
+ +To link your TiDB Cloud account to an Alibaba Cloud billing account, take the following steps: + +1. Open the [Alibaba Cloud Marketplace page](https://marketplace.alibabacloud.com/), search for `TiDB Cloud` and select **TiDB Cloud** in the search results. The TiDB Cloud product page is displayed. + +2. On the TiDB Cloud product page, click **Activate Now**, and then follow the onscreen instructions to confirm the pay-as-you-go mode and view the activation application. + +3. On the subscription page, locate your subscription of TiDB Cloud, and then click **Auto Login**. You are directed to the TiDB Cloud sign-up page. + +4. Check the notification in the upper part of the sign-up page and click **Sign in**. + +5. Sign in with your TiDB Cloud account. The page for linking to your Alibaba Cloud billing account is displayed. + +6. On the page, select the target organization and click **Link** to link to your Alibaba Cloud billing account. + + > **Note:** + > + > If your organization already has a payment method in TiDB Cloud, the existing payment method for this organization will be replaced by the newly added Alibaba Cloud billing account. +
diff --git a/tidb-cloud/tidb-cloud-budget.md b/tidb-cloud/tidb-cloud-budget.md index e0e5e2d96ea81..4439e7c024b65 100644 --- a/tidb-cloud/tidb-cloud-budget.md +++ b/tidb-cloud/tidb-cloud-budget.md @@ -11,7 +11,7 @@ When your monthly actual costs exceed the percentage thresholds of your specifie TiDB Cloud provides two types of budgets to help you track your spending: -- **Serverless Spending Limit** budget: for each {{{ .starter }}} scalable cluster, TiDB Cloud automatically creates a **Serverless Spending Limit** budget. This budget helps you track the actual cost against the [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) configured on that cluster. It includes three threshold rules: 75%, 90%, and 100% of the budget, which are not editable. +- **Starter Spending Limit** budget: for each {{{ .starter }}} with the spending limit > 0, TiDB Cloud automatically creates a **Starter Spending Limit** budget. This budget helps you track the actual cost against the [spending limit](/tidb-cloud/manage-serverless-spend-limit.md) configured on that cluster. It includes three threshold rules: 75%, 90%, and 100% of the budget, which are not editable. - **Custom** budget: you can create custom budgets to track actual costs for an entire organization or specific projects. For each budget, you can specify a budget scope, set a target spending amount, and configure alert thresholds. After creating a custom budget, you can compare your monthly actual costs with your planned costs to ensure you stay within budget. @@ -60,7 +60,7 @@ To create a custom budget to monitor the spending of your organization or specif > **Note:** > -> The **Serverless Spending Limit** budget cannot be edited because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} scalable cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). +> The **Starter Spending Limit** budget cannot be edited because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). To edit a custom budget, take the following steps: @@ -81,7 +81,7 @@ To edit a custom budget, take the following steps: > **Note:** > > - Once a custom budget is deleted, you will no longer receive any alert emails related to it. -> - The **Serverless Spending Limit** budget cannot be deleted because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} scalable cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). +> - The **Starter Spending Limit** budget cannot be deleted because it is automatically created by TiDB Cloud to help you track the cost of a {{{ .starter }}} cluster against its [spending limit](/tidb-cloud/manage-serverless-spend-limit.md). To delete a custom budget, take the following steps: diff --git a/tidb-cloud/tidb-cloud-connect-aws-dms.md b/tidb-cloud/tidb-cloud-connect-aws-dms.md index cb29c006d4326..792f6bf216612 100644 --- a/tidb-cloud/tidb-cloud-connect-aws-dms.md +++ b/tidb-cloud/tidb-cloud-connect-aws-dms.md @@ -18,9 +18,9 @@ You are expected to have an AWS account with enough access to manage DMS-related ### A TiDB Cloud account and a TiDB cluster -You are expected to have a TiDB Cloud account and a {{{ .starter }}} or TiDB Cloud Dedicated cluster. If not, refer to the following documents to create one: +You are expected to have a TiDB Cloud account and a {{{ .starter }}}, {{{ .essential }}}, or TiDB Cloud Dedicated cluster. If not, refer to the following documents to create one: -- [Create a {{{ .starter }}} cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or Essential cluster](/tidb-cloud/create-tidb-cluster-serverless.md) - [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md) ## Configure network @@ -29,17 +29,20 @@ Before creating DMS resources, you need to configure network properly to ensure -
+
-For {{{ .starter }}}, your clients can connect to clusters via public endpoint or private endpoint. +For {{{ .starter }}} or {{{ .essential }}}, your clients can connect to clusters via public endpoint or private endpoint. -- To [connect to a {{{ .starter }}} cluster via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. +- To [connect to a {{{ .starter }}} or Essential cluster via public endpoint](/tidb-cloud/connect-via-standard-connection-serverless.md), do one of the following to make sure that the DMS replication instance can access the internet. - Deploy the replication instance in public subnets and enable **Public accessible**. For more information, see [Configuration for internet access](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html#vpc-igw-internet-access). - Deploy the replication instance in private subnets and route traffic in the private subnets to public subnets. In this case, you need at least three subnets, two private subnets, and one public subnet. The two private subnets form a subnet group where the replication instance lives. Then you need to create a NAT gateway in the public subnet and route traffic of the two private subnets to the NAT gateway. For more information, see [Access the internet from a private subnet](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-scenarios.html#public-nat-internet-access). -- To connect to a {{{ .starter }}} cluster via private endpoint, [set up a private endpoint](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) first and deploy the replication instance in private subnets. +- To connect to a {{{ .starter }}} or {{{ .essential }}} cluster via private endpoint, refer to the following documents to set up a private endpoint first and deploy the replication instance in private subnets. + + - [Connect to {{{ .starter }}} via AWS PrivateLink](/tidb-cloud/set-up-private-endpoint-connections-serverless.md) + - [Connect to {{{ .starter }}} or Essential via Alibaba Cloud Private Endpoint](/tidb-cloud/set-up-private-endpoint-connections-on-alibaba-cloud.md)
@@ -110,14 +113,14 @@ For connectivity, the steps for using TiDB Cloud clusters as a source or as a ta -
+
- - **Server name**: `HOST` of {{{ .starter }}} cluster. - - **Port**: `PORT` of {{{ .starter }}} cluster. - - **User name**: User of {{{ .starter }}} cluster for migration. Make sure it meets DMS requirements. - - **Password**: Password of the {{{ .starter }}} cluster user. + - **Server name**: `HOST` of the cluster. + - **Port**: `PORT` of the cluster. + - **User name**: User of the cluster for migration. Make sure it meets DMS requirements. + - **Password**: Password of the cluster user. - **Secure Socket Layer (SSL) mode**: If you are connecting via public endpoint, it is highly recommended to set the mode to **verify-full** to ensure transport security. If you are connecting via private endpoint, you can set the mode to **none**. - - (Optional) **CA certificate**: Use the [ISRG Root X1 certificate](https://letsencrypt.org/certs/isrgrootx1.pem). For more information, see [TLS Connections to {{{ .starter }}}](/tidb-cloud/secure-connections-to-serverless-clusters.md). + - (Optional) **CA certificate**: Use the [ISRG Root X1 certificate](https://letsencrypt.org/certs/isrgrootx1.pem). For more information, see [TLS Connections to {{{ .starter }}} or Essential](/tidb-cloud/secure-connections-to-serverless-clusters.md).
diff --git a/tidb-cloud/tidb-cloud-console-auditing.md b/tidb-cloud/tidb-cloud-console-auditing.md index 3bfb14db0d25a..d0874f2ad69ee 100644 --- a/tidb-cloud/tidb-cloud-console-auditing.md +++ b/tidb-cloud/tidb-cloud-console-auditing.md @@ -152,12 +152,12 @@ The console audit logs record various user activities on the TiDB Cloud console | BindSupportPlan | Bind a support plan | | CancelSupportPlan | Cancel a support plan | | UpdateOrganizationName | Update the organization name | -| SetSpendLimit | Edit the spending limit of a {{{ .starter }}} scalable cluster | +| SetSpendLimit | Edit the spending limit of a {{{ .starter }}} cluster | | UpdateMaintenanceWindow | Modify maintenance window start time | | DeferMaintenanceTask | Defer a maintenance task | -| CreateBranch | Create a {{{ .starter }}} branch | -| DeleteBranch | Delete a {{{ .starter }}} branch | -| SetBranchRootPassword | Set root password for a {{{ .starter }}} branch | +| CreateBranch | Create a branch for {{{ .starter }}} or {{{ .essential }}} cluster | +| DeleteBranch | Delete a branch for {{{ .starter }}} or {{{ .essential }}} cluster | +| SetBranchRootPassword | Set root password for a branch of your {{{ .starter }}} or {{{ .essential }}} cluster | | ConnectBranchGitHub | Connect the cluster with a GitHub repository to enable branching integration | | DisconnectBranchGitHub | Disconnect the cluster from a GitHub repository to disable branching integration | diff --git a/tidb-cloud/tidb-cloud-encrypt-cmek.md b/tidb-cloud/tidb-cloud-encrypt-cmek.md index 6cf3a787fc32a..588b59485ba47 100644 --- a/tidb-cloud/tidb-cloud-encrypt-cmek.md +++ b/tidb-cloud/tidb-cloud-encrypt-cmek.md @@ -18,7 +18,7 @@ Once CMEK is enabled for a project, all clusters created within that project enc - Currently, TiDB Cloud only supports using AWS KMS to provide CMEK. - To use CMEK, you need to enable CMEK when creating a project and complete CMEK-related configurations before creating a cluster. You cannot enable CMEK for existing projects. -- Currently, in CMEK-enabled projects, you can only create [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters hosted on AWS. TiDB Cloud Dedicated clusters hosted on other cloud providers and [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters are not supported. +- Currently, in CMEK-enabled projects, you can only create [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters hosted on AWS. - Currently, in CMEK-enabled projects, [dual region backup](/tidb-cloud/backup-and-restore-concepts.md#dual-region-backup) is not supported. - Currently, for a specific project, you can only enable CMEK for one AWS region. Once you have configured it, you cannot create clusters in other regions within the same project. diff --git a/tidb-cloud/tidb-cloud-events.md b/tidb-cloud/tidb-cloud-events.md index eb5ed57dba08c..f82ee407bf9b2 100644 --- a/tidb-cloud/tidb-cloud-events.md +++ b/tidb-cloud/tidb-cloud-events.md @@ -42,7 +42,7 @@ TiDB Cloud logs the following types of cluster events: | ScaleChangefeed | Scale the specification of a changefeed | | FailedChangefeed | Changefeed failures | | ImportData | Import data to a cluster | -| UpdateSpendingLimit | Update spending limit of a {{{ .starter }}} scalable cluster | +| UpdateSpendingLimit | Update spending limit of a {{{ .starter }}} cluster | | ResourceLimitation | Update resource limitation of a {{{ .starter }}} cluster | For each event, the following information is logged: diff --git a/tidb-cloud/tidb-cloud-faq.md b/tidb-cloud/tidb-cloud-faq.md index be1d2827770a8..cb7bbc257a6c7 100644 --- a/tidb-cloud/tidb-cloud-faq.md +++ b/tidb-cloud/tidb-cloud-faq.md @@ -13,7 +13,7 @@ This document lists the most frequently asked questions about TiDB Cloud. ### What is TiDB Cloud? -TiDB Cloud makes deploying, managing, and maintaining your TiDB clusters even simpler with a fully managed cloud instance that you control through an intuitive console. You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, or Microsoft Azure to quickly build mission-critical applications. +TiDB Cloud makes deploying, managing, and maintaining your TiDB clusters even simpler with a fully managed cloud instance that you control through an intuitive console. You are able to easily deploy on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, or Alibaba Cloud to quickly build mission-critical applications. TiDB Cloud allows developers and DBAs with little or no training to handle once-complex tasks such as infrastructure management and cluster deployment with ease, to focus on your applications, not the complexities of your database. And by scaling TiDB clusters in or out with a simple click of a button, you no longer waste costly resources because you are able to provision your databases for exactly how much and how long you need them. @@ -33,7 +33,7 @@ You can use any language supported by the MySQL client or driver. ### Where can I run TiDB Cloud? -TiDB Cloud is currently available on Amazon Web Services (AWS), Google Cloud, and Microsoft Azure. +TiDB Cloud is currently available on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud. ### Does TiDB Cloud support VPC peering between different cloud service providers? @@ -42,7 +42,7 @@ No. ### What versions of TiDB are supported on TiDB Cloud? - For new TiDB Cloud Dedicated clusters, the default TiDB version is [v8.5.2](https://docs.pingcap.com/tidb/v8.5/release-8.5.2) starting from July 15, 2025. -- For {{{ .starter }}} clusters, the TiDB version is [v7.5.2](https://docs.pingcap.com/tidb/v7.5/release-7.5.2) starting from April 22, 2025. +- For {{{ .starter }}} and {{{ .essential }}} clusters, the TiDB version is [v7.5.2](https://docs.pingcap.com/tidb/v7.5/release-7.5.2) starting from April 22, 2025. For more information, see [TiDB Cloud Release Notes](/tidb-cloud/tidb-cloud-release-notes.md). @@ -64,7 +64,7 @@ The best way to learn about TiDB Cloud is to follow our step-by-step tutorial. C - [TiDB Cloud Introduction](/tidb-cloud/tidb-cloud-intro.md) - [Get Started](/tidb-cloud/tidb-cloud-quickstart.md) -- [Create a {{{ .starter }}} Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) +- [Create a {{{ .starter }}} or Essential Cluster](/tidb-cloud/create-tidb-cluster-serverless.md) ### What does `XXX's Org/default project/Cluster0` refer to when deleting a cluster? @@ -108,7 +108,7 @@ TiDB is highly compatible with MySQL. You can migrate data from any MySQL-compat ### Does TiDB Cloud support incremental backups? -No. If you need to restore data to any point in time within the cluster's backup retention, you can use PITR (Point-in-time Recovery). For more information, see [Use PITR in a TiDB Cloud Dedicated cluster](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) or [Use PITR in a {{{ .starter }}} cluster](/tidb-cloud/backup-and-restore-serverless.md#restore). +No. If you need to restore data to any point in time within the cluster's backup retention, you can use PITR (Point-in-time Recovery). For more information, see [Use PITR in a TiDB Cloud Dedicated cluster](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) or [Use PITR in a {{{ .essential }}} cluster](/tidb-cloud/backup-and-restore-serverless.md#restore). ## HTAP FAQs @@ -153,7 +153,7 @@ No. TiDB Cloud is Database-as-a-Service (DBaaS) and runs only in the TiDB Cloud ### Is my TiDB cluster secure? -In TiDB Cloud, you can use either a TiDB Cloud Dedicated cluster or a {{{ .starter }}} cluster according to your needs. +In TiDB Cloud, you can use a TiDB Cloud Dedicated cluster, a {{{ .starter }}} cluster, or a {{{ .essential }}} cluster according to your needs. For TiDB Cloud Dedicated clusters, TiDB Cloud ensures cluster security with the following measures: @@ -162,7 +162,7 @@ For TiDB Cloud Dedicated clusters, TiDB Cloud ensures cluster security with the - Creates server-side TLS certificates and component-level TLS certificates for each cluster to encrypt cluster data in transit. - Provide IP access rules for each cluster to ensure that only allowed source IP addresses can access your cluster. -For {{{ .starter }}} clusters, TiDB Cloud ensures cluster security with the following measures: +For {{{ .starter }}} and {{{ .essential }}} clusters, TiDB Cloud ensures cluster security with the following measures: - Creates independent sub-accounts for each cluster. - Sets up firewall rules to isolate external connections. @@ -184,14 +184,14 @@ For more information, see [Connect to Your TiDB Cloud Dedicated Cluster](/tidb-c
-
+
-For a {{{ .starter }}} cluster, the steps to connect to your cluster are simplified as follows: +For a {{{ .starter }}} or Essential cluster, the steps to connect to your cluster are simplified as follows: 1. Set a database user and login credential. 2. Choose a SQL client, get an auto-generated connection string displayed on the TiDB Cloud UI, and then connect to your cluster through the SQL client using the string. -For more information, see [Connect to Your {{{ .starter }}} Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +For more information, see [Connect to Your TiDB Cloud Cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md).
diff --git a/tidb-cloud/tidb-cloud-glossary.md b/tidb-cloud/tidb-cloud-glossary.md index 40d74cd749f79..8c84d101e7717 100644 --- a/tidb-cloud/tidb-cloud-glossary.md +++ b/tidb-cloud/tidb-cloud-glossary.md @@ -27,7 +27,7 @@ ACID refers to the four key properties of a transaction: atomicity, consistency, Chat2Query is an AI-powered feature integrated into SQL Editor that assists users in generating, debugging, or rewriting SQL queries using natural language instructions. For more information, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md). -In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} clusters. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). +In addition, TiDB Cloud provides a Chat2Query API for {{{ .starter }}} clusters hosted on AWS. After it is enabled, TiDB Cloud will automatically create a system Data App called **Chat2Query** and a Chat2Data endpoint in Data Service. You can call this endpoint to let AI generate and execute SQL statements by providing instructions. For more information, see [Get started with Chat2Query API](/tidb-cloud/use-chat2query-api.md). ### Credit @@ -147,7 +147,7 @@ A Request Unit (RU) is a unit of measure used to represent the amount of resourc ### Spending limit -Spending limit refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that enables you to set a budget for your {{{ .starter }}} clusters. For [scalable clusters](/tidb-cloud/select-cluster-tier.md#scalable-cluster-plan), the spending limit must be set to a minimum of $0.01. Also, the scalable cluster can have a free quota if it meets the qualifications. The scalable cluster with a free quota will consume the free quota first. +[Spending limit](/tidb-cloud/manage-serverless-spend-limit.md) refers to the maximum amount of money that you are willing to spend on a particular workload in a month. It is a cost-control mechanism that enables you to set a budget for your {{{ .starter }}} clusters. To scale the capacity of your {{{ .starter }}} cluster automatically based on your workload, the spending limit must be set to a minimum of $0.01. Also, the {{{ .starter }}} cluster can have a [free quota](/tidb-cloud/select-cluster-tier.md#usage-quota) if it meets the qualifications. The {{{ .starter }}} cluster with a free quota will consume the free quota first. ## T diff --git a/tidb-cloud/tidb-cloud-import-local-files.md b/tidb-cloud/tidb-cloud-import-local-files.md index dc72a38f5dd35..20c0d9fb7129e 100644 --- a/tidb-cloud/tidb-cloud-import-local-files.md +++ b/tidb-cloud/tidb-cloud-import-local-files.md @@ -1,18 +1,18 @@ --- -title: Import Local Files to {{{ .starter }}} -summary: Learn how to import local files to {{{ .starter }}}. +title: Import Local Files to {{{ .starter }}} or Essential +summary: Learn how to import local files to {{{ .starter }}} or {{{ .essential }}}. --- -# Import Local Files to {{{ .starter }}} +# Import Local Files to {{{ .starter }}} or Essential -You can import local files to {{{ .starter }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. +You can import local files to {{{ .starter }}} or {{{ .essential }}} directly. It only takes a few clicks to complete the task configuration, and then your local CSV data will be quickly imported to your TiDB cluster. Using this method, you do not need to provide the cloud storage and credentials. The whole importing process is quick and smooth. Currently, this method supports importing one CSV file for one task into either an existing empty table or a new table. ## Limitations - Currently, TiDB Cloud only supports importing a local file in CSV format within 250 MiB for one task. -- Importing local files is supported only for {{{ .starter }}} clusters, not for TiDB Cloud Dedicated clusters. +- Importing local files is supported only for {{{ .starter }}} and {{{ .essential }}} clusters, not for TiDB Cloud Dedicated clusters. - You cannot run more than one import task at the same time. ## Import local files diff --git a/tidb-cloud/tidb-cloud-intro.md b/tidb-cloud/tidb-cloud-intro.md index 23c4cbd0c749e..e6e5936f7d663 100644 --- a/tidb-cloud/tidb-cloud-intro.md +++ b/tidb-cloud/tidb-cloud-intro.md @@ -6,7 +6,7 @@ category: intro # What is TiDB Cloud -[TiDB Cloud](https://www.pingcap.com/tidb-cloud/) is a fully-managed Database-as-a-Service (DBaaS) that brings [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source Hybrid Transactional and Analytical Processing (HTAP) database, to your cloud. TiDB Cloud offers an easy way to deploy and manage databases to let you focus on your applications, not the complexities of the databases. You can create TiDB Cloud clusters to quickly build mission-critical applications on Amazon Web Services (AWS), Google Cloud, and Microsoft Azure. +[TiDB Cloud](https://www.pingcap.com/tidb-cloud/) is a fully-managed Database-as-a-Service (DBaaS) that brings [TiDB](https://docs.pingcap.com/tidb/stable/overview), an open-source Hybrid Transactional and Analytical Processing (HTAP) database, to your cloud. TiDB Cloud offers an easy way to deploy and manage databases to let you focus on your applications, not the complexities of the databases. You can create TiDB Cloud clusters to quickly build mission-critical applications on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud. ![TiDB Cloud Overview](/media/tidb-cloud/tidb-cloud-overview.png) @@ -50,7 +50,7 @@ With TiDB Cloud, you can get the following key features: - **Multi-Cloud Support** - Stay flexible without cloud vendor lock-in. TiDB Cloud is currently available on AWS, Azure, and Google Cloud. + Stay flexible without cloud vendor lock-in. TiDB Cloud is currently available on AWS, Azure, Google Cloud, and Alibaba Cloud. - **Simple Pricing Plans** @@ -62,17 +62,25 @@ With TiDB Cloud, you can get the following key features: ## Deployment options -TiDB Cloud provides the following two deployment options: +TiDB Cloud provides the following deployment options: -- [TiDB Cloud Serverless](https://www.pingcap.com/tidb-cloud-serverless) +- TiDB Cloud Serverless (renamed to Starter) - {{{ .starter }}} is a fully managed, multi-tenant TiDB offering. It delivers an instant, autoscaling MySQL-compatible database and offers a generous free tier and consumption based billing once free limits are exceeded. + {{{ .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. -- [TiDB Cloud Dedicated](https://www.pingcap.com/tidb-cloud-dedicated) + Currently, {{{ .starter }}} is generally available on AWS and in public preview on Alibaba Cloud. - TiDB Cloud Dedicated is for production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing). +- {{{ .essential }}} -For feature comparison between {{{ .starter }}} and TiDB Cloud Dedicated, see [TiDB: An advanced, open source, distributed SQL database](https://www.pingcap.com/get-started-tidb). + For applications experiencing growing workloads and needing scalability in real time, {{{ .essential }}} provides the flexibility and performance to keep pace with your business growth. + + Currently, {{{ .essential }}} is in public preview on Alibaba Cloud. For feature comparison between {{{ .starter }}} and {{{ .essential }}}, see [TiDB on Alibaba Cloud](https://www.pingcap.com/partners/alibaba-cloud/). + +- TiDB Cloud Dedicated + + TiDB Cloud Dedicated is designed for mission-critical businesses, offering high availability across multiple availability zones, horizontal scaling, and full [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing) capabilities. + + Currently, TiDB Cloud Dedicated is generally available on AWS and Google Cloud, and in public preview on Azure. For more information, see [TiDB Cloud Dedicated](https://www.pingcap.com/tidb-cloud-dedicated). ## Architecture diff --git a/tidb-cloud/tidb-cloud-migration-overview.md b/tidb-cloud/tidb-cloud-migration-overview.md index 9a0d2ad37ab47..c5daaa8038a71 100644 --- a/tidb-cloud/tidb-cloud-migration-overview.md +++ b/tidb-cloud/tidb-cloud-migration-overview.md @@ -41,21 +41,21 @@ If you have data files in SQL, CSV, Parquet, or Aurora Snapshot formats, you can - Import sample data (SQL file) to TiDB Cloud - You can import sample data (SQL file) to TiDB Cloud to quickly get familiar with the TiDB Cloud interface and the import process. For more information, see [Import Sample Data to {{{ .starter }}}](/tidb-cloud/import-sample-data-serverless.md) and [Import Sample Data to TiDB Cloud Dedicated](/tidb-cloud/import-sample-data.md). + You can import sample data (SQL file) to TiDB Cloud to quickly get familiar with the TiDB Cloud interface and the import process. For more information, see [Import Sample Data to {{{ .starter }}} or Essential](/tidb-cloud/import-sample-data-serverless.md) and [Import Sample Data to TiDB Cloud Dedicated](/tidb-cloud/import-sample-data.md). -- Import CSV files from Amazon S3, Google Cloud Storage (GCS), or Azure Blob Storage into TiDB Cloud +- Import CSV files from Amazon S3, Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud - You can import CSV files from Amazon S3, Google Cloud Storage (GCS), or Azure Blob Storage into TiDB Cloud. For more information, see [Import CSV Files from Cloud Storage into {{{ .starter }}}](/tidb-cloud/import-csv-files-serverless.md) and [Import CSV Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-csv-files.md). + You can import CSV files from Amazon S3, Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud. For more information, see [Import CSV Files from Cloud Storage into {{{ .starter }}} or Essential](/tidb-cloud/import-csv-files-serverless.md) and [Import CSV Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-csv-files.md). -- Import Apache Parquet files from Amazon S3, Google Cloud Storage (GCS), or Azure Blob Storage into TiDB Cloud +- Import Apache Parquet files from Amazon S3, Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud - You can import Parquet files from Amazon S3, Google Cloud Storage (GCS), or Azure Blob Storage into TiDB Cloud. For more information, see [Import Apache Parquet Files from Cloud Storage into {{{ .starter }}}](/tidb-cloud/import-parquet-files-serverless.md) and [Import Apache Parquet Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-parquet-files.md). + You can import Parquet files from Amazon S3, Google Cloud Storage (GCS), Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud. For more information, see [Import Apache Parquet Files from Cloud Storage into {{{ .starter }}} or Essential](/tidb-cloud/import-parquet-files-serverless.md) and [Import Apache Parquet Files from Cloud Storage into TiDB Cloud Dedicated](/tidb-cloud/import-parquet-files.md). ## Reference ### Configure cloud storage access -If your source data is stored in Amazon S3, Google Cloud Storage (GCS) buckets, or Azure Blob Storage containers, before importing or migrating the data to TiDB Cloud, you need to configure access to the storage. For more information, see [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md) and [Configure External Storage Access for TiDB Cloud Dedicated](/tidb-cloud/dedicated-external-storage.md). +If your source data is stored in Amazon S3, Google Cloud Storage (GCS) buckets, Azure Blob Storage containers, or Alibaba Cloud OSS buckets, before importing or migrating the data to TiDB Cloud, you need to configure access to the storage. For more information, see [Configure External Storage Access for {{{ .starter }}} or Essential](/tidb-cloud/serverless-external-storage.md) and [Configure External Storage Access for TiDB Cloud Dedicated](/tidb-cloud/dedicated-external-storage.md). ### Naming conventions for data import diff --git a/tidb-cloud/tidb-cloud-poc.md b/tidb-cloud/tidb-cloud-poc.md index 774f31e7a3447..e009e6955bc13 100644 --- a/tidb-cloud/tidb-cloud-poc.md +++ b/tidb-cloud/tidb-cloud-poc.md @@ -5,7 +5,7 @@ summary: Learn about how to perform a Proof of Concept (PoC) with TiDB Cloud. # Perform a Proof of Concept (PoC) with TiDB Cloud -TiDB Cloud is a Database-as-a-Service (DBaaS) product that delivers everything great about TiDB in a fully managed cloud database. It helps you focus on your applications, instead of the complexities of your database. TiDB Cloud is currently available on Amazon Web Services (AWS), Google Cloud, and Microsoft Azure. +TiDB Cloud is a Database-as-a-Service (DBaaS) product that delivers everything great about TiDB in a fully managed cloud database. It helps you focus on your applications, instead of the complexities of your database. TiDB Cloud is currently available on Amazon Web Services (AWS), Google Cloud, Microsoft Azure, and Alibaba Cloud. Initiating a proof of concept (PoC) is the best way to determine whether TiDB Cloud is the best fit for your business needs. It will also get you familiar with the key features of TiDB Cloud in a short time. By running performance tests, you can see whether your workload can run efficiently on TiDB Cloud. You can also evaluate the efforts required to migrate your data and adapt configurations. @@ -175,7 +175,7 @@ Now the workload testing is finished, you can explore more features, for example - Backup - To avoid vendor lock-in, you can use daily full backup to migrate data to a new cluster and use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data. For more information, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) and [Back Up and Restore {{{ .starter }}} Data](/tidb-cloud/backup-and-restore-serverless.md). + To avoid vendor lock-in, you can use daily full backup to migrate data to a new cluster and use [Dumpling](https://docs.pingcap.com/tidb/stable/dumpling-overview) to export data. For more information, see [Back Up and Restore TiDB Cloud Dedicated Data](/tidb-cloud/backup-and-restore.md#turn-on-auto-backup) and [Back Up and Restore Data on {{{ .starter }}} or Essential](/tidb-cloud/backup-and-restore-serverless.md). ## Step 8. Clean up the environment and finish the PoC diff --git a/tidb-cloud/tidb-cloud-quickstart.md b/tidb-cloud/tidb-cloud-quickstart.md index 9f1e8c5356666..8ae91892ae9ee 100644 --- a/tidb-cloud/tidb-cloud-quickstart.md +++ b/tidb-cloud/tidb-cloud-quickstart.md @@ -14,7 +14,7 @@ Additionally, you can try out TiDB features on [TiDB Playground](https://play.ti ## Step 1: Create a TiDB cluster -[TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) is the best way to get started with TiDB Cloud. To create a {{{ .starter }}} cluster, follow these steps: +[TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) (now Starter) is the best way to get started with TiDB Cloud. To create a {{{ .starter }}} cluster, follow these steps: 1. If you do not have a TiDB Cloud account, click [here](https://tidbcloud.com/free-trial) to sign up. @@ -30,20 +30,24 @@ Additionally, you can try out TiDB features on [TiDB Playground](https://play.ti - To create a new {{{ .starter }}} cluster on your own, follow these steps: 1. Click **Create Cluster**. - 2. On the **Create Cluster** page, **Serverless** is selected by default. Select the target region for your cluster, update the default cluster name if necessary, select your [cluster plan](/tidb-cloud/select-cluster-tier.md#cluster-plans), and then click **Create**. Your {{{ .starter }}} cluster will be created in approximately 30 seconds. + 2. On the **Create Cluster** page, **Starter** is selected by default. Select the cloud provider and target region for your cluster, update the default cluster name if necessary, and then click **Create**. Your {{{ .starter }}} cluster will be created in approximately 30 seconds. + + > **Note** + > + > Currently, {{{ .starter }}} is generally available on AWS and in public preview on Alibaba Cloud. The subsequent steps in this document use AWS as an example. ## Step 2: Try AI-assisted SQL Editor -You can use the built-in AI-assisted SQL Editor in the TiDB Cloud console to maximize your data value. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs. +For {{{ .starter }}} clusters hosted on AWS, you can use the built-in AI-assisted SQL Editor in the TiDB Cloud console to maximize your data value. This enables you to run SQL queries against databases without a local SQL client. You can intuitively view the query results in tables or charts and easily check the query logs. -1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click on a cluster name to go to its overview page, and then click **SQL Editor** in the left navigation pane. +1. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click a cluster name to go to its overview page, and then click **SQL Editor** in the left navigation pane. 2. To try the AI capacity of TiDB Cloud, follow the on-screen instructions to allow PingCAP and AWS Bedrock to use your code snippets for research and service improvement, and then click **Save and Get Started**. 3. In SQL Editor, press ⌘ + I on macOS (or Control + I on Windows or Linux) to instruct [Chat2Query (beta)](/tidb-cloud/tidb-cloud-glossary.md#chat2query) to generate SQL queries automatically. - For example, to create a new table `test.t` with two columns (column `id` and column `name`), you can type `use test;` to specify the database, press ⌘ + I, type `create a new table t with id and name` as the instruction, and then press **Enter** to let AI generate a SQL statement accordingly. - + For example, to create a new table `test.t` with two columns (column `id` and column `name`), you can type `use test;` to specify the database, press ⌘ + I, type `create a new table t with id and name` as the instruction, and then press **Enter** to let AI generate a SQL statement accordingly. + For the generated statement, you can accept it by clicking **Accept** and then further edit it if needed, or reject it by clicking **Discard**. > **Note:** @@ -105,18 +109,17 @@ FROM `t`; ``` -## Step 3: Try interactive tutorials +## Step 3: Try guided tour on the console -TiDB Cloud offers interactive tutorials with carefully crafted sample datasets to help you quickly get started with TiDB Cloud. You can try these tutorials to learn how to use TiDB Cloud for high-performance data analytics. +TiDB Cloud offers an interactive tutorial with carefully crafted sample datasets to help you quickly get started with TiDB Cloud. For {{{ .starter }}} clusters hosted on AWS, you can try this tutorial to learn how to use TiDB Cloud for high-performance data analytics. -1. Click on the **?** icon in the lower-right corner of the console and select **Interactive Tutorials**. -2. In the tutorials list, select a tutorial card to start, such as **Steam Game Stats**. -3. Choose a {{{ .starter }}} cluster that you want to use for the tutorial, and click **Import Dataset**. The import process might take approximately one minute. -4. Once the sample data is imported, follow the on-screen instructions to complete the tutorial. +1. Click the **?** icon in the lower-right corner of the console and select **Guided tour of SQL Editor**. +2. Choose a {{{ .starter }}} cluster that you want to use for the tour, and click **Import Dataset**. The import process might take approximately one minute. +3. Once the sample data is imported, follow the on-screen instructions to complete the tour. ## What's next -- To learn how to connect to your cluster using different methods, see [Connect to a {{{ .starter }}} cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). +- To learn how to connect to your cluster using different methods, see [Connect to a {{{ .starter }}} or Essential cluster](/tidb-cloud/connect-to-tidb-cluster-serverless.md). - For more information about how to use SQL Editor and Chat2Query to explore your data, see [Explore your data with AI-assisted SQL Editor](/tidb-cloud/explore-data-with-chat2query.md). - For TiDB SQL usage, see [Explore SQL with TiDB](/basic-sql-operations.md). - For production use with the benefits of cross-zone high availability, horizontal scaling, and [HTAP](https://en.wikipedia.org/wiki/Hybrid_transactional/analytical_processing), see [Create a TiDB Cloud Dedicated cluster](/tidb-cloud/create-tidb-cluster.md). diff --git a/tidb-cloud/tidb-cloud-release-notes.md b/tidb-cloud/tidb-cloud-release-notes.md index c922b1316c39d..c98260a71ce15 100644 --- a/tidb-cloud/tidb-cloud-release-notes.md +++ b/tidb-cloud/tidb-cloud-release-notes.md @@ -45,15 +45,15 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Enhance the cloud storage data import experience for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Enhance the cloud storage data import experience for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. The import process is now streamlined into a 3-step wizard with intelligent pre-checks. This new wizard guides you through connection setup, file mapping, and bucket scanning. With the scanning, TiDB Cloud shows you exactly which files will be imported and their target destinations before the import, significantly reducing configuration complexity and preventing import failures. For more information, see the following documentation: - - [Import Sample Data into {{{ .starter }}}](/tidb-cloud/import-sample-data-serverless.md) - - [Import CSV Files from Cloud Storage into {{{ .starter }}}](/tidb-cloud/import-csv-files-serverless.md) - - [Import Apache Parquet Files from Cloud Storage into {{{ .starter }}}](/tidb-cloud/import-parquet-files-serverless.md) + - [Import Sample Data into TiDB Cloud Serverless](/tidb-cloud/import-sample-data-serverless.md) + - [Import CSV Files from Cloud Storage into TiDB Cloud Serverless](/tidb-cloud/import-csv-files-serverless.md) + - [Import Apache Parquet Files from Cloud Storage into TiDB Cloud Serverless](/tidb-cloud/import-parquet-files-serverless.md) ## July 15, 2025 @@ -79,11 +79,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) database audit logging (beta) is now available upon request. This feature lets you record a history of user access details (such as any SQL statements executed) in logs. +- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) database audit logging (beta) is now available upon request. This feature lets you record a history of user access details (such as any SQL statements executed) in logs. - To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com) and click **Request Support**. Then, fill in "Apply for {{{ .starter }}} database audit logging" in the Description field and click **Submit**. + To request this feature, click **?** in the lower-right corner of the [TiDB Cloud console](https://tidbcloud.com) and click **Request Support**. Then, fill in "Apply for TiDB Cloud Serverless database audit logging" in the Description field and click **Submit**. - For more information, see [{{{ .starter }}} Database Audit Logging](/tidb-cloud/serverless-audit-logging.md). + For more information, see [TiDB Cloud Serverless Database Audit Logging](/tidb-cloud/serverless-audit-logging.md). - [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) supports user-controlled log redaction. @@ -165,9 +165,9 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **General changes** -- Full-text search (beta) now available in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) for AI applications. +- Full-text search (beta) now available in [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) for AI applications. - {{{ .starter }}} now supports full-text search (beta), enabling AI and Retrieval-Augmented Generation (RAG) applications to retrieve content by exact keywords. This complements vector search, which retrieves content by semantic similarity. Combining both methods significantly improves retrieval accuracy and answer quality in RAG workflows. Key features include: + TiDB Cloud Serverless now supports full-text search (beta), enabling AI and Retrieval-Augmented Generation (RAG) applications to retrieve content by exact keywords. This complements vector search, which retrieves content by semantic similarity. Combining both methods significantly improves retrieval accuracy and answer quality in RAG workflows. Key features include: - Direct text search: query string columns directly without the need for embeddings. - Multilingual support: automatically detects and analyzes text in multiple languages, even within the same table, without requiring language specification. @@ -203,24 +203,24 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Data export to Alibaba Cloud OSS is now supported. - [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters now support exporting data to [Alibaba Cloud Object Storage Service (OSS)](https://www.alibabacloud.com/en/product/object-storage-service) using an [AccessKey pair](https://www.alibabacloud.com/help/en/ram/user-guide/create-an-accesskey-pair). + [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters now support exporting data to [Alibaba Cloud Object Storage Service (OSS)](https://www.alibabacloud.com/en/product/object-storage-service) using an [AccessKey pair](https://www.alibabacloud.com/help/en/ram/user-guide/create-an-accesskey-pair). - For more information, see [Export Data from {{{ .starter }}}](/tidb-cloud/serverless-export.md#alibaba-cloud-oss). + For more information, see [Export Data from TiDB Cloud Serverless](/tidb-cloud/serverless-export.md#alibaba-cloud-oss). -- Upgrade the TiDB version of [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from [v7.1.3](https://docs.pingcap.com/tidb/v7.1/release-7.1.3) to [v7.5.2](https://docs.pingcap.com/tidb/v7.5/release-7.5.2). +- Upgrade the TiDB version of [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters from [v7.1.3](https://docs.pingcap.com/tidb/v7.1/release-7.1.3) to [v7.5.2](https://docs.pingcap.com/tidb/v7.5/release-7.5.2). ## April 15, 2025 **General changes** -- Support importing data from [Alibaba Cloud Object Storage Service (OSS)](https://www.alibabacloud.com/en/product/object-storage-service) into [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Support importing data from [Alibaba Cloud Object Storage Service (OSS)](https://www.alibabacloud.com/en/product/object-storage-service) into [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. - This feature simplifies data migration to {{{ .starter }}}. You can use an AccessKey pair to authenticate. + This feature simplifies data migration to TiDB Cloud Serverless. You can use an AccessKey pair to authenticate. For more information, see the following documentation: - - [Import CSV Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}}](/tidb-cloud/import-csv-files-serverless.md) - - [Import Apache Parquet Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into {{{ .starter }}}](/tidb-cloud/import-parquet-files-serverless.md) + - [Import CSV Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud Serverless](/tidb-cloud/import-csv-files-serverless.md) + - [Import Apache Parquet Files from Amazon S3, GCS, Azure Blob Storage, or Alibaba Cloud OSS into TiDB Cloud Serverless](/tidb-cloud/import-parquet-files-serverless.md) ## April 1, 2025 @@ -264,11 +264,11 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c **Console changes** -- Support firewall rules for public endpoints in [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Support firewall rules for public endpoints in [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. - You can now configure firewall rules for {{{ .starter }}} clusters to control access via public endpoints. Specify allowed IP addresses or ranges directly in the [TiDB Cloud console](https://tidbcloud.com/) to enhance security. + You can now configure firewall rules for TiDB Cloud Serverless clusters to control access via public endpoints. Specify allowed IP addresses or ranges directly in the [TiDB Cloud console](https://tidbcloud.com/) to enhance security. - For more information, see [Configure {{{ .starter }}} Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). + For more information, see [Configure TiDB Cloud Serverless Firewall Rules for Public Endpoints](/tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md). ## March 18, 2025 @@ -305,17 +305,17 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Connected Care Overview](/tidb-cloud/connected-care-overview.md). -- Support importing data from GCS and Azure Blob Storage into [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Support importing data from GCS and Azure Blob Storage into [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. - {{{ .starter }}} now supports importing data from Google Cloud Storage (GCS) and Azure Blob Storage. You can use a Google Cloud service account key or an Azure shared access signature (SAS) token to authenticate. This feature simplifies data migration to {{{ .starter }}}. + TiDB Cloud Serverless now supports importing data from Google Cloud Storage (GCS) and Azure Blob Storage. You can use a Google Cloud service account key or an Azure shared access signature (SAS) token to authenticate. This feature simplifies data migration to TiDB Cloud Serverless. - For more information, see [Import CSV Files from Amazon S3, GCS, or Azure Blob Storage into {{{ .starter }}}](/tidb-cloud/import-csv-files-serverless.md) and [Import Apache Parquet Files from Amazon S3, GCS, or Azure Blob Storage into {{{ .starter }}}](/tidb-cloud/import-parquet-files-serverless.md). + For more information, see [Import CSV Files from Amazon S3, GCS, or Azure Blob Storage into TiDB Cloud Serverless](/tidb-cloud/import-csv-files-serverless.md) and [Import Apache Parquet Files from Amazon S3, GCS, or Azure Blob Storage into TiDB Cloud Serverless](/tidb-cloud/import-parquet-files-serverless.md). ## January 21, 2025 **Console changes** -- Support importing a single local CSV file of up to 250 MiB per task to [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, increased from the previous limit of 50 MiB. +- Support importing a single local CSV file of up to 250 MiB per task to [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters, increased from the previous limit of 50 MiB. For more information, see [Import Local Files to TiDB Cloud](/tidb-cloud/tidb-cloud-import-local-files.md). @@ -371,7 +371,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c For more information, see [Identity Access Management](/tidb-cloud/manage-user-access.md#organization-roles). -- Regional high availability (beta) for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +- Regional high availability (beta) for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. This feature is designed for workloads that require maximum infrastructure redundancy and business continuity. Key functions include: @@ -381,7 +381,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c This feature is currently available only in the AWS Tokyo (ap-northeast-1) region and can be enabled only during cluster creation. - For more information, see [High Availability in {{{ .starter }}}](/tidb-cloud/serverless-high-availability.md). + For more information, see [High Availability in TiDB Cloud Serverless](/tidb-cloud/serverless-high-availability.md). - Upgrade the default TiDB version of new [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters from [v8.1.1](https://docs.pingcap.com/tidb/v8.1/release-8.1.1) to [v8.1.2](https://docs.pingcap.com/tidb/v8.1/release-8.1.2). @@ -389,8 +389,8 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Strengthen the data export service: - - Support exporting data from [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) to Google Cloud Storage and Azure Blob Storage through the [TiDB Cloud console](https://tidbcloud.com/). + - Support exporting data from [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) to Google Cloud Storage and Azure Blob Storage through the [TiDB Cloud console](https://tidbcloud.com/). - Support exporting data in Parquet files through the [TiDB Cloud console](https://tidbcloud.com/). - For more information, see [Export Data from {{{ .starter }}}](/tidb-cloud/serverless-export.md) and [Configure External Storage Access for {{{ .starter }}}](/tidb-cloud/serverless-external-storage.md). + For more information, see [Export Data from TiDB Cloud Serverless](/tidb-cloud/serverless-export.md) and [Configure External Storage Access for TiDB Cloud Serverless](/tidb-cloud/serverless-external-storage.md). diff --git a/tidb-cloud/tidb-node-group-management.md b/tidb-cloud/tidb-node-group-management.md index 21f3105e8067d..2582c25d8695d 100644 --- a/tidb-cloud/tidb-node-group-management.md +++ b/tidb-cloud/tidb-node-group-management.md @@ -9,7 +9,7 @@ This document describes how to manage TiDB node groups and their endpoints to is > **Note**: > -> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} clusters. +> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} or {{{ .essential }}} clusters. ## Terms diff --git a/tidb-cloud/tidb-node-group-overview.md b/tidb-cloud/tidb-node-group-overview.md index d8af27e84ca0f..8d66d90287b26 100644 --- a/tidb-cloud/tidb-node-group-overview.md +++ b/tidb-cloud/tidb-node-group-overview.md @@ -11,7 +11,7 @@ With TiDB node groups, you can divide computing nodes into multiple TiDB node gr > **Note**: > -> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} clusters. +> The TiDB Node Group feature is **NOT** available for {{{ .starter }}} and {{{ .essential }}} clusters. ## Implementation diff --git a/tidb-cloud/tune-performance.md b/tidb-cloud/tune-performance.md index 3f347c8ba7ed9..97df87f145908 100644 --- a/tidb-cloud/tune-performance.md +++ b/tidb-cloud/tune-performance.md @@ -17,7 +17,7 @@ TiDB Cloud provides [Slow Query](#slow-query), [Statement Analysis](#statement-a > **Note:** > -> Currently, **Key Visualizer** and **Index Insight (beta)** are unavailable for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. +> Currently, **Key Visualizer** and **Index Insight (beta)** are only available on TiDB Cloud Dedicated clusters. ## View the Diagnosis page diff --git a/tidb-cloud/upgrade-tidb-cluster.md b/tidb-cloud/upgrade-tidb-cluster.md index a1a600eb8f4d9..0db40382511a8 100644 --- a/tidb-cloud/upgrade-tidb-cluster.md +++ b/tidb-cloud/upgrade-tidb-cluster.md @@ -15,7 +15,7 @@ For the TiDB version that is too low, TiDB Cloud will regularly upgrade it unifo To submit an upgrade request, perform the steps in [TiDB Cloud Support](/tidb-cloud/tidb-cloud-support.md) to contact our support team. Note to provide the following information in the **Description** box: -- Cloud Provider: AWS, Azure, or Google Cloud +- Cloud Provider: AWS, Azure, Google Cloud, or Alibaba Cloud - Cluster Name: xxx TiDB Cloud technical support will confirm with you the time period for the upgrade. After you have confirmed the upgrade time, TiDB Cloud technical support will do the upgrade in the confirmed time period. diff --git a/tidb-cloud/use-chat2query-api.md b/tidb-cloud/use-chat2query-api.md index 5d6c2088f2dc8..e39ddea65b24a 100644 --- a/tidb-cloud/use-chat2query-api.md +++ b/tidb-cloud/use-chat2query-api.md @@ -11,7 +11,7 @@ Chat2Query API can only be accessed through HTTPS, ensuring that all data transm > **Note:** > -> Chat2Query API is available for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. To use the Chat2Query API on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +> Chat2Query API is only available for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) (now Starter) clusters hosted on AWS. To use the Chat2Query API on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Before you begin diff --git a/tidb-cloud/use-chat2query-knowledge.md b/tidb-cloud/use-chat2query-knowledge.md index 45158d463f650..dbef1eafbcebe 100644 --- a/tidb-cloud/use-chat2query-knowledge.md +++ b/tidb-cloud/use-chat2query-knowledge.md @@ -11,7 +11,7 @@ Starting from v3, the Chat2Query API enables you to add or modify knowledge base > **Note:** > -> Knowledge base related endpoints are available for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters by default. To use knowledge base related endpoints on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). +> Knowledge base related endpoints are only available for [{{{ .starter }}}](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters hosted on AWS. To use knowledge base related endpoints on [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters, contact [TiDB Cloud support](/tidb-cloud/tidb-cloud-support.md). ## Before you begin diff --git a/tidb-cloud/use-htap-cluster.md b/tidb-cloud/use-htap-cluster.md index 854c41ae12edf..f19979d7985bd 100644 --- a/tidb-cloud/use-htap-cluster.md +++ b/tidb-cloud/use-htap-cluster.md @@ -11,7 +11,7 @@ With TiDB Cloud, you can create an HTAP cluster easily by specifying one or more > **Note:** > -> TiFlash is always enabled for {{{ .starter }}} clusters. You cannot disable it. +> TiFlash is always enabled for {{{ .starter }}} and {{{ .essential }}} clusters. You cannot disable it. TiKV data is not replicated to TiFlash by default. You can select which table to replicate to TiFlash using the following SQL statement: diff --git a/tidb-cloud/vector-search-full-text-search-python.md b/tidb-cloud/vector-search-full-text-search-python.md index 16c0b1d23fbf1..a70cb55eed04f 100644 --- a/tidb-cloud/vector-search-full-text-search-python.md +++ b/tidb-cloud/vector-search-full-text-search-python.md @@ -28,7 +28,7 @@ The full-text search feature in TiDB provides the following capabilities: Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, Full-text search is only available for the following product option and regions: -- {{{ .starter }}}: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` +- {{{ .starter }}} on AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` To complete this tutorial, make sure you have a {{{ .starter }}} cluster in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. diff --git a/tidb-cloud/vector-search-full-text-search-sql.md b/tidb-cloud/vector-search-full-text-search-sql.md index 0f1fb1e17b889..4683ad4299679 100644 --- a/tidb-cloud/vector-search-full-text-search-sql.md +++ b/tidb-cloud/vector-search-full-text-search-sql.md @@ -28,7 +28,7 @@ The full-text search feature in TiDB provides the following capabilities: Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, Full-text search is only available for the following product option and regions: -- {{{ .starter }}}: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` +- {{{ .starter }}} on AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` Before using full-text search, make sure your {{{ .starter }}} cluster is created in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. diff --git a/tidb-cloud/vector-search-hybrid-search.md b/tidb-cloud/vector-search-hybrid-search.md index 46cbfeb86f4cb..ee5305b65766c 100644 --- a/tidb-cloud/vector-search-hybrid-search.md +++ b/tidb-cloud/vector-search-hybrid-search.md @@ -21,7 +21,7 @@ This tutorial demonstrates how to use hybrid search in TiDB with the [pytidb](ht Hybrid search relies on both [full-text search](/tidb-cloud/vector-search-full-text-search-python.md) and vector search. Full-text search is still in the early stages, and we are continuously rolling it out to more customers. Currently, Full-text search is only available for the following product option and regions: -- {{{ .starter }}}: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` +- {{{ .starter }}} on AWS: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)` To complete this tutorial, make sure you have a {{{ .starter }}} cluster in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it. diff --git a/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md b/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md index 3164d407cfd1d..6b7c93cfa6c5f 100644 --- a/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md +++ b/tidb-cloud/vector-search-integrate-with-amazon-bedrock.md @@ -17,7 +17,7 @@ This tutorial demonstrates how to integrate the [vector search](/vector-search/v > **Note** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). > **Tip** > @@ -249,7 +249,7 @@ In `demo.py`, add the following code to save the vector data to your {{{ .starte ```python # ---- Saving Vectors to TiDB ---- def save_entities_with_embedding(session, contents): - """Save multiple entities with their embeddings to the TiDB Serverless database.""" + """Save multiple entities with their embeddings to the TiDB database.""" for content in contents: entity = Entity(content=content, content_vec=embedding(content)) session.add(entity) diff --git a/tidb-distributed-execution-framework.md b/tidb-distributed-execution-framework.md index abe37293ecf6b..c2a0a1fe657d8 100644 --- a/tidb-distributed-execution-framework.md +++ b/tidb-distributed-execution-framework.md @@ -7,7 +7,7 @@ summary: Learn the use cases, limitations, usage, and implementation principles > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. TiDB adopts a computing-storage separation architecture with excellent scalability and elasticity. Starting from v7.1.0, TiDB introduces a **Distributed eXecution Framework (DXF)** to further leverage the resource advantages of the distributed architecture. The goal of the DXF is to implement unified scheduling and distributed execution of tasks, and to provide unified resource management capabilities for both overall and individual tasks, which better meets users' expectations for resource usage. diff --git a/tidb-global-sort.md b/tidb-global-sort.md index 91aa92b35aec2..3f05f3dd2859f 100644 --- a/tidb-global-sort.md +++ b/tidb-global-sort.md @@ -15,7 +15,7 @@ summary: Learn the use cases, limitations, usage, and implementation principles > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. ## Overview diff --git a/tidb-resource-control-background-tasks.md b/tidb-resource-control-background-tasks.md index 291e81834d754..038777eba7555 100644 --- a/tidb-resource-control-background-tasks.md +++ b/tidb-resource-control-background-tasks.md @@ -13,7 +13,7 @@ summary: Introduces how to control background tasks through Resource Control. > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. Background tasks, such as data backup and automatic statistics collection, are low-priority but consume many resources. These tasks are usually triggered periodically or irregularly. During execution, they consume a lot of resources, thus affecting the performance of online high-priority tasks. diff --git a/tidb-resource-control-ru-groups.md b/tidb-resource-control-ru-groups.md index d13073f23a499..4b930fa67f6b0 100644 --- a/tidb-resource-control-ru-groups.md +++ b/tidb-resource-control-ru-groups.md @@ -8,7 +8,7 @@ aliases: ['/tidb/v8.5/tidb-resource-control/','/tidb/stable/tidb-resource-contro > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. As a cluster administrator, you can use the resource control feature to create resource groups, set quotas for resource groups, and bind users to those groups. diff --git a/tidb-resource-control-runaway-queries.md b/tidb-resource-control-runaway-queries.md index 939651bb45643..0d1ed6ad5d933 100644 --- a/tidb-resource-control-runaway-queries.md +++ b/tidb-resource-control-runaway-queries.md @@ -7,7 +7,7 @@ summary: Introduces how to control and degrade queries with excessive resource c > **Note:** > -> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) clusters. +> This feature is not available on [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless) and [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential) clusters. A runaway query is a query that consumes more time or resources than expected. The term **runaway queries** is used in the following to describe the feature of managing the runaway query. diff --git a/variables.json b/variables.json index 7e37188aeb836..cccfc4758b600 100644 --- a/variables.json +++ b/variables.json @@ -3,7 +3,7 @@ "tidb-version": "v8.5.2", "tidb-release-date": "2025-06-12", "self-managed": "TiDB Self-Managed", - "starter": "TiDB Cloud Serverless", + "starter": "TiDB Cloud Starter", "essential": "TiDB Cloud Essential", "dedicated": "TiDB Cloud Dedicated", "console-url": "tidbcloud.com" diff --git a/vector-search/vector-search-data-types.md b/vector-search/vector-search-data-types.md index 7f2c920cf8888..b999aa742880d 100644 --- a/vector-search/vector-search-data-types.md +++ b/vector-search/vector-search-data-types.md @@ -25,7 +25,7 @@ A vector is a sequence of floating-point numbers, such as `[0.3, 0.5, -0.1, ...] > **Note:** > -> Vector data types are available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> Vector data types are available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). The following Vector data types are currently available: diff --git a/vector-search/vector-search-functions-and-operators.md b/vector-search/vector-search-functions-and-operators.md index bc56c998244c9..cec433dad2581 100644 --- a/vector-search/vector-search-functions-and-operators.md +++ b/vector-search/vector-search-functions-and-operators.md @@ -25,7 +25,7 @@ This document lists the functions and operators available for Vector data types. > **Note:** > -> Vector data types and these vector functions are available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> Vector data types and these vector functions are available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Vector functions diff --git a/vector-search/vector-search-get-started-using-python.md b/vector-search/vector-search-get-started-using-python.md index e6d9bd70ccaf4..5d5a0e21188db 100644 --- a/vector-search/vector-search-get-started-using-python.md +++ b/vector-search/vector-search-get-started-using-python.md @@ -27,7 +27,7 @@ Throughout this tutorial, you will develop this AI application using [TiDB Vecto > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -84,7 +84,7 @@ pip install sqlalchemy pymysql sentence-transformers tidb-vector python-dotenv Configure the cluster connection string depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-get-started-using-sql.md b/vector-search/vector-search-get-started-using-sql.md index b17405d9b9fee..3baa859766824 100644 --- a/vector-search/vector-search-get-started-using-sql.md +++ b/vector-search/vector-search-get-started-using-sql.md @@ -32,7 +32,7 @@ This tutorial demonstrates how to get started with TiDB Vector Search just using > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -65,7 +65,7 @@ To complete this tutorial, you need: Connect to your TiDB cluster depending on the TiDB deployment option you've selected. -
+
1. Navigate to the [**Clusters**](https://tidbcloud.com/console/clusters) page, and then click the name of your target cluster to go to its overview page. diff --git a/vector-search/vector-search-improve-performance.md b/vector-search/vector-search-improve-performance.md index 0a790d1ba348a..b47610a964d33 100644 --- a/vector-search/vector-search-improve-performance.md +++ b/vector-search/vector-search-improve-performance.md @@ -25,7 +25,7 @@ TiDB Vector Search enables you to perform Approximate Nearest Neighbor (ANN) que > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Add vector search index for vector columns diff --git a/vector-search/vector-search-index.md b/vector-search/vector-search-index.md index e7f8189b16869..8d3e7bc8991b7 100644 --- a/vector-search/vector-search-index.md +++ b/vector-search/vector-search-index.md @@ -27,7 +27,7 @@ To improve search efficiency, you can create vector search indexes in TiDB for a > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). Currently, TiDB supports the [HNSW (Hierarchical Navigable Small World)](https://en.wikipedia.org/wiki/Hierarchical_navigable_small_world) vector search index algorithm. diff --git a/vector-search/vector-search-integrate-with-django-orm.md b/vector-search/vector-search-integrate-with-django-orm.md index 60eac6863dd66..9f7ba5430eab4 100644 --- a/vector-search/vector-search-integrate-with-django-orm.md +++ b/vector-search/vector-search-integrate-with-django-orm.md @@ -25,7 +25,7 @@ This tutorial walks you through how to use [Django](https://www.djangoproject.co > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -103,7 +103,7 @@ For more information, refer to [django-tidb repository](https://github.com/pingc Configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integrate-with-jinaai-embedding.md b/vector-search/vector-search-integrate-with-jinaai-embedding.md index 3ccc0cbec171c..49a5df299325f 100644 --- a/vector-search/vector-search-integrate-with-jinaai-embedding.md +++ b/vector-search/vector-search-integrate-with-jinaai-embedding.md @@ -25,7 +25,7 @@ This tutorial walks you through how to use [Jina AI](https://jina.ai/) to genera > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -87,7 +87,7 @@ pip install -r requirements.txt Get the Jina AI API key from the [Jina AI Embeddings API](https://jina.ai/embeddings/) page, and then configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integrate-with-langchain.md b/vector-search/vector-search-integrate-with-langchain.md index e7b6622020e62..ff2240ead7f5e 100644 --- a/vector-search/vector-search-integrate-with-langchain.md +++ b/vector-search/vector-search-integrate-with-langchain.md @@ -25,7 +25,7 @@ This tutorial demonstrates how to integrate the [vector search](/vector-search/v > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). > **Tip** > @@ -94,7 +94,7 @@ from langchain_text_splitters import CharacterTextSplitter Configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integrate-with-llamaindex.md b/vector-search/vector-search-integrate-with-llamaindex.md index 60b8e13f57e49..af749bc7b50e6 100644 --- a/vector-search/vector-search-integrate-with-llamaindex.md +++ b/vector-search/vector-search-integrate-with-llamaindex.md @@ -25,7 +25,7 @@ This tutorial demonstrates how to integrate the [vector search](/vector-search/v > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). > **Tip** > @@ -93,7 +93,7 @@ from llama_index.vector_stores.tidbvector import TiDBVectorStore Configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integrate-with-peewee.md b/vector-search/vector-search-integrate-with-peewee.md index 7e20c04987132..7f91c7b726237 100644 --- a/vector-search/vector-search-integrate-with-peewee.md +++ b/vector-search/vector-search-integrate-with-peewee.md @@ -25,7 +25,7 @@ This tutorial walks you through how to use [peewee](https://docs.peewee-orm.com/ > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -93,7 +93,7 @@ pip install peewee pymysql python-dotenv tidb-vector Configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integrate-with-sqlalchemy.md b/vector-search/vector-search-integrate-with-sqlalchemy.md index 494ff09064ecd..fa8a5e7f06cfe 100644 --- a/vector-search/vector-search-integrate-with-sqlalchemy.md +++ b/vector-search/vector-search-integrate-with-sqlalchemy.md @@ -25,7 +25,7 @@ This tutorial walks you through how to use [SQLAlchemy](https://www.sqlalchemy.o > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Prerequisites @@ -93,7 +93,7 @@ pip install pymysql python-dotenv sqlalchemy tidb-vector Configure the environment variables depending on the TiDB deployment option you've selected. -
+
For a {{{ .starter }}} cluster, take the following steps to obtain the cluster connection string and configure environment variables: diff --git a/vector-search/vector-search-integration-overview.md b/vector-search/vector-search-integration-overview.md index f1c8fe5c905cc..7d0a871365f3e 100644 --- a/vector-search/vector-search-integration-overview.md +++ b/vector-search/vector-search-integration-overview.md @@ -25,7 +25,7 @@ This document provides an overview of TiDB vector search integration, including > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## AI frameworks diff --git a/vector-search/vector-search-limitations.md b/vector-search/vector-search-limitations.md index 399c578f1c579..a83d5e9e850f7 100644 --- a/vector-search/vector-search-limitations.md +++ b/vector-search/vector-search-limitations.md @@ -25,7 +25,7 @@ This document describes the known limitations of TiDB vector search. > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Vector data type limitations diff --git a/vector-search/vector-search-overview.md b/vector-search/vector-search-overview.md index d7a42e2c0ed95..eed337d26679f 100644 --- a/vector-search/vector-search-overview.md +++ b/vector-search/vector-search-overview.md @@ -25,7 +25,7 @@ Vector search offers a powerful solution for semantic similarity searches across > **Note:** > -> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). +> The vector search feature is available on TiDB Self-Managed, [{{{ .starter }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-serverless), [{{{ .essential }}}](https://docs.pingcap.com/tidbcloud/select-cluster-tier#essential), and [TiDB Cloud Dedicated](https://docs.pingcap.com/tidbcloud/select-cluster-tier#tidb-cloud-dedicated). For TiDB Self-Managed and TiDB Cloud Dedicated, the TiDB version must be v8.4.0 or later (v8.5.0 or later is recommended). ## Concepts