sp_help (Transact-SQL)sp_help (Transact-SQL)

適用対象: yesSQL Server yesAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse APPLIES TO: yesSQL Server yesAzure SQL Database noAzure Synapse Analytics (SQL DW) noParallel Data Warehouse

データベースオブジェクト ( sysobjects互換性ビューに一覧表示されているオブジェクト)、ユーザー定義データ型、またはデータ型に関する情報をレポートします。Reports information about a database object (any object listed in the sys.sysobjects compatibility view), a user-defined data type, or a data type.

トピック リンク アイコン Transact-SQL 構文表記規則Topic link icon Transact-SQL Syntax Conventions

構文Syntax

  
sp_help [ [ @objname = ] 'name' ]  

引数Arguments

[ @objname = ] 'name' は、 sysobjects内のオブジェクト、またはsystypesテーブル内のユーザー定義データ型の名前です。[ @objname = ] 'name' Is the name of any object, in sysobjects or any user-defined data type in the systypes table. 名前nvarchar ( 776 ) ,、既定値は NULL です。name is nvarchar( 776 ), with a default of NULL. データベース名は使用できません。Database names are not acceptable. 'Person.AddressType' や [Person.AddressType] など、2 つまたは 3 つの部分名を区切る必要があります。Two or three part names must be delimited, such as 'Person.AddressType' or [Person.AddressType].

リターン コードの値Return Code Values

0 (成功) または 1 (失敗)0 (success) or 1 (failure)

結果セットResult Sets

