開発者の皆さん、こんにちは！
InterSystems全製品のサーバ側コードで利用できる「ObjectScript」の基本の使い方から、困ったときのヒント集、エラーの読み方など、日本語ドキュメントの逆引きになるようなページを目指して、「ObjectScriptクックブック」を作成しました！
Hello Worldの出力から始めたい方に最適です。
2024/3/25更新：8. デバッグ方法 を追加しました。ぜひご参照ください。
ObjectScriptの記述に困ったときに読んでいただけるヒント集です。コミュニティに寄せられたご質問をどんどん掲載していきます。
ObjectScriptのプログラムでエラーが発生したときのエラーメッセージの読み方から、エラー情報の取得方法などを解説しています。
こちらの記事 では、ヘルスモニタのセンサー値を ^%SYSMONMGR ユーティリティを使用して変更する方法をご紹介しました。
今回は、ヘルスモニターセンサー値を コマンド（プログラム）で変更する方法をご紹介します。
ヘルスモニタは、CPUUsage（CPU使用率）、DBLatency（DBからのランダム読取に要する時間）、DiskPercentFull（DBのディスク使用率）などの該当しきい値を超えた場合に、通知を生成します。
※ヘルスモニタのセンサー値（閾値）について
センサーのしきい値を超えると、IRISのシステムログ（messages.log）に以下のようなメッセージが記録されます。
Cachéミラーリングは、CachéおよびEnsembleベースのアプリケーションに適した信頼性が高く、安価で実装しやすい高可用性および災害復旧ソリューションです。 ミラーリングは幅広い計画停止シナリオや計画外停止シナリオで自動フェイルオーバーを提供するもので、通常はアプリケーションの回復時間を数秒に抑制します。 論理的にデータが複製されるため、単一障害点およびデータ破損の原因となるストレージが排除されます。 ほとんど、またはダウンタイムなしでアップグレードを実行できます。
ただし、Cachéミラーの展開にはかなり大がかりな計画が必要であり、さまざまな手順が要求されます。 また、他の重要なインフラストラクチャコンポーネントと同様に、運用中のミラーには継続的な監視とメンテナンスが必要とされます。
この記事はよくある質問のリスト、あるいはミラーリングの理解と評価、ミラーの計画、ミラーの設定、ミラーの管理という簡単な一連のガイドとして利用することができます。 それぞれの回答には、各トピックの詳細なディスカッションへのリンクと各タスクの段階的手順へのリンクが含まれています。
ミラーを導入する計画を始める準備ができたら、まずはCaché高可用性ガイドの「ミラーリング」の章のミラーリングのアーキテクチャと計画セクションから必ず読み始めるようにしてください。
開発者の皆さん、こんにちは！
VSCode の ObjectScript エクステンションで、プロセスにアタッチしてデバッグする方法についてご紹介します。
ObjectScript エクステンションの基本的な操作方法については、こちらの記事をぜひご参照ください。
解説ビデオ（4分ちょっと）もあります。ぜひご参照ください。
VSCode のデバッグ実行に関連する各種の構成情報を記述するための launch.json に ObjectScript エクステンション用の設定を記述します。
.png)
（ビデオだと、最初～1:31 で解説しています）
プロセスにアタッチするデバッグ設定例は以下の通りです。
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.ファイルとディレクトリの操作に使用できる API 、%Library.File クラス (%File が省略形) の便利なサンプルコードをご紹介します。
こちらのAPIを使用して、ディレクトリやファイルの中身をのぞいたり、作成・書込み・読込みを行ってみます。
以下のサンプルは、C:\temp フォルダ内の *.txt ファイルをリストします(ファイルパス_サイズ_作成日)。
set stmt = ##class(%SQL.Statement).%New()
set status = stmt.%PrepareClassQuery("%File", "FileSet")
set rs = stmt.%Execute("c:\temp", "*.txt")
while rs.%Next(.rStatus) { write !, rs.%Get("Name")_"_"_rs.%Get("Size")_"byte"_"_"_rs.%Get("DateCreated") }サブディレクトリ内のファイルを含む場合はこちら (filetest.mac で保存) ↓
test(dir)
do disp(dir)
quit
disp(dir) {
set rs=##class(%ResultSet).以前公開している こちら の記事では、「OAuth 2.0 を利用して IRIS から Gmail を送信する」方法をご紹介しています。
本記事では、
外部アプリからGmailを受信するには OAuth 2.0が必要となるため、こちらの手順 に従ってAccessToken を取得しておきます。
また、「2.【準備】IRIS で、SSLクライアントの設定をする : 手順(4)」の手順に従って、GMAILSSL（任意の名前）の構成を作成しておきます。
以下のサンプルでは、
１．Gmailの受信サーバ（servername = pop.gmail.com）に、ユーザ名（user = xxx@gmail.com）、パスワード（pass = パスワード）、AccessTokenを使用して接続し、
Set status=server.Connect(servername,user,pass,accesstoken)２．メールボックスの情報を取得し、
Do ..ShowMailbox(server)３．Fetch() メソッドを使用して、添付ファイルを含むメールの内容の取得し、
（添付は server.AttachDir で指定したディレクトリに保存）
Do 前回、LinuxでODBC接続を行う方法 をご紹介しました。
今回は、LinuxでJDBC接続を行う方法 をご紹介します。作業は、root ユーザ で行います。
はじめに、Linuxのバージョンを確認します。
$ cat /etc/os-release
NAME="Red Hat Enterprise Linux"
VERSION="9.4 (Plow)"
:$ su -
Password:
Last login: Tue May 7 01:04:35 UTC 2024 on pts/0
# yum update今回は、Adoptium OpenJDK の Version 8 - LTS を使用してテストします。
※ *.tar.gz は、/usr/java 以下にダウンロードします。
# cd /usr/java
# ls
OpenJDK8U-jdk_x64_linux_hotspot_8u412b08.tar.gz
# tar zxvf OpenJDK8U-jdk_x64_linux_hotspot_8u412b08.tar.gz
:
# ls
jdk8u412-b08 OpenJDK8U-jdk_x64_linux_hotspot_8u412b08.tar.gzこれは InterSystems FAQ サイトの記事です。
以下のような情報収集ツールがあります。
| GLOSTAT | グローバルアクセスのカウンター情報 |
| mgstat | グローバルアクセスのカウンター情報を連続してファイルに記録する |
| JOBEXAM | 問題のあるプロセスをモニターする |
| SystemCheck または Buttons |
内部情報の収集
使用方法詳細は以下の記事もご参照ください。
|
| PERFMON |
グローバル、ルーチン、プロセス毎のグローバルアクセスカウンタ情報
|
これは InterSystems FAQ サイトの記事です。
XMLファイルの内容を格納する永続クラス定義を作成し、%XML.Adaptor を追加で継承します。
例は以下の通りです（右端の %XML.Adaptorクラスを追加で継承します）。
Class ISJ.Class1 Extends (%Persistent, %Populate, %XML.Adaptor)次に、%XML.Reader クラスを使用して格納先のインスタンスへ、タグとクラスの関連付け（Correlate()）を行い、reader.Next() でXMLを取り込みます。
set sc=reader.OpenFile(filename)
do reader.Correlate(tag,class)
while reader.Next(.x,.sc) { do x.%Save() } サンプルコードは以下の通りです。
Class ISJ.Class1 Extends (%Persistent, %Populate, %XML.これは、InterSystems FAQサイトの記事です。
CSPアプリケーションでは、リクエスト処理時間がサーバー応答タイムアウト値(CSPゲートウェイ管理ページで設定、既定値60 sec)を経過すると、CSPゲートウェイからクライアントブラウザにタイムアウトを通知し、処理を続けているデータプラットフォームサーバプロセスにエラーを発生させます。
エラーが発生している処理を確認して頂き、処理遅延の改善、例えばタイムアウトが発生しないように処理内容を見直して応答時間を短くすることや必要に応じてサーバ応答タイムアウト値を大きくすることで対処可能です。
これは InterSystems FAQ サイトの記事です。
WebゲートウェイのSystem Status（システムステータス）ページでは、現在のすべてのアクティブな接続のステータスを確認することができます。
最初のステータステーブル (システムステータス) は、IRIS への接続に関する情報を表示します。
2番目のステータステーブル (InterSystems IRIS サーバ) は、InterSystems IRIS サーバに関する情報を表示します。
3 番目のステータステーブルは、アプリケーションパスの情報を表示します。
4 番目のテーブルは、Web ゲートウェイの応答キャッシュに保持されるフォームを表示します。
いくつかのサンプル接続ステータスを例にご説明します。
【ケース１】
接続最小数５の設定で、現在3接続が処理中の場合。
使用中のプロセスは InUse のステータス、待ち受けで空いているプロセスは Free で表示されます。
※Free の接続は、[非活動タイムアウト(無使用タイムアウト)] まで残り、タイムアウトを過ぎると自動的に終了します。
ただし、[サーバ接続最小数] 分の接続は上記タイムアウトが過ぎても残り、次のリクエストで使用されます。
アイドル時間/タイムアウトの表示例は、0/0(接続最小数で残り続ける接続) や、300/86400(タイムアウト86400秒中、300秒経過)になります。
※Server のステータスは、Webゲートウェイレジストリメソッドで使用のプロセスです。
CSP.iniで以下の設定をしている場合は、このプロセスは作成されません。
[SYSTEM]
REGISTRY_METHODS=Disabled
あるメソッドやルーチンを実行してエラーとなった場合、エラー発生個所はエラーメッセージより取得することができますが、処理の呼び出し履歴（スタックトレース）はエラーメッセージのみではわかりません。
また、.Net や Python など IRIS 外からの呼び出しの場合に、エラー情報の詳細がクライアントに返らない場合などもあるかと思います。
/// 例：エラーメッセージだけでは、エラーが発生した処理の呼び出し履歴まではわからない。
USER>d ##class(User.Test).TestMethod1()
write a
^
<UNDEFINED>TestMethod3+1^User.Test3.1 *a
USER 4e1>
そんなときは、エラー処理にて Do BACK^%ETN を実施することで、IRIS側で強制的にスタック情報を記録することができます。
スタック情報を記録することで、どのような処理がどの順番で呼び出されたかや、エラー時の内部変数情報を知ることができます。
BACK^%ETN は、エラー発生後に $ZError($ZE) 変数に値が set されている場合、アプリケーションエラーログ（^ERRORS）に情報が記録されます。
上のエラーの場合の $ZE は、以下のように確認できます。
開発者の皆さん、こんにちは！
IRISのInteroperability（相互運用性）機能（Ensembleのプロダクション）を使用してどのようなことができるか、コード例をご覧いただきながら／サンプルを動かしながらご確認いただける記事をまとめてみました。
ぜひご参照ください。
記事一覧：
IRISをアップグレードすると、SQLクエリオプティマイザの機能向上により、旧バージョンとは異なるクエリプランによるクエリ実行コード(クエリキャッシュ)が作成される場合があります。
ほとんどの場合はパフォーマンスが向上するのですが、稀にパフォーマンスが低下するケースもあります。
・アップグレードによりオプティマイザが改善しているとはいえ、中には遅くなるクエリがあるのではないか？
・予期しないSQLの問題が起きるのではないか？
・アップグレード後に全てのクエリパターンをテストするには時間と労力がかかりすぎる
このように、機能向上よりも安定性を優先して「今までのプランのまま実行したい」というご要望もあることでしょう。
こちらの記事では、そのようなお客様への解決策をご案内します。
Cache2016.2以降（IRISはすべてのバージョン）で、クエリプランの凍結機能 が実装されました。
この機能により、IRISを新しいバージョンにアップグレードする際、既存のクエリプランは自動的に凍結されます。
これにより、アップグレードによる既存のクエリのパフォーマンスの低下の可能性を防げます（古いバージョンと同じプランが使用されるため）。
新しいクエリについてはもちろん、アップグレード後のクエリオプティマイザによるプランが使用されます。
これは InterSystems FAQ サイトの記事です。
^%GSIZE ユーティリティでは、グローバルのサイズを算出することができます。
このユーティリティで出力される各項目の意味について説明します。
例えば、USERネームスペースのグローバルについて do ^%GSIZE を実行し、以下のように出力結果を得られたとします。
これは InterSystems FAQ サイトの記事です。
タイムアウトを無効にするためには、DSNの設定でクエリタイムアウト無効に設定します。
Windowsコントロールパネル > [管理ツール] > [データソース（ODBC）] > [システムDSN]の構成
で クエリタイムアウト無効 にチェックを入れますと、タイムアウトは無効になります。
アプリケーション側で変更する場合は、ODBC APIレベルで設定することが可能です。
ODBCのSQLSetStmtAttr関数をコールする際に、SQL_ATTR_QUERY_TIMEOUT属性を設定してから、データソースに接続してください。
IRISアップグレードやインストールがうまくいかない場合、初めに以下の4点をご確認ください。
★１について
インストーラーのダウンロードに問題があったなどで、インストーラー自体に問題があり、インストールできないというケースがあります。
その場合は、インストーラーのハッシュ値（md5 checksum）を比較してファイルの同一性を確認するか、再ダウンロードしてインストールをお試しください。
インストーラーのハッシュ値は、WRCDirectのダウンロードページ にて対象の製品を選択してご確認いただけます。
例：
お持ちのインストーラーのハッシュ値は、以下のように確認します（Windowsの場合）。
c:\downloads\kits>CertUtil -hashfile IRIS-2023.1.1.380.0-win_x64.exe MD5
MD5 ハッシュ (対象 IRIS-2023.1.1.380.0-win_x64.これは、InterSystems FAQサイトの記事です。
こちらのメッセージは、エラーではなく、アプリケーションのエラーログを記録した古い ^ERRORSグローバルのパージ処理が実行された際に出力されるメッセージになります。ログを削除した旨のみを伝えるメッセージであり、出力されていても特に問題はありません。
また、このログは、^ERRORSグローバルのパージ処理がタスク実行される毎日01:00 に出力されます。
実際にアプリケーションエラーがある場合は、管理ポータルの [システムオペレーション] > [システムログ] > [アプリケーションエラーログ] にて、詳細を確認できます。
※このエラーログの内容は、各ネームスペースの ^ERRORS グローバルに格納されているものです。
これは InterSystems FAQ サイトの記事です。
「定期的にプロセスを監視し、あるイベントが発生したときにのみ処理を実行したい」ような場合に使用できる、便利な機能をご紹介します。
もちろん、Forループを行う常駐プロセスを作成してその中で Hang XX しながらIf文にてイベントを検知したり、タスクスケジュールでルーチンを定期実行してその中でIf文にてイベントを検知して処理することも可能です。
今回ご紹介する、%SYSTEM.Event クラスを使用することで、よりシンプルに処理を作成することが可能となります。
【こんな時に便利】
・テーブルやグローバルに、あるデータが全て格納されたら処理を行いたい
・あるエラーを検知したときにのみ、^SystemCheck情報を取得したい
・処理が必要なものがデータベースに入ったら順番に処理を行いたい（pythonだとQueueモジュールのような感じ）
【使用方法】
準備（任意のプロセス）
do $SYSTEM.Event.Create("test")
これで、testというイベントがシステムワイドで作成されます。
パターンA＝単純な常駐プロセス
(1) 待機プロセス側
do $SYSTEM.Event.Wait("test")
このコマンドの瞬間、このプロセスは待ち状態になります。
(2) 起こす側
do $SYSTEM.Event.
これはInterSystems FAQ サイトの記事です。
HTMLからRESTを使って画像ファイルをアップロードする方法をご紹介します。
1.はじめに、以下のようなhtmlとクラスを作成してください。
＊UploadTest.html
<html lang="ja">
<head>
<title>Upload</title>
</head>
<body>
<input id="up" type="file" />
<button id="btn">Upload</button>
<div></div>
<script type="text/javascript">
const sendfile = function(e) {
let up = document.getElementById("up");
let file = up.files[0];
let fd = new FormData();
fd.append("imgfile", file);
let xmlhttp = new XMLHttpRequest();
xmlhttp.これは InterSystems FAQ サイトの記事です。
Excelのマクロ機能を使ってVBAからREST/JSON経由でアクセスすることが可能です。
REST/JSONを使用したInterSystems製品との連携の簡単なサンプルを以下のGitHubサイトから入手できます。
マクロサンプルは Solution/activityreport.xlsm をご覧ください。
サンプルは、コンテナを利用しています。READMEに記載の方法でコンテナを開始し、Solution/activityreport.xlsm の「データ取得」ボタンをクリックすると以下の結果が得られます。
.png)
マクロの中では、以下のGET要求を実行しています。
以下の図例は、RESTクライアントでGET要求を行った結果です（ Basic 認証でアクセスしています）。
.png)
上記GET要求により、ベースURL（/pm）の指定で、RESTディスパッチクラス（PM.Broker）が起動し、要求されたパス（例では /getactivities）から、PM.REST クラスの GetActivities() メソッドを実行しています。
Class PM.Broker Extends %CSP.これは InterSystems FAQ サイトの記事です。
ジャーナルファイルのサイズが大きすぎて、管理ポータルで検索やフィルタリング等できない場合、以下の2つの方法で参照することができます。
① ^JRNDUMP ユーティリティを使用する方法
② プログラムで参照する方法
============================================================
① ^JRNDUMP ユーティリティを使用する方法 例えば、グローバル参照 ^ABC を含むジャーナルファイルのすべてのレコードを選択する場合は、以下のようになります。
※以下、すべてのコマンドは %SYS ネームスペースで実行してください。
DO SELECT^JRNDUMP("C:\MyCache\mgr\journal\YYYYMMDD.001","","","^ABC",1)グローバル参照 ^ABC に完全に一致するレコードのみを選択する場合は、以下のようになります。
DO SELECT^JRNDUMP("C:\MyCache\mgr\journal\YYYYMMDD.001","","","^ABC",0)グローバル ^ABC に対するローカルの Set 処理のレコードのみを選択する場合は、以下のようになります。
これは InterSystems FAQ サイトの記事です。
コンパイル時のフラグや修飾子の記号と意味については、以下ドキュメントをご参照ください。
なお、開発環境のスタジオやVisual Studio Codeでは、開発環境の設定画面でフラグを変更できます。
ターミナルでコンパイルを実行するときは $system.OBJ.CompileAll() などのシステムユーティリティが利用できます。
コンパイルフラグを引数に指定しない場合、デフォルトのコンパイルフラグが利用されます。デフォルトのフラグは $system.OBJ.ShowFlags() で確認できます。
これは InterSystems FAQ サイトの記事です。
REST アプリケーションはステートレスであることが想定されています。
しかし、複数の REST 呼び出し間でデータを保持したい場合などの理由で、Webセッションを使用したい場合は、UseSession パラメータを使用することができます。
以下のように、Web アプリケーションのディスパッチクラスとして定義された %CSP.REST のサブクラスでUseSession パラメータを指定することで、CSPと同じようにWebセッションを使用することが可能となります。
Class REST.MyServices Extends %CSP.REST
{
Parameter UseSession As Integer = 1;
詳細は以下のドキュメントをご覧ください。
以下は、UseSession パラメータを使用した簡単なサンプルになります。最初に、2つのクラスを作成してください。
*
Class REST.SessionTest Extends %CSP.これは、InterSystems FAQサイトの記事です。
グローバル単位でジャーナルのON/OFF設定を行いたい場合は、グローバルマッピング設定で、
・ジャーナルしたいグローバル ⇒ ジャーナルON(「はい」)のデータベースにマッピング
・ジャーナルしたくないグローバル ⇒ ジャーナルOFF(「いいえ」)のデータベースにマッピング
と、分けることで可能です。 但し、通常のデータベースは、ジャーナルOFF設定であっても、トランザクション中の更新についてはジャーナルファイルに記録されます。
一時グローバルを保存するIRISTEMP/CACHETEMPデータベースは、トランザクション中でもジャーナルファイルに記録されませんので、トランザクションデータもジャーナル記録したくない場合にはこれをマッピング先にすることも可能です。
但し、IRISTEMP/CACHETEMPデータベースは一時データベースであるため、インスタンス再起動でグローバルデータは失われますので注意が必要です。
一時グローバルと IRISTEMP データベース
こちらの記事では、LinuxでODBC接続の設定を行う方法をご紹介します。
はじめに、Linuxのバージョンを確認します。
$ cat /etc/os-release
NAME="Red Hat Enterprise Linux"
VERSION="9.4 (Plow)"
:$ sudo yum update$ sudo yum install unixODBC確認します
$ which odbcinst
/usr/bin/odbcinst
$ which isql
/usr/bin/isql
$ odbcinst -j
unixODBC 2.3.9
DRIVERS.: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES.: /etc/ODBCDataSources
USER DATA SOURCES.: /home/ec2-user/.odbc.ini
SQLULEN Size.: 8
SQLLEN Size.これは InterSystems FAQ サイトの記事です。
整合性チェックを行う場合、管理ポータルやタスクマネージャーから行う方法と、ターミナルから ^Integrity ユーティリティを使用して行う方法があります。
こちらのトピックでは、それぞれの違いをご説明します。
こちらの方法は、選択した複数のデータベースや、1 つのデータベースに格納された選択可能な複数のグローバルを対象に整合性をチェックを行います。
管理ポータル：
[システムオペレーション] > [データベース] 整合性チェック・ボタン
※チェックを行いたいネームスペース、必要に応じてグローバルを選択し、実行・ボタンをクリック
整合性チェックタスク：
[システムオペレーション] > [タスクマネージャー] > [タスクスケジュール] 整合性チェック・タスク
SYS.Database クラスの IntegrityCheck メソッド：
%SYS>do ##class(SYS.Database).IntegrityCheck($LB("c:\intersystems\iris\mgr\user\")) // DB指定
%SYS>do ##class(SYS.Database).これは InterSystems FAQ サイトの記事です。
InterSystems Data Platform自身には、ソース管理を行う機能はありません。
2016.2以降のバージョンをご使用の場合、統合開発環境として VSCode をご利用いただくことで、VSCode でご利用いただけるソース管理機能をご使用いただけます。
VSCode で ObjectScriptの操作を行うためには、専用エクステンションのインストールが必要です。
使用方法については、コミュニティの記事「VSCode を使ってみよう！」をご参照ください。
また、「VSCodeでのソースコード管理について」についても併せてご参照ください。
2016.2より前のバージョンをご使用の方でも使用できる方法としては、InterSystems製品 のIDEであるスタジオに、外部のソース管理ツール、製品と連携するためのフック機能があります。
このフック機能は、複数のAPIで構成されており、お客様毎にご自身の環境に合わせて、作りこむことを前提に提供されております。
よく使われるマイクロソフトのVisual Source SafeとSubversion（SVN）については、テンプレートがあります。
このテンプレートを利用すると、作りこみの作業を短縮することが可能です。
これは InterSystems FAQ サイトの記事です。
InterSystems 製品には、テーブルのコンテンツに関する統計を収集し、クエリの最適化に役立てる「テーブルチューニング機能」があります。
設定方法は、以下のドキュメントをご参照ください。
ターミナルでは次のコマンドを実行します。
do $SYSTEM.SQL.Stats.Table.GatherTableStats("スキーマ名.テーブル名")2021.1以前のバージョンでは以下メソッドを利用します。
Do $system.SQL.TuneTable("スキーマ名.テーブル名",1,1)また、以下の資料もご参照ください。
1) パフォーマンス調査の基礎知識として必要なグローバル構造の解説やSQLの動作の仕組みからクエリプランの見方の解説
2) パフォーマンスチューニングの例（P13～）
3) ビットマップ・インデックスの圧縮やオプティマイザ・ヒントなど、Caché SQLのパフォーマンスを最大限に引き出すための情報について
4) パフォーマンスに困ったときにどこに着目し、どのツールで調べていくか、お客様から日々ご相談をいただくカスタマーサポートから、解決に向かうアプローチの「イロハ」をご紹介するビデオ
5) 開発者コミュティのパフォーマンス関連情報（performanceタグ）
これはInterSystems FAQ サイトの記事です。
命名規約については、それぞれ下記のドキュメントページをご確認ください。
テーブル名（クラス名）について
カラム名（プロパティ名）について
こちらに記載しておりますように、カラム名（プロパティ名）には英数文字およびASCII 128 よりUnicodeコードポイントの大きな文字のみ使用可能です。
また、「リリース2012.2以降〜」の部分にありますように、
Property "My Property" As %String;のように " で囲むことで、使用できない記号等も使用できるようになります。
これとは別に、プロパティ名は英数字のみを使用して、SQLフィールド名のみ、別途指定することもできます。
Property iscname As %String [ SqlFieldName = isc_name ];