Caché ソース・コード・ファイル REST API の概要

この REST API は、Caché のソース・コード・ファイルへのアクセスを可能にします。インターシステムズがこの API を開発した目的は、弊社の Eclipse ベース IDE である Atelier から Caché サーバ上にある Caché のクラス定義、ルーチン、および CSP ファイルにアクセス可能にするためです。この API を使用して、Caché のクラス、ルーチン、および CSP ファイルにアクセスするために必要な操作を実行できます。これらの操作としては、以下が挙げられます。

• Caché インスタンス上で使用できるネームスペースの取得

• ネームスペース内で定義されているクラス定義、ルーチン、および CSP ファイルの検索

• クラス、ルーチン、および CSP ファイルのテキスト定義の取得

• クラス定義、ルーチン、または CSP ファイルの更新

• 新しいクラス定義、ルーチン、または CSP ファイルの作成

• クラス定義、ルーチン、または CSP ファイルの削除

• Caché クラスまたはルーチンのコンパイル

• テーブルに対する SQL クエリの実行による Caché 環境のプロパティの検出

これらの操作は、Caché のソース・コード・ファイルにアクセスするためのメカニズムを提供します。Caché 開発環境を作成するためには、この API を理解して、Caché のソース・コード・ファイルが Caché 内でどのように使用されるのかを包括的に理解する必要があります。

これは特定目的用の API です。開発環境を作成する場合や、クラス・ブラウザなどの同様のアプリケーションを扱う場合は、この API が役に立つ可能性があります。ただし、これは Caché オブジェクトにアクセスするための汎用 REST API ではありません。

Atelier のダウンロードや Atelier を使用して Caché アプリケーションを開発する方法の詳細が必要な場合は、Atelier のホームページ http://www.intersystems.com/atelierOpens in a new tab を参照してください。このページには、ダウンロードの手順や Atelier のドキュメントへのリンクがあります。

このドキュメントでは、Caché ソース・コード・ファイル REST API のバージョン 1 と 2 について説明します。バージョン 1 は最初に Caché 2016.2 で提供されました。バージョン 2 は最初に Caché 2017.2 で提供されました。将来の Caché リリースでは、追加の呼び出しを提供する、この REST API の上位バージョンがサポートされる可能性がありますが、常に旧バージョンを呼び出すことができます。バージョン 1 の API では URL に /v1/ が、バージョン 2 の API では /v2/ が含まれています。Caché で提供されているこの API のバージョンを確認するには、GetServer メソッドを呼び出します。

以下では、この API の主な機能について、およびこれらの機能を提供するメソッドについて説明します。

• サーバ環境に関する情報の取得 ：

  • GetServer メソッドは、サーバに関する重要な情報を提供します (サーバ上のネームスペースに関する情報を含む)。

  • GetNamespace メソッドは、指定されたネームスペースに関する追加情報を提供します。この情報には、そのネームスペースにマップされているデータベースのリストが含まれます。

  • HeadServer メソッドは、サーバに関するヘッダ情報を提供します。HeadServer を呼び出して、サーバが使用可能かどうかを確認できます。

  • GetJobs メソッドは、Caché で実行中のジョブに関する情報を提供します。

  • GetCSPApps メソッドは、CSP アプリケーションに関する情報を提供します。これらのアプリケーションは、Caché へのアクセスを可能にします。

• ソース・コード・ファイルに関する情報の取得：

  • GetDocNames メソッドは、ネームスペース内のソース・コード・ファイルの名前を返します。希望に応じて、対象となるファイルのファイル・カテゴリやファイル・タイプを限定できます。

  • GetModifiedDocNames メソッドは GetDocNames と同じ名前を返しますが、それに加えてデータベース状態のハッシュを返します。該当ファイルのローカル・コピーが保持されている場合は、GetModifiedDocNames を呼び出して、そのドキュメントが前回の取得時以降に変更されたかどうかを確認できます。

  • GetDoc メソッドは、指定されたソース・コード・ファイルの内容を取得します。希望に応じて ETAG および If-None-Match ヘッダを使用することで、ソース・コード・ファイルが前回の取得時以降に変更されている場合にのみ、ソース・コード・ファイルの内容を取得することもできます。

  • GetDocs メソッドは、指定されたファイルの内容を取得します。

  • Index メソッドは、ネームスペース内のクラス定義の一部のキー・プロパティを提供します。お使いのアプリケーションはこの情報を使用して、アクセスするクラス定義を選択できます。

  • HeadDoc メソッドは、ソース・コード・ファイルのヘッダ情報を提供します。

• ソース・コード・ファイルの作成、更新、および削除

  • PutDoc メソッドは、既存のソース・コード・ファイルを更新するか、既存のソース・コード・ファイルがない場合は新しいソース・コード・ファイルを作成します。

  • DeleteDoc メソッドは、指定されたソース・コード・ファイルを削除します。

  • DeleteDocs メソッドは、指定された一連のソース・コード・ファイルを削除します。

• ソース・コード・ファイルのコンパイル

  • Compile メソッドは、ソース・コード・ファイルをコンパイルします。

• Caché テーブルから情報を取得するための SQL クエリの実行

  • Query メソッドは、任意の Caché データベースに対する SQL クエリを実行します。

• ソース・コード・ファイルの検索

  • Search メソッドは、Caché データベース内のソース・コード・ファイルを検索します。

• Ensemble クラスを扱うための特別な呼び出し

  • GetEnsClassType メソッドは、Ensemble オブジェクトのクラス・タイプを返します。

  • GetAdpInputOutputClass メソッドは、Ensemble アダプタの入力/出力アダプタ・クラスを返します。