Native SDK for Python のクイック・リファレンス

iris.connect() は、新しい IRISConnection オブジェクトを返し、データベースへの新規接続の作成を試みます。このオブジェクトは、接続が成功すると開かれます。接続を確立できないと、例外がスローされます。

  iris.connect(hostname,port,namespace,username,password,timeout,sharedmemory,logfile)
  iris.connect(connectionstr,username,password,timeout,sharedmemory,logfile)

最後に成功した接続試行の hostname、port、namespace、timeout、および logfile が接続オブジェクトのプロパティとして保存されます。

パラメータ ：

パラメータは位置またはキーワードによって渡すことができます。

• hostname — サーバ URL を指定する str

• port — スーパーサーバ・ポート番号を指定する int

• namespace — ネームスペース・サーバを指定する str

• 以下のパラメータを、hostname、port、および namespace の引数の代わりに使用できます。

  • connectionstr — hostname:port/namespace の形式の str

• username — ユーザ名を指定する str

• password — パスワードを指定する str

• timeout (オプション) — 接続試行時に待機する最大ミリ秒数を指定する int既定値は 10000 です。

• sharedmemory (オプション) — bool を True に指定すると、ホスト名が localhost または 127.0.0.1 の場合に共有メモリ接続を試行します。False に指定すると、TCP/IP 経由の接続を強制します。既定値は True です。

• logfile (オプション) — クライアント側のログ・ファイル・パスを指定する strパスの最大長は、255 文字の ASCII 文字です。

iris.createIRIS() は、指定された IRISConnection を使用する IRIS の新規インスタンスを返します。接続が閉じられている場合は、例外をスローします。

    iris.createIRIS(conn)

返り値 ： iris. の新しいインスタンスIRIS

パラメータ ：

• conn — サーバ接続を提供する IRISConnection オブジェクト

IRIS.classMethodValue() は、クラス・メソッドを呼び出して、0 個以上の引数を渡し、ObjectScript の返り値のデータ型に対応するタイプとして値を返します。ObjectScript の返り値が空の文字列 ($$$NULLOREF) の場合は、None を返します。詳細と例は、“Python からのクラス・メソッドの呼び出し” を参照してください。

  classMethodValue (className, methodName, args)

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、または None。特定のタイプを返す方法は、"classMethodValue() 型キャスト・メソッド" を参照してください。

パラメータ ：

• class_name — 呼び出されるメソッドが属するクラスの完全修飾名。

• method_name — クラス・メソッドの名前。

• *args — 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

classMethodValue() に似ていて値を返さない "classMethodVoid()" も参照してください。

以下に示す IRIS.classMethodValue() 型キャスト・メソッドのすべてが、IRIS.classMethodValue() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。ObjectScript の返り値が空の文字列 ($$$NULLOREF) の場合、これらはすべて None を返します。詳細と例は、“Python からのクラス・メソッドの呼び出し” を参照してください。

  classMethodBoolean (className, methodName, args)
  classMethodBytes (className, methodName, args)
  classMethodDecimal (className, methodName, args)
  classMethodFloat (className, methodName, args)
  classMethodInteger (className, methodName, args)
  classMethodIRISList (className, methodName, args)
  classMethodString (className, methodName, args)
  classMethodObject (className, methodName, args)

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None。

パラメータ ：

• class_name — 呼び出されるメソッドが属するクラスの完全修飾名。

• method_name — クラス・メソッドの名前。

• *args — サポートされるタイプの 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

classMethodValue() に似ていて値を返さない "classMethodVoid()" も参照してください。

IRIS..classMethodVoid() は、返り値のない ObjectScript クラス・メソッドを呼び出し、0 個以上の引数を渡します。詳細と例は、“Python からのクラス・メソッドの呼び出し” を参照してください。

   classMethodVoid (className, methodName, args) 

パラメータ ：

• class_name — 呼び出されるメソッドが属するクラスの完全修飾名。

• method_name — クラス・メソッドの名前。

• *args — サポートされるタイプの 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

このメソッドは、返り値がないことを想定していますが、任意のクラス・メソッドの呼び出しに使用できます。classMethodVoid() を使用して、値を返すメソッドを呼び出した場合、メソッドは実行されますが、返り値は無視されます。

IRIS..close() は IRIS オブジェクトを閉じます。

  close () 

