X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fserver.xml;h=4110f9a8e21d695808a1f9dab9a7bc0b66042d20;hb=ba673549208d47aff1fdec9cf23455dbb1aadfc8;hp=908b3eb6c12d63abfd1c7269fc80404d8c3ad28f;hpb=ffead55f11110e1502bbc40100e7f4654d3bb8bf;p=idzebra-moved-to-github.git diff --git a/doc/server.xml b/doc/server.xml index 908b3eb..4110f9a 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,5 +1,5 @@ - + The Z39.50 Server @@ -16,7 +16,7 @@ zebrasrv manpage --> - DESCRIPTION + Description 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 @@ -36,12 +36,12 @@ - SYNOPSIS + Synopsis &zebrasrv-synopsis; - OPTIONS + Options The options for zebrasrv are the same @@ -52,19 +52,13 @@ &zebrasrv-options; - VIRTUAL HOSTS - - zebrasrv uses the YAZ server frontend and does - support multiple virtual servers behind multiple listening sockets. - - &zebrasrv-virtual; - - FILES + + Files zebra.cfg - SEE ALSO + See Also zebraidx @@ -76,18 +70,6 @@ - Section "The Z39.50 Server" in the Zebra manual. - http://www.indexdata.dk/zebra/doc/server.tkl - - - Section "Virtual Hosts" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/server.vhosts.tkl - - - Section "Specification of CQL to RPN mappings" in the YAZ manual. - http://www.indexdata.dk/yaz/doc/tools.tkl#tools.cql.map - - The Zebra software is Copyright Index Data http://www.indexdata.dk and distributed under the @@ -497,8 +479,8 @@ - - + + Present @@ -552,6 +534,131 @@ timeout. + + + Explain + + Zebra maintains a "classic" + Explain database + on the side. + This database is called IR-Explain-1 and can be + searched using the attribute set exp-1. + + + The records in the explain database are of type + grs.sgml and can be retrieved as + SUTRS, XML, + GRS-1 and ASN.1 Explain. + + + Classic Explain only defines retrieaval of Explain information + via ASN.1. Pratically no Z39.50 clients supports this. Fortunately + they don't have to - since Zebra allows retrieaval of this information + in the other formats. + + + The root element for the Explain grs.sgml records is + explain, thus + explain.abs is used for indexing. + + + + Zebra must be able to locate + explain.abs in order to index the Explain + records properly. Zebra will work without it but the information + will not be searchable. + + + + The following Explain categories are supported: + CategoryList, TargetInfo, + DatabaseInfo, AttributeDetails. + + + The following Explain search atributes are supported: + ExplainCategory (@attr 1=1), + DatabaseName (@attr 1=3), + DateAdded (@attr 1=9), + DateChanged(@ayyt 1=10). + See tab/explain.att for more information. + + + + Example searches + + + Get targetinfo, that is, investigate which databases exist at + this server: + + Z> base IR-Explain-1 + Z> @attr exp1 1=1 targetinfo + Z> form xml + Z> show 1+1 + Z> form grs-1 + Z> show 1+1 + Z> form sutrs + Z> show 1+1 + + + + + List supported categories (using yaz-client), the number of hits + is the number of databases found, which most commonly are the + following two: + the Default and the + IR-Explain-1 databases. + + Z> base IR-Explain-1 + Z> f @attr exp1 1=1 databaseinfo + Z> form sutrs + Z> show 1+2 + + + + + List supported categories: + + Z> base IR-Explain-1 + Z> @attr exp1 1=1 categorylist + Z> form sutrs + Z> show 1+2 + + + + + + Get databaseinfo record for database Default. + + Z> base IR-Explain-1 + Z> @and @attr exp1 1=1 databaseinfo @attr exp1 1=3 Default + + Identicall query with explicitely specified attributeset: + + Z> base IR-Explain-1 + Z> @attrset exp1 @and @attr 1=1 databaseinfo @attr 1=3 Default + + + + + Get attribute details record for database + Default. + 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. + + Z> base IR-Explain-1 + Z> @and @attr exp1 1=1 attributedetails @attr exp1 1=3 Default + + Identicall query with explicitely specified attributeset: + + Z> base IR-Explain-1 + Z> @attrset exp1 @and @attr 1=1 attributedetails @attr 1=3 Default + + + + + @@ -751,7 +858,7 @@ Explain Zebra fully supports SRU's core - searchRetrieve + explain operation, as described at @@ -761,7 +868,68 @@ operation=explain and version-number specified) 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 + Virtual Hosts documentation. + + 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 + 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 .. + + + There is no linkeage whatsoever between the Z39.50 explain model + and the SRU/SRW 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. + + + + + Some SRU Examples + + Surf into http://localhost:9999 + to get an explain response, or use + + + + See number of hits for a query + + + + Fetch record 5-7 in Dublin Core format + + + + Even search using PQF queries using the extended naughty + verb x-pquery + + + + Or scan indexes using the extended extremely naughty + verb x-pScanClause + + Don't do this in production code! + But it's a great fast debugging aid. +