<クエリー>の派生コマンドであり、同時に返される検索結果の数を制限するために使用されます。検索とクエリの一般情報については、<クエリー>を参照してください。
query-exコマンドの結果には、<query-token>要素が含まれている場合があります。後続のquery-exコマンドではquery-token要素が使用されて、追加の結果が取得されます。query-exの結果にquery-token要素が含まれていない場合は、そのquery-exコマンドの取得可能な結果がすべて返されます。結果セットごとに異なるquery-tokenが返される場合があります。最初の結果セットで返されたquery-tokenのみを使用することは十分ではありません。
query-exコマンドには、queryコマンドにはない次の追加属性があります。
max-result-count属性は、単一のquery-exコマンドの結果として返す<インスタンス>要素の最大数を指定します。
cancel属性は、query-exシーケンスを取り消すために使用され、その結果、検索に関連付けられたすべてのリソースが解放されます。
query-exコマンドシーケンスは、連続して発行された複数のquery-exコマンドで構成される場合があります。最初のquery-exコマンドは、検索パラメータを設定して、初期結果セットを返しますが、初期結果セットで返すことができない追加の結果がある場合は、後続のquery-exコマンドで使用される も返します。後続のquery-exコマンドはquery-token要素を含んでおり、初期検索から追加の結果セットを取得するために繰り返し発行されます。このプロセスは、結果セット内にquery-token要素がなくなるまで継続されます。
前のquery-exから返されたトークンを使用している後続のquery-exコマンドは、属性や子要素にかかわらず検索パラメータを変更しません。
query-exコマンドでcancel属性をtrueに設定することで、すべての結果が返される前にquery-exシーケンスを中止できます。
すべてのアプリケーションシムがquery-exをサポートしているわけではありません。query-exをサポートしているアプリケーションシムは、シムの起動時にメタディレクトリエンジンにそのことを報告します。この報告のために、ドライバ識別クエリへの応答として返された<インスタンス>要素の子として以下を返します。
<attr attr-name="query-ex-supported"> <value type="state">true</value> </attr>
<!-- search the whole application for all User objects --><!-- don't read any attributes --><query-ex class-name="User" event-id="0" scope="subtree" max-result-count="50"> <search-class class-name="User"/> <read-attr/></query-ex><!-- read additional results based on the above query, assuming thatthe results of the above included the query-token illustrated --><query-ex> <query-token>rO0ABXNyACxjb20ubm92ZWxsLm5kcy5kaXJ4bWwuZW5naW5lLk5EU1JlYWRlciRUb2tlbuWeJE0ga5xBAgACSgAFc3RhbXBJAAlzdGF0ZUhhc2h4cAAAAQQLokQbAbjW9w==</query-token></query-ex><!-- cancel a query-ex before having read all results --><query-ex cancel="true"> <query-token>rO0ABXNyACxjb20ubm92ZWxsLm5kcy5kaXJ4bWwuZW5naW5lLk5EU1JlYWRlciRUb2tlbuWeJE0ga5xBAgACSgAFc3RhbXBJAAlzdGF0ZUhhc2h4cAAAAQQLokQbAbjW9w==</query-token></query-ex>
|
属性 |
有効値 |
デフォルト値 |
|---|---|---|
|
キャンセル |
<query-token>要素が含まれたquery-exコマンドでtrueに設定した場合は、検索は中止されて、すべての関連付けられたリソースは検索ターゲットによって解放されます。 |
#IMPLIED |
|
class-name |
CDATA オブジェクトのベースクラスの名前。
|
#IMPLIED |
|
dest-dn |
CDATA |
#IMPLIED |
|
|
CDATA 予約済み。 |
#IMPLIED |
|
|
CDATA
|
#IMPLIED |
|
max-result-count |
CDATA query-exコマンドの結果として返す<インスタンス>要素の最大数を指定します。有効な値は正の10進整数です。 |
#IMPLIED |
|
scope |
クエリのスコープ。entryスコープは、query-exではほとんど意味がありませんがサポートされています。 |
( association ? , query-token ? , ( search-class | search-attr | read-attr | read-parent ) * , operation-data ? )