tMSSqlOutputの標準プロパティ - Cloud - 8.0

MSSql

Version
Cloud
8.0
Language
日本語 (日本)
Product
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for ESB
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
ジョブデザインと開発 > サードパーティーシステム > DBコンポーネント > MSSql
データガバナンス > サードパーティーシステム > DBコンポーネント > MSSql
データクオリティとプレパレーション > サードパーティーシステム > DBコンポーネント > MSSql

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

[Standard] (標準) tMSSqlOutputコンポーネントは、データベースファミリーに属しています。

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

注: このコンポーネントは、動的データベースコネクターの特定のバージョンです。データベース設定に関連するプロパティは、データベースタイプの選択に応じて異なります。動的データベースコネクターについては、動的データベースコンポーネントをご覧ください。

基本設定

[Database] (データベース)

データベースのタイプをリストから選択し、[Apply] (適用)をクリックします。

[Property type] (プロパティタイプ)

[Built-in] (組み込み)または[Repository] (リポジトリー)のいずれかです。

  • [Built-In] (組み込み): 一元的に保存されるプロパティデータはありません。
  • [Repository] (リポジトリー): プロパティが保管されるリポジトリーファイルを選択します。後続フィールドは、取得されたデータを使用して自動的に入力されます。

このアイコンをクリックすると、データベース接続ウィザードが開き、コンポーネント[Basic settings] (基本設定)ビューに設定したデータベース接続パラメーターが保存されます。

データベース接続パラメーターの設定と保存の詳細は、 Talend Studio ユーザーガイドを参照してください。

[Use an existing connection] (既存の接続を使用)

定義済みの接続の詳細を再利用するには、このチェックボックスをオンにして、[Component List] (コンポーネントリスト)ドロップダウンリストで目的の接続コンポーネントを選択します。

注: ジョブに親ジョブと子ジョブが含まれている時は、親ジョブと子ジョブの間の既存の接続を共有したい場合(たとえば、親ジョブで作成した接続を子ジョブと共有するなど)には、次のように実行します。
  1. 親レベルで、共有するデータベース接続を、そのデータベース接続そのものを作成する接続コンポーネントの[Basic settings] (基本設定)ビューに登録します。
  2. 子レベルで、登録済みのそのデータベース接続を読み取るために専用の接続コンポーネントを使用します。

ジョブレベルをまたがってデータベース接続を共有する方法の例は、 Talend Studio ユーザーガイドをご覧ください。

[JDBC Provider] (JDBCプロバイダー)

使うJDBCドライバーのプロバイダー、[Microsoft] (マイクロソフト) (デフォルト、推奨)または[Open source JTDS] (オープンソースJTDS)を選択します。

Microsoftを選択した場合は、SQL Server用Microsoft JDBCドライバーを[Microsoftダウンロードセンター]からダウンロードし、ダウンロードしたzipファイルを解凍し、解凍したフォルダーからお使いのJREバージョンに基づいてjarを選択し、jarの名前をmssql-jdbc.jarに変更し、手動でインストールする必要があります。jarの選択については、Microsoftダウンロードセンターでシステム要件情報をご覧ください。

OSGiビルドには、オープンソースのjTDSJDBCドライバーが含まれないことにご注意ください。このコンポーネントが含まれているジョブをOSGiバンドルとしてビルドする必要がある時は、Microsoftの公式JDBCドライバーを使用してください。このドライバーを使用しない場合、このコンポーネントは Talend Runtimeに正しくインストールされたjTDSJDBCドライバーを使用するデータソースでのみ機能します。

[Host] (ホスト)

使うデータベースサーバーかAzure Synapse AnalyticsのIPアドレスまたはホスト名を指定します。

サーバーが存在するマシンでSQL Server Browserサービスが実行中である場合は、このフィールドにホスト名とインスタンス名を{host_name}\{instance_name}という形式で指定すれば、TCPダイナミックポートを通じてネームドインスタンスに接続できるようになります。この場合は[Port] (ポート)フィールドを空白のまましておきます。関連情報は、SQL Server Browser serviceをご覧ください。

[Port] (ポート)

使うデータベースサーバーかAzure Synapse Analyticsのリスニングポート番号を入力します。

サーバーが存在するマシンでSQL Server Browserサービスが実行中である場合は、[Host] (ホスト)フィールドにホスト名とインスタンス名を入力し、このフィールドを空にしておけば、TCPダイナミックポートを通じてネームドインスタンスに接続できるようになります。関連情報は、SQL Server Browser serviceをご覧ください。

[Schema] (スキーマ)

スキーマの名前。

