Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

その他の DeepSee ツールの概要

この章では、DeepSee で使用するその他のツールを紹介します。

MDX シェル

DeepSee には、MDX クエリを発行して、DeepSee キューブおよびサブジェクト領域を検索できるシェルが用意されています。このセクションでは、このシェルの概要を示し、サポートされている MDX のオプションと関数を提示します。

MDX クエリの概要は、"DeepSee での MDX の使用法" を参照してください。ここには多くの例が示されています。

"DeepSee MDX リファレンス" も参照してください。

MDX シェルへのアクセス

MDX シェルにアクセスするには、ターミナルを起動して、以下の操作を実行します。

  1. キューブまたはサブジェクト領域を定義したネームスペースに切り替えます。

  2. 以下のコマンドを入力します。

     Do ##class(%DeepSee.Utils).%Shell()

ここで以下のような MDX クエリを入力します。

SELECT MEASURES.[%COUNT] ON 0, birthd.decade.MEMBERS ON 1 FROM patients

クエリを入力すると、シェルによってクエリが実行され、以下のようにコンソールに結果が表示され、シェル・プロンプトが再表示されます。

                             Patient Count
 1 1910s                                 71
 2 1920s                                223
 3 1930s                                572
 4 1940s                                683
 5 1950s                              1,030
 6 1960s                              1,500
 7 1970s                              1,520
 8 1980s                              1,400
 9 1990s                              1,413
10 2000s                              1,433
11 2010s                                155
---------------------------------------------------------------------------
Elapsed time:       .014128s

シェルで以下の操作を行います。

  • キューブおよびサブジェクト領域のリストを表示するには、cube と入力します。

  • キューブまたはサブジェクト領域の内容を表示するには、cube name_of_cube_or_subject_area と入力します。

    Note:

    このコマンドによって、計算メンバおよび名前付きセットが表示されることはありませんが、これらの要素をシェルやその他の場所で使用することはできます。

    サブジェクト領域の場合、このコマンドによって、サブジェクト領域では非表示として指定されている要素を含む、すべての要素がリスト表示されます。

  • シェルを終了するには q を入力します。

  • クエリ・キャッシュを有効にするには、cache on と入力します。

  • 非同期モードを有効にするには、async on と入力します。

  • キューブを構築するには、build cubename と入力します。

  • クエリ・キャッシュをリセットにするには、reset と入力します。

  • その他のシェル・オプションのリストを表示するには、? と入力します。

クエリで使用されるインデックスの表示

DeepSee シェルでは、クエリで使用されるインデックスを簡単に表示できます。

  1. 以下のシェル・コマンドを発行します。

    stats on
    
  2. %SHOWPLAN に続いて、クエリを入力します。以下はその例です。

    %SHOWPLAN SELECT aged.[age group].members ON 0, allerd.H1.MEMBERS ON 1 FROM patients WHERE colord.red
     
                               0 to 29           30 to 59               60 +
     1 additive/colorin              27                 19                 14
     2 animal dander                 15                 25                  8
     3 ant bites                     15                 19                 11
     4 bee stings                    24                 27                  7
     5 dairy products                25                 25                  4
     6 dust mites                    28                 23                 10
     7 eggs                          19                 21                 13
     8 fish                          26                 17                 11
     9 mold                          23                 23                  6
    10 nil known allerg              80                 82                 21
    11 No Data Availabl             216                194                 92
    12 peanuts                       26                 15                  8
    13 pollen                        29                 22                 11
    14 shellfish                     29                 23                 14
    15 soy                           25                 25                  6
    16 tree nuts                     22                 18                  8
    17 wheat                         16                 17                  8
    -------------- Query Plan ---------------------
    **%SHOWPLAN SELECT [AGED].[AGE GROUP].MEMBERS ON 0,[ALLERD].[H1].MEMBERS ON 1 FROM [PATIENTS] WHERE [COLORD].[RED]**
    **DIMENSION QUERY (%FindMemberByName): SELECT TOP 1 %ID,Dx327553094 MKEY,Dx327553094 FROM 
    Cubes_StudyPatients.Star327553094 WHERE Dx327553094=? ORDER BY Dx327553094**
    **EXECUTE PARALLEL: 1x1 task(s) **
    **CONSOLIDATE**
    -------------- End of Plan -----------------
    

    ここでは、見やすくするために改行を追加してあります。

