include/idzebra/api.h

   1 /* $Id: api.h,v 1.41 2006-11-21 22:17:49 adam Exp $
   2    Copyright (C) 1995-2006
   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 this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 */
  22
  23 /** \file api.h
  24     \brief Zebra API
  25
  26     Return codes:
  27     Most functions has return type 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     zint processed;
  44     zint inserted;
  45     zint updated;
  46     zint 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     zint sysno;
  61     int  score;
  62 } ZebraRetrievalRecord;
  63
  64 /** Scan Term Descriptor */
  65 typedef struct {
  66     zint 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 /** \brief Creates a Zebra Service.
  81     \param configName name of configuration file
  82
  83     This function is a simplified version of zebra_start_res.
  84 */
  85 YAZ_EXPORT
  86 ZebraService zebra_start(const char *configName
  87     ) ZEBRA_GCC_ATTR((warn_unused_result));
  88
  89 /** \brief Creates a Zebra service with resources.
  90     \param configName name of configuration file
  91     \param def_res default resources
  92     \param over_res overriding resources
  93
  94     This function typically called once in a program. A Zebra Service
  95     acts as a factory for Zebra session handles.
  96 */
  97 YAZ_EXPORT
  98 ZebraService zebra_start_res(const char *configName,
  99                              Res def_res, Res over_res
 100     ) ZEBRA_GCC_ATTR((warn_unused_result));
 101
 102 /** \brief stops a Zebra service.
 103     \param zs service handle
 104
 105     Frees resources used by the service.
 106 */
 107 YAZ_EXPORT
 108 ZEBRA_RES zebra_stop(ZebraService zs);
 109
 110 /** \brief Lists enabled Zebra filters
 111     \param zs service handle
 112     \param cd callback parameter (opaque)
 113     \param cb callback function
 114 */
 115 YAZ_EXPORT
 116 void zebra_filter_info(ZebraService zs, void *cd,
 117                        void (*cb)(void *cd, const char *name));
 118
 119
 120 /** \brief Creates a Zebra session handle within service.
 121     \param zs service handle.
 122     \param res resources to be used for the service (NULL for none)
 123
 124     There should be one handle for each thread doing something
 125     with zebra, be that searching or indexing. In simple apps
 126     one handle is sufficient
 127 */
 128 YAZ_EXPORT
 129 ZebraHandle zebra_open(ZebraService zs, Res res
 130     ) ZEBRA_GCC_ATTR((warn_unused_result));
 131
 132 /** \brief Destroys Zebra session handle.
 133     \param zh zebra session handle.
 134  */
 135 YAZ_EXPORT
 136 ZEBRA_RES zebra_close(ZebraHandle zh);
 137
 138 /** \brief Returns error code for last error
 139     \param zh zebra session handle.
 140 */
 141 YAZ_EXPORT
 142 int zebra_errCode(ZebraHandle zh);
 143
 144 /** \brief Returns error string for last error
 145     \param zh zebra session handle.
 146 */
 147 YAZ_EXPORT
 148 const char *zebra_errString(ZebraHandle zh);
 149
 150 /** \brief Returns additional info for last error
 151     \param zh zebra session handle.
 152 */
 153 YAZ_EXPORT
 154 char *zebra_errAdd(ZebraHandle zh);
 155
 156 /** \brief Returns error code and additional info for last error
 157     \param zh zebra session handle.
 158     \param code pointer to returned error code
 159     \param addinfo pointer to returned additional info
 160 */
 161 YAZ_EXPORT
 162 void zebra_result(ZebraHandle zh, int *code, char **addinfo);
 163
 164 /** \brief Set limit before Zebra does approx hit count
 165     \param zh session handle
 166     \param approx_limit the limit
 167
 168     Results will be approximiate if hit count is greater than the
 169     limit specified. By default there is a high-limit (no limit).
 170 */
 171 ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit);
 172
 173 /** \brief Search using PQF Query String
 174     \param zh session handle
 175     \param pqf_query query
 176     \param setname name of resultset
 177     \param hits of hits is returned
 178 */
 179 YAZ_EXPORT
 180 ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
 181                            const char *setname, zint *hits);
 182
 183 /** \brief Search using RPN Query structure (from ASN.1)
 184     \param zh session handle
 185     \param o ODR handle
 186     \param query RPN query using YAZ structure
 187     \param setname name of resultset
 188     \param hits number of hits is returned
 189 */
 190 YAZ_EXPORT
 191 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
 192                               const char *setname, zint *hits);
 193
 194 /** \brief Retrieve records from result set (after search)
 195     \param zh session handle
 196     \param stream allocate records returned using this ODR
 197     \param setname name of result set to retrieve records from
 198     \param comp Z39.50 record composition
 199     \param input_format transfer syntax (OID)
 200     \param num_recs number of records to retrieve
 201     \param recs store records in this structure (size is num_recs)
 202 */
 203 YAZ_EXPORT
 204 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
 205                                  const char *setname,
 206                                  Z_RecordComposition *comp,
 207                                  oid_value input_format,
 208                                  int num_recs,
 209                                  ZebraRetrievalRecord *recs);
 210 /** \brief Deletes one or more resultsets
 211     \param zh session handle
 212     \param function Z_DeleteResultSetRequest_{list,all}
 213     \param num_setnames number of result sets
 214     \param setnames result set names
 215     \param statuses status result
 216 */
 217 YAZ_EXPORT
 218 int zebra_deleteResultSet(ZebraHandle zh, int function,
 219                           int num_setnames, char **setnames,
 220                           int *statuses);
 221
 222
 223 /** \brief returns number of term info terms assocaited with result set
 224     \param zh session handle
 225     \param setname result set name
 226     \param num_terms number of terms returned in this integer
 227
 228     This function is used in conjunction with zebra_result_set_term_info.
 229     If operation was successful, ZEBRA_OK is returned; otherwise
 230     ZEBRA_FAIL is returned (typically non-existing setname)
 231 */
 232 YAZ_EXPORT
 233 ZEBRA_RES zebra_result_set_term_no(ZebraHandle zh, const char *setname,
 234                                    int *num_terms);
 235
 236 /** \brief returns information about a term assocated with a result set
 237     \param zh session handle
 238     \param setname result set name
 239     \param no the term we want to know about (0=first, 1=second,..)
 240     \param count the number of occurrences of this term, aka hits (output)
 241     \param approx about hits: 0=exact,1=approx (output)
 242     \param termbuf buffer for term string (intput, output)
 243     \param termlen size of termbuf (input=max, output=actual length)
 244     \param term_ref_id if non-NULL *term_ref_id holds term reference
 245
 246     Returns information about one search term associated with result set.
 247     Use zebra_result_set_term_no to read total number of terms associated
 248     with result set. If this function can not return information,
 249     due to no out of range or bad result set name, ZEBRA_FAIL is
 250     returned.
 251     The passed termbuf must be able to hold at least *termlen characters.
 252     Upon completion, *termlen holds actual length of search term.
 253 */
 254 YAZ_EXPORT
 255 ZEBRA_RES zebra_result_set_term_info(ZebraHandle zh, const char *setname,
 256                                      int no, zint *count, int *approx,
 257                                      char *termbuf, size_t *termlen,
 258                                      const char **term_ref_id);
 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     \param setname limit scan by this set (NULL means no limit)
 271 */
 272 YAZ_EXPORT ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream,
 273                                 Z_AttributesPlusTerm *zapt,
 274                                 oid_value attributeset,
 275                                 int *position, int *num_entries,
 276                                 ZebraScanEntry **entries,
 277                                 int *is_partial,
 278                                 const char *setname);
 279
 280 /** \brief performs Scan (taking PQF string)
 281     \param zh session handle
 282     \param stream ODR handle for result
 283     \param query PQF scan query
 284     \param position input/output position
 285     \param num_entries number of terms requested / returned
 286     \param entries list of resulting terms (ODR allocated)
 287     \param is_partial upon return 1=partial, 0=complete
 288     \param setname limit scan by this set (NULL means no limit)
 289 */
 290 YAZ_EXPORT
 291 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
 292                          int *position, int *num_entries,
 293                          ZebraScanEntry **entries,
 294                          int *is_partial, const char *setname);
 295
 296 /** \brief authenticate user. Returns 0 if OK, != 0 on failure
 297     \param zh session handle
 298     \param user user name
 299     \param pass password
 300 */
 301 YAZ_EXPORT
 302 ZEBRA_RES zebra_auth(ZebraHandle zh, const char *user, const char *pass);
 303
 304 /** \brief Normalize zebra term for register (subject to change!)
 305     \param zh session handle
 306     \param reg_id register ID, 'w', 'p',..
 307     \param input_str input string buffer
 308     \param input_len input string length
 309     \param output_str output string buffer
 310     \param output_len output string length
 311 */
 312 YAZ_EXPORT
 313 int zebra_string_norm(ZebraHandle zh, unsigned reg_id, const char *input_str,
 314                       int input_len, char *output_str, int output_len);
 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 /** \brief Deletes a database (drop)
 324     \param zh session handle
 325     \param db database to be deleted
 326 */
 327 YAZ_EXPORT
 328 ZEBRA_RES zebra_drop_database(ZebraHandle zh, const char *db);
 329
 330 YAZ_EXPORT
 331 ZEBRA_RES zebra_admin_shutdown(ZebraHandle zh);
 332
 333 YAZ_EXPORT
 334 ZEBRA_RES zebra_admin_start(ZebraHandle zh);
 335
 336 YAZ_EXPORT
 337 ZEBRA_RES zebra_shutdown(ZebraService zs);
 338
 339 YAZ_EXPORT
 340 ZEBRA_RES zebra_admin_import_begin(ZebraHandle zh, const char *database,
 341                                    const char *record_type);
 342
 343 YAZ_EXPORT
 344 ZEBRA_RES zebra_admin_import_segment(ZebraHandle zh,
 345                                      Z_Segment *segment);
 346
 347 YAZ_EXPORT
 348 ZEBRA_RES zebra_admin_import_end(ZebraHandle zh);
 349
 350 YAZ_EXPORT
 351 ZEBRA_RES zebra_admin_exchange_record(ZebraHandle zh,
 352                                       const char *rec_buf,
 353                                       size_t rec_len,
 354                                       const char *recid_buf, size_t recid_len,
 355                                       int action);
 356
 357 YAZ_EXPORT
 358 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw
 359     ) ZEBRA_GCC_ATTR((warn_unused_result));
 360
 361 YAZ_EXPORT
 362 ZEBRA_RES zebra_end_trans(ZebraHandle zh
 363     ) ZEBRA_GCC_ATTR((warn_unused_result));
 364
 365 YAZ_EXPORT
 366 ZEBRA_RES zebra_end_transaction(ZebraHandle zh,
 367                                 ZebraTransactionStatus *stat);
 368
 369 YAZ_EXPORT
 370 ZEBRA_RES zebra_commit(ZebraHandle zh);
 371
 372 YAZ_EXPORT
 373 ZEBRA_RES zebra_clean(ZebraHandle zh);
 374
 375 YAZ_EXPORT
 376 ZEBRA_RES zebra_init(ZebraHandle zh);
 377
 378 YAZ_EXPORT
 379 ZEBRA_RES zebra_compact(ZebraHandle zh);
 380
 381 YAZ_EXPORT
 382 ZEBRA_RES zebra_repository_update(ZebraHandle zh, const char *path);
 383
 384 YAZ_EXPORT
 385 ZEBRA_RES zebra_repository_delete(ZebraHandle zh, const char *path);
 386
 387 YAZ_EXPORT
 388 ZEBRA_RES zebra_repository_show(ZebraHandle zh, const char *path);
 389
 390 YAZ_EXPORT
 391 ZEBRA_RES zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
 392
 393 YAZ_EXPORT
 394 ZEBRA_RES zebra_insert_record(ZebraHandle zh,
 395                               const char *recordType,
 396                               zint *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_update_record(ZebraHandle zh,
 402                               const char *recordType,
 403                               zint *sysno, const char *match,
 404                               const char *fname,
 405                               const char *buf, int buf_size,
 406                               int force_update);
 407 YAZ_EXPORT
 408 ZEBRA_RES zebra_delete_record(ZebraHandle zh,
 409                               const char *recordType,
 410                               zint *sysno, const char *match,
 411                               const char *fname,
 412                               const char *buf, int buf_size,
 413                               int force_update);
 414
 415 YAZ_EXPORT
 416 ZEBRA_RES zebra_sort(ZebraHandle zh, ODR stream,
 417                      int num_input_setnames,
 418                      const char **input_setnames,
 419                      const char *output_setname,
 420                      Z_SortKeySpecList *sort_sequence,
 421                      int *sort_status
 422     ) ZEBRA_GCC_ATTR((warn_unused_result));
 423
 424 YAZ_EXPORT
 425 ZEBRA_RES zebra_select_databases(ZebraHandle zh, int num_bases,
 426                                  const char **basenames
 427     ) ZEBRA_GCC_ATTR((warn_unused_result));
 428
 429 YAZ_EXPORT
 430 ZEBRA_RES zebra_select_database(ZebraHandle zh, const char *basename
 431     ) ZEBRA_GCC_ATTR((warn_unused_result));
 432
 433 YAZ_EXPORT
 434 void zebra_shadow_enable(ZebraHandle zh, int value);
 435
 436 YAZ_EXPORT
 437 int zebra_register_statistics(ZebraHandle zh, int dumpdict);
 438
 439 YAZ_EXPORT
 440 ZEBRA_RES zebra_record_encoding(ZebraHandle zh, const char *encoding);
 441
 442 YAZ_EXPORT
 443 ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding);
 444
 445 /* Resources */
 446 YAZ_EXPORT
 447 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
 448 YAZ_EXPORT
 449 const char *zebra_get_resource(ZebraHandle zh,
 450                                const char *name, const char *defaultvalue);
 451
 452
 453 YAZ_EXPORT
 454 void zebra_pidfname(ZebraService zs, char *path);
 455
 456 typedef struct {
 457     char *term;
 458     char *db;
 459     zint sysno;
 460     int score;
 461 } ZebraMetaRecord;
 462
 463 YAZ_EXPORT
 464 ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh,
 465                                            const char *name,
 466                                            int num, zint *positions);
 467
 468
 469 YAZ_EXPORT
 470 ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
 471                                                  const char *name,
 472                                                  zint start, int num);
 473
 474 YAZ_EXPORT
 475 void zebra_meta_records_destroy(ZebraHandle zh, ZebraMetaRecord *records,
 476                                 int num);
 477
 478 YAZ_EXPORT
 479 struct BFiles_struct *zebra_get_bfs(ZebraHandle zh);
 480
 481 YAZ_EXPORT
 482 ZEBRA_RES zebra_set_limit(ZebraHandle zh, int complement_flag, zint *ids);
 483
 484 YAZ_END_CDECL
 485
 486 /** \mainpage Zebra
 487  *
 488  * \section intro_sec Introduction
 489  *
 490  * Zebra is a search engine for structure data, such as XML, MARC
 491  * and others.
 492  *
 493  * API users should read the api.h for all the public definitions.
 494  *
 495  * The remaining sections briefly describe each of
 496  * Zebra major modules/components.
 497  *
 498  * \section util Base Utilities
 499  *
 500  * The Zebra utilities (util.h) defines fundamental types and a few
 501  * utilites for Zebra.
 502  *
 503  * \section res Resources
 504  *
 505  * The resources system (res.h) is a manager of configuration
 506  * resources. The resources can be viewed as a simple database.
 507  * Resources can be read from a configurtion file, they can be
 508  * read or written by an application. Resources can also be written,
 509  * but that facility is not currently in use.
 510  *
 511  * \section bfile Bfiles
 512  *
 513  * The Bfiles (bfile.h) provides a portable interface to the
 514  * local file system. It also provides a facility for safe updates
 515  * (shadow updates). All file system access is handle by this module
 516  * (except for trival reads of configuration files).
 517  *
 518  * \section dict Dictionary
 519  *
 520  * The Zebra dictionary (dict.h) maps a search term (key) to a value. The
 521  * value is a reference to the list of records identifers in which
 522  * the term occurs. Zebra uses an ISAM data structure for the list
 523  * of term occurrences. The Dictionary uses \ref bfile.
 524  *
 525  * \section isam ISAM
 526  *
 527  * Zebra maintains an ISAM for each term where each ISAM is a list
 528  * of record identifiers corresponding to the records in which the
 529  * term occur. Unlike traditional ISAM systems, the Zebra ISAM
 530  * is compressed. The ISAM system uses \ref bfile.
 531  *
 532  * Zebra has more than one ISAM system. The old and stable ISAM system
 533  * is named isamc (see isamc.h). Another version isams is a write-once
 534  * isam system that is quite compact - suitable for CD-ROMs (isams.h).
 535  * The newest ISAM system, isamb, is implemented as a B-Tree (see isamb.h).
 536  *
 537  * \section data1 Data-1
 538  *
 539  * The data1 (data1.h) module deals with structured documents. The module can
 540  * can read, modify and write documents. The document structure was
 541  * originally based on GRS-1 - a Z39.50 v3 structure that predates
 542  * DOM. These days the data1 structure may describe XML/SGML as well.
 543  * The data1, like DOM, is a tree structure. Each node in the tree
 544  * can be of type element, text (cdata), preprocessing instruction,
 545  * comment. Element nodes can point to attribute nodes.
 546  *
 547  * \section recctrl Record Control
 548  *
 549  * The record control module (recctrl.h) is responsible for
 550  * managing the various record types ("classes" or filters).
 551  *
 552  * \section rset Result-Set
 553  *
 554  * The Result-Set module (rset.h) defines an interface that all
 555  * Zebra Search Results must implement. Each operation (AND, OR, ..)
 556  * correspond to an implementation of that interface.
 557  *
 558  * \section dfa DFA
 559  *
 560  * DFA (dfa.h) Deterministic Finite Automa is a regular expression engine.
 561  * The module compiles a regular expression to a DFA. The DFA can then
 562  * be used in various application to perform fast match against the
 563  * origianl expression. The \ref Dict uses DFA to perform lookup
 564  * using regular expressions.
 565  */
 566
 567 #endif
 568 /*
 569  * Local variables:
 570  * c-basic-offset: 4
 571  * indent-tabs-mode: nil
 572  * End:
 573  * vim: shiftwidth=4 tabstop=8 expandtab
 574  */
 575