識別子のルールとガイドライン

回避する必要があるネームスペース名

予約済みのネームスペース名は、%SYS、BIN、BROKER、DOCBOOK、および DOCUMATIC です。これらのネームスペースのいくつかについては、このドキュメントで前述した “システム提供ネームスペース” で説明しています。他のものは Caché によって内部で使用されます。

また、ネームスペース名 SAMPLES を使用する場合、この名前を使用するインターシステムズのコード・サンプル・データベースをインストールしないように注意する必要があります。

回避する必要があるデータベース名

予約済みのデータベース名は、CACHE、CACHESYS、CACHELIB、CACHEAUDIT、CACHETEMP、および DOCBOOK です。

また、データベース名 SAMPLES を使用する場合、その名前を持つインターシステムズのコード・サンプル・データベースをインストールしないように注意する必要があります。

これらのデータベースの詳細は、このドキュメント内の前述の “システム提供データベース” を参照してください。

回避する必要があるローカル変数名

ローカル変数に対して以下の名前は使用しないでください。

• SQLCODE

  Caché SQL が実行される可能性があるコンテキストでは、変数の名前として SQLCODE を使用しないでください。"Caché エラー・リファレンス" の “SQLCODE 値とエラー・メッセージ” の章を参照してください。

• zenPage、this、および zenThis

  Zen クラスでは、変数の名前としてこれらを使用しないでください。"Zen アプリケーションの開発" の “Zen ページ” の章にある “Zen の特殊変数” を参照してください。

回避する必要があるグローバル変数名

データベースを作成すると、Caché によって、それ自体が使用するためのいくつかのグローバルでそれが初期化されます。また、作成するネームスペースすべてに、システム・グローバルへのマッピングが含まれます。これには、書き込み可能システム・データベース内のグローバル・ノードも含まれます。

システム・グローバルを上書きしないようにするために、ネームスペースでは以下のグローバルを設定、変更、または削除しないでください。

• 以下の例外を除く、^% で始まる名前を持つグローバル

  • ^%z または ^%Z で始まる名前を持つ独自のグローバル

  • ^%SYS (ドキュメントに記載されているようにノードを設定できます)

