sp_help (Transact-SQL)
適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance
データベース オブジェクト ( sys.sysobjects 互換性ビューにリストされている任意のオブジェクト)、ユーザー定義データ型、またはデータ型に関する情報を報告します。
構文
sp_help [ [ @objname = ] 'name' ]
引数
[ @objname = ] 'name'
sysobjects 内の任意のオブジェクトの名前、または systypes テーブル内の任意のユーザー定義データ型です。 name は nvarchar(776)で、既定値は NULL です。 データベース名は使用できません。 'Person.AddressType' や '[Person] など、2 つまたは 3 つの部分の名前を区切ります。[AddressType]'。
リターン コードの値
0 (成功) または 1 (失敗)
結果セット
返される結果セットは、名前が指定されているかどうか、 指定 された場合、およびどのデータベース オブジェクトであるかによって異なります。
引数なしでsp_helpを実行すると、現在のデータベースに存在するすべての型のオブジェクトの概要情報が返されます。
列名 データ型 説明 名前 nvarchar(128) オブジェクト名 所有者 nvarchar(128) オブジェクト所有者 (これはオブジェクトを所有するデータベース プリンシパルです。既定値は、 オブジェクトを含むスキーマの所有者です)。 Object_type nvarchar(31) オブジェクトの種類 name がSQL Serverデータ型またはユーザー定義データ型の場合、sp_helpはこの結果セットを返します。
列名 データ型 説明 Type_name nvarchar(128) データ型名。 Storage_type nvarchar(128) 型名をSQL Serverします。 [データ型] smallint データ型の物理長 (バイト単位)。 Prec int 有効桁数 (合計桁数)。 スケール int 10 進数の右側の桁数。 NULL 値の使用 varchar(35) NULL 値を許可するかどうかを示します: はいまたはいいえ。 Default_name nvarchar(128) このデータ型にバインドされた既定値の名前です。
NULL = 既定値はバインドされません。Rule_name nvarchar(128) このデータ型にバインドされたルールの名前です。
NULL = 既定値はバインドされません。Collation sysname データ型の照合順序。 文字以外のデータ型の場合は NULL。 name がデータ型以外のデータベース オブジェクトである場合、sp_helpは、指定されたオブジェクトの型に基づいて、この結果セットと追加の結果セットも返します。
列名 データ型 説明 名前 nvarchar(128) テーブル名 所有者 nvarchar(128) テーブル所有者 Type nvarchar(31) テーブルの種類です。 Created_datetime datetime 作成日テーブル 指定したデータベース オブジェクトに応じて、 sp_help は追加の結果セットを返します。
name がシステム テーブル、ユーザー テーブル、またはビューの場合、sp_helpは次の結果セットを返します。 ただし、ビューに対しては、データ ファイルがファイル グループ内のどこに配置されているかを表す結果セットは返されません。
列オブジェクトに関して次の結果セットが返されます。
列名 データ型 説明 Column_name nvarchar(128) 列名。 Type nvarchar(128) 列データ型。 計算 varchar(35) 列の値が計算されるかどうかを示します。[はい] または [いいえ] です。 [データ型] int 列の長さ (バイト単位)。
注: 列データ型が大きな値型 (varchar(max)、 nvarchar(max)、 varbinary(max)、または xml) の場合、値は -1 として表示されます。Prec char(5) 列の有効桁数。 スケール char(5) 列の小数点以下桁数です。 NULL 値の使用 varchar(35) 列に NULL 値を使用できるかどうかを示します:Yes または No。 TrimTrailingBlanks varchar(35) 末尾の空白をトリミングします。 Yes または No を返します。 FixedLenNullInSource varchar(35) これは旧バージョンとの互換性のためにだけ用意されています。 Collation sysname 列の照合順序。 非文字データ型の場合は NULL。 ID 列で返される追加の結果セット:
列名 データ型 説明 ID nvarchar(128) データ型が ID として宣言されている列名。 種子 numeric ID 列の開始値。 Increment numeric この列の値に使用する増分値。 [レプリケーションでは使用しない] int SQLrepl などのレプリケーション ログインがテーブルにデータを挿入する場合、IDENTITY プロパティは適用されません。
1 = True
0 = False列に返される追加の結果セット:
列名 データ型 説明 RowGuidCol sysname 一意なグローバル識別子列の名前です。 ファイル グループで返される追加の結果セット:
列名 データ型 説明 Data_located_on_filegroup nvarchar(128) データが格納されているファイル グループ (プライマリ、セカンダリ、またはトランザクション ログ)。 インデックスに対して返される追加の結果セット:
列名 データ型 説明 index_name sysname インデックス名。 Index_description varchar(210) インデックスの説明です。 index_keys nvarchar(2078) インデックスが作成される列名。 xVelocity メモリ最適化列ストア インデックスの NULL を返します。 制約に関して次の結果セットが返されます。
列名 データ型 説明 constraint_type nvarchar(146) 制約の型。 constraint_name nvarchar(128) 制約の名前。 delete_action nvarchar(9) DELETE 操作が NO_ACTION、CASCADE、SET_NULL、SET_DEFAULT、該当なし、のどれであるかを示します。
ただし、FOREIGN KEY 制約にだけ適用されます。update_action nvarchar(9) UPDATE アクションが NO_ACTION、CASCADE、SET_NULL、SET_DEFAULT、N/A のいずれであるかを示します。
ただし、FOREIGN KEY 制約にだけ適用されます。status_enabled varchar(8) 制約が有効であるかどうかを示します。この値は Enabled、Disabled、N/A のいずれかです。
CHECK 制約と FOREIGN KEY 制約にのみ適用されます。status_for_replication varchar(19) 制約がレプリケーションを対象とするのかどうかを示します。
CHECK 制約と FOREIGN KEY 制約にのみ適用されます。constraint_keys nvarchar(2078) 制約を構成する列の名前です。デフォルトおよびルールの場合は、デフォルトまたはルールを定義するテキストです。 参照元オブジェクトで返される追加の結果セット:
列名 データ型 説明 Table is referenced by nvarchar(516) テーブルを参照する他のデータベース オブジェクトを識別します。 ストアド プロシージャ、関数、または拡張ストアド プロシージャに関して次の結果セットが返されます。
列名 データ型 説明 Parameter_name nvarchar(128) ストアド プロシージャのパラメーター名。 Type nvarchar(128) ストアド プロシージャ パラメーターのデータ型。 [データ型] smallint 物理ストレージの最大長 (バイト単位)。 Prec int 有効桁数または桁数の合計。 スケール int 小数点の右側の桁数。 Param_order smallint パラメーターの順番です。
解説
sp_help プロシージャは、現在のデータベース内のオブジェクトのみを検索します。
name が指定されていない場合、sp_helpは、現在のデータベース内のすべてのオブジェクトのオブジェクト名、所有者、およびオブジェクトの種類を一覧表示します。 sp_helptrigger はトリガーに関する情報を提供します。
sp_help は、並べ替え可能なインデックス列のみを公開します。そのため、XML インデックスや空間インデックスに関する情報は公開されません。
アクセス許可
ロール public のメンバーシップが必要です。 ユーザーは 、objname に対して少なくとも 1 つのアクセス許可を持っている必要があります。 列の制約キー、既定値、またはルールを表示するには、テーブルに対する VIEW DEFINITION 権限が必要です。
例
A. すべてのオブジェクトに関する情報を返す
次の例では、データベース内の各オブジェクトに関する情報を一 master
覧表示します。
USE master;
GO
EXEC sp_help;
GO
B. 1 つのオブジェクトに関する情報を返す
次の例では、テーブルに関する情報を Person
表示します。
USE AdventureWorks2022;
GO
EXEC sp_help 'Person.Person';
GO
参照
データベース エンジン ストアド プロシージャ (Transact-SQL)
sp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL)
sp_helpuser (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)
sys.sysobjects (Transact-SQL)
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示