IRIS.function() は、関数を呼び出して、0 個以上の引数を渡し、ObjectScript の返り値のデータ型に対応するタイプとして値を返します。ObjectScript の返り値が空の文字列 ($$$NULLOREF) の場合は、None を返します。詳細と例は、“Python からの関数とプロシージャの呼び出し” を参照してください。

  function (functionName, routineName, args) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None。特定のタイプを返す方法は、"function() 型キャスト・メソッド" を参照してください。

パラメータ ：

• function_name — 呼び出す関数の名前。

• routine_name — 関数を含むルーチンの名前。

• *args — サポートされるタイプの 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

function() に似ていて値を返さない "procedure()" も参照してください。

以下に示す IRIS.function() 型キャスト・メソッドのすべてが、IRIS.function() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。ObjectScript の返り値が空の文字列 ($$$NULLOREF) の場合、これらはすべて None を返します。詳細と例は、“Python からの関数とプロシージャの呼び出し” を参照してください。

  functionBoolean (functionName, routineName, args)
  functionBytes (functionName, routineName, args)
  functionDecimal (functionName, routineName, args)
  functionFloat (functionName, routineName, args)
  functionInteger (functionName, routineName, args)
  functionIRISList (functionName, routineName, args)
  functionString (functionName, routineName, args)
  functionObject (functionName, routineName, args) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• function_name — 呼び出す関数の名前。

• routine_name — 関数を含むルーチンの名前。

• *args — サポートされるタイプの 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

function() に似ていて値を返さない "procedure()" も参照してください。

IRIS.get() は、プロパティの ObjectScript データ型に対応するタイプとしてグローバル・ノードの値を返します。ノードが空の文字列であるか、値がないか、またはノードが存在しない場合は、None を返します。

  get (globalName, subscripts) 

返り値 ： bool、bytes、int、float、Decimal、str、IRISList、Object、または None。他のタイプを返す方法は、"get() 型キャスト・メソッド" を参照してください。

パラメータ ：

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

以下に示す IRIS.get() 型キャスト・メソッドのすべてが、IRIS.get() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。ノードが空の文字列であるか、値がないか、またはノードが存在しない場合は、これらすべてのメソッドが None を返します。

  getBoolean (globalName, subscripts)
  getBytes (globalName, subscripts)
  getDecimal (globalName, subscripts)
  getFloat (globalName, subscripts)
  getInteger (globalName, subscripts)
  getIRISList (globalName, subscripts)
  getString (globalName, subscripts)
  getObject (globalName, subscripts)

返り値 ： bool、bytes、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

非推奨の型キャスト・メソッド "getLong()" も参照してください。

IRIS.getAPIVersion() は、このバージョンの Native SDK のバージョン文字列を返します。"getServerVersion()" も参照してください。

  getAPIVersion () 

返り値 ： str

IRIS.getLong()。Python long 型は、Python 3 で不要になりました。同じ精度をサポートする IRIS.get() 型キャスト・メソッド getInteger() を使用してください。

IRIS.getServerVersion() は、現在接続されている InterSystems IRIS サーバのバージョン文字列を返します。"getAPIVersion()" も参照してください。

  getServerVersion () 

返り値 ： str

IRIS.getTLevel() は、セッションで現在開いている入れ子になったトランザクションの数を返します (現在のトランザクションが入れ子になっていない場合は 1、開いているトランザクションがない場合は 0)。これは、ObjectScript $TLEVEL 特殊変数の値のフェッチと同じです。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  getTLevel () 

返り値 ： int

IRIS.increment() は、value 引数だけグローバル・ノードをインクリメントして、グローバル・ノードの新しい値を返します。指定されたアドレスに既存のノードがない場合は、指定した値で新しいノードが作成されます。このメソッドはきわめて高速のスレッドセーフなアトミック処理を使用して、ノードの値を変更します。したがって、ノードは決してロックされません。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  increment (value, globalName, subscripts) 

返り値 ： float

パラメータ ：

• value — インクリメントする int または float の数値

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

$INCREMENT は通常、新しいエントリをデータベースに追加する前に、カウンタをインクリメントするために使用します。$INCREMENT を使用すると、LOCK コマンドを使用しなくても、この操作を迅速に行うことができます。"ObjectScript リファレンス" の “$INCREMENT とトランザクション処理” を参照してください。

IRIS.isDefined() は、ノードが値、子ノード、またはその両方を持つかどうかを示す値を返します。

  isDefined (globalName, subscripts)

返り値 ： 以下のいずれかの int 値

• 0 ： ノードが存在しない場合

• 1 ： ノードに値はあるが、子ノードがない場合

