X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffield-structure.xml;h=6318dbe3f805bd686986fb077f2d3131edb5caf6;hb=8e584bbdc77d4c825ed3596c4d8c24a0ab7300e5;hp=758542b3ed84da1979baa1dcd1e15f414324f872;hpb=7b25277add2aae5caabee02213911aeeb65030c8;p=idzebra-moved-to-github.git diff --git a/doc/field-structure.xml b/doc/field-structure.xml index 758542b..6318dbe 100644 --- a/doc/field-structure.xml +++ b/doc/field-structure.xml @@ -1,5 +1,5 @@ - + Field Structure and Character Sets @@ -76,6 +76,27 @@ search containing space characters as a word proximity search. + + + firstinfield boolean + + + This directive enables or disables first-in-field indexing. + The value of the boolean should be 0 + (disable) or 1. + + + + + alwaysmatches boolean + + + This directive enables or disables alwaysmatches indexing. + The value of the boolean should be 0 + (disable) or 1. + + + charmap filename @@ -240,6 +261,135 @@ would both produce the same results. + +
+ Accessing Zebra internal record data using + the <literal>zebra::</literal> element sets + + Starting with Zebra version + 2.0.4-2 or newer, one has the possibility to + use the special + zebra::data, + zebra::meta and + zebra::index element set names. + + + + Usage of the zebra:: element sets accesses + record data directly from the internal storage, and will + therefore work exactly the same way, irrespectively of indexing + filter used. + + + These element set names are optimized for retrieval speed, and + will perform better than using for example + alvis filter XSLT based extraction of small + parts of the records. + + + + For example, to fetch the raw binary record data stored in the + zebra internal storage, or on the filesystem, the following + commands can be issued: + + Z> f @attr 1=title my + Z> format xml + Z> elements zebra::data + Z> s 1+1 + Z> format sutrs + Z> s 1+1 + Z> format usmarc + Z> s 1+1 + + + + + The special + zebra::data element set name is + defined for any record syntax, but will always fetch + the raw record data in exactly the original form. No record syntax + specific transformations will be applied to the raw record data. + + + + Also, Zebra internal metadata about the record can be accessed: + + Z> f @attr 1=title my + Z> format xml + Z> elements zebra::meta::sysno + Z> s 1+1 + + displays in XML record syntax only internal + record system number, whereas + + Z> f @attr 1=title my + Z> format xml + Z> elements zebra::meta + Z> s 1+1 + + displays all available metadata on the record. These include sytem + number, database name, indexed filename, filter used for indexing, + score and static ranking information and finally bytesize of record. + + + + The special + zebra::meta element set names are only + defined for + SUTRS and XML record + syntaxes. + + + + Sometimes, it is very hard to figure out what exactly has been + indexed how and in which indexes. Using the indexing stylesheet of + the Alvis filter, one can at least see which portion of the record + went into which index, but a similar aid does not exist for all + other indexing filters. + + + The special + zebra::index element set names are provided to + access information on per record indexed fields. For example, the + queries + + Z> f @attr 1=title my + Z> format sutrs + Z> elements zebra::index + Z> s 1+1 + + will display all indexed tokens from all indexed fields of the + first record, and it will display in SUTRS + record syntax, whereas + + Z> f @attr 1=title my + Z> format xml + Z> elements zebra::index::title + Z> s 1+1 + Z> elements zebra::index::title:p + Z> s 1+1 + + displays in XML record syntax only the content + of the zebra string index title, or + even only the type p phrase indexed part of it. + + + + The special zebra::index + element set names are only + defined for + SUTRS and XML record + syntaxes. + + Trying to access numeric Bib-1 use + attributes or trying to access non-existent zebra intern string + access points will result in a + + Diagnostic [25]: Specified element set name not valid for specified database + + + +