パラメータ (データベース エンジン)
パラメータは、ストアド プロシージャや関数と、それらを呼び出したアプリケーションやツールとの間でデータを交換するために使用されます。
入力パラメータは、呼び出し側がストアド プロシージャや関数にデータ値を渡すときに使用します。
出力パラメータは、ストアド プロシージャが呼び出し側にデータ値またはカーソル変数を返すときに使用します。ユーザー定義関数では出力パラメータを指定できません。
ストアド プロシージャはいずれも呼び出し側に整数のリターン コードを返します。ストアド プロシージャがリターン コードの値を明示的に設定しないと、リターン コードは 0 になります。
次のストアド プロシージャは、入力パラメータ、出力パラメータ、およびリターン コードを使用する例を示しています。
-- Create a procedure that takes one input parameter
-- and returns one output parameter and a return code.
CREATE PROCEDURE SampleProcedure @EmployeeIDParm INT,
@MaxTotal INT OUTPUT
AS
-- Declare and initialize a variable to hold @@ERROR.
DECLARE @ErrorSave INT
SET @ErrorSave = 0
-- Do a SELECT using the input parameter.
SELECT FirstName, LastName, JobTitle
FROM HumanResources.vEmployee
WHERE EmployeeID = @EmployeeIDParm
-- Save any nonzero @@ERROR value.
IF (@@ERROR <> 0)
SET @ErrorSave = @@ERROR
-- Set a value in the output parameter.
SELECT @MaxTotal = MAX(TotalDue)
FROM Sales.SalesOrderHeader;
IF (@@ERROR <> 0)
SET @ErrorSave = @@ERROR
-- Returns 0 if neither SELECT statement had
-- an error; otherwise, returns the last error.
RETURN @ErrorSave
GO
ストアド プロシージャや関数を実行するときは、入力パラメータの値に定数を設定することも、変数の値を使用することもできます。出力パラメータとリターン コードは、値を変数に代入して返す必要があります。パラメータとリターン コードにより、Transact-SQL 変数やアプリケーション変数との間でデータ値を交換できます。
バッチやスクリプトからストアド プロシージャを呼び出す場合、パラメータとリターン コード値には同じバッチ内で定義された Transact-SQL 変数を使用できます。次の例は、作成済みのプロシージャを実行するバッチを示しています。入力パラメータの値が定数で指定され、出力パラメータとリターン コードでは Transact-SQL 変数に値が格納されます。
-- Declare the variables for the return code and output parameter.
DECLARE @ReturnCode INT
DECLARE @MaxTotalVariable INT
-- Execute the stored procedure and specify which variables
-- are to receive the output parameter and return code values.
EXEC @ReturnCode = SampleProcedure @EmployeeIDParm = 19,
@MaxTotal = @MaxTotalVariable OUTPUT
-- Show the values returned.
PRINT ' '
PRINT 'Return code = ' + CAST(@ReturnCode AS CHAR(10))
PRINT 'Maximum Quantity = ' + CAST(@MaxTotalVariable AS CHAR(10))
GO
アプリケーションはプログラム変数にバインドされたパラメータ マーカーを使用して、アプリケーション変数、パラメータ、およびリターン コード間でデータを交換できます。