• 10 ： ノードに値はないが、1 つ以上の子ノードがある場合

• 11 ： ノードに値と子ノードの両方がある場合

パラメータ ：

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

IRIS.iterator() は非推奨です。代わりに node() を使用してください。既存のアプリケーションで継続使用される機能の詳細は、"クラス iris.LegacyIterator" を参照してください。

IRIS.kill() は、指定されたグローバル・ノードとそのすべてのサブノードを削除します。指定されたアドレスにノードがない場合、このコマンドは何も行いません。<UNDEFINED> 例外はスローされません。

  kill (globalName, subscripts) 

パラメータ ：

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

IRIS.lock() は、グローバルをロックします。このメソッドは増分ロックを実行します (前のロックをすべてアンロックする場合は、まず releaseAllLocks() メソッドを呼び出す必要があります)。ロックの取得を待機中に timeout 値に到達した場合は、<TIMEOUT> 例外がスローされます。詳細は、“Python による並列処理の制御” を参照してください。

  lock (lock_mode, timeout, lock_reference, subscripts) 

パラメータ ：

• lock_mode — 次のいずれかの文字列 ： 共有ロックの場合は "S"、エスカレート・ロックの場合は "E"、両方の場合は "SE"、どちらでもない場合は ""。空の文字列が既定モードです (非共有または非エスカレート)。

• timeout — ロックの取得を待機する秒数

• lock_reference — 曲折アクセント記号 (^) で始まり、その後にグローバル名が続く文字列 (例えば、単なる myGlobal ではなく ^myGlobal)。

  注意 ： ほとんどのメソッドで使用される global_name パラメータとは異なり、lock_reference パラメータには先頭に曲折アクセント記号を付ける必要があります。global_name ではなく lock_reference を使用するのは、lock() および unlock() のみです。

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

ロックの詳細は、"ObjectScript リファレンス" の “LOCK” を参照してください。

IRIS.nextSubscript() は、ノード・アドレスを受け入れ、照合順で次の兄弟ノードの添え字を返します。指定された方向にノードがそれ以上見つからない場合は None が返されます。このメソッドは、ObjectScript の $ORDER と同様です。

  nextSubscript (reversed, globalName, subscripts) 

返り値 ： bytes、int、str、または float (指定された方向の次の添え字)

パラメータ ：

• reversed — ブーリアン値 true は、ノードを逆方向の照合順に走査する必要があることを示します。

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

"node()" も参照してください。これは、指定されたノードの子を反復処理するオブジェクトを返します (指定されたノードと同じレベルのノードに対する反復処理を可能にする nextSubscript() とは異なります)。

IRIS.node() は、指定されたノードの子に対する反復処理を可能にする IRISGlobalNode オブジェクトを返します。IRISGlobalNode は、グローバル・ノードの直接の子を表す仮想ディクショナリのように動作します。これは、反復処理、逆の操作、インデックス付け、およびスライスが可能です。

def  node (self, globalName, subscripts) 

パラメータ ：

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

"nextSubscript()" も参照してください。これを使用すると、指定されたノードと同じレベルのノードを反復処理できます (指定されたノードの子を反復処理する node() とは異なります)。

IRIS.procedure() は ObjectScript プロシージャまたは関数を呼び出して、0 個以上の引数を渡し、何も返しません (IRIS.function() も参照)。詳細と例は、“Python からの関数とプロシージャの呼び出し” を参照してください。

  procedure (procedureName, routineName, args) 

パラメータ ：

• procedureName — 呼び出すプロシージャの名前。

• routine_name — プロシージャを含むルーチンの名前。

• *args — 0 個以上のメソッド引数。タイプが bool、bytes、Decimal、float、int、str、および IRISList の引数は、リテラルとして投影されます。その他のタイプはすべて、プロキシ・オブジェクトとして投影されます。

このメソッドは、返り値がないことを想定していますが、任意の関数の呼び出しに使用できます。procedure() を使用して、値を返す関数を呼び出した場合、関数は実行されますが、返り値は無視されます。

IRIS..releaseAllLocks() は、セッションに関連付けられたすべてのロックを解放します。詳細は、“Python による並列処理の制御” を参照してください。

  releaseAllLocks () 

IRIS.set()は、value を現在のノード値として割り当てます。新しい値は、bool、bytes、bytearray、Decimal、float、int、str、または IRISList のいずれかです。

  set (value, globalName, subscripts) 

パラメータ ：

