Invoke-ASCmd コマンドレット

[アーティクル]
05/07/2013

データベース管理者は、XMLA スクリプト、多次元式 (MDX)、またはデータマイニング拡張機能 (DMX) ステートメントを実行できます。

構文

Invoke-ASCmd –Query <string> [-Server <string>] [-Database <string>] [-Credential <PSCredential>] [-ConnectionTimeout <int>] [-QueryTimeout <int>] [-Variable <string[]>] [-TraceFile <string>] [-TraceFileFormat <TraceFileFormatOption>] [-TraceFileDelimiter <string>] [-TraceTimeout <int>] [-TraceLevel <TraceLevelOption>] [<CommonParameters>]

Invoke-ASCmd –InputFile <string> [-Server <string>] [-Database <string>] [-Credential <PSCredential>] [-ConnectionTimeout <int>] [-QueryTimeout <int>] [-Variable <string[]>] [-TraceFile <string>] [-TraceFileFormat <TraceFileFormatOption>] [-TraceFileDelimiter <string>] [-TraceTimeout <int>] [-TraceLevel <TraceLevelOption>] [<CommonParameters>]

説明

Invoke ASCmd コマンドレットは、入力ファイルに含まれるクエリまたはスクリプトを実行できます。サポートされるコマンドは、Alter、Backup、Batch、BeginTransaction、Cancel、ClearCache、CommitTransaction、Create、Delete、DesignAggregations、Drop、Insert、Lock、MergePartitions、NotifyTableChange、Process、Restore、RollbackTransaction、Statement (MDX クエリと DMX ステートメントの実行に使用)、Subscribe、Synchronize、Unlock、Update、UpdateCells です。

このコマンドレットは、HTTP アクセスに対して Analysis Services インスタンスを構成している場合に使用できる、–Credential パラメーターをサポートします。 –Credential パラメーターは、Windows のユーザー ID を提供する PSCredential オブジェクトを受け取ります。 IIS は、Analysis Services に接続する際、このユーザーの権限を借用します。スクリプトを実行するために、この ID には、Analysis Services インスタンスに対するシステム管理者権限が必要です。

パラメーター

-Query <string>

ファイル内にではなくコマンドラインから直接、実際のスクリプト、クエリ、またはステートメントを指定します。パイプライン入力としてクエリを指定することもできます。 Invoke-AsCmd を使用する場合は、–InputFile または –Query パラメーターの値を指定する必要があります。

必須/オプション	必須
位置	指定
既定値
パイプライン入力の受け入れ	可 (ByValue)
ワイルドカード文字の受け入れ	不可

-InputFile <string>

XMLA スクリプト、MDX クエリ、または DMX ステートメントが記述されているファイルを指定します。 Invoke-AsCmd を使用する場合は、–InputFile または –Query パラメーターの値を指定する必要があります。

必須/オプション	必須
位置	指定
既定値
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-Server <string>

コマンドレットが接続して実行する Analysis Services インスタンスを指定します。サーバー名が指定されていない場合は、localhost に接続されます。既定のインスタンスの場合は、サーバー名のみを指定します。名前付きインスタンスの場合は、servername \instancename 形式を使用します。 HTTP 接続では、http[s]://server[:port]/virtualdirectory/msmdpump.dll 形式を使用します。

必須/オプション	オプション
位置	指定
既定値	localhost
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-Database <string>

MDX クエリまたは DMX ステートメントの実行対象であるデータベースを指定します。 XMLA スクリプトにはデータベース名が埋め込まれているため、コマンドレットで XMLA スクリプトを実行する場合、Database パラメーターは無視されます。

必須/オプション	オプション
位置	指定
既定値
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-Credential <PSCredential>

Windows ユーザー名とパスワードを提供する PSCredential オブジェクトを指定します。基本認証を使用して、HTTP アクセスに対する Analysis Services インスタンスを構成している場合のみ、このパラメーターを指定します。統合セキュリティを使用するネイティブ接続では、このパラメーターは無視されます。

このパラメーターが存在する場合、パラメーターで提供される資格情報は接続文字列に付加されます。 IIS は、Analysis Services に接続する際、このユーザー ID を借用します。資格情報を指定していない場合は、ツールを実行しているユーザーの既定の Windows アカウントが使用されます。

このパラメーターを使用するには、最初に、Get-Credential を使用して PSCredential オブジェクトを作成し、ユーザー名とパスワードを指定します ($Cred=Get-Credential “adventure-works\admin” など)。このオブジェクトは、–Credential パラメーター (-Credential:$Cred) にパイプできます。

