# tMSSqlSP

複数のクエリーや複雑なクエリーをデータベースで一元的に管理し、簡単に呼び出す便利な方法が提供されています。

tMSSqlSPは、Microsoft SQL ServerまたはAzure SQLデータベースのストアドプロシージャーを呼び出します。

## tMSSqlSPの標準プロパティ

これらのプロパティは、[標準]ジョブのフレームワークで実行されているtMSSqlSPを設定するために使われます。

標準のtMSSqlSPコンポーネントは、データベースファミリーに属しています。

このフレームワーク内のコンポーネントは、すべてのTalend製品で利用できます。

情報メモ注: このコンポーネントは、動的データベースコネクターの特定のバージョンです。データベース設定に関連するプロパティは、データベースタイプの選択に応じて異なります。動的データベースコネクターについては、[DB Genericコンポーネント](https://help.qlik.com/talend/r/ja-JP/8.0/components/db-generic/db-generic-component)をご覧ください。

情報メモ注: ESB用にジョブをOSGIバンドルとしてビルドする場合、SQL Serverコンポーネントで使われるMS SQL Serverドライバーであるjtdsとmssql-jdbcは、ビルドアーティファクトには含まれていません。 Talend Runtimeでアーティファクトを実行する場合は、これらのドライバーを&lt;TalendRuntimePath&gt;/libフォルダーにコピーして手動でデプロイし、 Talend Runtimeを再起動する必要があります。

## 基本設定

| プロパティ | 説明 |
| --- | --- |
| データベース | 目的のデータベースタイプをリストから選択し、[Apply] (適用)をクリックします。 |
| [Property type] (プロパティタイプ) | [Built-in] (組み込み)と[Repository] (リポジトリー)のいずれかです。<br><br><ul> <li> <span>[Built-In] (組み込み)</span>: 一元的に保存されるプロパティデータはありません。</li> <li> <span>[Repository] (リポジトリー)</span>: プロパティが保管されるリポジトリーファイルを選択します。後続フィールドは、取得されたデータを使用して自動的に入力されます。</li> </ul> |
| [Use an existing connection] (既存の接続を使用) | 定義済みの接続の詳細を再利用する場合は、このチェックボックスを選択して、[Component List] (コンポーネントリスト)ドロップダウンリストから、目的の接続コンポーネントを選択します。<br><br>情報メモ注: ジョブに親ジョブと子ジョブが含まれている時は、親ジョブと子ジョブの間の既存の接続を共有したい場合(たとえば、親ジョブで作成した接続を子ジョブと共有するなど)には、次のように実行します。<br><br><ol> <li>親レベルで、共有するデータベース接続を、そのデータベース接続そのものを作成する接続コンポーネントの<span>[Basic settings] (基本設定)</span>ビューに登録します。 </li> <li>子レベルで、登録済みのそのデータベース接続を読み取るために専用の接続コンポーネントを使用します。 </li> </ol><br><br>ジョブレベル全体でデータベース接続を共有する方法の例は、[データベース接続を共有](https://help.qlik.com/talend/r/ja-JP/7.3/studio-user-guide/sharing-database-connection)をご覧ください。 |
| [JDBC Provider] (JDBCプロバイダー) | 使うJDBCドライバーのプロバイダー、[Microsoft] (マイクロソフト) (デフォルト、推奨)または[Open source JTDS] (オープンソースJTDS)を選択します。<br><br>Microsoftを選択した場合は、SQL Server用Microsoft JDBCドライバーを[\[Microsoftダウンロードセンター\]](https://www.microsoft.com/en-us/download/details.aspx?id=11774)からダウンロードし、ダウンロードしたzipファイルを解凍し、解凍したフォルダーからお使いのJREバージョンに基づいてjarを選択し、jarの名前を*mssql-jdbc.jar*に変更し、手動でインストールする必要があります。jarの選択については、[Microsoftダウンロードセンター](https://www.microsoft.com/en-us/download/details.aspx?id=11774)でシステム要件情報をご覧ください。<br><br>OSGiビルドには、オープンソースのjTDSJDBCドライバーが含まれないことにご注意ください。このコンポーネントが含まれているジョブをOSGiバンドルとしてビルドする必要がある時は、Microsoftの公式JDBCドライバーを使用してください。このドライバーを使用しない場合、このコンポーネントは、 Talend Runtimeに正しくインストールされたjTDSJDBCドライバーを使用するデータソースでのみ機能します。 |
| [Host] (ホスト) | 使うデータベースサーバーかAzure Synapse AnalyticsのIPアドレスまたはホスト名を指定します。<br><br>サーバーが存在するマシンでSQL Server Browserサービスが実行中である場合は、このフィールドにホスト名とインスタンス名を{host\_name}\{instance\_name}という形式で指定すれば、TCPダイナミックポートを通じてネームドインスタンスに接続できるようになります。この場合は[Port] (ポート)フィールドを空白のまましておきます。関連情報は、[SQL Server Browser service](https://docs.microsoft.com/ja-jp/sql/tools/configuration-manager/sql-server-browser-service?view=sql-server-ver16)をご覧ください。 |
| [Port] (ポート) | 使うデータベースサーバーかAzure Synapse Analyticsのリスニングポート番号を入力します。<br><br>サーバーが存在するマシンでSQL Server Browserサービスが実行中である場合は、[Host] (ホスト)フィールドにホスト名とインスタンス名を入力し、このフィールドを空にしておけば、TCPダイナミックポートを通じてネームドインスタンスに接続できるようになります。関連情報は、[SQL Server Browser service](https://docs.microsoft.com/ja-jp/sql/tools/configuration-manager/sql-server-browser-service?view=sql-server-ver16)をご覧ください。 |
| データベース | データベースの名前を入力します。 |
| スキーマ | データベーススキーマの名前を入力します。 |
| [Username] (ユーザー名)と[Password] (パスワード) | 認証データを入力します。<br><br>パスワードを入力するためには、[Password] (パスワード)フィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して[OK]をクリックし、設定を保存します。<br><br>[Additional JDBC Parameters] (追加のJDBCパラメーター)フィールドにintegratedSecurity=trueを追加し、これら2つのフィールドを空にしておけば、Windowsで[Type 2 integrated authentication] (タイプ2のインテグレーション認証)を使用できるようになります。関連情報は、[Building the connection URL](https://docs.microsoft.com/en-us/sql/connect/jdbc/building-the-connection-url?redirectedfrom=MSDN)で*Connecting with integrated authentication On Windows*というセクションをご覧ください。 |
| [Schema] (スキーマ)と[Edit Schema] (スキーマを編集) | SPでは原則的に、スキーマは入力パラメーターになります。<br><br>スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。<br><br>[Built-in] (組み込み): そのコンポーネントに対してのみスキーマを作成し、ローカルに保管します。<br><br>[Repository] (リポジトリー): スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。<br><br>スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。<br><br><ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> |
| [SP Name] (ストアドプロシージャー名) | ストアドプロシージャーの正確な名前を入力します。 |
| [Is Function] (ファンクションとして使用) /[Return result in] (結果を返す) | このチェックボックスをオンにすると、値のみが返されます。<br><br>スキーマカラムのリストから返す値を選択します。 |
| [Parameters] (パラメーター) | [+]ボタンをクリックして、プロシージャーで必要となる各種[Schema Columns] (スキーマカラム)を選択します。SPスキーマには、プロシージャーで使用されているパラメーターを超える数のカラムを含めることができます。<br><br>パラメーターの[Type] (タイプ)を選択します。<br><br>[IN]: 入力パラメーター<br><br>[OUT]: 出力パラメーター/戻り値<br><br>IN OUT: 通常、入力パラメーターはプロシージャー(ファンクション)によって変更された後に値として返されます。<br><br>RECORDSET: 入力パラメーターは単一の値ではなく、値のセットとして返されます。<br><br>情報メモ注: データベーステーブルまたはDBクエリーから一連のレコードを分析し、単一のレコードを返す場合は、[マザー/ドーターテーブルにデータを挿入する](https://help.qlik.com/talend/`ja-JP/components/8.0/mysql/tmysqlconnection-tmysqlrollback-tfileinputdelimited-inserting-data-in-mother-daughter-tables-standard-component-the)をご覧ください。 |
| [Specify a data source alias] (データソースエイリアスを指定) | このチェックボックスを選択し、データソース設定で定義した共有接続プールを使用するために、 *Talend Runtime* 側で作成したデータソースのエイリアスを指定します。このオプションは、 *Talend Runtime* 内にジョブをデプロイして実行する時にのみ機能します。<br><br>このチェックボックスは、[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている場合は利用できません。 |
| [Data source alias] (データソースエイリアス) | *Talend Runtime* 側で作成したデータソースのエイリアスを入力します。<br><br>このフィールドは、[Specify a data source alias] (データソースエイリアスを指定)チェックボックスがオンの時のみ利用可能です。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| [Additional JDBC parameters] (追加のJDBCパラメーター) | 作成するデータベース接続に接続の追加プロパティを指定します。プロパティはセミコロンで区切られ、各プロパティはキー-値ペアです。たとえばAzure SQLデータベース接続の場合は、*encrypt=true;trustServerCertificate=false;* *hostNameInCertificate=\*.database.windows.net;loginTimeout=30;*となります。<br><br>このフィールドは、[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている場合は利用できません。 |
| [Authenticate using Azure Active Directory] (Azure Active Directoryを使って認証) | このオプションを選択すると、接続を確立する時にAzure Active Directory認証を使用できます。関連情報は、[Azure AD Authentication](https://docs.microsoft.com/en-us/azure/sql-database/sql-database-aad-authentication)をご覧ください。<br><br>このオプションは、[Basic settings] (基本設定)ビューの[JDBC Provider] (JDBCプロバイダー)ドロップダウンリストからMicrosoftが選択されている場合のみ利用できます。 |
| [Enable always encrypted (Column encryption)] (常に暗号化を有効にする(カラムの暗号化)) | このオプションを選択すると、Microsoftの[Always encrypted](https://learn.microsoft.com/en-us/sql/relational-databases/security/encryption/always-encrypted-database-engine?view=sql-server-ver15)機能が使用され、データが暗号化および保護されます。このオプションを使用するためには、事前に[Azure Key Vault](https://learn.microsoft.com/en-us/azure/key-vault/general/basic-concepts)でシークレットを保存しておく必要があります:<br><br><ul> <li> <span>[Application Client ID] (アプリケーションクライアントID)</span>: 登録済みアプリケーションのクライアントIDを入力します。この情報は、<span><span>Azure Active Directory</span> &gt; <span>[App registrations] (アプリの登録)</span> &gt; <span>[Essentials] (基本)</span></span>の下にあるアプリの詳細に記載されています。</li> <li> <span>[Application Client Secret] (アプリケーションクライアントシークレット)</span>: 登録済みアプリケーションのクライアントパスワードを入力します。この情報は、<span><span>Azure Active Directory</span> &gt; <span>[App registrations] (アプリの登録)</span> &gt; <span>[Certificates and secrets] (証明書とシークレット)</span></span>の下にあるアプリの詳細に記載されています。</li> </ul><br><br>この機能には、クエリー操作とステートメントに関する制限がいくつか適用されます。制限事項の包括的なリストは、[Microsoft SQL Serverのドキュメンテーション](https://learn.microsoft.com/en-us/sql/relational-databases/security/encryption/always-encrypted-database-engine?view=sql-server-ver15#limitations)をご覧ください。 |
| [tStatCatcher Statistics] (tStatCatcher統計) | このチェックボックスを選択すると、コンポーネントレベルでログデータを収集できます。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは、中間コンポーネントとして使用されます。開始コンポーネントとしても使用できますが、その場合は入力パラメーターになります。 |
| [Dynamic settings] (ダイナミック設定) | [+]ボタンをクリックしてテーブルに行を追加し、[Code] (コード)フィールドにコンテキスト変数を入力して、ジョブ内で計画した複数の接続からデータベース接続をダイナミックに選択します。この機能は、データストラクチャーが同じでデータベースが異なるデータベーステーブルにアクセスする必要がある場合、特に、Talend Studioを介さずにジョブをデプロイおよび実行する必要がある時など、ジョブの設定を変更できない環境で作業している場合に役立ちます。<br><br>[Dynamic settings] (ダイナミック設定)テーブルは、[Basic settings] (基本設定)ビューで[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている時のみ利用可能です。ダイナミックパラメーターを定義すると、[Basic settings] (基本設定)ビューの[Component List] (コンポーネントリスト)ボックスは利用できなくなります。<br><br>ダイナミックパラメーターの定義法を示すユースケースについては、[コンテキストベースのダイナミック接続によってデータベースからデータを読み取り](https://help.qlik.com/talend/r/ja-JP/8.0/components/defining-context-groups/reading-data-from-databases-through-context-based-dynamic-connections)と、[ダイナミックにロードされた接続パラメーターを使って異なるMySQLデータベースからデータを読み取り](https://help.qlik.com/talend/r/ja-JP/8.0/components/context/reading-data-from-different-mysql-databases-using-dynamically-loaded-connection-parameters)をご覧ください。ダイナミック設定とコンテキスト変数の詳細は、[ダイナミックスキーマ](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/dynamic-schema)と[コンテキストグループを作成し、その中でコンテキスト変数を定義](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/creating-context-group-and-define-context-variables-in-it)をご覧ください。 |
| 制限事項 | ストアドプロシージャーの構文は、データベースの構文とマッチしている必要があります。<br><br>ライセンスの互換性の問題のため、このコンポーネントの使用に必要な1つ以上のJARが提供されていません。この特定のコンポーネントに不足しているJARをインストールするには、Component (コンポーネント)タブビューの[Install] (インストール)ボタンをクリックします。Talend StudioのIntegrationパースペクティブにある[Modules] (モジュール)タブでも、不足しているすべてのJARを簡単に見つけて追加できます。詳細は、[外部モジュールをインストール](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/installing-external-modules)をご覧ください。 |

**関連概念**

[ストアドプロシージャーを使用して個人情報を受信](https://help.qlik.com/talend/ja-JP/components/8.0/mssql/tmssqlsp-tlogrow-tparserecordset-tfixedflowinput-retrieving-personal-information-using-stored-procedure-standard-component-this)