DESCRIBE

接続されているCassandraクラスター、またはクラスターに格納されているデータ・オブジェクトに関する情報を提供します。

接続されているCassandraクラスター、またはクラスターに格納されているデータ・オブジェクトに関する情報を提供します。

構文

DESCRIBE FULL(CLUSTER | SCHEMA)| KEYSPACES |(KEYSPACE keyspace_name)| TABLES |(TABLE table_name)| TYPES |(TYPE user_defined_type)| FUNCTIONS |(FUNCTION user_defined_function)| AGGREGATES |(AGGREGATE user_defined_aggregate)| INDEX |(INDEX index_name)

構文の凡例

  • 大文字はリテラルを意味する
  • 小文字は、リテラルでないことを意味する
  • イタリック体は指定が任意であることを意味する
  • パイプ(|)記号はORまたはAND/ORを意味する
  • 省略記号(...)は繰り返し可能を意味する
  • 範囲記号「(」および「)」はリテラルではなく、範囲を示す

説明

DESCRIBEまたはDESCコマンドは、接続されているCassandraクラスター、またはそこに格納されているデータに関する情報を出力します。システム・テーブルに直接クエリーを実行するには、SELECTを使用します。

キースペースおよびテーブル名の引数は大文字と小文字が区別されるため、内部に格納されている名前の大文字または小文字と一致する必要があります。オブジェクトをその内部名ごとにリストする場合はDESCRIBEコマンドを使用します。system_*キースペースのスキーマが必要な場合は、DESCRIBE FULL SCHEMAを使用します。

DESCRIBEは以下のように機能します。

DESCRIBEコマンド 説明
DESCRIBE CLUSTER DESCRIBE CLUSTER; 接続されているCassandraクラスターに関する情報を出力します。出力には、クラスター名、パーティショナー、およびスニッチが含まれます。非システム・キースペースの場合は、エンドポイント範囲の所有権情報も表示されます。
DESCRIBE KEYSPACES すべてのキースペース名のリストを出力します。
DESCRIBE KEYSPACE <keyspace_name> DESCRIBE KEYSPACE cycling; 指定されたキースペースのCQLコマンドを出力します。これらのCQLコマンドは、キースペースやテーブルを再作成するために使用できます。
DESCRIBE [FULL] SCHEMA 非システム・キースペースおよびテーブル・スキーマ全体のCQLコマンドを出力します。FULLオプションを使用すると、システム・キースペースも含められます。
DESCRIBE TABLES 現在のキースペース内、または現在のキースペースが存在しない場合にはすべてのキースペース内のすべてのテーブルを出力します。
DESCRIBE TABLE <table_name> DESCRIBE TABLE upcoming_calendar; 指定されたテーブルのCQLコマンドを出力します。このCQLコマンドは、テーブルを再作成するために使用できます。
DESCRIBE INDEX <index_name> DESCRIBE INDEX team_entry; 指定されたインデックスのCQLコマンドを出力します。このCQLコマンドは、インデックスを再作成するために使用できます。
DESCRIBE TYPES 現在のキースペース内のすべてのユーザー定義型のリストを出力します。
DESCRIBE TYPE <type_name> DESCRIBE TYPE basic_info; 指定されたユーザー定義型のCQLコマンドを出力します。このCQLコマンドは、インデックスを再作成するために使用できます。
DESCRIBE FUNCTIONS <keyspace_name> DESCRIBE FUNCTIONS cycling; 指定されたキースペース内のすべてのユーザー定義関数の名前を出力します。
DESCRIBE FUNCTION <keyspace_name>.<function_name> DESCRIBE FUNCTION cycling.myFunction; 指定されたユーザー定義関数に関する情報を出力します。
DESCRIBE AGGREGATES <keyspace_name> DESCRIBE AGGREGATES cycling; 指定されたキースペース内のすべてのユーザー定義集計の名前を出力します。
DESCRIBE AGGREGATE <keyspace_name>.<aggregate_name> DESCRIBE AGGREGATE cycling.myAggregate; 指定されたユーザー定義集計に関する情報を出力します。