DeepSee では、クエリで使用されるすべてのインデックスが取得され、レポートされます。クエリは部分的に実行されているだけなので、クエリ結果が正しいとは限りません。%SHOWPLAN の目的は、インデックスを表示できるようにすることであり、クエリ結果を取得することではありません。

ユーティリティ・メソッド

  • %SYSTEM.DeepSeeOpens in a new tab クラスには、一般的に使用されるユーティリティ・メソッドが含まれています。これには、以下のものがあります。

    • BuildCube()

    • KillCube()

    • ListCubes()

    • Reset()

    • Shell()

    • SynchronizeCube()

    このクラスは、$SYSTEM 特殊変数により使用可能です。すべてのクラスが %SYSTEM パッケージに含まれているためです。例えば、キューブを構築するために、以下のように使用できます。

     Do $system.DeepSee.BuildCube("MyCube")
  • %DeepSee.UtilsOpens in a new tab クラスには、以下のものを含めて一連の多数のユーティリティ・メソッドがあります。

    • %ExportExcelToFile() — DeepSee クエリや KPI を Microsoft Excel 形式でファイルにエクスポートします。

    • %ExportPDFToFile() — DeepSee クエリや KPI を PDF 形式でファイルにエクスポートします。

    • %GetAgentCount() — 現在のエージェント数を取得します。

    • %GetBaseCube() — サブジェクト領域の基となるキューブの名前を取得します。

    • %GetCubeFactClass() — キューブに関連付けられているファクト・テーブル・クラスの名前を取得します。

    • %GetCubeLevels() — キューブで定義されているレベル、メジャー、およびリレーションシップを取得します。

    • %GetDimensionMembers() — ディメンジョンのメンバのリストを取得します。

    • %GetMetricList() — 現在のユーザに対して表示可能なすべての Ensemble ビジネス・メトリックを取得します。

    • %GetSQLTableName() — 指定されたクラスの SQL テーブル名を取得します。

    • %ProcessFact() — キューブの単一ファクトを更新します。

    • %GetMDXFromPivot() — ピボット・テーブルで定義された MDX クエリを返します。

    • %ExecutePivot() — ピボット・テーブルで定義された MDX クエリを実行して、オプションで %DeepSee.ResultSetOpens in a new tab のインスタンスを返します。

    • %GetResultsetFromPivot() — ピボット・テーブルで定義された MDX クエリを格納している %DeepSee.ResultSetOpens in a new tab のインスタンスを返して、オプションでそのクエリを実行します。

  • %DeepSee.UserLibrary.UtilsOpens in a new tab クラスには、フォルダマネージャでサポートされるタスクをプログラムで実行する場合に使用できるメソッドが含まれています。これには、以下のメソッドがあります。

    • %AddFavorite()

    • %DeleteFolderContents()

    • %DeleteFolderItem()

    • %Export()

    • %GetFolderList()

    • %ImportContainer()

データ・コネクタ

データ・コネクタ・クラス (%DeepSee.DataConnectorOpens in a new tab) を使用すると、DeepSee キューブおよびリストで任意の SQL クエリを使用できるようになります。"DeepSee 実装ガイド" を参照してください。

結果セット API

%DeepSee.ResultSetOpens in a new tab クラスを使用すると、MDX クエリをプログラムで実行し、その結果にアクセスできるようになります。

詳細は、"DeepSee 実装ガイド" を参照してください。

JavaScript API と REST API

DeepSee JavaScript API は、install-dir/CSP/broker ディレクトリにある DeepSee.js ファイルによって提供されます。この JavaScript ライブラリを使用すると、JavaScript ベースのクライアントから DeepSee を操作できます。このライブラリ内の関数は、DeepSee 用の REST ベース API のラッパです。REST API を直接使用することもできます。

詳細は、"DeepSee Web クライアントを作成するためのツール" を参照してください。

FeedbackOpens in a new tab