Skip to content

Commit

Permalink
Add a note to clarify the purpose of the quick start guide (pingcap#5876
Browse files Browse the repository at this point in the history
)
  • Loading branch information
TomShawn authored Jul 12, 2021
1 parent 9577038 commit 89646b2
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
1 change: 0 additions & 1 deletion experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ This document introduces the experimental features of TiDB in different versions

+ [Integrate TiCDC with Kafka Connect (Confluent Platform)](/ticdc/integrate-confluent-using-ticdc.md) (Introduced in v5.0)
+ [The cyclic replication feature of TiCDC](/ticdc/manage-ticdc.md#cyclic-replication) (Introduced in v5.0)
+ [Bit flags of columns](/ticdc/ticdc-open-protocol.md#bit-flags-of-columns) in [TiCDC Open Protocol](/ticdc/ticdc-open-protocol.md#row-changed-event).

## Storage

Expand Down
8 changes: 7 additions & 1 deletion quick-start-with-tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ aliases: ['/docs/dev/quick-start-with-tidb/','/docs/dev/test-deployment-using-do

This guide walks you through the quickest way to get started with TiDB. You will be using TiUP, a package manager in the TiDB ecosystem, to help you run any TiDB cluster component with only a single line of command.

To deploy an on-premise production cluster instead, go to [production installation guide](/production-deployment-using-tiup.md). To deploy TiDB in Kubernetes, go to [Get Started with TiDB in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/get-started). To manage TiDB in the cloud, go to [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/beta/tidb-cloud-quickstart).
> **Note:**
>
> The deployment method provided in this guide is **ONLY FOR** quick start, **NOT FOR** production.
>
> - To deploy an on-premises production cluster, see [production installation guide](/production-deployment-using-tiup.md).
> - To deploy TiDB in Kubernetes, see [Get Started with TiDB in Kubernetes](https://docs.pingcap.com/tidb-in-kubernetes/stable/get-started).
> - To manage TiDB in the cloud, see [TiDB Cloud Quick Start](https://docs.pingcap.com/tidbcloud/beta/tidb-cloud-quickstart).
<SimpleTab>
<div label="Mac">
Expand Down
3 changes: 1 addition & 2 deletions ticdc/ticdc-open-protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ This section introduces the formats of Row Changed Event, DDL Event, and Resolve
| Column Name | String | The column name. |
| Column Type | Number | The column type. For details, see [Column Type Code](#column-type-code). |
| Where Handle | Boolean | Determines whether this column can be the filter condition of the `Where` clause. When this column is unique on the table, `Where Handle` is `true`. |
| Flag (**experimental**) | Number | The bit flags of columns. For details, see [Bit flags of columns](#bit-flags-of-columns). |
| Flag | Number | The bit flags of columns. For details, see [Bit flags of columns](#bit-flags-of-columns). |
| Column Value | Any | The Column value. |

### DDL Event
Expand Down Expand Up @@ -385,6 +385,5 @@ If the value of a column is `46`, the column is a composite index column, a prim

> **Note:**
>
> + This feature is still experimental. Do **NOT** use it in the production environment.
> + `BinaryFlag` is meaningful only when the column type is BLOB/TEXT (including TINYBLOB/TINYTEXT and BINARY/CHAR). When the upstream column is the BLOB type, the `BinaryFlag` value is set to `1`. When the upstream column is the TEXT type, the `BinaryFlag` value is set to `0`.
> + To replicate a table from the upstream, TiCDC selects a [valid index](/ticdc/ticdc-overview.md#restrictions) as the Handle index. The `HandleKeyFlag` value of the Handle index column is set to `1`.

0 comments on commit 89646b2

Please sign in to comment.