1. リファレンス
  2. Oracle Text結果表

A Oracle Text結果表

この付録では、CTX_QUERY、CTX_DOCおよびCTX_THESパッケージのプロシージャによって生成された出力を格納するために使用する結果表の構造について説明します。

この付録の内容は次のとおりです。

A.1 CTX_QUERY結果表

結果を戻すCTX_QUERYプロシージャに対して、プロシージャがコールされる前に結果を格納するための表を作成しておく必要があります。表には自由に名前を付けることができますが、特定の名前およびデータ型を持つ列が組み込まれている必要があります。

この項では、次のタイプの結果表とその結果表に必要な列について説明します。

A.1.1 EXPLAIN表

この項では、EXPLAIN表について説明します。

A.1.1.1 EXPLAIN表構造

表A-1は、CTX_QUERY.EXPLAINによって結果が書き込まれる表の構造を示しています。

表A-1 EXPLAIN結果表

列名 データ型 説明

EXPLAIN_ID

VARCHAR2(30)

FEEDBACKコールで指定したexplain_id引数の値。

ID

NUMBER

問合せ実行ツリーの各ノードに割り当てられた番号。ルート・オペレーション・ノードでは、ID =1です。ノードは、解析ツリーでの表示のとおり、上から下、左から右の順に順序番号が付けられます。

PARENT_ID

NUMBER

IDステップの出力で操作する実行ステップのID。グラフィック的には、これは、問合せ実行ツリー内の親ノードです。ルート・オペレーション・ノード(ID =1)では、PARENT_ID = 0です。

OPERATION

VARCHAR2(30)

実行する内部操作の名前。有効な値は、表A-2を参照してください。

OPTIONS

VARCHAR2(30)

OPERATION列で示した操作のバリエーションを表す文字。OPERATIONに対応付けられた複数のOPTIONSがある場合、OPTIONSの値は処理の順に連結されます。有効な値は、表A-3を参照してください。

OBJECT_NAME

VARCHAR2(80)

セクション名、ワイルド・カード語句、重み、しきい値、または索引で検索する語句。

POSITION

NUMBER

同じPARENT_IDを持つすべてのノードの処理順序。位置は、昇順に1から番号が付けられます。

CARDINALITY

NUMBER

将来の使用のために予約されています。将来の互換性のためにこの列を作成してください。
A.1.1.2 EXPLAIN表のOPERATION列の値

表A-2は、EXPLAIN表のOPERATION列の有効な値を示しています。

表A-2 EXPLAIN表のOPERATION列

演算値 問合せ演算子 等価記号

ABOUT

ABOUT

該当なし

ACCUMULATE

ACCUM

,

AND

AND

&

COMPOSITE

(なし)

該当なし

EQUIVALENCE

EQUIV

=

MINUS

MINUS

-

NEAR

NEAR

;

NOT

NOT

~

NO_HITS

(この問合せからのヒットはありません)

該当なし

OR

OR

|

PHRASE

(検索する句)

該当なし

SECTION

(セクション)

該当なし

THRESHOLD

>

>

WEIGHT

*

*

WITHIN

WITHIN

該当なし

WORD

(単一語)

該当なし
A.1.1.3 EXPLAIN表のOPTIONS列の値

表A-3は、EXPLAIN表のOPTIONS列の有効な値を示しています。

表A-3 EXPLAIN表のOPTIONS列

OPTIONSの値 説明

($)

STEM

(?)

FUZZY

(!)

SOUNDEX

(T)

順序付けされたNEARの順序

(F)

順序付けされていないNEARの順序

(n)

NEAR演算子のmax_spanパラメータに対応付けられた数値

[9]

index_stemsが設定され、問合せがtoken_type 9を使用していることを示す

A.1.2 HFEEDBACK表

この項では、HFEEDBACK表について説明します。

A.1.2.1 HFEEDBACK表の構造

