EDB/Gate

EDBへのアプリケーションレベルでのコネクション指向アクセスインタフェースを提供する．

以下に，EDB/Gateへの接続に必要な諸元を示す． EDB/Gateはクライアントサイドのアプリケーションからの接続を想定しているが，接続例のようにマニュアルでも接続は可能である．

• サーバのリスト: http://web.db.tokushima-u.ac.jp/config/edbgate.list

  (注)サーバのメンテナンス等の事由により，これらのサーバは常にアクティブではないことに注意．EdbGateへのコネクションを張る前に，必ずサーバのリストを取得し，それに含まれているサーバに接続すること(そうでなければ，サーバ側で強制的にコネクションを切断されることもありうる．)．
  また，負荷分散のために，常に同じサーバを利用するのではなく，乱数などを用いて接続先を選択することが望ましい．

全ての通信データは，Unicode (UTF-8 encoding)で表現された文字列で行われる．

EDB/Gateはクライアントサイドのアプリケーションとの接続を想定しているので，telnetのようなコマンドプロンプトは提示しない． その代わりに，クライアントからのリクエストをrequest-idによって管理し，レスポンスにそれらを付加して応答を行う．

リクエストの発行方法と，レスポンスの様式は以下に示す通り．

<Request Form>

COMMAND  arg₁  [arg₂  [arg₃ ...]]

OPTION₁  arg₁  [arg₂  [arg₃ ...]]

OPTION₂  arg₁  [arg₂  [arg₃ ...]]

...

      (insert a blank line: blank line means the end-of-request)

<Response Form>

--- BEGIN-OF-RESPONSE (request-id)

request-id(TAB)   Status: 3-digits-code  comment

request-id(TAB)   result-information₁

request-id(TAB)   result-information₂

request-id(TAB)   ...

request-id(TAB)   (blank)

request-id(TAB)   content-of-response₁

request-id(TAB)   content-of-response₂

request-id(TAB)   content-of-response₃

request-id(TAB)   content-of-response₄

request-id(TAB)   ...

--- END-OF-RESPONSE (request-id)

○ リクエストのブロックの終了は空行(改行コードのみの行)で示す．

EDB/Gateは空行が現れたとき，コマンドの解析と実行を開始する．

○ リクエストは，レスポンスの終了を待たなくても，発行することができる．

ただし，ソケット接続においてブロックされないことが必要．

○ EDB/Gateからのレスポンスについて

EDB/Gateからのレスポンスは，

--- BEGIN-OF-RESPONSE (request-id)

--- END-OF-RESPONSE (request-id)

でブロック化されて返送される．

このブロック内に含まれる行には，