[Database] (データベース)

データベースの名前。

[Username] (ユーザー名)[Password] (パスワード)

認証データを入力します。

パスワードを入力するためには、[Password] (パスワード)フィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して[OK]をクリックし、設定を保存します。

[Additional JDBC Parameters] (追加のJDBCパラメーター)フィールドにintegratedSecurity=trueを追加し、これら2つのフィールドを空にしておけば、Windows[Type 2 integrated authentication] (タイプ2の統合認証)を使用できるようになります。関連情報は、Building the connection URLConnecting with integrated authentication On Windowsというセクションをご覧ください。

[Table] (テーブル)

書き込まれるテーブルの名前。一度に書き込みができるテーブルは1つだけです。

[Action on table] (テーブルでのアクション)

定義済みのテーブルで、次のオペレーションの1つを実行できます。

[Default] (デフォルト): 操作は行われません。

[Drop and create table] (ドロップしてテーブルを作成): テーブルが削除され、再作成されます。

[Create table] (テーブルを作成): テーブルが存在しないため、作成します。

[Create table if not exists] (存在しない場合はテーブルを作成): テーブルが存在しない場合は作成されます。

[Drop table if exists and create] (存在する場合はテーブルをドロップして作成): テーブルが既に存在する場合は削除されて再作成されます。

[Clear table] (テーブルをクリア): テーブルの内容が削除されます。

[Truncate table] (テーブルを切り詰める): テーブルの内容が削除されます。操作をロールバックすることはできません。

[Turn on identity insert] (ID挿入をオンにする)

(SQL Serverに次の順次値を選択させるのではなく)挿入されたレコードのID値に独自のシーケンスを使うには、このチェックボックスをオンにします。

[Action on data] (データでのアクション)

定義されたテーブルのデータで実行できる操作は次のとおりです。

[Insert] (挿入): テーブルに新しいエントリーを追加します。重複が見つかった場合、ジョブは停止されます。

[Single Insert Query] (単一挿入クエリー): バッチ内のテーブルにエントリーを追加します。

[Update] (アップデート): 既存のエントリーが変更されます。
注: スキーマカラムがすべてキーとして設定されている場合は、このアクションによってエラーが発生し、ジョブが失敗します。
[Insert or update] (挿入またはアップデート): 新しいレコードを挿入します。指定された参照を持つレコードが既に存在する場合は、アップデートされます。
注: スキーマカラムがすべてキーとして設定されている場合は、このアクションによって警告メッセージが発生し、ジョブが続行されます。
[Update or insert] (アップデートまたは挿入): 指定された参照を使用してレコードをアップデートします。レコードが存在しない場合は、新しいレコードが挿入されます。
注: スキーマカラムがすべてキーとして設定されている場合は、このアクションによって警告メッセージが発生し、ジョブが続行されます。

[Delete] (削除): 入力フローに対応するエントリーを削除します。

[Insert if not exist] (存在しない場合は挿入) : テーブルに新しいエントリーが存在しない場合は追加します。

警告: [Update] (更新)および[Delete] (削除)操作を行うプライマリキーとして少なくとも1つのカラムを指定する必要があります。そのためには、[Edit Schema] (スキーマを編集)をクリックし、プライマリキーに指定するカラムの横にあるチェックボックスをオンにします。高度な設定を行う場合は、[Advanced settings] (詳細設定)ビューをクリックして、[Update] (アップデート)および[Delete] (削除)操作のプライマリキーを同時に定義できます。これを設定するには、以下のようにします:[Use field options] (フィールドオプションを使う)チェックボックスをオンにし、[Key in update column] (更新カラムの入力)で、更新操作のベースとして使うカラム名の横にあるチェックボックスをオンにします。削除操作の[Key in delete column] (削除カラムの入力)でも同じようにします。
注: ダイナミックスキーマ機能は以下のモードで使用できます: [Insert] (挿入)[Update] (更新)[Insert or update] (挿入または更新)[Update or insert] (更新または挿入)[Delete] (削除)

[Specify identity field] (IDフィールドの指定)

IDフィールドを指定するには、このチェックボックスをオンにします。IDフィールドは自動的にインクリメントするID番号で構成されています。

このチェックボックスをオンにすると、他の3つのフィールドが表示されます。

[Identity field] (IDフィールド): IDフィールドとして定義するカラムをリストから選択します。

[Start value] (開始値): テーブルにロードされる最初の行に使う開始値を入力します。

[Step] (ステップ): ロードされた前の行の値に追加する増分値を入力します。