表A-4は、CTX_QUERY.HFEEDBACK によって結果が書き込まれる表の構造を示しています。

表A-4 HFEEDBACK結果表

列名 データ型 説明

FEEDBACK_ID

VARCHAR2(30)

HFEEDBACKコールで指定したfeedback_id引数の値。

ID

NUMBER

問合せ実行ツリーの各ノードに割り当てられた番号。ルート・オペレーション・ノードでは、ID =1です。ノードは、解析ツリーでの表示のとおり、上から下、左から右の順に順序番号が付けられます。

PARENT_ID

NUMBER

IDステップの出力で操作する実行ステップのID。グラフィック的には、これは、問合せ実行ツリー内の親ノードです。ルート・オペレーション・ノード(ID =1)では、PARENT_ID = 0です。

OPERATION

VARCHAR2(30)

実行する内部操作の名前。有効な値は、表A-5を参照してください。

OPTIONS

VARCHAR2(30)

OPERATION列で示した操作のバリエーションを表す文字。OPERATIONに対応付けられた複数のOPTIONSがある場合、OPTIONSの値は処理の順に連結されます。有効な値は、表A-6を参照してください。

OBJECT_NAME

VARCHAR2(80)

セクション名、ワイルド・カード語句、重み、しきい値、または索引で検索する語句。

POSITION

NUMBER

同じPARENT_IDを持つすべてのノードの処理順序。位置は、昇順に1から番号が付けられます。

BT_FEEDBACK

CTX_FEEDBACK_TYPE

上位フィードバック語を格納します。表A-7を参照してください。

PT_FEEDBACK

CTX_FEEDBACK_TYPE

関連フィードバック語を格納します。表A-7を参照してください。

NT_FEEDBACK

CTX_FEEDBACK_TYPE

下位フィードバック語を格納します。表A-7を参照してください。

A.1.2.2 HFEEDBACK表のOPERATION列の値

表A-5は、HFEEDBACK表のOPERATION列の有効な値を示しています。

表A-5 HFEEDBACK結果表のOPERATION列

演算値 問合せ演算子 等価記号

ABOUT

ABOUT

(none)

ACCUMULATE

ACCUM

,

AND

AND

&

EQUIVALENCE

EQUIV

=

MINUS

MINUS

-

NEAR

NEAR

;

NOT

NOT

~

OR

OR

|

SECTION

(セクション)

TEXT

テキスト問合せのワードまたは句

THEME

ABOUT問合せのワードまたは句

THRESHOLD

>

>

WEIGHT

*

*

WITHIN

WITHIN

(なし)
A.1.2.3 HFEEDBACK表のOPTIONS列の値

表A-6は、HFEEDBACK表のOPTIONS列の有効な値を示しています。

表A-6 HFEEDBACK結果表のOPTIONS列

OPTIONSの値 説明

(T)

順序付けされたNEARの順序

(F)

順序付けされていないNEARの順序

(n)

NEAR演算子のmax_spanパラメータに対応付けられた数値

A.1.2.4 CTX_FEEDBACK_TYPE

CTX_FEEDBACK_TYPEはオブジェクトのNESTED TABLEです。このデータ型はCTXSYSスキーマで事前定義済です。この型を使用して、BT_FEEDBACK、RT_FEEDBACKおよびNT_FEEDBACK列を定義します。

このネストした表CTX_FEEDBACK_TYPEは、CTXSYSスキーマで事前定義済のCTX_FEEDBACK_ITEM_TYPE型のオブジェクトを格納します。このオブジェクトは次のように、3つのメンバーと1つのメソッドで定義されています。

表A-7 CTX_FEEDBACK_ITEM_TYPE

CTX_FEEDBACK_ITEM_TYPEメンバーおよびメソッド 型 説明

text

NUMBER

フィードバック語

cardinality

NUMBER

(将来の拡張用)

score

NUMBER

(将来の拡張用)