• value — グローバル・ノードの新しい値

• global_name — グローバル名

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

IRIS..tCommit() は、現在のトランザクションをコミットします。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  tCommit () 

IRIS..tRollback() は、セッション内の開いているトランザクションすべてをロールバックします。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  tRollback () 

IRIS..tRollbackOne() は、現在のレベルのトランザクションのみをロールバックします。これは入れ子になったトランザクションを対象としており、呼び出し元が 1 レベルのみをロールバックする場合に使用します。入れ子になったトランザクションである場合、それより上のレベルのトランザクションはロールバックされません。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  tRollbackOne () 

IRIS.tStart() は、トランザクションを開始するか、開きます。詳細と例は、“Python でのトランザクションの処理” を参照してください。

  tStart () 

IRIS.unlock() は、指定されたロックのロック・カウントをデクリメントし、ロック・カウントが 0 の場合はアンロックします。共有ロックまたはエスカレート・ロックを削除するには、適切な lockMode を指定する必要があります (共有ロックの場合は "S"、エスカレート・ロックの場合は "E")。 詳細は、“Python による並列処理の制御” を参照してください。

  unlock (lock_mode, lock_reference, subscripts) 

パラメータ ：

• lock_mode — 次のいずれかの文字列 ： 共有ロックの場合は "S"、エスカレート・ロックの場合は "E"、両方の場合は "SE"、どちらでもない場合は ""。空の文字列が既定モードです (非共有または非エスカレート)。

• lock_reference — 曲折アクセント記号 (^) で始まり、その後にグローバル名が続く文字列 (例えば、単なる myGlobal ではなく ^myGlobal)。

  注意 ： ほとんどのメソッドで使用される global_name パラメータとは異なり、lock_reference パラメータには先頭に曲折アクセント記号を付ける必要があります。global_name ではなく lock_reference を使用するのは、lock() および unlock() のみです。

• *subscripts — ターゲット・ノードを指定する 0 個以上の添え字

IRISList.add() は、IRISList の末尾に値を追加して、その IRISList オブジェクトを返します。

  add (value) 

返り値 ： self (IRISList オブジェクト)

パラメータ ：

• value — いずれかのサポート対象タイプの値、または値の配列かコレクション。配列またはコレクションの各要素は、個別に追加されます。IRISList のインスタンスは、常に単一要素として追加されます。

add() メソッドが IRISList の 2 つのインスタンスを連結することはありません。ただし、IRISList.toArray() を使用して、IRISList を配列に変換できます。結果として生成される配列で add() を呼び出すと、各要素が個別に追加されます。

IRISList.clear() は、リストからすべての要素を削除することでリストをリセットして、その IRISList オブジェクトを返します。

  clear () 

返り値 ： self (IRISList オブジェクト)

IRISList.count() は、リスト内のデータ要素の数を返します。

  count () 

返り値 ： int

IRISList.equals() は、指定された irislist2 を IRISList のこのインスタンスと比較し、それらが同一である場合に true を返します。同じであるためには、両方のリストに、同じ数の要素が同じ順序で、シリアライズされた同一の値で含まれている必要があります。

  equals (irislist2) 

返り値 ： bool

パラメータ ：

• irislist2 — 比較する IRISList のインスタンス。

IRISList.get() は、リストのカーソルを指定された index に移動し (指定されている場合)、カーソル位置にある要素を Object として返します。インデックスが範囲外の場合 (1 未満であるか、リストの末尾を越えている)、IndexOutOfBoundsException をスローします。以下の場合、None を返します。

  get (index) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• index — 新しいカーソル位置のインデックス (1 が基点) を指定するオプションの int

以下に示す IRISList.get() 型キャスト・メソッドのすべてが、IRISList.get() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。インデックスが範囲外の場合 (1 未満であるか、リストの末尾を越えている)、これらはすべて IndexOutOfBoundsException をスローします。

  getBoolean (index)
  getBytes (index)
  getDecimal (index)
  getFloat (index)
  getInteger (index)
  getIRISList (index)
  getString (index) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• index — 新しいカーソル位置のインデックス (1 が基点) を指定するオプションの int

IRISList.remove() は、リストの index にある要素を削除して、その IRISList オブジェクトを返します。

  remove (index) 

返り値 ： self (IRISList オブジェクト)

パラメータ ：

• index — 削除する要素のインデックス (1 が基点) を指定する int

IRISList.set() は、index にあるリスト要素を value に置き換えて、その IRISList オブジェクトを返します。