返される結果セットは、名前が指定されているかどうか、指定されているかどうか、およびデータベースオブジェクトがどのデータベースオブジェクトであるかによって異なります。The result sets that are returned depend on whether name is specified, when it is specified, and which database object it is.

  1. 引数を指定せずにsp_helpを実行すると、現在のデータベースに存在するすべての型のオブジェクトの概要情報が返されます。If sp_help is executed with no arguments, summary information of objects of all types that exist in the current database is returned.

    列名Column name データ型Data type [説明]Description
    名前Name nvarchar( 128 )nvarchar( 128 ) オブジェクト名です。Object name
    所有者Owner nvarchar( 128 )nvarchar( 128 ) オブジェクトの所有者 (これは、オブジェクトを所有するデータベースプリンシパルです。Object owner (This is the database principal that owns object. 既定値は、オブジェクトを含むスキーマの所有者です)。Defaults to the owner of the schema that contains the object.)
    Object_typeObject_type nvarchar( 31 )nvarchar( 31 ) オブジェクトの種類Object type
  2. 名前SQL ServerSQL Server データ型またはユーザー定義データ型である場合、 sp_helpはこの結果セットを返します。If name is a SQL ServerSQL Server data type or user-defined data type, sp_help returns this result set.

    列名Column name データ型Data type [説明]Description
    Type_nameType_name nvarchar( 128 )nvarchar( 128 ) データ型の名前。Data type name.
    Storage_typeStorage_type nvarchar( 128 )nvarchar( 128 ) SQL ServerSQL Server 型名。type name.
    [データ型]Length smallintsmallint データ型の物理的な長さ (バイト単位)。Physical length of the data type (in bytes).
    PrecPrec intint 有効桁数 (桁数の合計数)。Precision (total number of digits).
    小数点以下桁数Scale intint 小数点の右側の桁数。Number of digits to the right of the decimal.
    NULL 値の使用Nullable varchar( 35 )varchar( 35 ) NULL 値が許可されるかどうかを示します。 Yes または No。Indicates whether NULL values are allowed: Yes or No.
    Default_nameDefault_name nvarchar( 128 )nvarchar( 128 ) このデータ型にバインドされた既定値の名前です。Name of a default bound to this type.

    NULL = 既定値がバインドされていません。NULL = No default is bound.
    Rule_nameRule_name nvarchar( 128 )nvarchar( 128 ) このデータ型にバインドされたルールの名前です。Name of a rule bound to this type.

    NULL = 既定値がバインドされていません。NULL = No default is bound.
    [照合順序]Collation sysnamesysname データ型の照合順序。Collation of the data type. 文字以外のデータ型の場合は NULL です。NULL for non-character data types.
  3. 名前がデータ型以外のデータベースオブジェクトである場合、 sp_helpは、指定されたオブジェクトの型に基づいて、この結果セットと追加の結果セットを返します。If name is any database object other than a data type, sp_help returns this result set and also additional result sets, based on the type of object specified.

    列名Column name データ型Data type [説明]Description
    名前Name nvarchar( 128 )nvarchar( 128 ) テーブル名Table name
    所有者Owner nvarchar( 128 )nvarchar( 128 ) テーブルの所有者Table owner
    種類Type nvarchar( 31 )nvarchar( 31 ) テーブルの種類です。Table type
    Created_datetimeCreated_datetime datetimedatetime 作成された日付テーブルDate table created

    指定されたデータベースオブジェクトによっては、 sp_helpによって追加の結果セットが返されます。Depending on the database object specified, sp_help returns additional result sets.

    Nameがシステムテーブル、ユーザーテーブル、またはビューの場合、 sp_helpは次の結果セットを返します。If name is a system table, user table, or view, sp_help returns the following result sets. ただし、ビューに対しては、データ ファイルがファイル グループ内のどこに配置されているかを表す結果セットは返されません。However, the result set that describes where the data file is located on a file group is not returned for a view.

    • 列オブジェクトに関して次の結果セットが返されます。Additional result set returned on column objects:

      列名Column name データ型Data type [説明]Description
      Column_nameColumn_name nvarchar( 128 )nvarchar( 128 ) 列名Column name.
      種類Type nvarchar( 128 )nvarchar( 128 ) 列のデータ型。Column data type.
      L8Computed varchar( 35 )varchar( 35 ) 列の値が計算されるかどうかを示します。 Yes または No。Indicates whether the values in the column are computed: Yes or No.
      [データ型]Length intint 列の長さ (バイト単位)。Column length in bytes.

      注: 列のデータ型が大きな値の型 (varchar (max)nvarchar (max)varbinary (max) 、またはxml) の場合、値は-1 と表示されます。Note: If the column data type is a large value type (varchar(max), nvarchar(max), varbinary(max), or xml), the value will display as -1.
      PrecPrec char( 5 )char( 5 ) 列の有効桁数。Column precision.
      小数点以下桁数Scale char( 5 )char( 5 ) 列の小数点以下桁数です。Column scale.
      NULL 値の使用Nullable varchar( 35 )varchar( 35 ) 列で NULL 値を使用できるかどうかを示します。 Yes または No。Indicates whether NULL values are allowed in the column: Yes or No.
      TrimTrailingBlanksTrimTrailingBlanks varchar( 35 )varchar( 35 ) 末尾の空白をトリミングします。Trim the trailing blanks. Yes または No を返します。Returns Yes or No.
      FixedLenNullInSourceFixedLenNullInSource varchar( 35 )varchar( 35 ) これは旧バージョンとの互換性のためにだけ用意されています。For backward compatibility only.
      [照合順序]Collation sysnamesysname 列の照合順序。Collation of the column. 非文字データ型の場合は NULL です。NULL for noncharacter data types.
    • Id 列に対して次の結果セットが返されます。Additional result set returned on identity columns:

      列名Column name データ型Data type [説明]Description
      IdentityIdentity nvarchar( 128 )nvarchar( 128 ) データ型が id として宣言されている列の名前。Column name whose data type is declared as identity.
      シードSeed numericnumeric Id 列の開始値。Starting value for the identity column.
      IncrementIncrement numericnumeric この列の値に使用する増分です。Increment to use for values in this column.
      [レプリケーションでは使用しない]Not For Replication intint Sqlreplなどのレプリケーションログインでテーブルにデータを挿入するときに、IDENTITY プロパティは適用されません。IDENTITY property is not enforced when a replication login, such as sqlrepl, inserts data into the table:

      1 = True1 = True

      0 = False0 = False
    • 列に対して次の結果セットが返されます。Additional result set returned on columns:

      列名Column name データ型Data type [説明]Description
      RowGuidColRowGuidCol sysnamesysname 一意なグローバル識別子列の名前です。Name of the global unique identifier column.
    • ファイルグループで返される追加の結果セット:Additional result set returned on filegroups:

      列名Column name データ型Data type [説明]Description
      Data_located_on_filegroupData_located_on_filegroup nvarchar( 128 )nvarchar( 128 ) データが配置されているファイルグループ: プライマリ、セカンダリ、またはトランザクションログ。Filegroup in which the data is located: Primary, Secondary, or Transaction Log.
    • インデックスに対して次の結果セットが返されます。Additional result set returned on indexes:

      列名Column name データ型Data type [説明]Description
      index_nameindex_name sysnamesysname インデックス名。Index name.
      Index_descriptionIndex_description varchar( 210 )varchar( 210 ) インデックスの説明です。Description of the index.
      index_keysindex_keys nvarchar( 2078 )nvarchar( 2078 ) インデックスが作成される列の名前。Column names on which the index is built. XVelocity メモリ最適化列ストアインデックスの場合は NULL を返します。Returns NULL for xVelocity memory optimized columnstore indexes.
    • 制約に関して次の結果セットが返されます。Additional result set returned on constraints:

      列名Column name データ型Data type [説明]Description
      constraint_typeconstraint_type nvarchar( 146 )nvarchar( 146 ) 制約の種類。Type of constraint.
      constraint_nameconstraint_name nvarchar( 128 )nvarchar( 128 ) 制約の名前。Name of the constraint.
      delete_actiondelete_action nvarchar( 9 )nvarchar( 9 ) DELETE 操作が NO_ACTION、CASCADE、SET_NULL、SET_DEFAULT、該当なし、のどれであるかを示します。Indicates whether the DELETE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      ただし、FOREIGN KEY 制約にだけ適用されます。Only applicable to FOREIGN KEY constraints.
      update_actionupdate_action nvarchar( 9 )nvarchar( 9 ) 更新アクションが NO_ACTION、CASCADE、SET_NULL、SET_DEFAULT、または N/A のいずれであるかを示します。Indicates whether the UPDATE action is: NO_ACTION, CASCADE, SET_NULL, SET_DEFAULT, or N/A.

      ただし、FOREIGN KEY 制約にだけ適用されます。Only applicable to FOREIGN KEY constraints.
      status_enabledstatus_enabled varchar( 8 )varchar( 8 ) 制約が有効であるかどうかを示します。この値は Enabled、Disabled、N/A のいずれかです。Indicates whether the constraint is enabled: Enabled, Disabled, or N/A.

      CHECK 制約と FOREIGN KEY 制約にのみ適用されます。Only applicable to CHECK and FOREIGN KEY constraints.
      status_for_replicationstatus_for_replication varchar( 19 )varchar( 19 ) 制約がレプリケーションを対象とするのかどうかを示します。Indicates whether the constraint is for replication.

      CHECK 制約と FOREIGN KEY 制約にのみ適用されます。Only applicable to CHECK and FOREIGN KEY constraints.
      constraint_keysconstraint_keys nvarchar( 2078 )nvarchar( 2078 ) 制約を構成する列の名前です。デフォルトおよびルールの場合は、デフォルトまたはルールを定義するテキストです。Names of the columns that make up the constraint or, in the case for defaults and rules, the text that defines the default or rule.
    • 参照しているオブジェクトについて、追加の結果セットが返されます。Additional result set returned on referencing objects:

      列名Column name データ型Data type [説明]Description
      テーブルの参照元Table is referenced by nvarchar( 516 )nvarchar( 516 ) テーブルを参照する他のデータベースオブジェクトを識別します。Identifies other database objects that reference the table.
    • ストアド プロシージャ、関数、または拡張ストアド プロシージャに関して次の結果セットが返されます。Additional result set returned on stored procedures, functions, or extended stored procedures.

      列名Column name データ型Data type [説明]Description
      Parameter_nameParameter_name nvarchar( 128 )nvarchar( 128 ) ストアドプロシージャのパラメーター名。Stored procedure parameter name.
      種類Type nvarchar( 128 )nvarchar( 128 ) ストアドプロシージャパラメーターのデータ型。Data type of the stored procedure parameter.
      [データ型]Length smallintsmallint 物理ストレージの最大長 (バイト単位)。Maximum physical storage length, in bytes.
      PrecPrec intint 桁数または合計桁数。Precision or total number of digits.
      小数点以下桁数Scale intint 小数点の右側の桁数。Number of digits to the right of the decimal point.
      Param_orderParam_order smallintsmallint パラメーターの順番です。Order of the parameter.