これらのオブジェクトを定義するSQLコードは、次のとおりです。

CREATE OR REPLACE TYPE ctx_feedback_type AS TABLE OF ctx_feedback_item_type;
 
CREATE OR REPLACE TYPE ctx_feedback_item_type AS OBJECT 
(text        VARCHAR2(80), 
 cardinality NUMBER, 
 score       NUMBER, 
 MAP MEMBER FUNCTION rank RETURN REAL, 
 PRAGMA RESTRICT_REFERENCES (rank, RNDS, WNDS, RNPS, WNPS) 
); 
 
CREATE OR REPLACE TYPE BODY ctx_feedback_item_type AS 
   MAP MEMBER FUNCTION rank RETURN REAL IS 
   BEGIN 
      RETURN score; 
   END rank; 
END;

関連項目:

HFEEDBACK表およびそのネストした表からの選択方法の例は、「CTX_QUERYパッケージ」の「CTX_QUERY.HFEEDBACK」を参照してください。

A.2 CTX_DOC結果表

CTX_DOCプロシージャは、表に格納された結果を戻します。プロシージャをコールする前に、表を作成しておく必要があります。表には自由に名前を付けることができますが、特定の名前およびデータ型を持つ列が組み込まれている必要があります。

この項では、次のタイプの結果表とその結果表に必要な列について説明します。

A.2.1 フィルタ表

フィルタ表には、CTX_DOC.FILTER が戻したフィルタ処理されたドキュメントごとに1行が格納されます。フィルタ処理されたドキュメントは、プレーン・テキストまたはHTMLです。

ドキュメントにCTX_DOC.FILTERをコールした場合、そのドキュメントはテキスト列に対して定義されたフィルタで処理され、その結果が指定したフィルタ表に格納されます。

フィルタ表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-8 FILTER結果表

列名 型 説明

QUERY_ID

NUMBER

CTX_DOC.FILTERへの特定のコールで生成された結果の識別子(複数のFILTERコールの結果を表に格納するときのみ移入されます)。

DOCUMENT

CLOB

プレーン・テキストまたはHTMLで格納された、ドキュメントのテキスト。

A.2.2 要点表

要点表には、CTX_DOC.GISTが生成する要点/テーマ・サマリーごとに1行が格納されます。

要点表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-9 要点表

列名 型 説明

QUERY_ID

NUMBER

問合せID。

POV

VARCHAR2(80)

ドキュメント・テーマ。ドキュメントでのテーマの使用状況またはナレッジ・ベース内での表現方法によって異なります。

POVは、ドキュメントのGISTに対しては、GENERICの値を持ちます。

GIST

CLOB

プレーン・テキストとして格納された、要点またはテーマ・サマリーのテキスト。

A.2.3 ハイライト表

ハイライト表には、ドキュメント内のハイライト表示された語句のオフセットおよび長さの情報が格納されます。この情報は、CTX_DOC.HIGHLIGHT によって生成されます。ハイライト表示された語句は、ワード問合せまたはABOUT問合せを満たすワードまたは句です。

ドキュメントが形式設定されている場合、テキストはプレーン・テキストまたはHTMLのどちらかにフィルタ処理され、フィルタ処理されたテキストのオフセット情報が生成されます。オフセット情報を使用すると、CTX_DOC.FILTER でフィルタ処理された同じドキュメントの問合せ語句をハイライト表示できます。

ハイライト表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-10 ハイライト表

列名 型 説明

QUERY_ID

NUMBER

CTX_DOC.HIGHLIGHT への特定のコールで生成された結果の識別子(複数のHIGHLIGHTコールの結果を表に格納するときのみ移入されます)。

OFFSET

NUMBER

ドキュメント内のハイライト表示の位置(ドキュメントの開始位置1との相対的な位置)。

LENGTH

NUMBER

ハイライト表示の長さ。

A.2.4 マークアップ表