value が配列である場合、各配列要素が index の位置から開始してリストに挿入されます。index の後にある既存のリスト要素は、新しい値の場所を確保するために移動されます。

index がリストの末尾より後にある場合、value は index に格納され、リストはその位置まで NULL で埋められます。index が 1 未満の場合は、IndexOutOfBoundsException をスローします。

  set (index, value) 

返り値 ： self (IRISList オブジェクト)

パラメータ ：

• index — 設定するリスト要素のインデックス (1 が基点) を指定する int。

• value — index に挿入する Object 値または Object 配列。オブジェクトはサポートされているどのタイプでもかまいません。

IRISList.size() は、この IRISList のシリアライズされた値のバイト長を返します。

  size () 

返り値 ： int

IRISObject.close() は、IRISObject のこのインスタンスを解放します。

  close () 

返り値 ： self

IRISObject.get() は、プロキシ・オブジェクトのプロパティ値をフェッチします。IRIS の空の文字列 ($$$NULLOREF) の場合に None を返し、それ以外の場合は、プロパティの ObjectScript データ型に対応するタイプの変数を返します。

  get (propertyName)  

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• property_name — 返されるプロパティの名前。

以下に示す IRISObject.get() 型キャスト・メソッドのすべてが、IRISObject.get() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。これらはすべて、IRIS の空の文字列 ($$$NULLOREF) の場合に None を返し、それ以外の場合は、指定されたタイプの値を返します。

  getBoolean (propertyName)
  getBytes (propertyName)
  getDecimal (propertyName)
  getFloat (propertyName)
  getInteger (propertyName)
  getIRISList (propertyName)
  getString (propertyName)
  getObject (propertyName)

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• property_name — 返されるプロパティの名前。

IRISObject.getConnection() は、現在の接続を IRISConnection オブジェクトとして返します。

  getConnection ()

返り値 ： IRISConnection オブジェクト

IRISObject.getOREF() は、この IRISObject にマップされているデータベース・オブジェクトの OREF を返します。

  getOREF ()

返り値 ： OREF

IRISObject.invoke() は、オブジェクトのインスタンス・メソッドを呼び出して、プロパティの ObjectScript データ型に対応するタイプの変数を返します。

  invoke (methodName, args) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• method_name — 呼び出されるインスタンス・メソッドの名前。

• *args — サポートされるタイプの 0 個以上の引数。

invoke() に似ていて値を返さない "invokeVoid()" も参照してください。

以下に示す IRISObject.invoke() 型キャスト・メソッドのすべてが、IRISObject.invoke() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。これらはすべて、IRIS の空の文字列 ($$$NULLOREF) の場合に None を返し、それ以外の場合は、指定されたタイプの値を返します。

  invokeBoolean (methodName, args)
  invokeBytes (methodName, args)
  invokeDecimal (methodName, args)
  invokeFloat (methodName, args)
  invokeInteger (methodName, args)
  invokeIRISList (methodName, args)
  invokeString (methodName, args)
  invokeObject (methodName, args) 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

パラメータ ：

• method_name — 呼び出されるインスタンス・メソッドの名前。

• *args — サポートされるタイプの 0 個以上の引数。

invoke() に似ていて値を返さない "invokeVoid()" も参照してください。

IRISObject.invokeVoid() は、オブジェクトのインスタンス・メソッドを呼び出しますが、値は返しません。

  invokeVoid (methodName, args) 

パラメータ ：

• method_name — 呼び出されるインスタンス・メソッドの名前。

• *args — サポートされるタイプの 0 個以上の引数。

IRISObject.set() は、プロキシ・オブジェクトのプロパティを設定します。

  set (propertyName, propertyValue)

パラメータ ：

• property_name — value が割り当てられるプロパティの名前。

• value — 割り当てるプロパティ値。値はサポートされているどのタイプでもかまいません。

IRISReference.get_type() は非推奨です。目的のタイプの返り値を得るには、getValue() 型キャスト・メソッドのいずれかを使用してください。

  get_type () 

IRISReference.get_value() は非推奨です。代わりに、getValue() または getObject() 型キャスト・メソッドを使用してください。

IRISReference.getValue() は、参照されたパラメータの値を、データベース値のデータ型に対応するタイプとして返します。

  getValue () 

返り値 ： 参照されたパラメータの値