1. 行頭の`!'はその行が注釈である事を示す．
2. 行頭にrequest-id(TAB)が記述されている行

があり，前者はEDB/Gateのデバッグ用もしくは，内部処理を確認するためのものであるので，無視する．
後者は更に，

1. レスポンスヘッダ
2. コンテンツ

に分けられ，これらは，

request-id(TAB)

のみの行で区切られる． レスポンスヘッダにはリクエストの成功の可否やコンテンツの長さなどが示される． コマンドが何らかの情報を取得する場合には，コンテンツの場所において情報が返送される．

インタラクティブにコマンドとレスポンスを繰り返す場合には，request-idのフィールドに書かれているIDを無視することも可能であるが，コマンドを同時に発行するような場合には，ID部分によりレスポンスを選別した後，各々のレスポンスの内容を解析する必要がある．

なお，通常request-id はサーバ側で自動的に生成される．1ずつ増える値となるが，クライアント側から request-idをリクエストのオプションで指定する事も可能である．

• Request-ID: request-id

("request-id" は正の整数である事).
request-idを指定すると，それ以降の値は指定したrequest-idに続くものになる．

各フィールドはTAB文字(U+0009)で区切られる．(フィールド内のテキストにはTAB文字は含まれない．)

検索する情報に対する条件式を記述する．

○ 基本形は

XN = {values}

である．

・XNはテーブルもしくはカラムのXML名である．

・「XN = xn_tbl . xn₁ . xn₂」 のように展開し，xn_tblをテーブルのXML名とする．

・結果はカラムの値と条件の値(values)が合致する情報のEIDのリストとなる．

・valuesに記したどれか一つの値と適合する場合にEIDのリストに追加される．(OR結合)

・デフォルトのロジックを変更したい場合には，

XN = NOT{values}

XN = AND{values}

XN = OR{values}

XN = NAND{values}

XN = NOR{values}

XN = XOR{values}

XN = XNOR{values}

のように記述する．NOTはNORと解釈される．XOR, XNORの場合には値は2つでなくてはならない．

・xn_i (i>0)では"xmlname[1]"のように要素位置を指定できる．(配列の場合のみ)

○ 複数のカラムについて条件を指定したい場合には

XN₀.{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

と記述する．

・一般に， XN₁, XN₂ は XN₀ に含まれるカラムである．

・これらの条件式はANDで結合される．

・デフォルトのロジックを変更したい場合には，

XN₀.NOT{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

XN₀.AND{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

XN₀.OR{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

XN₀.NAND{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

XN₀.NOR{ XN₁ = {values₁}   XN₂ = {values₂}   [...] }

XN₀.XOR{ XN₁ = {values₁}   XN₂ = {values₂} }

XN₀.XNOR{ XN₁ = {values₁}   XN₂ = {values₂} }

のように記述する．NOTはNANDと解釈される． XOR, XNORの場合には条件は2つでなくてはならない．

・XN₁, XN₂ では，"@"を用いて， @.xn₁, @.xn₂ のように表現することができる．

○ カラム(@.xn₁)が配列の場合には，

xn_tbl.{ @.xn₁.xn₂ = {values₂} @.xn₁.xn₃ = {values₃} }

と

xn_tbl.xn₁.{ @.xn₂ = {values₂} @.xn₃ = {values₃} }

は異なる結果になりうる可能性があることに注意せよ．

○ サブカラムに条件をつけた配列の条件を指定したい場合には

XN₀.{ XN₁ = {values₁} }={values₂}

と記述する．すなわち，

xn_tbl.xn₁.{ @.xn₂ = {values₂} } ={values₁}

のような記述では，

xn_tbl.xn₁[k] = {values₁}

xn_tbl.xn₁[k].xn₂ = {values₂}

が同時に成り立つkが存在する時，真となる．xn₁が配列でない場合には，

xn_tbl.{@.xn₁ = {values₁} @.xn₁.xn₂ = {values₂} }

と書いても同じ結果となる．

○ xn_x…カラム名(XML名)

・ カラムが配列の場合には，

@.column[x] : 配列の添字=x

@.column[x:] : x<= 配列の添字

@.column[:y] : 配列の添字<=y

@.column[x:y] : x<=配列の添字 AND 配列の添字<=y

で範囲を指定することが可能．x, y は正整数．

特別なカラム名:

• EID … この情報}のEID
• REF … この{情報|カラム}が参照している他の情報のEIDのリスト
• PERM … この{情報|カラム}が権限委譲している他の情報のEIDのリスト
• OWN … この情報の所有者のEID
• MAP … この情報がマップしている情報のEID
• DATE … カラムの期間限定属性
• CAP … この情報の見出し
• ALL … この情報の全文
• PARENT … 情報が階層構造をなしているときの直上の親

○ オペレータ:

・オペレータには

• '=' … 一致
• '~' … 正規表現による一致

を指定できる．

・正規表現による一致は，対象となるカラムがテキスト型を含みかつ比較される値がテキストが他の場合にのみ行われる．

○ 値リスト: LOGIC{ values }

・LOGICには，NOT, AND, OR(デフォルト), NAND, NOR, XOR, XNORを指定できる．

・LOGICを省略すると，ORとして解釈される．

・LOGICにNOTを指定すると，NORと解釈される．

・LOGICにXOR, XNORを指定する場合には，valuesは2項でなくてはならない．

・LOGICがORであり，かつ，valuesが単項の場合には，'{'と'}'を省略することができる．

○ 値: value_x

・値リストを { value₁ value₂   [...] }と記述した場合，それぞれの value_x には以下の記法を用いることができる．

• !value_x …単項のNOT演算．
• ~value_x …正規表現による比較(テキストの比較のみ)．
• 両方を使う場合には，!~value_xの順に指定する．

・指定する値の型は左辺から抽出可能なものでなくてはならない．

valueの型	指定形式	説明
存在	ANY	何かがあるとき．リレーショナルデータベースにおいて比較の対象となるものが存在するときに真値をとる．!ANYは使用不可．
EID	\e{NULL} \E{NULL}	参照なし．
	\e{eid}	展開なし．
	\E{eid}	展開あり．
	サブクエリ	展開あり．
テキスト	"string"	登録内容に等しいテキスト．MTEXTのように左辺から複数のテキストを抽出可能な場合には，(英),(日),(読)のいずれかに等しいテキスト
数値	"val"	登録内容に等しい数値．
	"val1 val2"	もしくは登録内容を含む範囲
年月日	"date"	登録内容に等しい月日
	"from-date to-date"	登録内容を含む期間

INTEGER，DATE等を範囲で検索する場合には

	column="val1 val2"

と指定する．val₂が省略された場合，完全一致とみなす．
DATEは西暦年月日(YYYYMMDD; 年4桁, 月2桁, 日2桁)で指定する．

条件式の例

○ 【著作】の[著者]で検索．

article.author=\E{12345}

article.author={ \E{12345} \E{12346} }

article.author="Tokushima Taro"

article.author~"Tokushima Taro"

article.author={ \E{12345} \E{12346} "Tokushima Taro" }

○ 【著作】の第1[著者]で検索．

article.author[1]={ \E{12345} \E{12346} }

article.author[1]="Tokushima Taro"

○ 【著作】の第1,2,3[著者]で検索．

article.author[:3]={ \E{12345} \E{12346} }

article.author[:3]="Tokushima Taro"

○ 【著作】の第2,3[著者]で検索．

article.author[2:3]={ \E{12345} \E{12346} }

article.author[2:3]="Tokushima Taro"

○ 【著作】を組織{23456}に属している[著者]で検索．

article.author={ person.affiliation=\E{23456} }

○ 上記に[発行年月日]の条件をつけて検索．

article.{@.author={ person.affiliation=\E{23456} } @.date="20040000 20049999"}

○ 【組織】を期間限定属性で検索

organization.DATE="20050401"

EDB/Gateのコマンドにはトランザクションの開始(BEGIN)と終了(END)が用意されているが，これは，バックエンドデータベースのSQLにおける"BEGIN", "END"に1対1で対応していない．以下の点で異なる．

• EDB/Gateでトランザクションに入っていなくても，EDB/Gateでは各コマンド毎にバックエンドデータベースのトランザクションを開始，終了する．
• EDB/Gateでトランザクションに入っている場合には，バックエンドデータベースのトランザクションを維持するが，CHECK, MODIFY, UPDATABLE, UPDATE等のプライマリデータベース*に影響する/の影響を受ける*コマンドにおいては，別にバックエンドデータベースへのチャネルを開いてトランザクションを開始し，処理を行うことがある．

サーバのリソースを節約するため，アイドル状態が約60分以上経過すると自動的にEDB/Gateは接続を切断する．