パラメーター

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

パラメーターは、ストアド プロシージャや関数と、それらを呼び出したアプリケーションやツールとの間でデータを交換するために使用されます。

• 入力パラメーターは、呼び出し側がストアド プロシージャや関数にデータ値を渡すときに使用します。
• 出力パラメーターは、ストアド プロシージャが呼び出し側にデータ値またはカーソル変数を返すときに使用します。 ユーザー定義関数では出力パラメーターを指定できません。
• ストアド プロシージャはいずれも呼び出し側に整数のリターン コードを返します。 ストアド プロシージャがリターン コードの値を明示的に設定しないと、リターン コードは 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

アプリケーションはプログラム変数にバインドされたパラメーター マーカーを使用して、アプリケーション変数、パラメーター、およびリターン コード間でデータを交換できます。

参照

CREATE PROCEDURE (Transact-SQL)
DECLARE @local_variable (Transact-SQL)
CREATE FUNCTION (Transact-SQL)
「パラメーターと実行プランの再利用」セクション
変数 (Transact-SQL)