X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Ffield-structure.xml;h=bd46d2a5d71c222d4e0715148854099c1cb22044;hb=e70a548d193a5187b8074c439f2d7fa687a8e8c4;hp=6318dbe3f805bd686986fb077f2d3131edb5caf6;hpb=b9c1a6fcf5c4821d0190efdecbc14ea5d6c96aec;p=idzebra-moved-to-github.git diff --git a/doc/field-structure.xml b/doc/field-structure.xml index 6318dbe..bd46d2a 100644 --- a/doc/field-structure.xml +++ b/doc/field-structure.xml @@ -1,5 +1,5 @@ - + Field Structure and Character Sets @@ -262,134 +262,6 @@ -
- 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 - - - -