AdomdConnection.ConnectionString Property
AdomdConnection が分析データ ソースを開くために使用する string を取得します。値の設定も可能です。
名前空間: Microsoft.AnalysisServices.AdomdClient
アセンブリ: Microsoft.AnalysisServices.AdomdClient (microsoft.analysisservices.adomdclient.dll 内)
構文
'宣言
Public Property ConnectionString As String
public string ConnectionString { get; set; }
public:
virtual property String^ ConnectionString {
String^ get () sealed;
void set (String^ value) sealed;
}
/** @property */
public final String get_ConnectionString ()
/** @property */
public final void set_ConnectionString (String value)
public final function get ConnectionString () : String
public final function set ConnectionString (value : String)
プロパティ値
AdomdConnection によって使用される接続文字列を含む string です。
解説
ConnectionString プロパティは、OLE DB 接続文字列の形式にできる限り近づけて作られています。ConnectionString プロパティを使用すると、XML for Analysis 1.1 仕様をサポートする分析データ ソースに接続できます。
接続文字列の値の多くに、対応する読み取り専用プロパティがあります。接続文字列が設定されると、エラーが検出されない限り、これらのプロパティがすべて更新されます。エラーが検出された場合は、プロパティは一切更新されません。
閉じている接続の ConnectionString プロパティをリセットすると、接続文字列の値 (および関連するプロパティ) が、パスワードも含めてすべてリセットされます。たとえば、Catalog= Adventure Works DW
という文字列を含む接続文字列を設定した後、接続文字列を DataSource=localhost;Password=MyPassword
にリセットしたとします。その場合、Adventure Works DW データベースに接続するための設定が、Database プロパティから失われます (接続文字列の Catalog の設定は Database プロパティに対応します)。
このプロパティが設定されていると、接続文字列の予備検証が実行されます。アプリケーションで Open メソッドが呼び出されると、接続文字列が解析されて、個々のプロパティがサポートのレベルに基づいて評価されます。接続文字列で指定されているプロパティが AdomdConnection で直接サポートされている場合は、そのプロパティの値が検証されます。無効な値やサポートされていない値が指定されていた場合は、例外がスローされます。AdomdConnection で直接サポートされてはいないが、有効な XML 要素を作成するために使用できるプロパティについては、値と共に、基になるプロバイダに直接渡されます。そのようなプロパティに無効な値やサポートされていない値が含まれていた場合は、その時に例外がスローされます。
値は一重または二重の引用符で区切ることができます (例: name='value'
または name="value"
)。区切り文字として使用しない方の引用符は、接続文字列の中で使用できます (例: name="value's"
または name= 'value"s'
。name='value's'
や name= ""value""
は不可)。空白文字は、値に含まれている場合や引用符で囲まれている場合を除いてすべて無視されます。キーワードと値の組み合わせは、セミコロン (;) で区切る必要があります。セミコロンが値の一部である場合は、セミコロンも引用符で区切る必要があります。エスケープ シーケンスは一切サポートされていません。値の型は関係ありません。名前の大文字と小文字は区別されません。接続文字列の中に同じプロパティ名が複数含まれている場合は、最後の箇所で関連付けられた値が使用されます。
メモ : |
---|
アプリケーションでユーザー入力に基づいて接続文字列を作成する場合 (ユーザー ID とパスワードの情報をダイアログ ボックスから取得して接続文字列に追加する場合など) は、注意が必要です。そのようなアプリケーションでは、ユーザーがそれらの値に余分な接続文字列パラメータを埋め込むことができないようにする必要があります (たとえば、パスワードを validpassword;database=somedb として入力して別のデータベースに接続しようとする場合などが考えられます)。 |
次の表は、AdomdConnection で直接サポートされている接続文字列設定を示しています。この他に、プロバイダ固有の接続文字列設定もありますが、ここには含まれていません。
設定名
設定の別名
説明
Timeout
なし
AdomdConnection がコマンドの実行を待機する時間を設定します。この時間内にコマンドを実行できなかった場合は、コマンドの実行が中止されてエラーが生成されます。
Connect Timeout
なし
接続の確立を待機する時間を設定します。この時間内に接続を確立できなかった場合、AdomdConnection は接続を中止してエラーを生成します。
Data Source
DataSourceLocation
AdomdConnection が接続を確立するインスタンスまたはローカル キューブ (.cub) ファイルを設定します。
UserName
Authenticated User
UID
User ID
AdomdConnection が接続を確立するために使用するユーザー ID またはユーザー名を設定します。
メモ :
Authenticated User は現在サポートされません。
Password
PWD
指定したユーザー名で接続を確立するために AdomdConnection が使用するパスワードを設定します。
Catalog
Initial Catalog
Database
AdomdConnection が接続を確立するデータベースを設定します。
ProtectionLevel
なし
プロバイダが接続の署名や暗号化に使用する保護のレベルを設定します。この設定には、次のオプションがあります。
NONE サーバーに送信されるデータの認証は行われません。
CONNECT クライアントがサーバーとの接続を確立するときにのみ認証が行われます。
PKT INTEGRITY すべてのデータが正しいクライアントから受信されていること、および転送中に変更されていないことが確認されます。
PKT PRIVACY データの暗号化が行われ、データが正しいクライアントから受信されていること、および転送中に変更されていないことが確認されます。
Safety Options
なし
ユーザー定義関数とユーザー定義アクションのセキュリティの処理方法を決定するために使用される安全性のレベルを設定します。
AutoSyncPeriod
なし
オブジェクトが自動的にサーバーと同期するまでの時間をミリ秒単位で設定します。
ConnectTo
なし
AdomdConnection がサーバーへの接続に使用する方法を設定します。8.0 に設定すると、インプロセスの XML for Analysis を使用してサーバーに接続します。9.0 に設定すると、XML for Analysis を使用して接続します。Default に設定すると、まず XML for Analysis を使用して接続し、接続できない場合はインプロセスの XML for Analysis を使用して接続します。
Provider
なし
データ ソースのプロバイダの名前を設定します。既定値は MSOLAP です。
DataSourceInfo
なし
データ ソースにアクセスするために必要なプロバイダ固有の情報を設定します。
Integrated Security
なし
使用するアクセス制御を設定します。SSPI に設定すると、SSPI 対応のセキュリティ パッケージがユーザー認証に使用されます。Basic に設定する場合は、UserName と Password を設定する必要があります。HTTP 接続で使用できる設定は Basic のみです。
CreateCube
なし
ローカル キューブの作成時に使用される CREATE CUBE ステートメントを設定します。
Protocol Format
なし
サーバーに送信される XML の形式を設定します。設定できる値は、Default、XML、および Binary です。
Encryption Password
なし
ローカル キューブの復号化のためのパスワードを設定します。
Impersonation Level
なし
サーバーがクライアントの権限を借用するときに使用できる権限借用レベルを設定します。設定できる値は、Anonymous、Identify、Impersonate、および Delegate です。既定値は Impersonate です。
SSPI
なし
ユーザー認証に使用するセキュリティ パッケージを設定します。設定できる値は、Negotiate、Kerberos、NTLM、および Anonymous User です。既定値は Negotiate です。
UseExistingFile
なし
既存のファイルを使用するか上書きするかを設定します。true に設定する場合は、ローカル ファイルが既に存在している必要があります。キューブが存在しない場合は作成され、存在する場合はそれが使用されます。false に設定すると、既存のローカル キューブが上書きされます。既定値は false です。
Character Encoding
なし
文字のエンコード方法を設定します。既定値は、文字列 UTF-8 です。
Use Encryption for Data
なし
クライアントとサーバーの間で暗号化を使用するかどうかを設定します。true に設定すると、クライアントとサーバーの間で送信されるすべてのデータが SSL (Secure Sockets Layer) 暗号化を使って暗号化されます (サーバーに証明書がインストールされている場合)。
Packet Size
なし
クライアントとサーバーの間のネットワーク通信のパケット サイズをバイト単位で設定します。この値は 512 ~ 32767 の間にする必要があります。既定値は 4096 です。
Extended Properties
なし
Extended Properties が含まれている接続文字列をオーバーライドする接続文字列プロパティを設定します。このプロパティはそれ自体が接続文字列であり、その接続文字列のプロパティによって、Extended Properties が含まれている接続文字列がオーバーライドされます。Extended Properties には、別の Extended Properties を含めることができます。その場合は、含まれている方の Extended Properties のプロパティが優先されます。Extended Properties の入れ子には制限はありません。
LocaleIdentifier
なし
クライアント アプリケーションの優先ロケール ID を設定します。
Location
なし
サーバーの名前を設定します。
Restricted Client
なし
クライアントに制限を適用するかどうかを設定します。true に設定すると、クライアントによるローカル キューブやローカル マイニング モデルの使用が制限されます。したがって、クライアントがローカル キューブまたはローカル マイニング モデルを使おうとすると、エラーが発生します。
Persist Security Info
なし
セキュリティ情報を保存するかどうかを設定します。true に設定すると、接続を開いた後にセキュリティ関連の情報を接続から取得できます。
SessionID
なし
接続で使用するセッション識別子を設定します。このセッション識別子が既存のセッションと一致しないと、エラーが発生します。
Transport Compression
なし
接続で通信を圧縮するかどうかを設定します。None に設定すると、圧縮は使用されません。Compressed に設定すると、パケット サイズを小さくするために通信が圧縮される可能性があります。GZIP の設定は、HTTP 接続を圧縮します。Default に設定すると、HTTP 接続で GZIP が使用され、それ以外の場合は圧縮は使用されません。
Compression Level
なし
圧縮レベルを 0 ~ 9 の範囲で設定します。この値が大きいほど圧縮率が高くなります。
SspropInitAppName
なし
この接続に関連付けるアプリケーションの名前を設定します。この値は、トレース イベントを監視する場合に便利です。
ClientProcessID
なし
この接続に関連付けるアプリケーションのプロセス ID を設定します。SspropInitAppName が設定されている場合に ClientProcessID の値が設定されていないと、クライアント オペレーティング システムから取得したプロセス ID に自動的に設定されます。この値は、トレース イベントを監視する場合に便利です。
いくつかの接続文字列設定は、AdomdConnection の対応するプロパティにマップされます。次の表は、接続文字列の設定と AdomdConnection のプロパティの対応を示します。
設定名 |
プロパティ名 |
ConnectionTimeout |
ConnectionTimeout |
Catalog |
Database |
メモ : |
---|
初期化プロパティであるプロパティは、接続を開いた後には変更できません。利用可能な初期化プロパティのセットは、IDBProperties::GetPropertyInfo によってクエリを実行できます。 |
スレッド セーフ
この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。
プラットフォーム
開発プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
対象プラットフォーム
サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。
参照
関連項目
AdomdConnection Class
AdomdConnection Members
Microsoft.AnalysisServices.AdomdClient Namespace