このチェックボックスは、[Action on table] (テーブルでのアクション)リストで[Drop and create table] (ドロップしてテーブルを作成)[Create table] (テーブルの作成)[Create table if not exists] (存在しない場合はテーブルを作成)または[Drop table if exists and create] (テーブルが存在する場合はドロップして作成)を選択している場合にのみ利用でき、このチェックボックスは、 [Advanced settings] (詳細設定)ビューの[Enable parallel execution] (並列実行を有効化)チェックボックスをオンにしている場合は表示されません[Turn on identity insert] (ID挿入をオンにする)チェックボックスがオフの状態で[Action on table] (テーブルでのアクション)リストから[Create table if not exists] (存在しない場合はテーブルを作成)オプションを選択し、このチェックボックスをオンにすると、指定したテーブルが存在しない場合、データが挿入されていないテーブルのみが作成されます。

注: コンポーネントのスキーマからIDフィールドを指定することもできます。それには、関連するカラムの[DB Type] (DBタイプ)INT IDENTITYに設定します。
注: [Specify identity field] (IDフィールドの指定) チェックボックスが選択されている場合、スキーマ内のINT IDENTITY DB Typeは無視されます。

[Schema] (スキーマ)[Edit schema] (スキーマを編集)

スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語のlineを避けます。

スキーマを変更するには[Edit schema] (スキーマを編集)をクリックします。現在のスキーマがリポジトリータイプの場合は、3つのオプションを利用できます。

  • [View schema] (スキーマの表示): スキーマのみを表示する場合は、このオプションを選択します。

  • [Change to built-in property] (組み込みのプロパティに変更): ローカルで変更を行うためにスキーマを組み込みに変更する場合は、このオプションを選択します。

  • [Update repository connection] (リポジトリー接続をアップデート): リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。

    変更を現在のジョブにのみ反映する場合は、変更後、[No] (いいえ)を選択し、[Repository Content] (リポジトリーのコンテンツ)ウィンドウで再びこのスキーマのメタデータを選択します。

このコンポーネントはダイナミックスキーマ機能の利点を備えているので、ソースファイルから不明なカラムを取得したり、各カラムを個別にマッピングしなくてもソースからカラムを一括してコピーしたりできます。ダイナミックスキーマの詳細は、 Talend Studio ユーザーガイドをご覧ください。

このダイナミックスキーマ機能は、テーブルの不明なカラムを取得する目的で設計されており、この目的に限り使用をお勧めします。テーブルの作成で使用することは勧められていません。

[Built-in] (組み込み): このコンポーネントに対してのみスキーマを作成し、ローカルに保管します。

[Repository] (リポジトリー): スキーマは作成済みで、リポジトリーに保管されています。さまざまなプロジェクトやジョブデザインで再利用できます。

再使用するスキーマに整数またはファンクションのデフォルト値が指定されている場合は、これらのデフォルト値を引用符で囲まないようにご注意ください。引用符で囲まれている場合は手動で削除します。

詳細は、Talend Studioユーザーガイドでテーブルスキーマに関連する説明をご覧ください。

[Specify a data source alias] (データソースエイリアスを指定)

このチェックボックスをオンにして、データソース設定で定義した共有接続プールを使用するために、 Talend Runtime 側で作成したデータソースのエイリアスを指定します。このオプションは、 Talend Runtime 内にジョブをデプロイして実行する時にのみ機能します。

