DESCRIBE 文 [Interactive SQL]

DESCRIBE [ [ INDEX FOR ] TABLE | PROCEDURE ] [ owner.]object-name

 object-name : 
table
| view
| materialized view
| procedure
| function

DESCRIBE CONNECTION

INDEX FOR 句 指定した object-name のインデックスを表示することを指定します。
TABLE 句 記述する object-name がテーブルまたはビューであることを示します。
PROCEDURE 句 object-name がプロシージャーまたはファンクションであることを示します。

DESCRIBE TABLE を使用すると、指定したテーブルまたはビューのすべてのカラムが表示されます。DESCRIBE TABLE 文は 1 つのテーブルカラムにつき 1 つのローを返します。これには、次のものが含まれます。

カラム カラムの名前。
タイプ カラムに格納されているデータ型
NULL 入力可 NULL が許可されているかどうか (1=許可、0=不許可)
プライマリキー カラムがプライマリキーにあるかどうか (1=ある、0=ない)

DESCRIBE INDEX FOR TABLE を使用すると、指定したテーブルのすべてのインデックスが表示されます。DESCRIBE TABLE 文は 1 つのインデックスにつき 1 つのローを返します。これには、次のものが含まれます。

インデックス名 インデックスの名前。
カラム インデックス内のカラム。
ユニーク インデックスがユニークかどうか (1=ユニーク、0=ユニークではない)。
タイプ インデックスの型。可能な値は、「クラスタード」、「統計情報」、「ハッシュド」、「その他」です。

DESCRIBE PROCEDURE を使用すると、指定したプロシージャーまたはファンクションが使用しているすべてのパラメーターが表示されます。DESCRIBE PROCEDURE 文は、1 つのパラメーターにつき 1 つのローを返します。これには、次のものが含まれます。

パラメーター パラメーターの名前。
タイプ パラメーターのユーザー型。
入力／出力 パラメーターに渡すデータまたは返されるデータに関する情報。可能な値は、次のとおりです。
- 入力パラメーターはプロシージャーに渡されますが、修正されません。
- 出力プロシージャーはパラメーターの初期値を無視し、プロシージャーが返るときに値を設定します。
- 入力／出力 パラメーターはプロシージャーに渡され、プロシージャーはプロシージャーが返るときにパラメーターの値を設定します。
- 結果パラメーターは結果セットを返します。
- 戻り値 パラメーターは宣言済みの戻り値を返します。

TABLE または PROCEDURE を指定していない場合 (たとえば、DESCRIBE object-name)、Interactive SQL はオブジェクトをテーブルと仮定します。ただし、そのようなテーブルが存在しない場合、Interactive SQL はプロシージャーまたはファンクションとしてオブジェクトを記述しようとします。

構文 2 を使用して Interactive SQL が接続されているデータベースまたはデータベースサーバーに関する情報をリストします。次のプロパティが返されます。

データベース製品 Interactive SQL が接続されているデータベース製品の名前とバージョン番号 (SQL Anywhere 12.0.1.3600 など)。
ホスト名 データベースサーバーを実行しているコンピューターのネットワーク名。
ホストの TCP/IP アドレス データベースサーバーを実行しているコンピューターの IP アドレス。
ホストのオペレーティングシステム データベースサーバーを実行しているコンピューターで使用されるオペレーティングシステムの名前とバージョン番号。
サーバー名 データベースサーバーの名前。
サーバーの TCP/IP ポート 現在の接続でデータベースサーバーによって使用されるポート番号。
データベース名 Interactive SQL が接続されているデータベースの名前。
データベースの文字セット データベースの CHAR カラムに使用される文字セット。
接続文字列 データベースまたはデータベースサーバーとの接続に使用された接続文字列。3 つのアスタリスクはパスワードに置き換えます。

現在の接続に該当しないプロパティは省略されます。たとえば、共有メモリを使用してデータベースサーバーに接続する場合、TCP/IP ポートは省略されます。

なし

Interactive SQL

SQL/2008 ベンダー拡張。

Departments テーブル内のカラムを記述します。

DESCRIBE TABLE Departments;

この文の結果セットの例を示します。

カラム	タイプ	NULL 入力可	プライマリキー
DepartmentID	integer	0	1
DepartmentName	char (40)	0	0
DepartmentHeadID	integer	1	0

Customers テーブルのインデックスを表示します。

DESCRIBE INDEX FOR TABLE Customers;

この文の結果の例を示します。

Index Name	Columns	Unique	Type
IX_customer_name	Surname,GivenName	0	Clustered

DESCRIBE 文 [Interactive SQL]

構文 1 - データベースオブジェクトの記述

構文 2 - 現在の接続の記述

パラメーター

備考

パーミッション

関連する動作

参照

標準と互換性

例