catalog.create_execution (SSISDB データベース)catalog.create_execution (SSISDB Database)

適用対象: ○SQL Server (Linux を含む)○Azure SQL Database ○Azure SQL Data Warehouse XParallel Data WarehouseAPPLIES TO: yesSQL Server, including on Linux yesAzure SQL Database yesAzure SQL Data Warehouse noParallel Data Warehouse

適用対象: ○SQL Server XAzure SQL Database XAzure SQL Data Warehouse XParallel Data WarehouseAPPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Integration ServicesIntegration Services カタログの実行のインスタンスを作成します。Creates an instance of execution in the Integration ServicesIntegration Services catalog.

このストアド プロシージャは既定のサーバーのログ レベルを使用します。This stored procedure uses the default server logging level.

構文Syntax

catalog.create_execution [@folder_name = folder_name  
     , [@project_name =] project_name  
     , [@package_name =] package_name  
  [  , [@reference_id =] reference_id ]  
  [  , [@use32bitruntime =] use32bitruntime ] 
  [  , [@runinscaleout =] runinscaleout ]
  [  , [@useanyworker =] useanyworker ] 
     , [@execution_id =] execution_id OUTPUT  

引数Arguments

[@folder_name =] folder_name[@folder_name =] folder_name
実行するパッケージが格納されているフォルダーの名前。The name of the folder that contains the package that is to be executed. folder_namenvarchar(128) です。The folder_name is nvarchar(128).

[@project_name =] project_name[@project_name =] project_name
実行するパッケージが格納されているプロジェクトの名前。The name of the project that contains the package that is to be executed. project_namenvarchar(128) です。The project_name is nvarchar(128).

[@package_name =] package_name[@package_name =] package_name
実行するパッケージの名前。The name of the package that is to be executed. package_namenvarchar (260) です。The package_name is nvarchar(260).

[@reference_id =] reference_id[@reference_id =] reference_id
環境参照の一意識別子。A unique identifier for an environment reference. このパラメーターはオプションです。This parameter is optional. reference_idbigint です。The reference_id is bigint.

[@use32bitruntime =] use32bitruntime[@use32bitruntime =] use32bitruntime
64 ビット オペレーティング システムで 32 ビットのランタイムを使用してパッケージを実行すべきかどうかを示します。Indicates if the 32-bit runtime should be used to run the package on a 64-bit operating system. 値 1 を使用すると、64 ビット オペレーティング システムで実行しているときに、32 ビット ランタイムでパッケージを実行します。Use the value of 1 to execute the package with the 32-bit runtime when running on a 64-bit operating system. 値 0 を使用すると、64 ビット オペレーティング システムで実行しているときに、64 ビット ランタイムでパッケージを実行します。Use the value of 0 to execute the package with the 64-bit runtime when running on a 64-bit operating system. このパラメーターはオプションです。This parameter is optional. Use32bitruntimebit です。The Use32bitruntime is bit.

[@runinscaleout =] runinscaleout[@runinscaleout =] runinscaleout
実行が Scale Out であるかどうかを示します。パッケージを Scale Out で実行するには、値 1 を使用します。Scale Out を使用せずにパッケージを実行するには、値 0 を使用します。このパラメーターはオプションです。Indicate whether the execution is in Scale Out. Use the value of 1 to execute the package in Scale Out. Use the value of 0 to execute the package without Scale Out. This parameter is optional. 指定しない場合、その値は [SSISDB].[catalog].[catalog_properties] で DEFAULT_EXECUTION_MODE に設定されます。If not specified, its value is set to DEFAULT_EXECUTION_MODE in [SSISDB].[catalog].[catalog_properties]. runinscaleoutbit です。The runinscaleout is bit.

[@useanyworker =] useanyworker[@useanyworker =] useanyworker
任意の Scale Out Worker の実行が許可されるかどうかを示します。Indicate whether any Scale Out Worker is allowed to do the execution.

  • 任意の Scale Out Worker を使用してパッケージを実行するには、値 1 を使用します。Use the value of 1 to execute the package with any Scale Out Worker. @useanyworker を True に設定すると、(Worker 構成ファイルに指定されている) 最大タスク数に到達していない Worker でパッケージを実行できます。When you set @useanyworker to true, any worker whose maximum task count (as specified in the worker configuration file) is not yet reached is available to run the package. Worker 構成ファイルについては、「Integration Services (SSIS) Scale Out Worker」を参照してください。For info about the worker configuration file, see Integration Services (SSIS) Scale Out Worker.

  • すべての Scale Out Worker にパッケージの実行を許可しないことを示すには、値 0 を使用します。Use the value of 0 to indicate that not all Scale Out Workers are allowed to execute the package. @useanyworker を False に設定すると、Scale Out Manager を使用するか、ストアド プロシージャ [catalog].[add_execution_worker] を呼び出し、パッケージの実行が許可される Worker を指定する必要があります。When you set @useanyworker to false, you have to specify the workers that are allowed to run the package by using Scale Out Manager or by calling the stored procedure [catalog].[add_execution_worker]. 別のパッケージを既に実行している Worker を指定した場合、その Worker は現在のパッケージの実行を完了してから別の実行を要求します。If you specify a worker that's already running another package, the worker finishes running the current package before it requests another execution.

このパラメーターはオプションです。This parameter is optional. 指定しない場合、その値は 1 に設定されます。If not specified, its value is set to 1. useanyworkerbit です。The useanyworker is bit.

[@execution_id =] execution_id[@execution_id =] execution_id
実行のインスタンスの一意識別子を返します。Returns the unique identifier for an instance of execution. execution_idbigint です。The execution_id is bigint.

RemarksRemarks

実行は、パッケージの実行の 1 つのインスタンス中にパッケージによって使用されるパラメーター値を指定するために使用されます。An execution is used to specify the parameter values that are a package uses during a single instance of package execution.

環境参照を指定した場合、reference_id パラメーター、ストアド プロシージャは、プロジェクトおよびパッケージ パラメーターをリテラル値や対応する環境変数から参照される値を設定します。If an environment reference is specified with the reference_id parameter, the stored procedure populates the project and package parameters with literal values or referenced values from the corresponding environment variables. 環境参照が指定されている場合は、パッケージの実行中、既定のパラメーター値が使用されます。If environment reference is specified, default parameter values are used during package execution. 特定の実行のインスタンスに使用される値を正確に判断するには、このストアド プロシージャからの execution_id 出力パラメーター値を使用して、execution_parameter_values ビューをクエリします。To determine exactly which values are used for a particular instance of execution, use the execution_id output parameter value from this stored procedure and query the execution_parameter_values view.

実行で指定できるのは、エントリ ポイントのパッケージとしてマークされたパッケージのみです。Only packages that are marked as entry point packages can be specified in an execution. エントリ ポイントではないパッケージを指定すると、実行が失敗します。If a package that is not an entry point is specified, the execution fails.

Example

次の例では catalog.create_execution を呼び出して、Scale Out ではない、Child1.dtsx パッケージの実行のインスタンスを作成します。integration Services Project1 にはパッケージが含まれています。The following example calls catalog.create_execution to create an instance of execution for the Child1.dtsx package, which is not in Scale Out. Integration Services Project1 contains the package. 例では catalog.set_execution_parameter_value を呼び出して、Parameter1、Parameter2、LOGGING_LEVEL の各パラメーターの値を設定します。The example calls catalog.set_execution_parameter_value to set values for the Parameter1, Parameter2, and LOGGING_LEVEL parameters. 例では catalog.start_execution を呼び出して、実行のインスタンスを起動します。The example calls catalog.start_execution to start an instance of execution.

Declare @execution_id bigint  
EXEC [SSISDB].[catalog].[create_execution] @package_name=N'Child1.dtsx', @execution_id=@execution_id OUTPUT, @folder_name=N'TestDeply4', @project_name=N'Integration Services Project1', @use32bitruntime=False, @reference_id=Null  
Select @execution_id  
DECLARE @var0 sql_variant = N'Child1.dtsx'  
EXEC [SSISDB].[catalog].[set_execution_parameter_value] @execution_id, @object_type=20, @parameter_name=N'Parameter1', @parameter_value=@var0  
DECLARE @var1 sql_variant = N'Child2.dtsx'  
EXEC [SSISDB].[catalog].[set_execution_parameter_value] @execution_id, @object_type=20, @parameter_name=N'Parameter2', @parameter_value=@var1  
DECLARE @var2 smallint = 1  
EXEC [SSISDB].[catalog].[set_execution_parameter_value] @execution_id, @object_type=50, @parameter_name=N'LOGGING_LEVEL', @parameter_value=@var2  
EXEC [SSISDB].[catalog].[start_execution] @execution_id  
GO  

リターン コード値Return Code Value

成功した場合は 0 を返します。0 (success)

結果セットResult Sets

なしNone

アクセス許可Permissions

このストアド プロシージャには、次の権限のいずれかが必要です。This stored procedure requires one of the following permissions:

  • プロジェクトの READ および EXECUTE 実行権限と、該当する場合は、参照先の環境での READ 権限READ and EXECUTE permissions on the project and, if applicable, READ permissions on the referenced environment

  • ssis_admin データベース ロールのメンバーシップMembership to the ssis_admin database role

  • sysadmin サーバー ロールのメンバーシップMembership to the sysadmin server role

@runinscaleout が 1 の場合、ストアド プロシージャには、次のアクセス許可のいずれかが必要です。If @runinscaleout is 1, the stored procedure requires one of the following permissions:

  • ssis_admin データベース ロールのメンバーシップMembership to the ssis_admin database role

  • ssis_cluster_executor データベース ロールのメンバーシップMembership to the ssis_cluster_executor database role

  • sysadmin サーバー ロールのメンバーシップMembership to the sysadmin server role

エラーおよび警告Errors and Warnings

エラーまたは警告が発生する可能性がある条件を以下に示します。The following list describes some conditions that can raise an error or warning:

  • パッケージが存在しない。The package does not exist.

  • ユーザーに適切なアクセス許可がない。The user does not have the appropriate permissions.

  • 環境参照 reference_id が無効である。The environment reference, reference_id, is not valid.

  • 指定したパッケージが、エントリ ポイントのパッケージではない。The package that is specified is not an entry point package.

  • 参照先の環境変数のデータ型が、プロジェクトまたはパッケージ パラメーターのデータ型と異なる。The data type of the referenced environment variable is different from the data type of the project or package parameter.

  • プロジェクトまたはパッケージに、値が必要なパラメーターが含まれているが、値が割り当てられていない。The project or package contains parameters that require values, but no values have been assigned.

  • 参照先の環境変数が、環境参照 reference_id が指定する環境に見つかりません。The referenced environment variables cannot be found in the environment that the environment reference, reference_id, specifies.

参照See Also

catalog.start_execution (SSISDB データベース) catalog.start_execution (SSISDB Database)
catalog.set_execution_parameter_value (SSISDB データベース)catalog.set_execution_parameter_value (SSISDB Database)
catalog.add_execution_worker (SSISDB データベース)catalog.add_execution_worker (SSISDB Database)