SQL statement template
- このテンプレートでは
*ADMIN SET REPLICA STATUS*
を例として使用し、SQL コマンドトピックの記述要件を説明します。- 実行テキスト内のコマンドとキーワードは大文字にします。例えば、「SELECT ステートメントは、特定の条件を満たすレコードをクエリするために使用されます。」、「この列のデータを GROUP BY でグループ化できます。」、「LIMIT キーワードは返されるレコードの最大数を指定します。」
- 実行テキスト内でパラメータやパラメータ値に言及する必要がある場合は、二重バッククォートで囲みます。例えば、
*cachesize*
。- CREATE TABLE、INSERT/LOAD データ、クエリ、クエリ結果、結果の説明を含む完全な例を提供します。
ADMIN SET REPLICA STATUS
トピックタイトル。英語のコマンド名をトピックタイトルとして使用します。コマンド名のすべての文字を大文字にします。正しいスペルを使用してください。
Description
tablet のレプリカステータスを指定します。このコマンドは、tablet のレプリカステータスを手動で bad
または ok
に設定するために使用されます。
このコマンドが何をするか。関連する説明や使用上の注意を追加できます。
Syntax
ADMIN SET REPLICA STATUS
PROPERTIES ("key" = "value", ...);
このコマンドの構文。構文をコードブロックで囲みます。構文がコーディング仕様に準拠していることを確認してください。
-
適切な改行とインデントを使用します。
-
コード内で中国語の文字(中国語のセミコロンやコンマなど)を使用しないでください。
-
SQL コマンドのキーワードを大文字にします。例:
SELECT ta.x, count(ta.y) AS y, sum(tb.z) AS z
FROM (
SELECT a AS x, b AS y
FROM t) ta
JOIN tb
ON ta.x = tb.x
WHERE tb.a > 10
GROUP BY ta.x
ORDER BY ta.x, z
LIMIT 10
Parameters
PROPERTIES
: 各プロパティはキーと値のペアでなければなりません。サポートされているプロパティ:
tablet_id
: tablet の ID。このパラメータは必須です。backend_id
: tablet の BE ID。このパラメータは必須です。status
: レプリカのステータス。このパラメータは必須です。有効な値:bad
とok
。値ok
は、システムが自動的に tablet のレプリカを修復することを示します。レプリカステータスがbad
に設定されている場合、レプリカは直ちに削除される可能性があります。この操作を行う際は注意してください。指定した tablet が存在しない場合やレプリカステータスがbad
の場合、システムはこれらのレプリカを無視します。
コマンド内のパラメータの説明。
-
推奨されるパラメータの説明には、パラメータの意味、値の形式、値の範囲、このパラメータが必須かどうか、必要に応じて他の注釈を含める必要があります。
-
パラメータの説明を整理するために、順序なしリストを使用できます。説明が複雑な場合は、情報を表として整理できます。表は次の列で構成できます: パラメータ名、値のタイプ(オプション)、例の値(オプション)、パラメータの説明。
Return fields
返されるフィールドを説明します。フィールドに複数の値がある場合は、これらの値と特定の値が返されるシナリオをリストします。
Usage notes (optional)
このコマンドを使用する際の注意事項や注意点を追加できます。
Examples
例 1: BE 10001 上の tablet 10003 のレプリカステータスを bad
に設定します。
ADMIN SET REPLICA STATUS PROPERTIES("tablet_id" = "10003", "backend_id" = "10001", "status" = "bad");
例 2: BE 10001 上の tablet 10003 のレプリカステータスを ok
に設定します。
ADMIN SET REPLICA STATUS PROPERTIES("tablet_id" = "10003", "backend_id" = "10001", "status" = "ok");
-
このコマンドを使用する例を提供し、各例の目的を説明します。
-
複数の例を提供できます。
-
例で複数のシナリオを説明する必要がある場合は、コードスニペット内の各シナリオにコメントを追加して、ユーザーがすばやく区別できるようにします。