X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fquerymodel.xml;h=afdb4078ceae66d6eb96dc5f100c4e03a8c6dfb9;hb=5ca4e60e990af6ad6b62ebff855d7b642f37c3ec;hp=cdb344d90153a72d25f4d328e35f5b594def22ab;hpb=e6ff84c71e457ff668dce640382fc1ad88c37d6d;p=idzebra-moved-to-github.git diff --git a/doc/querymodel.xml b/doc/querymodel.xml index cdb344d..afdb407 100644 --- a/doc/querymodel.xml +++ b/doc/querymodel.xml @@ -1,5 +1,5 @@ - + Query Model
@@ -9,7 +9,7 @@ Query Languages - Zebra is born as a networking Information Retrieval engine adhering + &zebra; is born as a networking Information Retrieval engine adhering to the international standards Z39.50 and SRU, @@ -42,7 +42,7 @@ Prefix Query Notation, or in short PQN. See for further explanations and - descriptions of Zebra's capabilities. + descriptions of &zebra;'s capabilities.
@@ -56,7 +56,7 @@ CQL is not natively supported. - Zebra can be configured to understand and map CQL to PQF. See + &zebra; can be configured to understand and map CQL to PQF. See . @@ -66,7 +66,7 @@
Operation types - Zebra supports all of the three different + &zebra; supports all of the three different Z39.50/SRU operations defined in the standards: explain, search, and scan. A short description of the @@ -150,7 +150,7 @@ The PQF grammar is documented in the YAZ manual, and shall not be repeated here. This textual PQF representation - is not transmistted to Zebra during search, but it is in the + is not transmistted to &zebra; during search, but it is in the client mapped to the equivalent Z39.50 binary query parse tree. @@ -173,13 +173,13 @@ Attribute sets Attribute sets define the exact meaning and semantics of queries - issued. Zebra comes with some predefined attribute set + issued. &zebra; comes with some predefined attribute set definitions, others can easily be defined and added to the configuration. - Attribute sets predefined in Zebra + Attribute sets predefined in &zebra; @@ -206,7 +206,7 @@ Standard PQF query language attribute set which defines the semantics of Z39.50 searching. In addition, all of the non-use attributes (types 2-12) define the hard-wired - Zebra internal query + &zebra; internal query processing. default @@ -237,7 +237,7 @@ - The Zebra internal query processing is modeled after + The &zebra; internal query processing is modeled after the Bib-1 attribute set, and the non-use attributes type 2-6 are hard-wired in. It is therefore essential to be familiar with . @@ -349,7 +349,7 @@ Atomic (APT) queries are always leaf nodes in the PQF query tree. UN-supplied non-use attributes types 2-12 are either inherited from - higher nodes in the query tree, or are set to Zebra's default values. + higher nodes in the query tree, or are set to &zebra;'s default values. See for details. @@ -369,7 +369,7 @@ List of orthogonal attributes Any of the orthogonal attribute types may be omitted, these are inherited from higher query tree nodes, or if not - inherited, are set to the default Zebra configuration values. + inherited, are set to the default &zebra; configuration values. @@ -427,7 +427,7 @@
Named Result Sets - Named result sets are supported in Zebra, and result sets can be + Named result sets are supported in &zebra;, and result sets can be used as operands without limitations. It follows that named result sets are leaf nodes in the PQF query tree, exactly as atomic APT queries are. @@ -462,28 +462,28 @@ Named result sets are only supported by the Z39.50 protocol. The SRU web service is stateless, and therefore the notion of - named result sets does not exist when accessing a Zebra server by + named result sets does not exist when accessing a &zebra; server by the SRU protocol.
- Zebra's special access point of type 'string' + &zebra;'s special access point of type 'string' The numeric use (type 1) attribute is usually referred to from a given - attribute set. In addition, Zebra let you use + attribute set. In addition, &zebra; let you use any internal index name defined in your configuration as use attribute value. This is a great feature for debugging, and when you do not need the complexity of defined use attribute values. It is - the preferred way of accessing Zebra indexes directly. + the preferred way of accessing &zebra; indexes directly. Finding all documents which have the term list "information - retrieval" in an Zebra index, using it's internal full string + retrieval" in an &zebra; index, using it's internal full string name. Scanning the same index. Z> find @attr 1=sometext "information retrieval" @@ -518,7 +518,7 @@
- Zebra's special access point of type 'XPath' + <title>&zebra;'s special access point of type 'XPath' for GRS filters As we have seen above, it is possible (albeit seldom a great @@ -634,7 +634,7 @@ Explain attribute set Exp-1, which is used to discover information about a server's search semantics and functional capabilities - Zebra exposes a "classic" + &zebra; exposes a "classic" Explain database by base name IR-Explain-1, which is populated with system internal information. @@ -679,7 +679,7 @@ Classic Explain only defines retrieval of Explain information via ASN.1. Practically no Z39.50 clients supports this. Fortunately - they don't have to - Zebra allows retrieval of this information + they don't have to - &zebra; allows retrieval of this information in other formats: SUTRS, XML, GRS-1 and ASN.1 Explain. @@ -741,7 +741,7 @@ Get attribute details record for database Default. - This query is very useful to study the internal Zebra indexes. + This query is very useful to study the internal &zebra; indexes. If records have been indexed using the alvis XSLT filter, the string representation names of the known indexes can be found. @@ -770,7 +770,7 @@ Attribute Set version from 2003. Index Data is not the copyright holder of this information, except for the configuration details, the listing of - Zebra's capabilities, and the example queries. + &zebra;'s capabilities, and the example queries. @@ -814,7 +814,7 @@ be sourced in the main configuration zebra.cfg. - In addition, Zebra allows the access of + In addition, &zebra; allows the access of internal index names and dynamic XPath as use attributes; see and @@ -835,7 +835,7 @@
- Zebra general Bib1 Non-Use Attributes (type 2-6) + &zebra; general Bib1 Non-Use Attributes (type 2-6)
Relation Attributes (type 2) @@ -1029,12 +1029,12 @@ - Zebra only supports first-in-field seaches if the + &zebra; only supports first-in-field seaches if the firstinfield is enabled for the index Refer to . - Zebra does not distinguish between first in field and + &zebra; does not distinguish between first in field and first in subfield. They result in the same hit count. - Searching for first position in (sub)field in only supported in Zebra + Searching for first position in (sub)field in only supported in &zebra; 2.0.2 and later. @@ -1046,7 +1046,7 @@ The structure attribute specifies the type of search term. This causes the search to be mapped on - different Zebra internal indexes, which must have been defined + different &zebra; internal indexes, which must have been defined at index time. @@ -1189,7 +1189,7 @@ The structure attribute value Local number (107) - is supported, and maps always to the Zebra internal document ID, + is supported, and maps always to the &zebra; internal document ID, irrespectively which use attribute is specified. The following queries have exactly the same unique record in the hit set: @@ -1213,7 +1213,7 @@ - The exact mapping between PQF queries and Zebra internal indexes + The exact mapping between PQF queries and &zebra; internal indexes and index types is explained in . @@ -1330,7 +1330,7 @@ The truncation attribute value - Regexp-2 (103) is a Zebra specific extension + Regexp-2 (103) is a &zebra; specific extension which allows fuzzy matches. One single error in spelling of search terms is allowed, i.e., a document is hit if it includes a term which can be mapped to the used @@ -1401,7 +1401,7 @@ Incomplete subfield (1) is the default, and - makes Zebra use + makes &zebra; use register type="w", whereas Complete field (3) triggers search and scan in index type="p". @@ -1409,13 +1409,13 @@ The Complete subfield (2) is a reminiscens from the happy MARC - binary format days. Zebra does not support it, but maps silently + binary format days. &zebra; does not support it, but maps silently to Complete field (3). - The exact mapping between PQF queries and Zebra internal indexes + The exact mapping between PQF queries and &zebra; internal indexes and index types is explained in . @@ -1427,9 +1427,9 @@
- Extended Zebra RPN Features + Extended &zebra; RPN Features - The Zebra internal query engine has been extended to specific needs + The &zebra; internal query engine has been extended to specific needs not covered by the bib-1 attribute set query model. These extensions are non-standard and non-portable: most functional extensions @@ -1441,9 +1441,9 @@
- Zebra specific retrieval of all records + &zebra; specific retrieval of all records - Zebra defines a hardwired string index name + &zebra; defines a hardwired string index name called _ALLRECORDS. It matches any record contained in the database, if used in conjunction with the relation attribute @@ -1470,28 +1470,28 @@ The special string index _ALLRECORDS is experimental, and the provided functionality and syntax may very - well change in future releases of Zebra. + well change in future releases of &zebra;.
- Zebra Search Attribute Extensions + &zebra; Search Attribute Extensions Name Value Operation - Zebra version + &zebra; version @@ -1542,7 +1542,7 @@
- Zebra Extension Embedded Sort Attribute (type 7) + &zebra; Extension Embedded Sort Attribute (type 7) The embedded sort is a way to specify sort within a query - thus removing the need to send a Sort Request separately. It is both @@ -1584,7 +1584,7 @@
@@ -2438,14 +2438,14 @@