X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;f=doc%2Fserver.xml;h=4110f9a8e21d695808a1f9dab9a7bc0b66042d20;hb=ba673549208d47aff1fdec9cf23455dbb1aadfc8;hp=fd4dc074de2bbf62811899d9807a74c33af64d22;hpb=2c0ee3249ef46031064a0e8e7d63bd400317f5e9;p=idzebra-moved-to-github.git diff --git a/doc/server.xml b/doc/server.xml index fd4dc07..4110f9a 100644 --- a/doc/server.xml +++ b/doc/server.xml @@ -1,5 +1,5 @@ - + The Z39.50 Server @@ -479,8 +479,8 @@ - - + + Present @@ -534,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 + + + + + @@ -743,6 +868,9 @@ 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 @@ -755,7 +883,8 @@ 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 ..). + in Zebra, that is ..). Zebra does not provide a means using + Z39.50 to obtain the ZeeRex record. @@ -764,49 +893,40 @@ 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 + ]]> + + + 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.