このチェックボックスは、[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている場合は利用できません。

[Data source alias] (データソースエイリアス)

Talend Runtime 側で作成したデータソースのエイリアスを入力します。

このフィールドは、[Specify a data source alias] (データソースエイリアスを指定)チェックボックスがオンの場合のみ利用できます。

[Die on error] (エラー発生時に強制終了)

このチェックボックスはデフォルトで選択されています。エラーの発生した行をスキップし、エラーが発生していない行の処理を完了するには、このチェックボックスをオフにします。必要に応じて[Row] (行) > [Rejects] (リジェクト)リンクを使用してエラー発生時に行を取得できます。

詳細設定

[Additional JDBC parameters] (追加のJDBCパラメーター)

作成するデータベース接続に接続の追加プロパティを指定します。プロパティはセミコロンで区切られ、各プロパティはキー/値ペアです。たとえばAzure SQLデータベース接続の場合は、encrypt=true;trustServerCertificate=false; hostNameInCertificate=*.database.windows.net;loginTimeout=30;となります。

このフィールドは、[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている場合は利用できません。

[Authenticate using Azure Active Directory] (Azure Active Directoryを使って認証)

接続を確立する時にAzure Active Directory認証を使うには、このオプションを選択します。関連情報は、Azure AD Authenticationをご覧ください。

このオプションは、[Basic settings] (基本設定)ビューの[JDBC Provider] (JDBCプロバイダー)ドロップダウンリストでMicrosoftが選択されている場合に利用できます。

[Commit every] (コミットする間隔)

ノードのバッチがDBにコミットされるまでに完了しているべき行数を入力します。このオプションにより、トランザクションの質(ただしロールバックは含まない)、特に実行時のパフォーマンスの向上が保証されます。

[Additional Columns] (追加のカラム)

このオプションは、DBテーブルを作成する場合(ドロップありまたはドロップなし)には提供されません。このオプションにより、SAL関数を呼び出してカラムにアクションを実行できます。ただし、挿入、アップデート、削除のアクションでないこと、特定の事前処理を必要とするアクションでないことが条件です。

  • [Name] (名前): 変更するか、または新しいカラムとして挿入するスキーマカラムの名前を入力します。
  • [SQL expression] (SQL式): 関連するカラムデータを変更または挿入するために実行するSQLステートメントを入力します。
  • [Position] (位置): 参照カラムに対して実行されるアクションに従って、[Before] (実行前)[Replace] (置換)[After] (実行後)のいずれかを選択します。
  • [Reference column:] (参照カラム:)新規または変更されたカラムを配置または置換するためにtDBOutputが使える参照のカラムを入力します。

[Use field options] (フィールドオプションを使用)

特にデータに二重のアクションがある場合、リクエストをカスタマイズするには、このチェックボックスをオンにします。

[Ignore date validation] (日付の検証を無視する)

日付検証を無視して、DATE、DATETIME、DATETIME2、DATETIMEOFFSETのデータ型に対してデータをデータベースに直接挿入するには、このチェックボックスをオンにします。

[Debug query mode] (デバッグクエリーモード)

このチェックボックスをオンにすると、データベースのエントリーの処理中に各ステップが表示されます。

[Support null in "SQL WHERE" statement] ("SQL WHERE"ステートメントでnullをサポート)

DBテーブルに含まれているNull値を処理する場合は、このチェックボックスをオンにします。

注: スキーマ内の対応するカラムで[Nullable] (nullを許可)チェックボックスがオンになっていることをご確認ください。

[Use Batch] (バッチを使用)

このチェックボックスをオンにして、データ処理のバッチモードを有効にします。

このチェックボックスは、[Action on data] (データでのアクション)リストで[Insert] (挿入)[Update] (更新)[Single Insert Query] (単一挿入クエリー)、または[Delete] (削除)オプションを選択している場合にのみ使えます。

注: [Action on data] (データでのアクション)リストで[Single Insert Query] (単一挿入クエリー)オプションを選択する場合は、バッチサイズをカラム数で除した数値がJDBCドライバーによって許可されているパラメーターマーカーの上限(一般に2000)を超えないようにご注意ください。詳細は、下記の [Limitation] (制限事項)参照してください。

[Batch Size] (バッチサイズ)

各バッチで処理するレコードの数を指定します。

このフィールドは、[Use batch mode] (バッチモードの使用)チェックボックスがオンの場合のみ表示されます。

[Set Query Timeout] (クエリータイムアウトを設定)

このオプションを選択して、クエリーまたはバッチクエリーのタイムアウト期間を設定します。クエリーまたはバッチクエリーがタイムアウトするとジョブは終了します。[Timeout] (タイムアウト)フィールドで、タイムアウト期間(秒)を設定できます。

注:
  • このオプションは、Microsoftが提供するJDBCドライバーを使う(つまり[JDBC Provider] (JDBCプロバイダー)ドロップダウンリストからMicrosoftを選択する)と、バッチクエリーに適用されます。JTDSドライバーを使う(つまり[JDBC Provider] (JDBCプロバイダー)ドロップダウンリストからOpen source JTDSを選択する)と、個別のクエリーに適用されます。
  • このオプションは、TalendのR2021-12以降のStudio月次アップデートをインストールした場合のみ利用できます。詳細は管理者にお問い合わせください。

[tStatCatcher Statistics] (tStatCatcher統計)

このチェックボックスをオンにすると、コンポーネントレベルでログデータを収集できます。

[Enable parallel execution] (並列実行を有効化)

このチェックボックスをオンにすると、複数のデータフローを同時に処理することにより、高速データ処理を実行できます。このフィーチャーは、データベースまたは複数の挿入を並行して処理するアプリケーションの機能と、関係するCPUの数に依存していることにご注意ください。[Number of parallel executions] (並列実行の数)フィールドで次のいずれかの操作を行います。
  • 実行する並列実行の数を入力する。
  • Ctrl + スペースを押して、リストから適切なコンテキスト変数を選択する。詳細は、 Talend Studioユーザーガイドをご覧ください。

並列実行を有効にすると、グローバル変数を使ってサブジョブで戻り値を取得することはできないことにご注意ください。

警告:
  • [Action on table] (テーブルでのアクション)フィールドは、並列化機能では利用できません。したがって、テーブルを作成する場合は、tCreateTableのコンポーネントを使用する必要があります。
  • 並列実行を有効にすると、グローバル変数を使ってサブジョブで戻り値を取得できません。

グローバル変数

[Global Variables] (グローバル変数) 

NB_LINE: 処理された行の数。これはAfter変数で、整数を返します。

NB_LINE_UPDATED: アップデートされた行の数。これはAfter変数で、整数を返します。

NB_LINE_INSERTED: 挿入された行の数。これはAfter変数で、整数を返します。

NB_LINE_DELETED: 削除された行の数。これはAfter変数で、整数を返します。

NB_LINE_REJECTED: 拒否された行の数。これはAfter変数で、整数を返します。

QUERY: 処理されたクエリーステートメント。これはAfter変数で、文字列を返します。

ERROR_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。

Flow変数はのコンポーネントの実行中に機能し、After変数はコンポーネントの実行後に機能します。

フィールドまたは式に変数を入れるには、Ctrl + スペースを押して変数リストにアクセスし、リストから使用する変数を選択します。

変数の詳細は、 Talend Studio ユーザーガイドをご覧ください。

使用方法

使用ルール

このコンポーネントでは、DBクエリーの柔軟性によるメリットが提供されており、使用可能なすべてのSQLクエリーが網羅されています。

このコンポーネントは出力コンポーネントとして使用する必要があります。このコンポーネントを使用して、MSSqlデータベース内のテーブルまたはテーブルのデータにアクションを実行できます。また、[Row] (行) > [Rejects] (リジェクト)リンクを使用して、エラーのあるデータをフィルタリングするリジェクトフローを作成することもできます。tMysqlOutputの使い方の例は、リジェクトリンクを使用してエラーデータを取得するを参照してください。

[Dynamic settings] (ダイナミック設定)

[+]ボタンをクリックしてテーブルに行を追加し、[Code] (コード)フィールドにコンテキスト変数を入力して、ジョブ内で計画した複数の接続からデータベース接続をダイナミックに選択します。この機能は、データ構造が同じでデータベースが異なるデータベーステーブルにアクセスする必要がある場合、特に、Talend Studioを介さずにジョブをデプロイおよび実行する必要がある時など、ジョブの設定を変更できない環境で作業している場合に役立ちます。

[Dynamic settings] (ダイナミック設定)テーブルは、[Basic settings] (基本設定)ビューで[Use an existing connection] (既存の接続を使用)チェックボックスがオンになっている場合のみ利用できます。ダイナミックパラメーターを定義すると、[Basic settings] (基本設定)ビューの[Component List] (コンポーネントリスト)ボックスは利用できなくなります。

動的パラメーターの使用サンプルは、コンテキストベースの動的接続によるデータベースからのデータの読み取りおよび動的に読み取られた接続パラメーターを使用した異なるMySQLデータベースからのデータの読み取りをご覧ください。[Dynamic settings] (ダイナミック設定)とコンテキスト変数については、Talend Studioユーザーガイドをご覧ください。

制限事項

[Action on data] (データでのアクション)リストで[Single Insert Query] (単一挿入クエリー)オプションが選択されている場合は、SQLの準備されたステートメントが生成されます。例: INSERT INTO table (col1, col2, col3) VALUES (?,?,?) , (?,?,?) , (?,?,?) ,(?,?,?) . 括弧内は数が2000を超えることができないパラメーターのグループです。これは一般に、JBDCドライバーによって左右されます。したがって、バッチサイズはこの制限を守って設定する必要があります。

ライセンスの互換性の問題のため、このコンポーネントの使用に必要な1つ以上のJARが提供されていません。この特定のコンポーネントに不足しているJARをインストールするには、Component (コンポーネント)タブビューの[Install] (インストール)ボタンをクリックします。Studioの Integration パースペクティブの[Modules] (モジュール)タブでも、不足しているすべてのJARを簡単に見つけて追加できます。詳細は、外部モジュールのインストールをご覧ください。外部モジュールをインストールする方法の詳細は、Talend Help Center (https://help.talend.com)をご覧ください。