任意のSQLの実行を行います。
SharePointへのアクセスはCData Software Inc.社の提供する技術を利用してRDBのようにSQLでアクセスする手段を提供します。利用できるSQLなどの詳細についてはこちらも参考にしてください。
その他CDataアダプターをご利用する際の注意事項に関してはこちらをご覧ください。
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 1 | |
| 説明 |
入力ストリームは使われません。ストリームフォーマットは選択不可です。 | |
| 出力 | フォーマット | すべて |
| 説明 | 実行する処理が「SELECT文を発行」または「ストアド実行(結果あり)」の場合は、出力ストリームはRecordになります。 実行する処理が「任意のSQLを実行」または「ストアド実行(結果なし)」の場合は、入力ストリームをそのまま出力します。 |
| 名前 | データ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| コネクション名 | connection | - | 接続先のSharePointを指定します。 コネクションペインまたは管理コンソールにて作成されたSharePoint接続名を選択します。 | ||||||
| 実行する処理 | choice | - |
実行するSQLの種類を指定します。 各種類ごとの動作は、下記トピック「実行する処理ごとの動作」を参照してください。
| ||||||
| SQL文 | string | In & Out |
実行するSQLまたはProcedureを記述します。 フロー実行時の動的な値を含めるためのSQLまたはProcedureの記述方法は、下記トピック「SQLパラメーターの使い方」を参照してください。 | ||||||
| ループを開始 | loopProcess | - | 実行する処理が「SELECT文を発行」または「ストアド実行(結果あり)」の場合、結果セットをまとめて出力するか1レコードずつループして出力するかを選択します。実行する処理がこれ以外はプロパティが表示されません。
| ||||||
| タイムアウト(秒) | int | In & Out |
SharePointに対してSQL文を発行してから結果が返ってくるまでの待ち時間を秒単位で指定します。 指定時間を経過しても実行が終わらない場合はエラーになります。0の場合、タイムアウトしません。 | ||||||
| レコードが無い場合エラー | boolean | - |
結果セットのレコード件数が0件だった場合にエラーを発生するかどうかを選択します。
| ||||||
| 処理件数 | int | Out | 実行する処理が「任意のSQLを実行」の場合に更新されたレコード件数が取得できます。 実行する処理がそれ以外の場合はプロパティが表示されません。 | ||||||
| トランザクションに含める | boolean | - |
このプロパティの値は無視されます。
| ||||||
| SQLパラメーターを使用する | boolean | - |
$,? を使用したいときにこのプロパティを「いいえ」にするとSQLパラメーター置換処理をせずコンポーネントを実行できます。
また、この場合はSQLパラメーターが設定されていても無視されるので注意してください。 ストアド実行(結果あり)の場合、「? = call procedulre_name( )」等記述してある場合動作しなくなります。
| ||||||
| SQLパラメーター | category | In & Out |
パラメーター名、入出力種別、データ型、値のセットで定義します。 値は、前に連結したマッパーからマッピングすることが可能です。また、入出力種別で出力するパラメーターは直後に連結したマッパーから参照することもできます。詳細については、下記トピック「SQLパラメーターの使い方」を参照してください。 |
出力ストリームがRecordで、かつループを開始が「はい」の場合、このコンポーネントがループの起点となって結果セットのレコードを1レコードずつ出力します。
| タイプ | パラメータ | エラー処理フローへのストリーム | エラー コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネント入力のストリーム | なし | コネクション名に指定したコネクションが見つからない場合 |
| 例外コード | SQLまたはProcedureの実行に失敗した場合 | |||
| 例外コード | SQL文がタイムアウトした場合 | |||
| 接続エラー | なし | コンポーネントの入力ストリーム | なし | SharePointとの接続に失敗した場合 |
| レコードが無い | なし | コンポーネントの入力ストリーム | なし | 出力ストリーム型がRecordとなる場合かつレコードが無い場合エラーが「はい」で、結果セットが0行の場合 |
フローを強制終了すると、通常は実行中のコンポーネントの処理が終了してから次のコンポーネントに制御が遷移する時点でフローがアボートしますが、本コンポーネントでは実行中の処理を強制的に終了してフローがアボートします。
SELECT以外の任意のSQLを実行する場合に使用します。
SQL文にはInsert、Update、Deleteなど、サポートするあらゆるSQLを記述することができます。
SELECT文を実行する場合に使用します。
SQL文には実行するSELECT文を記述します。
結果セットとフィールド定義の関係は、下記トピック「SQL文中のカラムと出力ストリームのフィールドの関係」を参照してください。
結果セットを返さないストアドプロシージャを実行する場合に使用します。
SQLの書式はのように、実行するプロシージャを{ callと}で囲んで記述します。
この例ではPROC-NAMEがプロシージャ名、P1、P2がSQLパラメーター名です。
{ call PROC-NAME( ?P1?, ?P2?)}
結果セットを返すストアドプロシージャを実行する場合に使用します。
結果セットとフィールド定義の関係は、下記トピック「SQL文中のカラムと出力ストリームのフィールドの関係」を参照してください。
本コンポーネントの出力ストリームとしてレコードを取得するには、ストリームペインにフィールドを定義する必要がありますが、SQL文中の各カラムと出力ストリームのフィールドは順序によってマッピングされるため、カラム名とフィールド名は一致する必要はありません。
カラム数が出力ストリームで定義されたフィールド数と異なる場合や、カラムのデータ型が対応するフィールドのデータ型と異なる場合でも、順序によってマッピングされます。
SQLパラメーターを使うと、実行時の動的な文字列を含むSQL文を実行することができます。SQL文に記述する際に、SQLパラメーターで定義した任意の名前のパラメーター名を含むSQL文を記述します。本コンポーネントの前にマッパーを配置し、定義したパラメーターにマッピングすることにより、実行時の動的な文字列を含むSQL文を実行することができます。
パラメーターには、以下の2つの書式があります。
SQLパラメーター書式は、SQL文中のフィールド値となる箇所で使います。パラメーターの定義では、フィールドに対応したデータ型を指定します。SQL文で、置き換えたい文字列を使用する部分に「?パラメーター?」のようにパラメーター名を?で囲んで記述します。
置換文字列書式は、SQL文中の任意の箇所で使います。パラメーターの定義では、データ型にStringを指定します。SQL文で、置き換えたい文字列を使用する部分に「$パラメーター名$」のようにパラメーター名を$で囲んで記述します。
以下の手順で記述します。
実行する処理が「任意のSQLを実行」または「SELECT文を発行」の場合、入出力種別はすべて「入力」を指定します。ストアド実行(結果なし)」または「ストアド実行(結果あり)」の場合は、ストアドプロシージャの入出力タイプに応じて指定します。
SQLパラメータータブで、フィールドを右クリックして表示されるメニューから「上に移動」「下に移動」「挿入」「削除」を操作します。
パラメーターフィールドリストをCSV形式で表現した一覧を、いつも使用しているエディタで編集することができます。パラメーターフィールドリストのCSV形式は、各項目の文字列をカンマ(,)区切りで表現しています。以下に、例と項目の説明を示します。
para1,in,VARCHAR,TEST para2,in/out,VARCHAR,SAMPLE
| 項目名 | 内容 |
|---|---|
| パラメーター名 | パラメーター名。 |
| 入出力 | 入力の場合、in。 入出力の場合、in/out。 出力の場合、out。 |
| データ型 | データ型。 |
| 値 | 値。指定しなかった場合は空文字になります。 |
フローデザイナーのテキストエディタが表示されます。いつも使用しているエディタで編集するには、テキストエディタ画面上部にある「外部エディタ」ボタンをクリックします。関連付けられたエディタが起動されます。
| 認証スキーム[AuthScheme] |
このプロパティは、お使いの環境およびID プロバイダーの要件に基づくセキュアな認証を実現します。 Microsoft SharePoint オンプレミスMicrosoft SharePoint オンプレミスインスタンスに接続する場合、このプロパティはUser およびPassword と共に、認証の処理方法を決定します。 デフォルトの認証スキームはNTLM です。利用可能なオプションは以下のとおりです。
Microsoft SharePoint オンラインMicrosoft SharePoint オンラインに接続する場合、AzureAD がデフォルトの認証スキームです。設定されているSchema に応じて、以下のオプションを使用できます。 REST
SOAP廃止予定のお知らせ Microsoft はSharePoint Online における従来のIDCRL 認証プロトコルを廃止します。2026年1月31日より、従来の認証はデフォルトでブロックされます。2026年5月1日の完全廃止以降、SOAP 呼び出しは成功しなくなります。SOAP でサポートされている認証スキームがBasic と NTLM のみであるためです。SharePoint REST API(または他のモダンエンドポイント)に切り替え、OAuth ベースの認証(例:AzureAD 経由)を使用することを強く推奨します。 Basic および NTLM 認証スキームはSharePoint Online では非推奨です。 Default Value: AzureAD Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Auto Cache[AutoCache] |
この接続プロパティがTrue に設定されている場合、本製品 はSELECT クエリの対象となるテーブルの内容を自動的にキャッシュします。これらのテーブルの内容は、CacheConnection およびCacheDriver 接続プロパティで指定されたキャッシュデータベースにキャッシュされます。
関連項目その他の情報については、以下を参照してください:
Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Azure Environment[AzureEnvironment] |
Azure は、異なる地域や政府のユースケースに対応する複数のクラウド環境を提供しています。AzureEnvironment プロパティは、プロバイダーが認証時に接続する環境を決定します。 利用可能なオプションは以下のとおりです。
ほとんどの場合、デフォルト環境(GLOBAL)が機能します。ただし、Azure アカウントが国や政府のクラウドの一部である場合、このプロパティを適切に設定して認証エラーやURL の不一致を回避してください。 URL サフィックスの不一致の問題が発生した場合や、政府クラウドを対象とする必要がある場合は、このプロパティを使用してください。設定方法の詳細については、 Microsoft ドキュメントの「各国のクラウド」を参照してください。 Default Value: GLOBAL Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Azure Tenant[AzureTenant] |
テナントとは、Microsoft Entra ID(旧称:Azure AD)を通じて管理される、組織のユーザーやリソースのためのデジタルコンテナです。 各テナントには一意のディレクトリID が関連付けられており、多くの場合、カスタムドメイン(例:microsoft.com やcontoso.onmicrosoft.com)も関連付けられています。 Microsoft Entra 管理センターでディレクトリ(テナント)ID を確認するには、Microsoft Entra ID -> プロパティに移動し、「ディレクトリ(テナント)ID」と表示されている値をコピーします。 このプロパティは以下の場合に必要です。
テナントの値は、2つの形式のいずれかで指定できます。
テナントを明示的に指定することで、認証リクエストが正しいディレクトリにルーティングされるようになります。これは、ユーザーが複数のテナントに所属している場合や、サービスプリンシパルベースの認証を使用する場合に特に重要です。 この値が必要な場面で省略されると、認証に失敗したり、誤ったテナントに接続されたりする可能性があります。その結果、認可されていないまたはリソースが見つからないといったエラーが発生する可能性があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Batch Size[BatchSize] |
BatchSize に 0 より大きい値を設定すると、本製品 は操作全体を複数の小さなバッチに分割します。各バッチには、BatchSize プロパティで指定した行数が含まれ、サーバーへ 1 件ずつ送信されます。 0 を設定した場合、本製品 はバッチ全体を 1 つのリクエストとして送信します。 BatchSize は、サーバーがリクエストのサイズに制限を課している場合に役立ちます。 操作を小さな単位に分割することで、これらの制限を回避してバッチ処理を成功させることができます。 Default Value: 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Browsable Schemas[BrowsableSchemas] |
利用可能なすべてのデータベーススキーマの一覧表示には余分な時間がかかり、パフォーマンスが低下する場合があります。接続文字列にスキーマのリストを提供することで、時間を節約しパフォーマンスを向上させることができます。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cache Connection[CacheConnection] |
対象のキャッシュデータベースは、この接続プロパティとCacheDriver 接続プロパティの組み合わせによって決定されます。指定されたキャッシュデータベースを使用するには、両方のプロパティが必要です。 この接続プロパティで指定された接続文字列は、CacheDriver 接続プロパティで指定されたJDBC ドライバーに直接渡されます。使用可能な接続プロパティの詳細については、指定されたJDBC ドライバー のドキュメントを参照してください。 CacheDriver で指定したJDBC ドライバーがアプリケーションのクラスパスに含まれていることを確認してください。 以下に、一般的なキャッシュデータベースの設定例を示します。
Derby およびJava DBCacheDriver とこの接続プロパティを使用して、Derby への接続を設定します。以下は、Derby JDBC URL 構文です。
jdbc:derby:[subsubprotocol:][databaseName][;attribute=value[;attribute=value] ... ]
例えば、インメモリデータベースにキャッシュするには、以下を使用します。
jdbc:derby:memory
SQLiteSQLite へキャッシュするにはSQLite JDBC ドライバーを使用できます。次はJDBC URL の構文です。
jdbc:sqlite:dataSource
MySQL
以下はCData JDBC Driver for MySQL のJDBC URL の例です。
jdbc:mysql:User=root;Password=root;Server=localhost;Port=3306;Database=cache
一般的な接続プロパティは次のとおりです:
SQL ServerMicrosoft JDBC Driver for SQL Server のJDBC URL の構文は次のとおりです。
jdbc:sqlserver://[serverName[\instance][:port]][;database=databaseName][;property=value[;property=value] ... ]
次に例を示します。
jdbc:sqlserver://localhost\sqlexpress:1433;integratedSecurity=true
次は一般的なSQL Server 接続プロパティです。
Oracle次はOracle JDBC Thin ドライバーの従来のJDBC URL 構文です。
jdbc:oracle:thin:[userId/password]@[//]host[[:port][:sid]]
次に例を示します。
jdbc:oracle:thin:scott/tiger@myhost:1521:orcl
次は一般的な接続プロパティです。
PostgreSQL次は公式のPostgreSQL JDBC ドライバーのJDBC URL 構文です。
jdbc:postgresql:[//[host[:port]]/]database[[?option=value][[&option=value][&option=value] ... ]]
例えば、次の接続文字列はデフォルトホスト(localhost)およびポート(5432)上のデータベースに接続します。
jdbc:postgresql:postgres
一般的な接続プロパティは次のとおりです:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cache Driver[CacheDriver] |
CData JDBC drivers を含むJDBC ドライバーが用意されている任意のデータベースにキャッシュできます。 Note:指定されたJDBC ドライバーのJAR ファイルをクラスパスに追加する必要があります。CData JDBC drivers の場合、このJAR ファイルはドライバーのインストールディレクトリの"lib" サブフォルダにあります。 また、CacheConnection 接続プロパティを設定して、指定されたJDBC ドライバーの接続文字列を入力する必要があります。
例次の例は、いくつかの主要なデータベースにキャッシュする方法を示しています。 JDBC URL 構文および一般的な接続プロパティの詳細については、CacheConnection を参照してください。
Derby およびJava DBJava DB は、Derby のOracle ディストリビューションです。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。 クラスパスにderbytools.jar を追加した後、以下のようにJava DB データベースにキャッシュすることができます。
jdbc:sharepoint:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:sample';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;インメモリデータベースにキャッシュするには、次のようにJDBC URL を使用します。 jdbc:sharepoint:CacheDriver=org.apache.derby.jdbc.EmbeddedDriver;CacheConnection='jdbc:derby:memory';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite; SQLite次はSQLite JDBC ドライバーのJDBC URL です。
jdbc:sharepoint:CacheDriver=org.sqlite.JDBC;CacheConnection='jdbc:sqlite:C:/Temp/sqlite.db';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
MySQL以下はCData JDBC Driver for MySQL のJDBC URL です。
jdbc:sharepoint:Cache Driver=cdata.jdbc.mysql.MySQLDriver;Cache Connection='jdbc:mysql:Server=localhost;Port=3306;Database=cache;User=root;Password=123456';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
SQL Server次のJDBC URL はMicrosoft JDBC Driver for SQL Server を使用しています。
jdbc:sharepoint:Cache Driver=com.microsoft.sqlserver.jdbc.SQLServerDriver;Cache Connection='jdbc:sqlserver://localhost\sqlexpress:7437;user=sa;password=123456;databaseName=Cache';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
Oracle次はOracle Thin Client のJDBC URL です。
jdbc:sharepoint:Cache Driver=oracle.jdbc.OracleDriver;CacheConnection='jdbc:oracle:thin:scott/tiger@localhost:1521:orcldb';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
NOTE:9i より前のバージョンのOracle を使用している場合は、キャッシュドライバーは代わりにoracle.jdbc.driver.OracleDriver になります。
PostgreSQL次のJDBC URL は公式のPostgreSQL JDBC ドライバーを使用しています。
jdbc:sharepoint:CacheDriver=cdata.jdbc.postgresql.PostgreSQLDriver;CacheConnection='jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=localhost;Port=5432;';User=MyUserAccount;Password=MyPassword;Auth Scheme=NTLM;URL=http://sharepointserver/mysite;
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cache Location[CacheLocation] |
CacheLocation は単純なファイルベースキャッシュです。 本製品 はDerby データベースのOracle のディストリビューションあるJava DB をファイルベースのキャッシュに使用しています。Java DB にキャッシュするには、Derby JDBC ドライバーのJAR ファイルであるderbytools.jar をクラスパスに追加する必要があります。 Derby JDBC ドライバーのJAR ファイルは、このページからダウンロードできるdb-derby-10.17.1.0-bin.zip に同梱されています。derbytools.jar はこのzip ファイルの"lib" サブフォルダにあります。 指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SharePoint Data Provider となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます。
関連項目
Default Value: %APPDATA%\\CData\\SharePoint Data Provider | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cache Metadata[CacheMetadata] |
この接続プロパティがTrue に設定されている場合、クエリを実行すると、Microsoft SharePoint カタログのテーブルメタデータはCacheConnection とCacheDriver で指定されたキャッシュデータベースにキャッシュされ、もしこれらの接続プロパティが設定されていない場合はユーザーのホームディレクトリにキャッシュされます。 ホームディレクトリの場所はプラットフォームによって異なります。
CacheMetadata を使用するタイミング本製品 がメタデータ検索で取得するMicrosoft SharePoint テーブルとカラムの数が多い場合、本製品 がすべてのテーブルメタデータをリストするのに時間がかかることがあります。 次のような場合に、メタデータの取得に時間がかかることがあります。
CacheMetadata を使用しないタイミング本製品 は、はじめてテーブルやビューのメタデータを発見したときから最大1時間、そのメタデータをメモリに自動的に保持するため、通常はCacheMetadata は必要ありません。 CacheMetadata は、変動しやすいメタデータを扱うシナリオでは理想的ではありません。はじめてテーブルをクエリするとき、本製品 はそのメタデータをキャッシュデータベースファイルにキャッシュします。このキャッシュはテーブルスキーマの更新を反映するために動的に更新されることはないため、新規、変更、削除されたカラムを取得するには、キャッシュデータベースファイルを削除して再構築する必要があります。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Cache Tolerance[CacheTolerance] |
キャッシュ内のテーブルに対してクエリを実行すると、本製品 はキャッシュの最終更新から経過した時間を確認します。 キャッシュの最終更新がこの接続プロパティの値(秒単位)よりも前の場合、本製品 はキャッシュを更新します。 それ以外は、本製品 はキャッシュから直接データを返します。 Default Value: 600 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| コールバックUrl[CallbackURL] |
カスタムOAuth アプリケーションを作成した場合、OAuth 認可サーバーは認証プロセス中にユーザーをこのURL にリダイレクトします。 この値は、カスタムOAuth アプリケーションの設定時に指定したコールバックURL と一致する必要があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Connection Life Time[ConnectionLifeTime] |
このプロパティを0(デフォルト)より大きい値に設定すると接続の有効期間が制限され、その後本製品 が接続を終了します。 このプロパティを空白のままにするか、0 に設定すると、接続は明示的に閉じられるか、ネットワークの中断やセッションのタイムアウトなどの外部要因によって終了されるまで開いたままになります。 このプロパティは、リソースの利用状況を管理し、古くなった接続やアイドル状態の接続が無期限に持続するのを防ぐのに役立ちます。 Default Value: 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Connect On Open[ConnectOnOpen] |
ConnectOnOpen がTrue の場合、プロバイダーは「接続テスト」操作を実行します。これは、データベースツールで接続性を検証するために一般的に使用されます。 この操作はセッションデータを保持しません。代わりに、接続が確立できるかどうかを確認し、NOOP(操作なし)コマンドのように機能します。 ConnectOnOpen がFalse の場合、接続は操作が必要になるまで遅延されます。これは、接続が頻繁に開閉されるがすぐに操作が行われないような状況でパフォーマンスが向上する場合があります。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Continue On Error[ContinueOnError] |
バッチ操作を実行すると、アイテムの追加、更新、削除中にエラーが発生することがあります。 ContinueOnError プロパティは、エラーが発生した後に本製品 が処理を続行するかどうかを決定します。 true に設定すると、本製品 はバッチ内の残りのアイテムの処理を続行し、すべての可能な操作を完了させます。 false に設定すると、本製品 はエラーが発生するとすぐに処理を停止します。エラーが発生する前に処理されたアイテムは、そのまま追加、更新、または削除されます。 このプロパティはSOAP スキーマとREST スキーマの両方に適用され、バッチ操作ができるだけ多くのアイテムを処理することを優先するか、エラーに対処するために直ちに停止するかを制御するのに役に立ちます。 追加情報エラー後も処理を続行することで、中断することなく可能な限り多くのアイテムを処理し、バッチ効率を向上させることができます。 ただし、この場合失敗したエントリに対処するためのフォローアップ処理の必要性が増す可能性があります。 エラーで停止することでトラブルシューティングが簡素化されますが、スループットが低下し、バッチの再スタートやより小さなバッチサイズの使用が必要になる場合があります。 Default Value: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Create ID Columns[CreateIDColumns] |
In Microsoft SharePoint, certain fields, such as Lookup columns and Person or Group columns, store values that reference items in other lists. By default, when querying these fields using the SOAP schema, the 本製品 returns both the value and a supplemental ID column containing the referenced entry’s ID from the original list. When set to true, the 本製品 creates these ID columns alongside the referenced values, making it easier to trace relationships and perform lookups. When set to false, only the referenced values are returned, and the related IDs are not included. This property is useful for preserving relational context and enabling more advanced filtering or joins when working with data that includes references to other lists. Performance ConsiderationsCreating supplemental ID columns may increase the size of result sets and slightly impact performance when working with large datasets or wide tables. Disabling this property can reduce result set complexity and improve performance if the additional ID information is not needed. Default Value: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Disable Filter Limit[DisableFilterLimit] |
Microsoft SharePoint REST APIs natively support listing up to 5000 records based on list filters. For filters with 5000 or fewer records, server-side filtering provides the fastest performance. When set to true, the 本製品 attempts to delegate filtering to the server even when the filter exceeds 5000 records. However, this will likely result in a server error, as Microsoft SharePoint typically enforces the 5000-record limit. When set to false, if a filter exceeds 5000 records, the 本製品 queries from the entire list and applies filtering client-side. This avoids server errors, but introduces additional processing overhead. This property is useful for scenarios where filter sizes vary and you need to control whether filtering happens server-side or client-side based on performance or reliability requirements. Performance ConsiderationsServer-side filtering provides optimal performance for filters of 5000 records or fewer. Attempting to disable the limit for larger filters can result in server errors and failed queries. Client-side filtering allows queries to succeed beyond 5000 records, but increases data transfer and processing time, potentially impacting performance for large datasets. Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Exposed Table Types[ExposedTableTypes] |
ExposedTableTypes プロパティは、メタデータのクエリ時に Microsoft SharePoint のどのスキーマオブジェクトをテーブルとして公開するかを決定します。
すべてのモードで、TableListTypes プロパティが適用され、対象のリストテンプレートが絞り込まれます。フィールドのないビューは公開されません。ビューベースのテーブルには常にID 列が含まれます。 Default Value: ListsOnly | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Firewall Password[FirewallPassword] |
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。 プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Firewall Port[FirewallPort] |
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。 プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。 Default Value: 0 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Firewall Server[FirewallServer] |
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。 プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Firewall Type[FirewallType] |
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。 プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。 Note:デフォルトでは、本製品 はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。 次の表は、サポートされている各プロトコルのポート番号情報です。
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。 Default Value: NONE Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Firewall User[FirewallUser] |
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。 プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Folder Option[FolderOption] |
FolderOption プロパティは、Microsoft SharePoint のリストおよびライブラリのクエリ結果にファイルとフォルダーを表示する方法を決定します。利用可能なオプションは以下のとおりです。
このプロパティは、ネストしたフォルダー構造を含むリストやライブラリを使用する際に、クエリ結果のスコープを制御するのに役立ちます。REST スキーマでは、フィルタリングはサーバーサイドで適用され、ドキュメントライブラリにのみ影響します。ドキュメントライブラリ以外のリストには影響しません。 パフォーマンスに関する考慮事項RecursiveAll などの再帰的なオプションを選択すると、特にフォルダー階層が深いリストでは、クエリの実行時間と結果セットのサイズが増加する場合があります。 FilesOnly または FilesAndFolders を使用すると、結果のスコープを絞り込み、データ取得のオーバーヘッドを低減することでパフォーマンスが向上する場合があります。 フォルダースコープに必要な列FolderOption の設定を反映するため、ShowHiddenColumns および ShowPredefinedColumns の設定によって通常は非表示になる場合でも、本製品 は特定のドキュメントライブラリの列を常に通常のクエリ可能な列として公開します。この動作は REST スキーマに適用され、Microsoft SharePoint のドキュメントライブラリにのみ影響します。 以下の列が公開されます。
各列がどの名前で表示されるかは、UseDisplayNames プロパティによって決まります。UseDisplayNames が有効な場合 (デフォルト)、表示名の Path および Item Type が使用されます。無効な場合は、内部名の FileDirRef および FSObjType が使用されます。 Default Value: RecursiveAll Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Get Columns Metadata[GetColumnsMetadata] |
GetColumnsMetadata プロパティは、REST スキーマ使用時に本製品 がテーブルの列メタデータを取得およびキャッシュするタイミングを制御します。 これは、クエリの開始速度と事前読み込みの量に影響します。利用可能なオプションは以下のとおりです。
このプロパティは、複数のテーブルへの即時クエリ応答性と接続時間の短縮のバランスを取るのに役立ちます。 パフォーマンスに関する考慮事項起動時にメタデータを取得すると、すべての列定義を事前に読み込むことで後のクエリ遅延を低減できますが、特に大規模なデータセットでは接続時間が大幅に増加する場合があります。 使用時にメタデータを取得すると接続が速くなりますが、メタデータがオンデマンドで読み込まれるため、各テーブルへの最初のクエリが遅延する場合があります。Default Value: OnUse Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Lookup Columns[IncludeLookupColumns] |
Microsoft SharePoint tables can contain lookup columns, which pull data from other lists or sources. By default, the provider includes these columns when returning query results. When set to true, the 本製品 returns all defined lookup columns along with other table columns. When set to false, lookup columns are excluded from query results, reducing the number of fields retrieved. This property is useful for limiting query size and avoiding issues caused by Microsoft SharePoint server restrictions on the number of lookup columns returned in a single request. Performance ConsiderationsIncluding lookup columns can significantly increase query size and complexity, especially in lists with many lookup fields. This may lead to slower performance or server rejections if the number of included lookup columns exceeds SharePoint’s internal limits. Excluding lookup columns can improve performance and reliability when working with large or complex tables. Default Value: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Lookup Display Value Columns[IncludeLookupDisplayValueColumns] |
In the REST schema, lookup columns by default return only the record identifiers that reference data from other lists. For example:
MultiLookUpColumn=1, 2When IncludeLookupDisplayValueColumns is set to true, the 本製品 includes an additional column for each lookup field with a _DisplayValue suffix. This column shows the human-readable values associated with each lookup ID. For example: MultiLookUpColumn = 1, 2 MultiLookUpColumn_DisplayValue = United States, United Kingdom This property is useful for making query results more readable and eliminating the need to perform manual lookups to resolve IDs to display values. Performance ConsiderationsIncluding display value columns increases server processing time and resource usage, as additional data must be retrieved for each lookup field. This can slow query execution and impact performance, especially when working with large lists or multiple lookup columns. Leaving this property disabled reduces query overhead.Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| イニシエートOAuth[InitiateOAuth] |
OAuth は、アプリケーションがHTTP サービス上のユーザーアカウントに限定的にアクセスすることを可能にする認可フレームワークです。OAuth フローは、以下の用途で使用される方法を定義します。
OAuth アクセスの開始と維持のオプションは、本製品 が処理するフローの部分に基づいて命名されています。
Default Value: OFF Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos KDC[KerberosKDC] |
Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。 本製品 は、Kerberos KDC サービス(通常はドメインコントローラーと同じ場所にあります)にセッションチケットと一時的なセッションキーを要求します。 Note: Windows 認証は、JRE 1.6 以上でのみサポートされます。 KerberosKDC が指定されていない場合、本製品 は以下の場所から自動的にプロパティを検出しようとします。
Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。 本製品 は、Kerberos KDC サービス(通常はドメインコントローラーと同じ場所にあります)にセッションチケットと一時的なセッションキーを要求します。 Note: Windows 認証は、JRE 1.6 以上でのみサポートされます。 KerberosKDC が指定されていない場合、本製品 は以下の場所から自動的にプロパティを検出しようとします。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos Keytab File[KerberosKeytabFile] |
keytab(“key table” の略)は、1つ以上のプリンシパルの長期キーを格納します。 ほとんどの場合、エンドユーザーはクライアントシークレット(パスワード)を使用してKDCに 認証します。 ただし、自動化されたスクリプトやアプリケーションで認証や再認証が行われる場合、keytab を使用する方が効率的です。keytab はパスワードを暗号化された形式で自動的にKDC に送信します。 Keytab は通常、標準形式のファイルで表現され、type:value の形式で命名されます。 通常、type はFILE で、value はファイルの絶対パス名です。 type のもう一つの可能な値はMEMORY で、これは現在のプロセスのメモリに格納された一時的なkeytab を示します。 keytab には1つ以上のエントリが含まれ、各エントリはタイムスタンプ(エントリがkeytab に書き込まれた時刻を示す)、プリンシパル名、キーバージョン番号、暗号化タイプ、および暗号化キー自体で構成されます。 これらはkutil を使用して生成できます。 例:
[admin@myhost]# ktutil ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes256-cts-hmac-sha1-96 Password for starlord/myhost.galaxy.com: ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e aes128-cts-hmac-sha1-96 Password for starlord/myhost.galaxy.com: ktutil: addent -password -p starlord/myhost.galaxy.com@GALAXY.COM -k 1 -e des3-cbc-sha1 Password for starlord/myhost.galaxy.com: ktutil: wkt /path/to/starlord.keytab Note: サポートしたいすべての認証方法(暗号化タイプ)に対してプリンシパルを作成する必要があります。 keytab を表示するには、klist -k を使用します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos Realm[KerberosRealm] |
レルムとは、ドメインに似た論理的なネットワークで、同じマスターKDC の下にあるシステムのグループを定義します。一部のレルムは階層構造を持ち、一方のレルムが他方の上位集合となることもありますが、通常は非階層型(「直接型」)であり、2つのレルム間のマッピングを定義する必要があります。 Kerberos のクロスレルム認証により、異なるレルム間での認証が可能になります。各レルムは、相手レルムのプリンシパル情報を自レルムのKDC に登録しておく必要があります。 Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。 本製品 は、Kerberos KDC サービス(通常はドメインコントローラーと同じ場所にあります)にセッションチケットと一時的なセッションキーを要求します。 Kerberos レルムは、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。 Kerberos レルムが指定されていない場合、本製品 は、これらのプロパティを自動的に次の場所から検出しようとします。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos Service KDC[KerberosServiceKDC] |
KerberosServiceKDC は、クロスレルムKerberos 認証を使用する際にサービスKerberos KDC を指定するために使われます。 ほとんどの場合、Kerberos 認証の実行には単一のレルムとKDC マシンが使用されるため、このプロパティは必要ありません。ただし、認証チケット(AS リクエスト)とサービスチケット(TGS リクエスト)の取得に異なるレルムとKDC マシンが使用される複雑なセットアップではこのプロパティを使用できます。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos Service Realm[KerberosServiceRealm] |
KerberosServiceRealm は、クロスレルムKerberos 認証を使用する際にサービスのKerberosRealm を指定するために使われます。 ほとんどの場合、Kerberos 認証の実行には単一のレルムとKDC マシンが使用されるため、このプロパティは必要ありません。ただし、認証チケット(AS リクエスト)とサービスチケット(TGS リクエスト)の取得に異なるレルムとKDC マシンが使用される複雑なセットアップではこのプロパティを使用できます。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos SPN[KerberosSPN] |
Kerberos ドメインコントローラー上のSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN をKDC のURL に設定します。 Kerberos ドメインコントローラー上のSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN をKDC のURL に設定します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos Ticket Cache[KerberosTicketCache] |
MIT Kerberos Ticket Manager またはkinit コマンドを使用して作成された認証情報キャッシュファイルを使用する場合は、このプロパティを設定します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Kerberos User[KerberosUser] |
Kerberos プリンシパルが存在する場合、データベースへの認証には常にそのKerberos プリンシパル名を使用する必要があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Location[Location] |
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。 Note: 本製品 は複数のスキーマをサポートするため、Microsoft SharePoint のカスタムスキーマファイルは以下のような構造にになります。
Location は常に親フォルダに設定されるべきで、個々のスキーマのフォルダに設定すべきではありません。 指定しない場合、デフォルトの場所は%APPDATA%\\CData\\SharePoint Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
Default Value: %APPDATA%\\CData\\SharePoint Data Provider\\Schema | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Logfile[Logfile] |
このプロパティは、認証イベント、クエリ実行、接続の詳細など、本製品 の操作を記録するログファイルの場所と名前を指定します。 指定されたファイルが存在しない場合、本製品 はそのファイルを作成します。本製品 を実行しているユーザーまたはサービスが、指定されたパスまたはファイルへの書き込み権限を持っていることを確認してください。 適切な権限がない場合、ログファイルは作成されません。 パスワードやトークンなどの接続文字列の機密情報は、ログで自動的にマスキングされます。 ただし、データ自体に含まれる機密情報はマスキングされない可能性があります。 Logfile に相対パスを指定し、Location プロパティが設定されている場合、そのディレクトリがログファイルのベースパスとして使用されます。 追加プロパティにより、ログの動作をカスタマイズできます。
Java のログ出力Java のログ出力をサポートするには、Logfile プロパティを次のように設定します:Logfile=JAVALOG://myloggername ここで、JAVALOG:// は必須のプレフィックスで、myloggername はロガーの名前です。 Logfile プロパティが適切に設定されると、指定されたロガーのgetLogger メソッドが呼び出され、指定された値を使用してLogger インスタンスが作成されます。ログ出力インスタンスがすでに存在する場合、この呼び出しは既存のインスタンスを参照します。 Java のログ出力が有効になっている場合、Verbosity は自動的に特定のログレベルに対応します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Log Modules[LogModules] |
本製品 は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。 ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の 本製品 の操作がどのモジュールに属するかを示すラベルとして使用されます。 この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META; デフォルトでは、すべてのモジュールの操作がログに含まれます。 モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、本製品 は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。 使用可能なモジュールとサブモジュールは次のとおりです。
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Max Log File Count[MaxLogFileCount] |
各ログファイル名には、識別しやすいように日付と時刻が含まれています。 このプロパティには以下の値を指定できます。
ログファイルのサイズを管理するには、MaxLogFileSize プロパティを使用します。これらの2つのプロパティは、ログフォルダ内のログファイルのサイズと保持を制御するために連携して動作します。 Default Value: -1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Max Log File Size[MaxLogFileSize] |
100 KB より小さい値の場合、本製品 は100 KB を最小許容サイズとして使用します。 保持されるログファイルの総数を制御するには、このプロパティとMaxLogFileCount プロパティを組み合わせて使用します。 これらのプロパティを組み合わせることで、ログファイルのサイズと保持を効果的に管理できます。 Default Value: 100MB | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Max Rows[MaxRows] |
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。) MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。 このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。 Default Value: -1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuthアクセストークン[OAuthAccessToken] |
OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。 これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。 このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。 OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。 タイムアウトは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。 InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 本製品 は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。 OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、本製品 はトークンを直ちにリフレッシュします。 Note:アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuthクライアントID[OAuthClientId] |
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでに本製品 によって設定されており、手動で入力する必要がないことがあります。) OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。 OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。 クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuthクライアントシークレット[OAuthClientSecret] |
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。 クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。 OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。 Notes:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth Expires In[OAuthExpiresIn] |
OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。 サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthExpiresIn は、トークンが作成されてから有効である秒数です。例えば、2024-01-29 20:00:00 UTC に生成され、2024-01-29 21:00:00 UTC(1時間後)に期限切れとなるトークンは、現在の時刻に関係なくOAuthExpiresIn の値は3600です。 ユーザーがアクセストークンの有効期限が切れるまでの時間を確認するには、OAuthTokenTimestamp をチェックします。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth JWT Cert[OAuthJWTCert] |
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword を使用してパスワードを指定します。 OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値が設定され、かつOAuthJWTCertSubject が設定されている場合、CData JDBC Driver for Microsoft SharePoint 2026J は証明書の検索を開始します。 詳しくは、OAuthJWTCertSubject を参照してください。 証明書ストアの指定はプラットフォームに依存します。 注記
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth JWT Cert Password[OAuthJWTCertPassword] |
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth JWT Cert Type[OAuthJWTCertType] |
Default Value: USER Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth JWT Issuer[OAuthJWTIssuer] |
Java Web Token の発行者。 ほとんどの場合、これはOAuth App Id(クライアントId)接続プロパティの値を使用するため、個別に設定する必要はありません。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth Refresh Token[OAuthRefreshToken] |
現在のアクセストークンが期限切れになったときに、新しいアクセストークンを取得するためにリフレッシュトークンが使用されます。 これにより、ユーザーが再度ログインすることなく、長時間実行されるワークフローや自動化された処理において、シームレスな認証が可能になります。 このプロパティは、対話型の認証ができないヘッドレス環境、CI/CD、またはサーバーベースの環境において特に重要です。 リフレッシュトークンは通常、初回のOAuth 交換時にGetOAuthAccessToken ストアドプロシージャを呼び出すことで取得されます。 その後、このプロパティを使用してトークンの自動更新を有効にするか、手動で更新を管理したい場合はRefreshOAuthAccessToken ストアドプロシージャに渡すことができます。 InitiateOAuth がREFRESH に設定されている場合、ドライバーはこのトークンを使用して、新しいアクセストークンを自動的に取得します。 最初のリフレッシュの後、ドライバーは更新されたトークンをOAuthSettingsLocation によって定義された場所に保存し、その後の接続ではその値を使用します。 Note:OAuthRefreshToken は安全に取り扱い、信頼できる場所に保管する必要があります。 アクセストークンと同様に、リフレッシュトークンもID プロバイダーのポリシーによって、有効期限が切れたり、取り消されたりする場合があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth設定場所[OAuthSettingsLocation] |
OAuth 設定を中心的な場所に保管することで、ユーザーがログインするたびにOAuth 接続プロパティを手動で入力する必要がなくなります。また、資格情報を接続やプロセス間で共有することもできます。 以下のいずれかの方法でOAuth の値をセントラルファイルに保存し、その値へのアクセスを共有できます。
以下のセクションでは、それぞれの方法について詳しく説明します。
OAuthSettingsLocation ファイルパスの指定デフォルトのOAuth 設定の場所は%APPDATA%\\CData\\SharePoint Data Provider\\OAuthSettings.txt となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます。 デフォルト値は、ユーザーのオペレーティングシステムによって異なります。
メモリストレージ経由での資格情報のロードメモリの場所は、memory:// で始まる値とそのクレデンシャルのセット(例:memory://user1)の一意の識別子を使用して指定します。識別子は任意のものを選択できますが、ユーザーごとに一意である必要があります。資格情報が接続間で永続化されるファイルベースのストレージとは異なり、メモリストレージは資格情報を静的メモリにロードし、資格情報はプロセスが継続している間は同じ識別子を使用して接続間で共有されます。そのプロセス外で資格情報を永続化するには、接続を閉じる前に資格情報を手動で保存する必要があります。これにより、プロセスが再開されたときに接続にそれらを設定することができます。 OAuth プロパティの値を取得するには、sys_connection_props システムテーブルをクエリします。複数の接続で同じ資格情報を使用している場合は、プロパティは最後に閉じた接続から読み取られます。 サポートされるストレージの種類
Default Value: %APPDATA%\\CData\\SharePoint Data Provider\\OAuthSettings.txt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth Token Timestamp[OAuthTokenTimestamp] |
OAuth アクセストークンは認証済みのユーザーに割り当てられ、そのユーザーに指定された期間のネットワークへのアクセスを許可します。アクセストークンはユーザーのログインID とパスワードの代わりに使用され、サーバーに保持されます。 サーバーによって作成されたアクセストークンは、限定された時間のみ有効です。OAuthTokenTimestamp は、サーバーがトークンを作成した時のUnix タイムスタンプです。例えば、OAuthTokenTimestamp=1706558400 は、OAuthAccessToken がサーバーによって2024-01-29 20:00:00 UTC に生成されたことを示します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| OAuth Verifier[OAuthVerifier] |
OAuthVerifier 値の取得方法の詳細については、 を参照してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Offline[Offline] |
この接続プロパティががTrue に設定されている場合、すべてのクエリは、ライブMicrosoft SharePoint データではなくキャッシュデータベースに対して実行されます。 このモードでは、INSERT、UPDATE、DELETE、CACHE などの一部のSQL 操作が無効になります。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Other[Other] |
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。 Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
キャッシュの設定
統合およびフォーマット
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pagesize[Pagesize] |
クエリを処理する際、Microsoft SharePoint でクエリされたデータすべてを一度にリクエストする代わりに、本製品 はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。 この接続プロパティは、本製品 がページごとにリクエストする結果の最大数を決定します。 Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時に本製品 がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。 Default Value: 1000 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| パスワード[Password] |
Password プロパティはUser プロパティと共に使用され、サーバーに対して認証を行います。 パスワードは、Microsoft SharePoint に設定されたユーザーアカウントまたは関連するID プロバイダーに関連付けられた資格情報と一致している必要があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pool Idle Timeout[PoolIdleTimeout] |
接続プーリングは、リクエストごとに新しい接続を作成するのではなく、確立されたデータベース接続を再利用するメカニズムです。 これにより、頻繁な接続作成に伴うオーバーヘッドを削減し、パフォーマンスが向上します。 PoolIdleTimeout は、使用されていない接続を閉じてリソースを管理するのに役立ち、アイドル接続を維持することによる潜在的なオーバーヘッドを削減します。 値を小さくするとアイドル状態の接続を迅速にクリーンアップできます。一方、値を大きくすると接続を長く開いておけるため、再接続が頻繁に発生するシナリオではパフォーマンスが向上する可能性があります。 Default Value: 60 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pool Max Size[PoolMaxSize] |
PoolMaxSize は、接続プールで維持できるアクティブな接続の最大数を定義します。 上限に達すると、新しい接続リクエストは既存の接続がプールに戻されるのを待つ必要があります。 このプロパティは、リソースの使用率を最適化し、アプリケーションがサーバーやネットワークの制限を超えないようにするのに役立ちます。 プーリングを無効にするには、PoolMaxSize を0 または負の値に設定します。 Note:プーリングを無効にすると接続の管理を簡素化できますが、トラフィックが多いシナリオではパフォーマンスが低下する可能性があります。 Default Value: 100 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pool Min Size[PoolMinSize] |
PoolMinSize は、少なくとも1つ(デフォルト)の接続が常に接続プールで利用可能であることを確実にします。 これにより、指定された数の接続が事前に初期化され、すぐに使用できるようになり、レイテンシの短縮に役立ちます。 より大きな値を設定することで、一貫したトラフィックがある環境でのパフォーマンスを向上させることができますが、リソースの使用量が増加する可能性があります。 値を小さくすると、非アクティブ時にプールがすべての接続を解放し、リソースの消費を抑えることができます。 Default Value: 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pool Wait Time[PoolWaitTime] |
このプロパティは、新しい接続リクエストがプールの利用可能な接続を待機する時間を制御します。デフォルト値は60秒で、接続リクエストが無期限に待機しないようにします。 Note: トラフィックが多い環境やプールサイズが限られている場合、この値を大きくすることで接続が利用可能になるまでの時間を延ばすことができますが、失敗したリクエストのエラー処理が遅れる可能性があります。 Default Value: 60 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Auth Scheme[ProxyAuthScheme] |
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。 SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。 Default Value: BASIC Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Auto Detect[ProxyAutoDetect] |
この接続プロパティをTrue に設定すると、本製品 は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。 この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するために本製品 を構成する場合は、ProxyAutoDetect をFalse に設定します。
このプロパティがTrue に設定されている場合、使用するプロキシはこれらの場所をこの順番でチェックして決定されます。ある場所でプロキシが決定できない場合、本製品 は次の場所をチェックします。
これらの設定は、マシンの現在のユーザーにのみ適用されることに注意してください。アプリケーションをサービスとして実行している場合、本製品 はユーザー設定を読み込みません。代わりに、本製品 の接続プロパティでプロキシ設定を手動で行う必要があります。 HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Exceptions[ProxyExceptions] |
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。 Note:本製品 はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Password[ProxyPassword] |
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。 ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。 Note:本製品 は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Port[ProxyPort] |
ProxyAutoDetect がFalse に設定されている場合、本製品 はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。 その他のプロキシタイプについては、FirewallType を参照してください。 Default Value: 80 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy Server[ProxyServer] |
ProxyAutoDetect がFalse に設定されている場合、本製品 はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy SSL Type[ProxySSLType] |
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
Default Value: AUTO Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Proxy User[ProxyUser] |
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。 ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
Note:本製品 は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、本製品 は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Pseudo Columns[PseudoColumns] |
このプロパティを使用すると、本製品 がテーブルカラムとして公開する擬似カラムを定義できます。 個々の擬似カラムを指定するには、以下の形式を使用します。 Table1=Column1;Table1=Column2;Table2=Column3 すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください: *=* | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Readonly[Readonly] |
True に設定すると、本製品 はSELECT クエリのみを許可します。INSERT、UPDATE、DELETE、またはストアドプロシージャのクエリを実行しようとすると、失敗してエラーメッセージが表示されます。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Resolve Calculated Types[ResolveCalculatedTypes] |
True に設定した場合、本製品 は計算式の結果型(数値、通貨、日時、はい / いいえなど)を読み取り、その結果型を最も近いネイティブSQL 型にマッピングすることで、各計算列のデータ型を自動的に決定します。 False(デフォルト)に設定した場合、数式の結果型に関係なく、すべての計算列は文字列として扱われます。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| RTK[RTK] |
ほとんどの構成で標準的なライセンス機構をサポートしているため、通常はこのプロパティは不要です。 このランタイムキーは、OEM ライセンスを購入した場合にのみ使用できます。このプロパティの設定方法については、同梱のライセンスドキュメントを参照してください。 Warning: このプロパティの値は既存のすべてのライセンス情報よりも優先されます。ライセンスエラーを避けるため、提供されたランタイムキーが正しいことを確認してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| スキーマ[Schema] |
Schema プロパティは、本製品 がデータの取得と管理にどのMicrosoft SharePoint API を使用するかを決定します。利用可能なオプションは、設定されたSharePointEdition に依存します。
Default Value: REST Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Scope[Scope] |
この接続プロパティは、Microsoft SharePoint への認証時にOAuth フローで要求されるアクセス許可のセットを決定します。このプロパティが指定されていない場合、本製品 は自動的に.default をスコープとして使用します。 このプロパティの有効なオプションは以下のとおりです。
このプロパティは、OAuth フロー中に本製品 が要求するアクセスレベルを制御し、返されるトークンが目的の操作に適したアクセス許可を持つようにするために役立ちます。 追加情報AllSites.Manage などのより許容範囲が広いスコープを選択すると、リストへのフルアクセスや作成機能が可能になり操作が簡素化されますが、セキュリティ上の懸念が生じる可能性があります。 スコープを読み取りまたは書き込みに制限することで、潜在的な露出を減らすことができますが、特定の操作には再認証やスコープの変更が必要になる場合があります。 .default を使用すると、本製品 が事前承認されたアプリケーションのアクセス許可に依存できるため、認証を効率化できますが、適切なAzure アプリケーションの構成が必要です。 Default Value: .default Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Share Pointエディション[SharePointEdition] |
SharePointEdition プロパティは、本製品 が接続する環境の種類を決定します。利用可能なオプションは以下のとおりです。
追加情報正しいエディションを選択することで、適切なAPI 処理を確実に行い、認証の失敗や予期しないエラーを回避できます。 誤った設定を使用すると、プロバイダーが互換性のないエンドポイントやプロトコルを使用しようとするため、接続に問題が生じたり、再試行回数が増えたりする可能性があります。 Default Value: SharePoint Online Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Show Hidden Columns[ShowHiddenColumns] |
The ShowHiddenColumns property determines whether hidden columns in Microsoft SharePoint lists or libraries are displayed in metadata and query results. When set to true, hidden columns are included, allowing access to fields that are not visible by default in the Microsoft SharePoint UI. When set to false, hidden columns are excluded from the column listing. This property applies to both the SOAP and REST schemas and is useful for advanced querying scenarios where hidden metadata fields or internal columns need to be accessed or analyzed. Performance ConsiderationsIncluding hidden columns may increase result set size and metadata processing time, especially for lists with many internal or system fields. Excluding hidden columns can improve performance and simplify result sets, reducing unnecessary overhead in most use cases. Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Show Predefined Columns[ShowPredefinedColumns] |
The ShowPredefinedColumns property determines whether predefined columns, those derived from a base type, are included in the metadata and query results. Predefined columns are typically system fields, such as CreatedBy, Author, and Modified, but can also include common columns like Title. When set to true, these columns are included in the column listing. When set to false, all columns derived from a base type are removed from the column listing, resulting in a cleaner, more focused set of fields. This property applies to both the SOAP and REST schemas and is useful for simplifying metadata and query output by excluding default system columns when they are not needed. Performance ConsiderationsExcluding predefined columns can reduce metadata size and simplify query results, which may improve performance and readability, especially in environments with large tables and many system-defined fields. Including them provides access to additional metadata, but can increase result set complexity. Default Value: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Show Version Views[ShowVersionViews] |
The ShowVersionViews property determines whether the 本製品 includes version views for Microsoft SharePoint lists during metadata discovery. When set to true, version views are included, and versioned lists appear as additional views in the metadata, typically with names like ListName_Versions. When set to false, these version views are excluded from the metadata listing. This property applies only to the SOAP schema and is useful for accessing historical versions of list items when versioning is enabled. Performance ConsiderationsIncluding version views may increase metadata discovery time and the number of views returned, particularly in environments with many versioned lists. Excluding version views helps streamline metadata loading and reduces complexity when version history is not required. Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSL Client Cert[SSLClientCert] |
このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。 証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY(個人証明書)などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。 Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSL Client Cert Password[SSLClientCertPassword] |
このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。 証明書ストアの種類がパスワードを必要としない場合(Windows のUSER やMACHINE など)、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSL Client Cert Subject[SSLClientCertSubject] |
このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。本製品 は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、本製品 はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。 サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。
Note: フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例:CN="Example, Inc.", C=US。 Default Value: * | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSL Client Cert Type[SSLClientCertType] |
このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。
Default Value: USER Possible Values:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSL Server Cert[SSLServerCert] |
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。 このプロパティは、次のフォームを取ります:
証明書は、システムのトラストストアに基づいてマシンによって信頼されていると検証されています。使用されるトラストストアは、システムに指定された'javax.net.ssl.trustStore' 値になります。このプロパティに値が指定されていない場合は、Java のデフォルトのトラストストア(例えば、JAVA_HOME\lib\security\cacerts)が使用されます。 Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSO Domain[SSODomain] |
SSODomain プロパティは、シングルサインオン(SSO)経由で認証を行い、ユーザーのログイン資格情報のドメイン(例えば、user@mydomain.com)がSSO サービスで構成されたドメイン(例えば、user@myssodomain.com)と異なる場合に使用されます。 このプロパティは、AuthScheme プロパティがADFS、OneLogin、Okta などのSSO 認証スキームに設定されている場合にのみ適用されます。 このプロパティは、ユーザー資格情報とSSO サービスドメインが一致しない場合に、適切な認証ルーティングを確保するために役立ちます。 追加情報正しいSSO ドメインを指定することで、認証の失敗や不要な再試行を回避し、接続確立時間を改善できます。 必要な場合にこのプロパティを未設定のままにしておくと、ログインに何度も失敗したり、認証処理が遅くなったりする可能性があります。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSO Login URL[SSOLoginURL] |
ID プロバイダーのログインURL。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SSO Properties[SSOProperties] |
ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。 SSOLoginURL と一緒に使用します。 SSO 設定については、 で詳しく説明します。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| State[State] |
追加のOAuth ステート情報を表すオプションの値。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| STSURL[STSURL] |
The STSURL property defines the endpoint of the security token service (STS) used during SSO authentication. In most cases, the 本製品 automatically determines the correct STS URL, and this property does not need to be set. This property may only be necessary in advanced or custom SSO configurations where the default discovery process does not resolve the correct STS endpoint. This property is useful for troubleshooting or custom setups where the security token service URL must be specified manually to complete the authentication flow. Additional InformationManually specifying this property can prevent authentication delays when automatic discovery fails or points to an incorrect endpoint. However, incorrect configuration of this property can lead to failed authentication attempts and slow connection setup. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Table List Types[TableListTypes] |
Enter a comma-separated list of template identifiers. You can use either the numeric value or the string representation of the template (e.g., "GenericList,101,Tasks,106"). If your list uses a custom template or a template not shown below, simply enter its numeric value in the property. When specified, only lists matching these templates are exposed as tables. Common Template Values
See this page in Microsoft's documentation for the full list of SharePoint template IDs. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Tables[Tables] |
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。 利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。 Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| タイムアウト(秒)[Timeout] |
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。 タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。 タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。 Default Value: 60 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| URL[URL] |
URL プロパティは、本製品 が接続するMicrosoft SharePoint サイトのベースエンドポイントを定義します。これには、リストやライブラリの取得、テーブルに対するCRUD 操作の実行、ストアドプロシージャの実行などが含まれます。これらはすべて、URL で定義されたサイトに関連します。有効な値の例としては、以下のようなものがあります。
末尾のスラッシュは任意です。URL が、本製品 がクエリや操作に使用するルートサイトまたはサイトコレクションを指していることを確認してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use Connection Pooling[UseConnectionPooling] |
UseConnectionPooling は、頻繁な接続作成に関連するオーバーヘッドを削減し、接続の使用率が高いアプリケーションのパフォーマンスを向上させます。 接続プーリングが有効な場合、アプリケーションは各接続が不要になったら明示的に閉じる必要があります。 接続を閉じると、物理的に終了するのではなく、再利用できるようにプールに戻ります。 接続がPoolIdleTimeout 時間を超えてアイドル状態になると、本製品 は自動的に接続を閉じてリソースを解放します。 接続プールはデフォルトで無効ですが、PoolMaxSize、PoolIdleTimeout、PoolWaitTime などの追加プロパティを使用して、接続プールの動作をカスタマイズできます。これらのプロパティにより、プールサイズ、アイドル接続タイムアウト、および接続が利用可能になるまでの待機時間を細かく調整できます。 接続プールの使用については、接続プール を参照してください。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use Display Names[UseDisplayNames] |
The UseDisplayNames property determines how column names are presented in metadata and query results. When set to true, the 本製品 uses the display names shown in the Microsoft SharePoint UI, making queries and results more user-friendly and readable. When set to false, the 本製品 uses the internal API names for columns, which may be less descriptive but more consistent for programmatic use. This property applies to both the SOAP and REST schemas and is useful for aligning result sets with familiar column labels seen in the Microsoft SharePoint interface or for simplifying integration with external applications that rely on known display names. Additional InformationUsing display names can improve readability, but may introduce slight overhead during metadata retrieval, as display names must be resolved and mapped from API names. Using API names can streamline metadata processing and reduce complexity in environments where consistent field naming is preferred. Default Value: true | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use Entity Type Name[UseEntityTypeName] |
UseEntityTypeName プロパティは、メタデータの取得時に 本製品 が Microsoft SharePoint リストの EntityTypeName をテーブル名として使用するかどうかを決定します。 true に設定すると、本製品 はリストの EntityTypeName をテーブル名として使用します。これにより、テーブルに対してより一貫性のある API フレンドリーな名前を付けることができます。 false に設定すると、本製品 はリストの Title フィールドをテーブル名として使用します。この場合、Microsoft SharePoint の UI に表示される名前と一致します。 このプロパティは REST スキーマにのみ適用されます。リストのタイトルが変更される可能性がある環境で、クエリや統合において一貫性のある安定した名前付けを保証するのに役立ちます。 補足情報EntityTypeName を使用すると、リストのタイトル編集によるテーブル名の変更を回避できるため、クエリや統合の長期的な安定性が向上します。 ただし、表示名の方がエンドユーザーにとってより直感的な場合があります。両者を切り替える際は、クエリの更新やメタデータの再取得が必要になることがあります。 Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use NTLMV1[UseNTLMV1] |
This property determines which version of the NTLM authentication protocol the 本製品 uses when connecting. When set to true, the 本製品 attempts to connect using NTLMv1, an older and less secure version of the protocol. When set to false, the 本製品 uses NTLMv2, which is more secure and recommended for all environments. This property is useful for compatibility with legacy systems that only support NTLMv1, though its use is discouraged in modern deployments. Performance ConsiderationsUsing NTLMv1 may expose connections to security vulnerabilities and is generally slower and less efficient than NTLMv2. NTLMv2 provides stronger authentication and improved performance. Only enable NTLMv1 when required for compatibility with older servers. Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ユーザー[User] |
User プロパティはPassword プロパティと共に使用され、Microsoft SharePoint サーバーに対して認証を行います。 Microsoft SharePoint オンプレミスの場合、ユーザー名には次の形式でドメインを含める必要があります:DOMAIN\Username Microsoft SharePoint オンラインの場合、ユーザー名は通常次のような形式となります:username@domain.onmicrosoft.com | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| User Defined Views[UserDefinedViews] |
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューは本製品 によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。 次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Calendar WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、本製品 はそのビューだけを参照します。 詳しくは、ユーザー定義ビュー を参照してください。 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Use Simple Names[UseSimpleNames] |
Microsoft SharePoint テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、本製品 を従来のデータベースツールでより簡単に使用できるようになります。 UseSimpleNames をTrue に設定すると、返されるカラム名をシンプルにします。 表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 Notes:
Default Value: false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Verbosity[Verbosity] |
このプロパティは、本製品 がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。 デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。 LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。 Default Value: 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Views[Views] |
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。 利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。 Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。 |
SQLパラメーターの基本的な概念はSharePointGetコンポーネントで使用するSQLパラメーターと同じですが、以下の点が異なります。