include/idzebra/api.h

   1 /* $Id: api.h,v 1.27 2005-06-22 19:42:38 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 /** \file api.h
  24     \brief Zebra API
  25
  26     Return codes:
  27     Most functions return ZEBRA_RES, where ZEBRA_FAIL indicates
  28     failure; ZEBRA_OK indicates success.
  29 */
  30
  31 #ifndef IDZEBRA_API_H
  32 #define IDZEBRA_API_H
  33
  34 #include <yaz/odr.h>
  35 #include <yaz/oid.h>
  36 #include <yaz/proto.h>
  37 #include <idzebra/res.h>
  38 #include <idzebra/version.h>
  39
  40 YAZ_BEGIN_CDECL
  41
  42 typedef struct {
  43     int processed;
  44     int inserted;
  45     int updated;
  46     int deleted;
  47     long utime;
  48     long stime;
  49 } ZebraTransactionStatus;
  50
  51 /** Retrieval Record Descriptor */
  52 typedef struct {
  53     int errCode;         /* non-zero if error when fetching this */
  54     char *errString;     /* error string */
  55     int position;        /* position of record in result set (1,2,..) */
  56     char *buf;           /* record buffer (void pointer really) */
  57     int len;             /* length */
  58     oid_value format;    /* record syntax */
  59     char *base;
  60     SYSNO sysno;
  61     int  score;
  62 } ZebraRetrievalRecord;
  63
  64 /** Scan Term Descriptor */
  65 typedef struct {
  66     int occurrences;     /* scan term occurrences */
  67     char *term;          /* scan term string */
  68 } ZebraScanEntry;
  69
  70 /** \var ZebraHandle
  71     \brief a Zebra Handle - (session)
  72 */
  73 typedef struct zebra_session *ZebraHandle;
  74
  75 /** \var ZebraService
  76     \brief a Zebra Service handle
  77 */
  78 typedef struct zebra_service *ZebraService;
  79
  80 /** \fn ZebraService zebra_start(const char *configName)
  81     \brief starts a Zebra service.
  82     \param configName name of configuration file
  83
  84     This function is a simplified version of zebra_start_res.
  85 */
  86 YAZ_EXPORT
  87 ZebraService zebra_start(const char *configName);
  88
  89 /** \fn ZebraService zebra_start_res(const char *configName, \
  90                                      Res def_res, Res over_res)
  91     \brief starts a Zebra service with resources.
  92     \param configName name of configuration file
  93     \param def_res default resources
  94     \param over_res overriding resources
  95
  96     This function typically called once in a program. A Zebra Service
  97     acts as a factory for Zebra session handles.
  98 */
  99 YAZ_EXPORT
 100 ZebraService zebra_start_res(const char *configName,
 101                              Res def_res, Res over_res);
 102
 103 /**
 104    \brief stops a Zebra service.
 105    \param zs service handle
 106
 107    Frees resources used by the service.
 108 */
 109 YAZ_EXPORT
 110 ZEBRA_RES zebra_stop(ZebraService zs);
 111
 112 /**
 113    \brief Lists enabled Zebra filters
 114    \param zs service handle
 115    \param cd callback parameter (opaque)
 116    \param cb callback function
 117  */
 118 YAZ_EXPORT
 119 void zebra_filter_info(ZebraService zs, void *cd,
 120                        void (*cb)(void *cd, const char *name));
 121
 122
 123 /**
 124    \brief Creates a Zebra session handle within service.
 125    \param zs service handle.
 126
 127    There should be one handle for each thread doing something
 128    with zebra, be that searching or indexing. In simple apps
 129    one handle is sufficient
 130 */
 131 YAZ_EXPORT
 132 ZebraHandle zebra_open(ZebraService zs);
 133
 134 /**
 135    \brief Destroys Zebra session handle.
 136    \param zh zebra session handle.
 137  */
 138 YAZ_EXPORT
 139 ZEBRA_RES zebra_close(ZebraHandle zh);
 140
 141 /**
 142    \brief Returns error code for last error
 143    \param zh zebra session handle.
 144 */
 145 YAZ_EXPORT
 146 int zebra_errCode(ZebraHandle zh);
 147
 148 /**
 149    \brief Returns error string for last error
 150    \param zh zebra session handle.
 151 */
 152 YAZ_EXPORT
 153 const char *zebra_errString(ZebraHandle zh);
 154
 155 /**
 156    \brief Returns additional info for last error
 157    \param zh zebra session handle.
 158 */
 159 YAZ_EXPORT
 160 char *zebra_errAdd(ZebraHandle zh);
 161
 162 /**
 163    \brief Returns error code and additional info for last error
 164    \param zh zebra session handle.
 165    \param code pointer to returned error code
 166    \param addinfo pointer to returned additional info
 167 */
 168 YAZ_EXPORT
 169 void zebra_result(ZebraHandle zh, int *code, char **addinfo);
 170
 171 /**
 172     \brief Clears last error.
 173     \param zh zebra session handle.
 174 */
 175 YAZ_EXPORT
 176 void zebra_clearError(ZebraHandle zh);
 177
 178
 179 /**
 180    \brief Set limit before Zebra does approx hit count
 181    \param zh session handle
 182    \param approx_limit the limit
 183
 184    Results will be approximiate if hit count is greater than the
 185    limit specified. By default there is a high-limit (no limit).
 186 */
 187 ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit);
 188
 189 /**
 190    \brief Search using PQF Query
 191    \param zh session handle
 192    \param pqf_query query
 193    \param setname name of resultset
 194    \param hits of hits is returned
 195  */
 196 YAZ_EXPORT
 197 ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
 198                            const char *setname, zint *hits);
 199
 200 /** \fn ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query, \
 201                 const char *setname, zint *hits)
 202     \brief Search using RPN Query
 203     \param zh session handle
 204     \param o ODR handle
 205     \param query RPN query using YAZ structure
 206     \param setname name of resultset
 207     \param hits number of hits is returned
 208  */
 209 YAZ_EXPORT
 210 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
 211                               const char *setname, zint *hits);
 212
 213 /**
 214     \fn ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream, \
 215                 const char *setname, Z_RecordComposition *comp, \
 216                 oid_value input_format, int num_recs, \
 217                 ZebraRetrievalRecord *recs)
 218     \brief Retrieve records from result set (after search)
 219     \param zh session handle
 220     \param stream allocate records returned using this ODR
 221     \param setname name of result set to retrieve records from
 222     \param comp Z39.50 record composition
 223     \param input_format transfer syntax (OID)
 224     \param num_recs number of records to retrieve
 225     \param recs store records in this structure (size is num_recs)
 226 */
 227 YAZ_EXPORT
 228 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
 229                                  const char *setname,
 230                                  Z_RecordComposition *comp,
 231                                  oid_value input_format,
 232                                  int num_recs,
 233                                  ZebraRetrievalRecord *recs);
 234 /**
 235    \brief Deletes one or more resultsets
 236    \param zh session handle
 237    \param function Z_DeleteResultSetRequest_{list,all}
 238    \param num_setnames number of result sets
 239    \param setnames result set names
 240    \param statuses status result
 241 */
 242 YAZ_EXPORT
 243 int zebra_deleteResultSet(ZebraHandle zh, int function,
 244                           int num_setnames, char **setnames,
 245                           int *statuses);
 246
 247
 248
 249 YAZ_EXPORT
 250 ZEBRA_RES zebra_result_set_term_no(ZebraHandle zh, const char *setname,
 251                                    int *num_terms);
 252
 253 YAZ_EXPORT
 254 ZEBRA_RES zebra_result_set_term_info(ZebraHandle zh, const char *setname,
 255                                      int no, zint *count, int *approx,
 256                                      char *termbuf, size_t *termlen,
 257                                      const char **term_ref_id);
 258
 259
 260 /**
 261    \brief performs Scan (Z39.50 style)
 262    \param zh session handle
 263    \param stream ODR handle for result
 264    \param zapt Attribute plus Term (start term)
 265    \param attributeset Attributeset for Attribute plus Term
 266    \param position input/output position
 267    \param num_entries number of terms requested / returned
 268    \param entries list of resulting terms (ODR allocated)
 269    \param is_partial upon return 1=partial, 0=complete
 270 */
 271 YAZ_EXPORT ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream,
 272                                 Z_AttributesPlusTerm *zapt,
 273                                 oid_value attributeset,
 274                                 int *position, int *num_entries,
 275                                 ZebraScanEntry **entries,
 276                                 int *is_partial);
 277
 278 /**
 279    \brief performs Scan (taking PQF string)
 280    \param zh session handle
 281    \param stream ODR handle for result
 282    \param query PQF scan query
 283    \param position input/output position
 284    \param num_entries number of terms requested / returned
 285    \param entries list of resulting terms (ODR allocated)
 286    \param is_partial upon return 1=partial, 0=complete
 287 */
 288 YAZ_EXPORT
 289 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
 290                     int *position, int *num_entries, ZebraScanEntry **entries,
 291                     int *is_partial);
 292
 293 /**
 294    \brief authenticate user. Returns 0 if OK, != 0 on failure
 295    \param zh session handle
 296    \param user user name
 297    \param pass password
 298  */
 299 YAZ_EXPORT
 300 ZEBRA_RES zebra_auth(ZebraHandle zh, const char *user, const char *pass);
 301
 302 /**
 303    \brief Normalize zebra term for register (subject to change!)
 304    \param zh session handle
 305    \param reg_id register ID, 'w', 'p',..
 306    \param input_str input string buffer
 307    \param input_len input string length
 308    \param output_str output string buffer
 309    \param output_len output string length
 310  */
 311 YAZ_EXPORT
 312 int zebra_string_norm(ZebraHandle zh, unsigned reg_id, const char *input_str,
 313                 int input_len, char *output_str, int output_len);
 314
 315 /**
 316    \brief Creates a database
 317    \param zh session handle
 318    \param db database to be created
 319 */
 320 YAZ_EXPORT
 321 ZEBRA_RES zebra_create_database(ZebraHandle zh, const char *db);
 322
 323 /**
 324    \brief Deletes a database (drop)
 325    \param zh session handle
 326    \param db database to be deleted
 327 */
 328 YAZ_EXPORT
 329 ZEBRA_RES zebra_drop_database(ZebraHandle zh, const char *db);
 330
 331 YAZ_EXPORT
 332 ZEBRA_RES zebra_admin_shutdown(ZebraHandle zh);
 333
 334 YAZ_EXPORT
 335 ZEBRA_RES zebra_admin_start(ZebraHandle zh);
 336
 337 YAZ_EXPORT
 338 ZEBRA_RES zebra_shutdown(ZebraService zs);
 339
 340 YAZ_EXPORT
 341 ZEBRA_RES zebra_admin_import_begin(ZebraHandle zh, const char *database,
 342                                    const char *record_type);
 343
 344 YAZ_EXPORT
 345 ZEBRA_RES zebra_admin_import_segment(ZebraHandle zh,
 346                                      Z_Segment *segment);
 347
 348 YAZ_EXPORT
 349 ZEBRA_RES zebra_admin_import_end(ZebraHandle zh);
 350
 351 YAZ_EXPORT
 352 ZEBRA_RES zebra_admin_exchange_record(ZebraHandle zh,
 353                                       const char *rec_buf,
 354                                       size_t rec_len,
 355                                       const char *recid_buf, size_t recid_len,
 356                                       int action);
 357
 358 YAZ_EXPORT
 359 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw);
 360
 361 YAZ_EXPORT
 362 ZEBRA_RES zebra_end_trans(ZebraHandle zh);
 363
 364 YAZ_EXPORT
 365 ZEBRA_RES zebra_end_transaction(ZebraHandle zh,
 366                                 ZebraTransactionStatus *stat);
 367
 368 YAZ_EXPORT
 369 ZEBRA_RES zebra_commit(ZebraHandle zh);
 370
 371 YAZ_EXPORT
 372 ZEBRA_RES zebra_clean(ZebraHandle zh);
 373
 374 YAZ_EXPORT
 375 ZEBRA_RES zebra_init(ZebraHandle zh);
 376
 377 YAZ_EXPORT
 378 ZEBRA_RES zebra_compact(ZebraHandle zh);
 379
 380 YAZ_EXPORT int zebra_repository_update(ZebraHandle zh, const char *path);
 381 YAZ_EXPORT int zebra_repository_delete(ZebraHandle zh, const char *path);
 382 YAZ_EXPORT int zebra_repository_show(ZebraHandle zh, const char *path);
 383
 384 YAZ_EXPORT int zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
 385
 386 YAZ_EXPORT
 387 ZEBRA_RES zebra_insert_record(ZebraHandle zh,
 388                               const char *recordType,
 389                               SYSNO *sysno, const char *match,
 390                               const char *fname,
 391                               const char *buf, int buf_size,
 392                               int force_update);
 393 YAZ_EXPORT
 394 ZEBRA_RES zebra_update_record(ZebraHandle zh,
 395                               const char *recordType,
 396                               SYSNO *sysno, const char *match,
 397                               const char *fname,
 398                               const char *buf, int buf_size,
 399                               int force_update);
 400 YAZ_EXPORT
 401 ZEBRA_RES zebra_delete_record(ZebraHandle zh,
 402                               const char *recordType,
 403                               SYSNO *sysno, const char *match, const char *fname,
 404                               const char *buf, int buf_size,
 405                               int force_update);
 406
 407 YAZ_EXPORT
 408 int zebra_resultSetTerms(ZebraHandle zh, const char *setname,
 409                          int no, zint *count,
 410                          int *type, char *out, size_t *len);
 411
 412 YAZ_EXPORT
 413 ZEBRA_RES zebra_sort(ZebraHandle zh, ODR stream,
 414                      int num_input_setnames,
 415                      const char **input_setnames,
 416                      const char *output_setname,
 417                      Z_SortKeySpecList *sort_sequence,
 418                      int *sort_status);
 419
 420 YAZ_EXPORT
 421 ZEBRA_RES zebra_select_databases(ZebraHandle zh, int num_bases,
 422                                  const char **basenames);
 423
 424 YAZ_EXPORT
 425 ZEBRA_RES zebra_select_database(ZebraHandle zh, const char *basename);
 426
 427 YAZ_EXPORT
 428 void zebra_shadow_enable(ZebraHandle zh, int value);
 429
 430 YAZ_EXPORT
 431 int zebra_register_statistics(ZebraHandle zh, int dumpdict);
 432
 433 YAZ_EXPORT
 434 ZEBRA_RES zebra_record_encoding(ZebraHandle zh, const char *encoding);
 435
 436 YAZ_EXPORT
 437 ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding);
 438
 439 /* Resources */
 440 YAZ_EXPORT
 441 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
 442 YAZ_EXPORT
 443 const char *zebra_get_resource(ZebraHandle zh,
 444                                const char *name, const char *defaultvalue);
 445
 446
 447 YAZ_EXPORT
 448 void zebra_pidfname(ZebraService zs, char *path);
 449
 450 typedef struct {
 451     char *term;
 452     char *db;
 453     zint sysno;
 454     int score;
 455 } ZebraMetaRecord;
 456
 457 YAZ_EXPORT
 458 ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh,
 459                                            const char *name,
 460                                            int num, zint *positions);
 461
 462
 463 YAZ_EXPORT
 464 ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
 465                                                  const char *name,
 466                                                  zint start, int num);
 467
 468 YAZ_EXPORT
 469 void zebra_meta_records_destroy(ZebraHandle zh, ZebraMetaRecord *records,
 470                                 int num);
 471
 472 YAZ_EXPORT
 473 struct BFiles_struct *zebra_get_bfs(ZebraHandle zh);
 474
 475 YAZ_EXPORT
 476 ZEBRA_RES zebra_set_limit(ZebraHandle zh, int complement_flag, zint *ids);
 477
 478 YAZ_END_CDECL
 479
 480 /** \mainpage Zebra
 481  *
 482  * \section intro_sec Introduction
 483  *
 484  * Zebra is a search engine for structure data, such as XML, MARC
 485  * and others. The following chapters briefly describe each of
 486  * Zebra major modules/components.
 487  *
 488  * \section util Base Utilities
 489  *
 490  * The Zebra utilities (util.h) defines fundamental types and a few
 491  * utilites for Zebra.
 492  *
 493  * \section res Resources
 494  *
 495  * The resources system (res.h) is a manager of configuration
 496  * resources. The resources can be viewed as a simple database.
 497  * Resources can be read from a configurtion file, they can be
 498  * read or written by an application. Resources can also be written,
 499  * but that facility is not currently in use.
 500  *
 501  * \section bfile Bfiles
 502  *
 503  * The Bfiles (bfile.h) provides a portable interface to the
 504  * local file system. It also provides a facility for safe updates
 505  * (shadow updates). All file system access is handle by this module
 506  * (except for trival reads of configuration files).
 507  *
 508  * \section dict Dictionary
 509  *
 510  * The Zebra dictionary (dict.h) maps a search term (key) to a value. The
 511  * value is a reference to the list of records identifers in which
 512  * the term occurs. Zebra uses an ISAM data structure for the list
 513  * of term occurrences. The Dictionary uses \ref bfile.
 514  *
 515  * \section isam ISAM
 516  *
 517  * Zebra maintains an ISAM for each term where each ISAM is a list
 518  * of record identifiers corresponding to the records in which the
 519  * term occur. Unlike traditional ISAM systems, the Zebra ISAM
 520  * is compressed. The ISAM system uses \ref bfile.
 521  *
 522  * Zebra has more than one ISAM system. The old and stable ISAM system
 523  * is named isamc (see isamc.h). Another version isams is a write-once
 524  * isam system that is quite compact - suitable for CD-ROMs (isams.h).
 525  * The newest ISAM system, isamb, is implemented as a B-Tree (see isamb.h).
 526  *
 527  * \section data1 Data-1
 528  *
 529  * The data1 (data1.h) module deals with structured documents. The module can
 530  * can read, modify and write documents. The document structure was
 531  * originally based on GRS-1 - a Z39.50 v3 structure that predates
 532  * DOM. These days the data1 structure may describe XML/SGML as well.
 533  * The data1, like DOM, is a tree structure. Each node in the tree
 534  * can be of type element, text (cdata), preprocessing instruction,
 535  * comment. Element nodes can point to attribute nodes.
 536  *
 537  * \section recctrl Record Control
 538  *
 539  * The record control module (recctrl.h) is responsible for
 540  * managing the various record types ("classes" or filters).
 541  *
 542  * \section rset Result-Set
 543  *
 544  * The Result-Set module (rset.h) defines an interface that all
 545  * Zebra Search Results must implement. Each operation (AND, OR, ..)
 546  * correspond to an implementation of that interface.
 547  *
 548  * \section dfa DFA
 549  *
 550  * DFA (dfa.h) Deterministic Finite Automa is a regular expression engine.
 551  * The module compiles a regular expression to a DFA. The DFA can then
 552  * be used in various application to perform fast match against the
 553  * origianl expression. The \ref Dict uses DFA to perform lookup
 554  * using regular expressions.
 555  */
 556
 557 #endif