sp_helptext (Transact-SQL)

適用対象: SQL Server Azure SQL Database Azure SQL Managed Instance

ユーザー定義ルール、既定の暗号化されていない Transact-SQL ストアド プロシージャ、ユーザー定義 Transact-SQL 関数、トリガー、計算列、 CHECK 制約、ビュー、システム オブジェクト (システム ストアド プロシージャなど) の定義を表示します。

Transact-SQL 構文表記規則

構文

sp_helptext
    [ @objname = ] N'objname'
    [ , [ @columnname = ] N'columnname' ]
[ ; ]

引数

[ @objname = ] N'objname'

ユーザー定義のスキーマ スコープ オブジェクトの修飾名または非修飾名。 @objname は nvarchar(776)で、既定値はありません。 引用符は、修飾オブジェクトが指定されている場合にのみ必要です。 データベース名を含む完全修飾名を指定する場合、データベース名は現在のデータベースの名前である必要があります。 オブジェクトは、現在のデータベースに存在する必要があります。

[ @columnname = ] N'columnname'

定義情報を表示する計算列の名前。 @columnname は sysname で、既定値は NULL です。 列を含むテーブルは、 @objnameとして指定する必要があります。

リターン コードの値

0 (成功) または 1 (失敗)。

結果セット

解説

sp_helptext には、複数の行にオブジェクトを作成するために使用される定義が表示されます。 各行には、Transact-SQL 定義の 255 文字が含まれています。 定義は、sys.sql_modules カタログ ビューのdefinition列に存在します。

アクセス許可

ロール public のメンバーシップが必要です。 システム オブジェクトの定義は、公開されます。 ユーザー オブジェクトの定義は、 ALTER、 CONTROL、 TAKE OWNERSHIP、または VIEW DEFINITIONのいずれかの権限を持つオブジェクト所有者または権限付与対象ユーザーに表示されます。

例

A. トリガーの定義を表示する

次の例では、AdventureWorks2022 データベースのトリガー dEmployeeの定義を表示します。

USE AdventureWorks2022;
GO
EXEC sp_helptext 'HumanResources.dEmployee';
GO

B. 計算列の定義を表示する

次の例では、AdventureWorks2022 データベースのSalesOrderHeader テーブルにTotalDue計算列の定義を表示します。

USE AdventureWorks2022;
GO
sp_helptext
    @objname = N'AdventureWorks2022.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)