sp_helptext (Transact-SQL)
ユーザー定義のルール、既定値、暗号化されていない Transact-SQL ストアド プロシージャ、ユーザー定義の Transact-SQL 関数、トリガ、計算列、CHECK 制約、ビュー、またはシステム ストアド プロシージャなどのシステム オブジェクトの定義を表示します。
.gif "トピック リンク アイコン")
構文
sp_helptext [ @objname = ] 'name' [ , [ @columnname = ] computed_column_name ]
引数
- [ @objname = ] 'name'
ユーザー定義のスキーマ スコープ オブジェクトの修飾名または修飾されていない名前です。引用符が必要なのは、修飾されているオブジェクトを指定する場合のみです。データベース名を含む完全修飾名を指定する場合、データベース名は現在のデータベースの名前である必要があります。オブジェクトは現在のデータベースに存在していなければなりません。name のデータ型は nvarchar(776) で、既定値はありません。
- [ @columnname = ] 'computed_column_name'
定義情報を表示する計算列の名前です。列を含むテーブルを name として指定する必要があります。column_name のデータ型は sysname で、既定値はありません。
結果セット
| 列名 | データ型 | 説明 |
|---|---|---|
Text |
nvarchar(255) |
オブジェクトの定義 |
解説
sp_helptext は、複数の行でオブジェクトを作成するために使用される定義を表示します。各行は、255 文字の Transact-SQL の定義を含みます。定義は、sys.sql_modules カタログ ビューの definition 列に存在します。
権限
public ロールのメンバシップである必要があります。システム オブジェクトの定義は公開されます。ユーザー オブジェクトの定義は、オブジェクトの所有者、または ALTER、CONTROL、TAKE OWNERSHIP、VIEW DEFINITION のいずれかの権限を許可された人が表示できます。
戻り値
成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。
例
A. トリガの定義を表示する
次の例では、AdventureWorks データベースの uBillOfMaterials トリガの定義を表示します。
USE AdventureWorks;
GO
EXEC sp_helptext 'Production.uBillOfMaterials';
GO
B. 計算列の定義を表示する
次の例では、AdventureWorks データベースの SalesOrderHeader テーブルにある計算列 TotalDue の定義を表示します。
USE AdventureWorks;
GO
sp_helptext @objname = N'AdventureWorks.Sales.SalesOrderHeader', @columnname = TotalDue ;
GO
以下に結果セットを示します。
Text
--------------------------------------------
(isnull(([SubTotal]+[TaxAmt])+[Freight],(0)))
参照
関連項目
データベース エンジンのストアド プロシージャ (Transact-SQL)
OBJECT_DEFINITION (Transact-SQL)
sp_help (Transact-SQL)
sys.sql_modules (Transact-SQL)
システム ストアド プロシージャ (Transact-SQL)