マークアップ表には、ドキュメント内にマークアップ・タグによってハイライト表示された問合せ語句があるプレーン・テキストまたはHTML形式のドキュメントが格納されます。この情報は、ユーザーがCTX_DOC.MARKUP をコールしたときに生成されます。

マークアップ表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-11 マークアップ表

列名 型 説明

QUERY_ID

NUMBER

CTX_DOC.MARKUPへの特定のコールで生成された結果の識別子(複数のMARKUPコールの結果を表に格納するときのみ移入されます)。

DOCUMENT

CLOB

プレーン・テキストまたはHTML形式で格納された、ドキュメントのマークアップされたテキスト。

A.2.5 テーマ表

テーマ表には、CTX_DOC.THEMESが生成したテーマごとに1行が格納されます。THEME列に格納される値は、単一のテーマ句か、コロンで区切られた親テーマの文字列のいずれかです。

テーマ表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-12 テーマ表

列名 型 説明

QUERY_ID

NUMBER

問合せID

THEME

VARCHAR2(2000)

テーマ句か、コロン(:)で区切られた親テーマの文字列。

WEIGHT

NUMBER

ドキュメントのその他のテーマ句と比較したテーマ句の重み。

A.2.6 トークン表

トークン表には、ドキュメントのテキスト・トークンが、CTX_DOC.TOKENSプロシージャの出力として格納されます。トークン表には自由に名前を付けることができますが、次の名前およびデータ型を持つ列が組み込まれている必要があります。

表A-13 トークン表

列名 型 説明

QUERY_ID

NUMBER

CTX_DOC.HIGHLIGHT への特定のコールで生成された結果の識別子(複数のHIGHLIGHTコールの結果を表に格納するときのみ移入されます)。

TOKEN

VARCHAR2(255)

テキスト内のトークン文字列。

OFFSET

NUMBER

ドキュメント内のトークンの位置(ドキュメントの開始位置1との相対的な位置)。

LENGTH

NUMBER

トークンの文字の長さ。
THES_TOKENS VARCHAR2(4000) TOKEN列のトークンのシソーラスを使用して生成されたシノニムまたは上位語。これらはコロンを使用して区切ります。

A.3 CTX_THES結果表およびデータ型

BT、NT、SYNなどのCTX_THES拡張ファンクションは、EXP_TAB型の表に拡張結果を戻すことができます。restab引数で表の名前を指定します。

A.3.1 EXP_TAB表型

EXP_TAB表型は、EXP_REC型の行の表です。

EXP_RECおよびEXP_TAB型は、CTXSYSスキーマで次のように定義されます。 

type exp_rec is record (
    xrel varchar2(12),
    xlevel number,
    xphrase varchar2(256)
);

type exp_tab is table of exp_rec index by binary_integer;

シソーラス拡張ファンクションをコールしてrestabを指定する場合、システムは拡張結果をEXP_TAB表として戻します。この表の各行は、EXP_REC型で、拡張のワードまたは句を表します。表A-14は、EXP_RECのフィールドを示しています。

表A-14 EXP_TAB表型(EXP_REC)

EXP_RECフィールド 説明

xrel

xrelフィールドには、語句と入力語句のリレーションが含まれます('SYN'、'PT'、'RT'など)。入力語句が拡張に表示されている場合、xrel値はPHRASEです。翻訳に対しては、xrel値は言語です。

xlevel

xlevelフィールドは、リレーションのレベルです。これは、主にxrelが階層リレーション(BT*/NT*)の場合に使用されます。

xlevelフィールドは、xrelがPHRASEのときは0(ゼロ)です。

xlevelフィールドは、TRSYNでのシノニムの翻訳の場合は2です。

xlevelフィールドは、PTやRTなどの階層でない演算子の場合は1です。

xphrase

xphraseは関連語です。関連語に修飾子が存在する場合は、カッコ内で囲みます。コンパウンド語句は、非コンパウンド化されません。