認証と資格情報の使用法の詳細については、「Analysis Services PowerShell」を参照してください。 HTTP アクセスの詳細については、「インターネットインフォメーションサービス (IIS) 7.0 上の Analysis Services への HTTP アクセスの構成」を参照してください。

必須/オプション	不可
位置	指定
既定値
パイプライン入力の受け入れ	可 (ByValue)
ワイルドカード文字の受け入れ	不可

-ConnectionTimeout <int>

Analysis Services インスタンスへの接続がタイムアウトするまでの秒数を指定します。タイムアウトの値には、0 ～ 65,534 の範囲の整数値を指定してください。 0 を指定した場合、接続の試行はタイムアウトしません。

必須/オプション	オプション
位置	指定
既定値	30
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-QueryTimeout <int>

クエリがタイムアウトになる時間を秒単位で指定します。タイムアウト値を指定しない場合、クエリはタイムアウトしません。タイムアウトには、1 ～ 65,535 の範囲の整数値を指定してください。

必須/オプション	オプション
位置	指定
既定値	30
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-Variable <string[]>

追加のスクリプト変数を指定します。各変数は、名前と値のペアです。スペースや制御文字が値に含まれている場合は、二重引用符で囲む必要があります。複数の変数とその値を指定するには、PowerShell 配列を使用します。

必須/オプション	オプション
位置	指定
既定値
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-TraceFile <string>

XMLA スクリプト、MDX クエリ、または DMX ステートメントを実行しているときに Analysis Services トレースイベントを受け取るファイルを指定します。ファイルが既に存在する場合は、自動的にそのファイルが上書きされます (-TraceLevel:Duration および –TraceLevel:DurationResult パラメーター設定を使用して作成されるトレースファイルは例外です)。空白を含んでいるファイル名は、引用符 (" ") で囲む必要があります。ファイル名が無効な場合は、エラーメッセージが生成されます。

必須/オプション	オプション
位置	指定
既定値
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-TraceFileFormat <string>

–TraceFile パラメーター (このパラメーターを指定している場合) のファイル形式を指定します。使用できるオプションは text または csv です。既定値は "csv" です。

必須/オプション	オプション
位置	指定
既定値	csv
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-TraceFileDelimiter <string>

トレースファイルの形式として csv を指定している場合は、どの文字をトレースファイルの区切り記号として使用するかを指定します。既定値は | (パイプ、つまり縦棒) です。

必須/オプション	オプション
位置	指定
既定値
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-TraceTimeout <int>

トレースを終了するまで Analysis Services エンジンが待機する秒数を指定します (–TraceFile パラメーターを指定している場合)。指定された秒数の間、トレースメッセージが記録されなかった場合、トレースが終了したと見なされます。トレースタイムアウトの既定値は 5 秒です。

必須/オプション	オプション
位置	指定
既定値	5
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

-TraceLevel <TraceLevelOption>

トレースファイルにどのようなデータを集めて記録するかを指定します。指定できる値は、High、Medium、Low、Duration、DurationResult です。

必須/オプション	オプション
位置	指定
既定値	High
パイプライン入力の受け入れ	不可
ワイルドカード文字の受け入れ	不可

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています (-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、「About_CommonParameters」を参照してください。

入力および出力

入力型は、コマンドレットにパイプできるオブジェクトの型です。戻り値の型は、コマンドレットが返すオブジェクトの型です。

入力	PSObject
出力	String

例 1

Invoke-ASCmd –InputFile:”C:\MyFolder\DiscoverConnections.xmla”

このコマンドは、サーバー上のアクティブな接続の一覧を返す XMLA スクリプトを実行します。 DiscoverConnections.xmla ファイルには次の XMLA スクリプトが含まれています。

<Discover xmlns="urn:schemas-microsoft-com:xml-analysis">
<RequestType>DISCOVER_CONNECTIONS</RequestType>

<Restrictions />

<Properties>

<PropertyList>

<Content>Data</Content>

</PropertyList>

</Properties>

</Discover>

例 2

Invoke-ASCmd -Database:"Adventure Works DW" -Query:"<Discover xmlns='urn:schemas-microsoft-com:xml analysis'><RequestType>DISCOVER_DATASOURCES</RequestType><Restrictions></Restrictions><Properties></Properties></Discover>"

XMLA 検出クエリは、分析サーバーで使用できるデータソースとそれらに接続するために必要な情報を返します。結果は XML 内です。読みやすくするために、出力を XML ファイルにパイプして (たとえば、| Out-file C:\Results\XMLAQueryOutput.xml をコマンドに追加する)、ブラウザーまたは構造化された XML をサポートする他のアプリケーションに結果を表示することができます。

次の方法で共有