%local;
<!ENTITY % entities SYSTEM "entities.ent">
%entities;
- <!ENTITY % common SYSTEM "common/common.ent">
- %common;
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+ %idcommon;
]>
- <!-- $Id: zebrasrv.xml,v 1.3 2007-01-15 14:55:50 adam Exp $ -->
+ <!-- $Id: zebrasrv.xml,v 1.5 2007-05-22 11:12:53 adam Exp $ -->
<refentry id="zebrasrv">
<refentryinfo>
<productname>zebra</productname>
<refsect1><title>DESCRIPTION</title>
<para>Zebra is a high-performance, general-purpose structured text indexing
and retrieval engine. It reads structured records in a variety of input
- formats (eg. email, XML, MARC) and allows access to them through exact
+ formats (eg. email, &xml;, &marc;) and allows access to them through exact
boolean search expressions and relevance-ranked free-text queries.
</para>
<para>
- <command>zebrasrv</command> is the Z39.50 and SRU frontend
+ <command>zebrasrv</command> is the &z3950; and &sru; frontend
server for the <command>Zebra</command> search engine and indexer.
</para>
<para>
<para>
The options for <command>zebrasrv</command> are the same
- as those for YAZ' <command>yaz-ztest</command>.
+ as those for &yaz;' <command>yaz-ztest</command>.
Option <literal>-c</literal> specifies a Zebra configuration
file - if omitted <filename>zebra.cfg</filename> is read.
</para>
</refsect1>
<refsect1 id="protocol-support">
- <title>Z39.50 Protocol Support and Behavior</title>
+ <title>&z3950; Protocol Support and Behavior</title>
<refsect2 id="zebrasrv-initialization">
- <title>Z39.50 Initialization</title>
+ <title>&z3950; Initialization</title>
<para>
During initialization, the server will negotiate to version 3 of the
- Z39.50 protocol, and the option bits for Search, Present, Scan,
+ &z3950; protocol, and the option bits for Search, Present, Scan,
NamedResultSets, and concurrentOperations will be set, if requested by
the client. The maximum PDU size is negotiated down to a maximum of
1 MB by default.
</refsect2>
<refsect2 id="zebrasrv-search">
- <title>Z39.50 Search</title>
+ <title>&z3950; Search</title>
<para>
The supported query type are 1 and 101. All operators are currently
</refsect2>
<refsect2 id="zebrasrv-present">
- <title>Z39.50 Present</title>
+ <title>&z3950; Present</title>
<para>
The present facility is supported in a standard fashion. The requested
record syntax is matched against the ones supported by the profile of
- each record retrieved. If no record syntax is given, SUTRS is the
+ each record retrieved. If no record syntax is given, &sutrs; is the
default. The requested element set name, again, is matched against any
provided by the relevant record profiles.
</para>
</refsect2>
<refsect2 id="zebrasrv-scan">
- <title>Z39.50 Scan</title>
+ <title>&z3950; Scan</title>
<para>
The attribute combinations provided with the termListAndStartPoint are
processed in the same way as operands in a query (see above).
</para>
</refsect2>
<refsect2 id="zebrasrv-sort">
- <title>Z39.50 Sort</title>
+ <title>&z3950; Sort</title>
<para>
- Z39.50 specifies three different types of sort criteria.
+ &z3950; specifies three different types of sort criteria.
Of these Zebra supports the attribute specification type in which
case the use attribute specifies the "Sort register".
Sort registers are created for those fields that are of type "sort" in
</para>
<para>
- Z39.50 allows the client to specify sorting on one or more input
+ &z3950; allows the client to specify sorting on one or more input
result sets and one output result set.
Zebra supports sorting on one result set only which may or may not
be the same as the output result set.
</para>
</refsect2>
<refsect2 id="zebrasrv-close">
- <title>Z39.50 Close</title>
+ <title>&z3950; Close</title>
<para>
If a Close PDU is received, the server will respond with a Close PDU
with reason=FINISHED, no matter which protocol version was negotiated
</refsect2>
<refsect2 id="zebrasrv-explain">
- <title>Z39.50 Explain</title>
+ <title>&z3950; Explain</title>
<para>
Zebra maintains a "classic"
- <ulink url="&url.z39.50.explain;">Z39.50 Explain</ulink> database
+ <ulink url="&url.z39.50.explain;">&z3950; Explain</ulink> database
on the side.
This database is called <literal>IR-Explain-1</literal> and can be
searched using the attribute set <literal>exp-1</literal>.
</refsect2>
</refsect1>
<refsect1 id="zebrasrv-sru">
- <title>The SRU Server</title>
+ <title>The &sru; Server</title>
<para>
- In addition to Z39.50, Zebra supports the more recent and
- web-friendly IR protocol <ulink url="&url.sru;">SRU</ulink>.
- SRU can be carried over SOAP or a REST-like protocol
- that uses HTTP GET or POST to request search responses. The request
+ In addition to &z3950;, Zebra supports the more recent and
+ web-friendly IR protocol <ulink url="&url.sru;">&sru;</ulink>.
+ &sru; can be carried over &soap; or a &rest;-like protocol
+ that uses HTTP &get; or &post; to request search responses. The request
itself is made of parameters such as
<literal>query</literal>,
<literal>startRecord</literal>,
<literal>maximumRecords</literal>
and
<literal>recordSchema</literal>;
- the response is an XML document containing hit-count, result-set
- records, diagnostics, etc. SRU can be thought of as a re-casting
- of Z39.50 semantics in web-friendly terms; or as a standardisation
+ the response is an &xml; document containing hit-count, result-set
+ records, diagnostics, etc. &sru; can be thought of as a re-casting
+ of &z3950; semantics in web-friendly terms; or as a standardisation
of the ad-hoc query parameters used by search engines such as Google
and AltaVista; or as a superset of A9's OpenSearch (which it
predates).
</para>
<para>
- Zebra supports Z39.50, SRU GET, SRU POST, SRU SOAP (SRW)
+ Zebra supports &z3950;, &sru; &get;, SRU &post;, SRU &soap; (&srw;)
- on the same port, recognising what protocol is used by each incoming
requests and handling them accordingly. This is a achieved through
the use of Deep Magic; civilians are warned not to stand too close.
</para>
<refsect2 id="zebrasrv-sru-run">
- <title>Running zebrasrv as an SRU Server</title>
+ <title>Running zebrasrv as an &sru; Server</title>
<para>
Because Zebra supports all protocols on one port, it would
- seem to follow that the SRU server is run in the same way as
- the Z39.50 server, as described above. This is true, but only in
+ seem to follow that the &sru; server is run in the same way as
+ the &z3950; server, as described above. This is true, but only in
an uninterestingly vacuous way: a Zebra server run in this manner
- will indeed recognise and accept SRU requests; but since it
- doesn't know how to handle the CQL queries that these protocols
+ will indeed recognise and accept &sru; requests; but since it
+ doesn't know how to handle the &cql; queries that these protocols
use, all it can do is send failure responses.
</para>
<note>
<para>
- It is possible to cheat, by having SRU search Zebra with
- a PQF query instead of CQL, using the
+ It is possible to cheat, by having &sru; search Zebra with
+ a &pqf; query instead of &cql;, using the
<literal>x-pquery</literal>
parameter instead of
<literal>query</literal>.
This is a
<emphasis role="strong">non-standard extension</emphasis>
- of CQL, and a
+ of &cql;, and a
<emphasis role="strong">very naughty</emphasis>
- thing to do, but it does give you a way to see Zebra serving SRU
+ thing to do, but it does give you a way to see Zebra serving &sru;
``right out of the box''. If you start your favourite Zebra
server in the usual way, on port 9999, then you can send your web
browser to:
&maximumRecords=1
</screen>
<para>
- This will display the XML-formatted SRU response that includes the
+ This will display the &xml;-formatted &sru; response that includes the
first record in the result-set found by the query
- <literal>mineral</literal>. (For clarity, the SRU URL is shown
+ <literal>mineral</literal>. (For clarity, the &sru; URL is shown
here broken across lines, but the lines should be joined to gether
to make single-line URL for the browser to submit.)
</para>
</note>
<para>
- In order to turn on Zebra's support for CQL queries, it's necessary
- to have the YAZ generic front-end (which Zebra uses) translate them
- into the Z39.50 Type-1 query format that is used internally. And
+ In order to turn on Zebra's support for &cql; queries, it's necessary
+ to have the &yaz; generic front-end (which Zebra uses) translate them
+ into the &z3950; Type-1 query format that is used internally. And
to do this, the generic front-end's own configuration file must be
used. See <xref linkend="gfs-config"/>;
- the salient point for SRU support is that
+ the salient point for &sru; support is that
<command>zebrasrv</command>
must be started with the
<literal>-f frontendConfigFile</literal>
<literal>-c zebraConfigFile</literal>
option,
and that the front-end configuration file must include both a
- reference to the Zebra configuration file and the CQL-to-PQF
+ reference to the Zebra configuration file and the &cql;-to-&pqf;
translator configuration file.
</para>
<para>
<literal>-c</literal>
command-line argument, and the
<literal><cql2rpn></literal>
- element contains the name of the CQL properties file specifying how
- various CQL indexes, relations, etc. are translated into Type-1
+ element contains the name of the &cql; properties file specifying how
+ various &cql; indexes, relations, etc. are translated into Type-1
queries.
</para>
<para>
A zebra server running with such a configuration can then be
- queried using proper, conformant SRU URLs with CQL queries:
+ queried using proper, conformant &sru; URLs with &cql; queries:
</para>
<screen>
http://localhost:9999/Default?version=1.1
</refsect2>
</refsect1>
<refsect1 id="zebrasrv-sru-support">
- <title>SRU Protocol Support and Behavior</title>
+ <title>&sru; Protocol Support and Behavior</title>
<para>
- Zebra running as an SRU server supports SRU version 1.1, including
- CQL version 1.1. In particular, it provides support for the
+ Zebra running as an &sru; server supports SRU version 1.1, including
+ &cql; version 1.1. In particular, it provides support for the
following elements of the protocol.
</para>
<refsect2 id="zebrasrvr-search-and-retrieval">
- <title>SRU Search and Retrieval</title>
+ <title>&sru; Search and Retrieval</title>
<para>
Zebra supports the
- <ulink url="&url.sru.searchretrieve;">SRU searchRetrieve</ulink>
+ <ulink url="&url.sru.searchretrieve;">&sru; searchRetrieve</ulink>
operation.
</para>
<para>
- One of the great strengths of SRU is that it mandates a standard
- query language, CQL, and that all conforming implementations can
+ One of the great strengths of &sru; is that it mandates a standard
+ query language, &cql;, and that all conforming implementations can
therefore be trusted to correctly interpret the same queries. It
is with some shame, then, that we admit that Zebra also supports
an additional query language, our own Prefix Query Format
- (<ulink url="&url.yaz.pqf;">PQF</ulink>).
- A PQF query is submitted by using the extension parameter
+ (<ulink url="&url.yaz.pqf;">&pqf;</ulink>).
+ A &pqf; query is submitted by using the extension parameter
<literal>x-pquery</literal>,
in which case the
<literal>query</literal>
- parameter must be omitted, which makes the request not valid SRU.
+ parameter must be omitted, which makes the request not valid &sru;.
Please feel free to use this facility within your own
- applications; but be aware that it is not only non-standard SRU
+ applications; but be aware that it is not only non-standard &sru;
but not even syntactically valid, since it omits the mandatory
<literal>query</literal> parameter.
</para>
</refsect2>
<refsect2 id="zebrasrv-sru-scan">
- <title>SRU Scan</title>
+ <title>&sru; Scan</title>
<para>
- Zebra supports <ulink url="&url.sru.scan;">SRU scan</ulink>
+ Zebra supports <ulink url="&url.sru.scan;">&sru; scan</ulink>
operation.
- Scanning using CQL syntax is the default, where the
+ Scanning using &cql; syntax is the default, where the
standard <literal>scanClause</literal> parameter is used.
</para>
<para>
In addition, a
- mutant form of SRU scan is supported, using
+ mutant form of &sru; scan is supported, using
the non-standard <literal>x-pScanClause</literal> parameter in
place of the standard <literal>scanClause</literal> to scan on a
- PQF query clause.
+ &pqf; query clause.
</para>
</refsect2>
<refsect2 id="zebrasrv-sru-explain">
- <title>SRU Explain</title>
+ <title>&sru; Explain</title>
<para>
- Zebra supports <ulink url="&url.sru.explain;">SRU explain</ulink>.
+ Zebra supports <ulink url="&url.sru.explain;">&sru; explain</ulink>.
</para>
<para>
The ZeeRex record explaining a database may be requested either
- with a fully fledged SRU request (with
+ with a fully fledged &sru; request (with
<literal>operation</literal>=<literal>explain</literal>
and version-number specified)
- or with a simple HTTP GET at the server's basename.
+ or with a simple HTTP &get; at the server's basename.
The ZeeRex record returned in response is the one embedded
- in the YAZ Frontend Server configuration file that is described in the
+ in the &yaz; Frontend Server configuration file that is described in the
<xref linkend="gfs-config"/>.
</para>
<para>
Unfortunately, the data found in the
- CQL-to-PQF text file must be added by hand-craft into the explain
- section of the YAZ Frontend Server configuration file to be able
+ &cql;-to-&pqf; text file must be added by hand-craft into the explain
+ section of the &yaz; Frontend Server configuration file to be able
to provide a suitable explain record.
Too bad, but this is all extreme
new alpha stuff, and a lot of work has yet to be done ..
</para>
<para>
- There is no linkeage whatsoever between the Z39.50 explain model
- and the SRU explain response (well, at least not implemented
+ There is no linkeage whatsoever between the &z3950; explain model
+ and the &sru; explain response (well, at least not implemented
in Zebra, that is ..). Zebra does not provide a means using
- Z39.50 to obtain the ZeeRex record.
+ &z3950; to obtain the ZeeRex record.
</para>
</refsect2>
<refsect2 id="zebrasrv-non-sru-ops">
- <title>Other SRU operations</title>
+ <title>Other &sru; operations</title>
<para>
- In the Z39.50 protocol, Initialization, Present, Sort and Close
- are separate operations. In SRU, however, these operations do not
+ In the &z3950; protocol, Initialization, Present, Sort and Close
+ are separate operations. In &sru;, however, these operations do not
exist.
</para>
<itemizedlist>
<listitem>
<para>
- SRU has no explicit initialization handshake phase, but
+ &sru; has no explicit initialization handshake phase, but
commences immediately with searching, scanning and explain
operations.
</para>
</listitem>
<listitem>
<para>
- Neither does SRU have a close operation, since the protocol is
+ Neither does &sru; have a close operation, since the protocol is
stateless and each request is self-contained. (It is true that
- multiple SRU request/response pairs may be implemented as
+ multiple &sru; request/response pairs may be implemented as
multiple HTTP request/response pairs over a single persistent
TCP/IP connection; but the closure of that connection is not a
protocol-level operation.)
</listitem>
<listitem>
<para>
- Retrieval in SRU is part of the
+ Retrieval in &sru; is part of the
<literal>searchRetrieve</literal> operation, in which a search
is submitted and the response includes a subset of the records
- in the result set. There is no direct analogue of Z39.50's
+ in the result set. There is no direct analogue of &z3950;'s
Present operation which requests records from an established
- result set. In SRU, this is achieved by sending a subsequent
+ result set. In &sru;, this is achieved by sending a subsequent
<literal>searchRetrieve</literal> request with the query
<literal>cql.resultSetId=</literal><emphasis>id</emphasis> where
<emphasis>id</emphasis> is the identifier of the previously
</listitem>
<listitem>
<para>
- Sorting in CQL is done within the
+ Sorting in &cql; is done within the
<literal>searchRetrieve</literal> operation - in v1.1, by an
explicit <literal>sort</literal> parameter, but the forthcoming
v1.2 or v2.0 will most likely use an extension of the query
- language, <ulink url="&url.cql.sorting;">CQL sorting</ulink>.
+ language, <ulink url="&url.cql.sorting;">&cql; sorting</ulink>.
</para>
</listitem>
</itemizedlist>
<para>
- It can be seen, then, that while Zebra operating as an SRU server
+ It can be seen, then, that while Zebra operating as an &sru; server
does not provide the same set of operations as when operating as a
- Z39.50 server, it does provide equivalent functionality.
+ &z3950; server, it does provide equivalent functionality.
</para>
</refsect2>
</refsect1>
<refsect1 id="zebrasrv-sru-examples">
- <title>SRU Examples</title>
+ <title>&sru; Examples</title>
<para>
Surf into <literal>http://localhost:9999</literal>
to get an explain response, or use
]]></screen>
</para>
<para>
- Even search using PQF queries using the <emphasis>extended naughty
+ Even search using &pqf; queries using the <emphasis>extended naughty
parameter</emphasis> <literal>x-pquery</literal>
<screen><
projects / idzebra-moved-to-github.git / blobdiff