一般的なプロパティ・パラメータ
このページでは、リテラル・プロパティで使用できる一般的なプロパティ・パラメータのリファレンス情報を提供します。
概要
プロパティによっては、その動作に作用するように、そのプロパティのパラメータを指定できます。例えば、パラメータでは、最大値と最小値、表示に使用する形式、照合、特定のシナリオに使用する区切り文字などを指定できます。クラス定義内でパラメータを指定できます。以下に例を示します。
Property MyProperty as %String (MAXLEN=500);
これらのパラメータの多くは、制約として機能します。制約という用語は、プロパティの値を制約するパラメータを指します。例えば、MAXVAL、MINVAL、DISPLAYLIST、VALUELIST、および PATTERN は、すべて制約です。
利用できるプロパティ・パラメータ (データ型クラス別にリスト)
CALCSELECTIVITY、CAPTION、EXTERNALSQLNAME、EXTERNALSQLTYPE、JAVATYPE、STORAGEDEFAULT は、すべてのプロパティ定義で使用できます。データ型クラスに応じて、追加のプロパティ・パラメータを使用できます。
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： MAXLEN、MINLEN
XML と SOAP のパラメータ ： CANONICALXML、MTOM、XSDTYPE
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST
XML と SOAP のパラメータ ： XMLLISTPARAMETER、XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
注意 ： この特殊な目的のクラスは、InterSystems IRIS への移行にのみ使用します。
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： DISPLAYLIST、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE
その他のパラメータ ： DATEFORMAT
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST
XML と SOAP のパラメータ ： XSDLISTPARAMETER、XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
その他のパラメータ ： STRICT
一般的なパラメータ ： ODBCDELIMITER
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： ODBCDELIMITER
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、SCALE、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： MAXVAL、MINVAL
XML と SOAP のパラメータ ： XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE
その他のパラメータ ： DATEFORMAT
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： COLLATION、CONTENT、DISPLAYLIST、ESCAPE、MAXLEN、MINLEN、PATTERN、TRUNCATE、VALUELIST
XML と SOAP のパラメータ ： XMLLISTPARAMETER、XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XMLTIMEZONE、XSDTYPE
その他のパラメータ ： PRECISION
一般的なパラメータ ： DISPLAYLIST、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XMLDEFAULTVALUE、XMLTIMEZONE、XSDTYPE
一般的なパラメータ ： DISPLAYLIST、FORMAT、MAXVAL、MINVAL、VALUELIST
XML と SOAP のパラメータ ： XSDTYPE
一般的なパラメータ ： DATATYPE、LEN、STORAGEDEFAULT
多くのデータ型クラスは INDEXNULLMARKER もサポートしています。これがオーバーライドされることはほとんどありません。これについては、次のセクションで残りのパラメータと共に説明します。
プロパティ・パラメータ・リファレンス
ここでは、XML と SOAP のコンテキストに適用されるものを除く、最も一般的なデータ型クラスで使用されるプロパティ・パラメータのリファレンス情報を提供します。
すべてのリテラル・プロパティで利用できます。テーブル・チューニング機能でプロパティの selectivity を計算するかどうかを制御します。通常は、このパラメータを既定 (1) のままにしておくことが最良です。詳細は、"テーブルのチューニング" を参照してください。
すべてのリテラル・プロパティで利用できます。クライアント・アプリケーションで、このプロパティに使用するキャプションです。
プロパティ値がインデックスに変換される方法を指定します。
照合の許容値については、"SQL 入門" を参照してください。
文字列が XML または HTML に変換される可能性があるコンテキストで使用される場合、その文字列のコンテンツを指定します。"STRING" (既定)、"ESCAPE"、または "MIXED" を指定します。
詳細は、"XML スキーマへの投影の制御" を参照してください。
-
%DateTimeOpens in a new tab の場合は、表示または ODBC 入力値に数値の日付形式が指定されているときに、このパラメータで日付部分の順序を指定します。有効なパラメータは mdy、dmy、ymd、ydm、myd、および dym です。 既定の DATEFORMAT は mdy です。
-
%PosixTimeOpens in a new tab の場合は、このパラメータで表示値の形式を指定します。許容される値については、$zdatetime 関数と $zdatetimeh 関数の fformat パラメータを参照してください。
VALUELIST と共に、列挙 (複数選択) プロパティに使用されます。詳細は、"列挙プロパティの定義" を参照してください。
文字列が特定のコンテキストで使用される場合に、エスケープを行うタイプを指定します。"XML" (既定) または "HTML" のいずれかを使用します。
既定では、小なり記号、大なり記号、およびアンド記号がそれぞれ <、>、および & に変換されます。"XML" の詳細は、"XML スキーマへの投影の制御" を参照してください。
すべてのリテラル・プロパティで利用できます。リンク・テーブルで使用します。このパラメータでは、このプロパティのリンク先の外部テーブルにあるフィールドの名前を指定します。リンク・テーブル・ウィザードは、クラス生成時にこのパラメータをプロパティごとに指定します。リモート・データベースの SQL フィールドの名前は、さまざまな理由 (リモート・データベースのフィールド名が InterSystems IRIS の予約語であるなど) で InterSystems IRIS サーバ上のプロパティ名と異なる必要がある場合があります。リンク・テーブルの詳細は、"リンク・テーブル・ウィザード ： テーブルまたはビューへのリンク" を参照してください。
プロパティ・パラメータ EXTERNALSQLNAME には、SQLFieldName コンパイラ・キーワードとは別の用途があり、それらの項目には別の値を保持できます。SQLFieldName では、InterSystems IRIS データベース内の投影された SQL フィールド名を指定します。また、EXTERNALSQLNAME はリモート・データベース内のフィールド名です。
すべてのリテラル・プロパティで利用できます。リンク・テーブルで使用します。このパラメータでは、このプロパティのリンク先の外部テーブルにあるフィールドの SQL タイプを指定します。リンク・テーブル・ウィザードは、クラス生成時にこのパラメータをプロパティごとに指定します。"EXTERNALSQLNAME" を参照してください。
表示値の形式を指定します。FORMAT の値については、$FNUMBER 関数の format 引数で指定した形式文字列を使用します。タイプ %NumericOpens in a new tab または %DecimalOpens in a new tab のプロパティの場合は、オプション "AUTO" も使用できます。このオプションは末尾のゼロを抑制します。
インデックス・マップの添え字でこのタイプのプロパティが使用される場合に使用する、既定の NULL 標識を指定します。このパラメータの既定値については、"%Library.DataTypeOpens in a new tab" と "%Library.PosixTimeOpens in a new tab" を参照してください。
これらの値をインデックス・グローバルに直接設定する既存のコードがあり、アプリケーション・コードで INSERT 文または SELECT 文でこれらの値を使用しないように注意している場合を除き、このパラメータはオーバーライドしないでください。
%NameOpens in a new tab 用。プロパティ値で区切り文字としてコンマを使用して、インデックス内のプロパティで使用される添え字の数を指定します。この数は、%Storage.Persistent クラスが使用します。2 の値は、プロパティ値の最初のコンマ部分は最初の添え字に、プロパティ値の 2 番目のコンマ部分は 2 番目の添え字に保存されることを示します。
すべてのリテラル・プロパティで利用できます。このプロパティの投影先になる Java データ型です。
文字列の最大文字数を指定します。既定値は 50 です。また、このパラメータが "" である場合、長さは無制限になります。他の多くのパラメータと同様に、このパラメータは、InterSystems IRIS によるデータの検証方法に影響します。これは、フィールドがデータベース・ドライバ上でどのように投影されるかにも影響することに注意してください。
データ型の論理値の最大値を指定します。
文字列の最小文字数を指定します。
データ型の論理値の最小値を指定します。
ODBC を使用して投影されるとき、%List 値の構成に使用する区切り文字を指定します。
文字列がマッチするパターンを指定します。PATTERN の値は、有効な InterSystems IRIS パターン・マッチング式である必要があります。パターン・マッチングの概要は、"パターン・マッチング (?)" を参照してください。
%TimeOpens in a new tab 用。保持する小数点以下桁数を指定します。値が "" (既定) の場合、システムはソース値で入力された小数点以下桁数を保持します。値が 0 の場合、最も近い秒に丸められます。
小数点以下の桁数を指定します。
すべてのリテラル・プロパティで利用できます。このプロパティを永続クラスで使用する場合に、プロパティ値を格納する方法を指定します。このパラメータに使用できる値は row、columnar、および globalnode です。最初の 2 つについては、"SQL テーブルのストレージ・レイアウトの選択" を参照してください。globalnode については、"プロパティに個別のグローバルを使用" を参照してください。
コレクション・プロパティもこのプロパティ・パラメータを使用しますが、使用できる値は異なります。"コレクション・プロパティのストレージと SQL プロジェクション" を参照してください。
%IntegerOpens in a new tab 用。値が整数である必要があります。既定では、プロパティが %IntegerOpens in a new tab 型の場合に、整数以外の数値を指定すると、InterSystems IRIS はその値を整数に変換します。プロパティに対して STRICT が 1 の場合には、InterSystems IRIS は値を変換せず、検証は失敗します。
文字列を MAXLEN の長さまで切り捨てるかどうかを指定します。1 は True で、0 は False です。このパラメータは、Normalize() メソッドと IsValid() メソッドによって使用されますが、データベース・ドライバには使用されません。
DISPLAYLIST と共に、列挙 (複数選択) プロパティに使用されます。詳細は、"列挙プロパティの定義" を参照してください。
すべてのプロパティで使用できるパラメータは、データ型クラスでは定義されていません。それ以外が、それらを使用するデータ型クラス内で定義されています。