以下に示す IRISReference.getValue() 型キャスト・メソッドのすべてが、IRISReference.getValue() とまったく同じように機能するだけでなく、返り値を特定のタイプにキャストします。

  getBoolean ()
  getBytes ()
  getDecimal ()
  getFloat ()
  getInteger ()
  getIRISList ()
  getString ()
  getObject () 

返り値 ： bool、bytes、bytearray、int、float、Decimal、str、IRISList、Object、または None

IRISReference.set_type() は非推奨です。IRISReference コンストラクタを呼び出す際は、タイプを設定するオプションがあります。

  set_type (type) 

IRISReference.setValue() は、参照される引数の値を設定します。

  setValue (value) 

パラメータ ：

• value — この IRISReference オブジェクトの値

IRISReference.set_value() は非推奨です。代わりに setValue() を使用してください。

iris.IRISGlobalNodeget() は、指定された subscript にあるノードの値を返します。ノードに値がない、またはノードが存在しない場合は、default_value を返します。

get (subscript, default_value)

パラメータ ：

• subscript — 取得する値が含まれる、子ノードの添え字

• default_value — 指定された添え字に値がない場合に返す値

iris.IRISGlobalNode.items() は、このノードのすべての子ノードについて添え字と値のタプルを示したビューを返します。

items ()

返り値 ： 添え字と値のタプルを示した IRISGlobalNodeView オブジェクト

iris.IRISGlobalNode.keys() は、このノードのすべての子ノードの添え字を示したビューを返します。subscripts() とまったく同じです。

keys ()

返り値 ： 添え字のみを示した IRISGlobalNodeView オブジェクト

iris.IRISGlobalNode.node() は、指定された添え字にある子ノードを表す IRISGlobalNode オブジェクトを返します。

node (subscript)

返り値 ： IRISGlobalNode オブジェクト

パラメータ ：

• subscript — 目的の子ノードの添え字

iris.IRISGlobalNode.nodes() は、このノードの子ノードごとの IRISGlobalNode オブジェクトを示したビューを返します。

nodes ()

返り値 ： IRISGlobalNode オブジェクトを示す IRISGlobalNodeView オブジェクト

iris.IRISGlobalNode.subscripts() は、このノードのすべての子ノードの添え字を示したビューを返します。keys() とまったく同じです。

subscripts ()

返り値 ： 添え字のみを示した IRISGlobalNodeView オブジェクト

iris.IRISGlobalNode.values() は、このノードのすべての子ノードの値を示したビューを返します。ノードに値がない場合は None を返します。

values ()

返り値 ： 値のみを示した IRISGlobalNodeView オブジェクト

このメソッドは、iris パッケージのメソッド iris.connect() に置き換えてください。

IRISNative.createConnection() は、IRIS インスタンスへの新しい接続の作成を試み、新しい接続オブジェクトを返します。このオブジェクトは、接続が成功すると開かれ、それ以外の場合は閉じられます。

   irisnative.createConnection(hostname,port,namespace,username,password,timeout,sharedmemory,logfile)
   irisnative.createConnection(connectionstr,username,password,timeout,sharedmemory,logfile)

最後に成功した接続試行の hostname、port、namespace、timeout、および logfile が接続オブジェクトのプロパティとして保存されます。

返り値 ： connection の新しいインスタンス

パラメータ ： パラメータは位置またはキーワードによって渡すことができます。

• hostname — サーバ URL を指定する str

• port — スーパーサーバ・ポート番号を指定する int

• namespace — ネームスペース・サーバを指定する str

• 以下のパラメータを、hostname、port、および namespace の引数の代わりに使用できます。

  • connectionstr — hostname:port/namespace の形式の str

• username — ユーザ名を指定する str

• password — パスワードを指定する str

• timeout (オプション) — 接続試行時に待機する最大ミリ秒数を指定する int既定値は 10000 です。

• sharedmemory (オプション) — bool を True に指定すると、ホスト名が localhost または 127.0.0.1 の場合に共有メモリ接続を試行します。False に指定すると、TCP/IP 経由の接続を強制します。既定値は True です。

• logfile (オプション) — クライアント側のログ・ファイル・パスを指定する strパスの最大長は、255 文字の ASCII 文字です。

このメソッドは、iris パッケージのメソッド iris.createIris() に置き換えてください。

IRISNative.createIris() は、指定された接続を使用する IRIS の新規インスタンスを返します。接続が閉じられている場合は、例外をスローします。

    irisnative.createIris(conn)

返り値 ： IRIS の新しいインスタンス

パラメータ ：

• conn — サーバ接続を提供するオブジェクト