• ^BP (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^COMO (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^CacheAuditD

• ^CacheMsg (Caché メッセージ・ディクショナリ。"Caché Server Pages (CSP) の使用法" の “CSP アプリケーションにおけるテキストのローカライズ” を参照してください。

• ^CacheTemp および ^CacheTemp で始まる名前を持つグローバル。ただし、以下の 1 つの例外を除きます。

  • ^CacheTempUser で始まる名前を持つ独自のグローバル

• ^CMQLlog (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます。ドキュメントに記載されているようにこのグローバルを設定または削除できます)

• ^D.1 および ^D.2 (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^DeepSee.* (制限は、DeepSee を使用しているネームスペースにのみ適用されます)

• ^DICT.* (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^ERRORS

• ^InterSystems.Sequences (制限は、Caché Hibernate 言語を使用しているネームスペースにのみ適用されます。"JDBC での Caché の使用法" の “Caché Hibernate 言語の使用法” を参照してください。)

• ^ISC.* (インターシステムズで使用するために予約されています)

• ^ISCDebugLevel (ドキュメントに記載されているようにノードを設定する場合を除く)

• ^ISCMonitor (ドキュメントに記載されているようにノードを設定する場合を除く)

• ^ISCSOAP (ドキュメントに記載されているようにノードを設定する場合を除く)

• ^mqh (SQL クエリの履歴)

• ^mtemp*

• ^MV.* (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^OBJ.GUID (ドキュメントに記載されている場合を除く)

• ^OBJ.DBTIME

• ^OBJ.JournalT

• ^oddBIND

• ^oddCOM

• ^oddDEF (クラス定義を含む)

• ^oddDEP

• ^oddEXT

• ^oddEXTR

• ^oddFMD (制限は、FileMan マッピング・ユーティリティを使用しているネームスペースにのみ適用されます)

• ^oddMAP

• ^oddMETA

• ^oddPKG

• ^oddPROC

• ^oddPROJECT

• ^oddSQL

• ^oddStudioDocument

• ^oddStudioMenu

• ^oddTSQL

• ^oddXML

• ^PH (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^rBACKUP

• ^rINC (インクルード・ファイルを含む)

• ^rINCSAVE

• ^rINDEX

• ^rINDEXCLASS

• ^rINDEXEXT

• ^rINDEXSQL

• ^rMAC (MAC コードを含む)

• ^rMACSAVE

• ^rMAP

• ^rOBJ (OBJ コードを格納する)

• ^ROUTINE (ルーチンを格納する)

• ^SAVEDLISTS (制限は、Caché MVBasic を使用しているネームスペースにのみ適用されます)

• ^SPOOL (制限は、Caché スプーリングを使用しているネームスペースにのみ適用されます。"Caché 入出力デバイス・ガイド" の “スプール・デバイス” を参照してください)

• ^SYS (ドキュメントに記載されているようにノードを設定する場合を除く)

• ^z* および ^Z* (インターシステムズで使用するために予約されています)

ユーザが使用するために予約されているルーチン名

Caché では、ユーザが使用するために、以下のルーチン名が予約されています。 これらのルーチンは存在しませんが、それらを定義した場合、これらのイベントが発生したときにそれらがシステムによって自動的に呼び出されます。

• ^ZWELCOME ルーチンは、ターミナルが起動したときに実行するカスタム・コードを含めることを目的としています。"ターミナルの使用法" を参照してください。

• ^ZAUTHENTICATE および ^ZAUTHORIZE ルーチンは、認証および承認のためのカスタム・コードを含めることを目的としています (代行認証 と 代行承認 をサポートするため)。このようなルーチンのために、Caché にはテンプレートが用意されています。"Caché セキュリティ管理ガイド" を参照してください。

• ^ZMIRROR ルーチンは、Caché ミラーリングを使用する場合の、フェイルオーバー動作をカスタマイズするためのコードを含めることを目的としています。"Caché 高可用性ガイド" を参照してください。

• ^%ZSTART および ^%ZSTOP ルーチンは、ユーザ・ログインなどの特定のイベントが発生したときに実行されるカスタム・コードを含めることを目的としています。それらを定義した場合、これらのイベントが発生したときにそれらがシステムによって呼び出されます。"Caché 専用のシステム/ツールおよびユーティリティ" の “^%ZSTART ルーチンと ^%ZSTOP ルーチンによる開始動作と停止動作のカスタマイズ” を参照してください。

• %ZLANGV00、および名前が %ZLANG で始まる他のルーチンは、カスタム変数、コマンド、および関数を含めることを目的としています。"Caché 専用のシステム/ツールおよびユーティリティ" の “^%ZLANG ルーチンによる言語の拡張” を参照してください。

• ^%ZJREAD ルーチンは、^JCONVERT ルーチンを使用する場合にジャーナル・ファイルを操作するためのロジックを含めることを目的としています。"Caché データ整合性ガイド" の “ジャーナリング” を参照してください。

回避する必要があるクラス名

永続クラスについては、クラスの短い名前として SQL 予約語を使用しないでください。

クラスの短い名前として SQL 予約語を使用する場合、そのクラスに対して SqlTableName キーワードを指定することが必要になります。また、短いクラス名と SQL テーブル名の間に不一致があると、将来コードを読むときに注意が必要になります。

SQL 予約語のリストは、"Caché SQL リファレンス" の “予約語” を参照してください。

回避する必要があるメンバ名

永続クラスについては、メンバの名前として SQL 予約語を使用しないでください。

これらの名前の 1 つに SQL 予約語を使用すると、そのクラスを SQL に投影する方法を指定するときに余分な作業が必要になります。例えば、プロパティの場合、SqlFieldName キーワードを指定する必要があります。また、クラスの識別子と SQL の識別子の間に不一致があると、将来コードを読むときに注意が必要になります。

SQL 予約語のリストは、"Caché SQL リファレンス" の “予約語” を参照してください。このリストには、%UPPER や %CONTAINS のように、名前が % で始まる項目が数多く含まれている点に注目してください。このような項目は、SQL に対する InterSystems 拡張機能です。将来のリリースで、その他の拡張機能が追加される可能性もあります。