RemarksRemarks

Sp_helpプロシージャは、現在のデータベースでのみオブジェクトを検索します。The sp_help procedure looks for an object in the current database only.

名前が指定されていない場合sp_help現在のデータベース内のすべてのオブジェクトのオブジェクト名、所有者、およびオブジェクトの種類が一覧表示されます。When name is not specified, sp_help lists object names, owners, and object types for all objects in the current database. sp_helptriggerは、トリガーに関する情報を提供します。sp_helptrigger provides information about triggers.

sp_helpは、順序付け可能インデックス列のみを公開します。そのため、XML インデックスや空間インデックスに関する情報は公開されません。sp_help exposes only orderable index columns; therefore, it does not expose information about XML indexes or spatial indexes.

アクセス許可Permissions

ロール public のメンバーシップが必要です。Requires membership in the public role. ユーザーは、 objnameに対して少なくとも1つのアクセス許可を持っている必要があります。The user must have at least one permission on objname. 列の制約キー、既定値、またはルールを表示するには、テーブルに対する VIEW DEFINITION 権限が必要です。To view column constraint keys, defaults, or rules, you must have VIEW DEFINITION permission on the table.

使用例Examples

A.A. すべてのオブジェクトに関する情報を返すReturning information about all objects

次の例では、master データベース内の各オブジェクトに関する情報を一覧表示します。The following example lists information about each object in the master database.

USE master;  
GO  
EXEC sp_help;  
GO  

b.B. 1つのオブジェクトに関する情報を返すReturning information about a single object

次の例では、Person テーブルに関する情報を表示します。The following example displays information about the Person table.

USE AdventureWorks2012;  
GO  
EXEC sp_help 'Person.Person';  
GO  

参照See Also

データベース エンジン ストアド プロシージャ(Transact-SQL) Database Engine Stored Procedures (Transact-SQL)
transact-sql ( の) sp_helpindexsp_helpindex (Transact-SQL)
sp_helprotect (Transact-SQL) sp_helprotect (Transact-SQL)
sp_helpserver (Transact-SQL) sp_helpserver (Transact-SQL)
sp_helptrigger (Transact-SQL) sp_helptrigger (Transact-SQL)
sp_helpuser (Transact-SQL) sp_helpuser (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL) System Stored Procedures (Transact-SQL)
システム(transact-sql)sys.sysobjects (Transact-SQL)