include/idzebra/api.h

   1 /* $Id: api.h,v 1.14 2005-03-08 14:02:08 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 an int. Unix-like, 0 means OK,
  28     non-zero means an error. The error info should be available
  29     via zebra_errCode and friends.
  30 */
  31
  32 #ifndef IDZEBRA_API_H
  33 #define IDZEBRA_API_H
  34
  35 #include <yaz/odr.h>
  36 #include <yaz/oid.h>
  37 #include <yaz/proto.h>
  38 #include <idzebra/res.h>
  39 #include <idzebra/version.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 typedef struct {
  44     int processed;
  45     int inserted;
  46     int updated;
  47     int deleted;
  48     long utime;
  49     long stime;
  50 } ZebraTransactionStatus;
  51
  52 /* Retrieval Record Descriptor */
  53 typedef struct {
  54     int errCode;         /* non-zero if error when fetching this */
  55     char *errString;     /* error string */
  56     int position;        /* position of record in result set (1,2,..) */
  57     char *buf;           /* record buffer (void pointer really) */
  58     int len;             /* length */
  59     oid_value format;    /* record syntax */
  60     char *base;
  61     SYSNO sysno;
  62     int  score;
  63 } ZebraRetrievalRecord;
  64
  65 /* Scan Term Descriptor */
  66 typedef struct {
  67     int occurrences;     /* scan term occurrences */
  68     char *term;          /* scan term string */
  69 } ZebraScanEntry;
  70
  71 /** \var ZebraHandle
  72     \brief a Zebra Handle - (session)
  73 */
  74 typedef struct zebra_session *ZebraHandle;
  75
  76 /** \var ZebraService
  77     \brief a Zebra Service handle
  78 */
  79 typedef struct zebra_service *ZebraService;
  80
  81 /** \fn ZebraService zebra_start(const char *configName)
  82     \brief starts a Zebra service.
  83     \param configName name of configuration file
  84
  85     This function is a simplified version of zebra_start_res.
  86 */
  87 YAZ_EXPORT 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 /** \fn int zebra_stop(ZebraService zs)
 104     \brief stops a Zebra service.
 105     \param zs service handle
 106
 107     Frees resources used by the service.
 108 */
 109 YAZ_EXPORT
 110 int zebra_stop(ZebraService zs);
 111
 112 /** \fn void zebra_filter_info(ZebraService zs, void *cd,
 113     void(*cb)(void *cd, const char *name))
 114     \brief lists enabled Zebra filters
 115     \param zs service handle
 116     \param cd callback parameter (opaque)
 117     \param cb callback function
 118  */
 119 YAZ_EXPORT
 120 void zebra_filter_info(ZebraService zs, void *cd,
 121                        void (*cb)(void *cd, const char *name));
 122
 123
 124 /** \fn ZebraHandle zebra_open(ZebraService zs)
 125     \brief creates a Zebra session handle within service.
 126     \param zs service handle.
 127
 128     There should be one handle for each thread doing something
 129     with zebra, be that searching or indexing. In simple apps
 130     one handle is sufficient
 131 */
 132 YAZ_EXPORT ZebraHandle zebra_open(ZebraService zs);
 133
 134 /** \fn int zebra_close(ZebraHandle zh)
 135     \brief destroys Zebra session handle.
 136     \param zh zebra session handle.
 137  */
 138 YAZ_EXPORT int zebra_close(ZebraHandle zh);
 139
 140 /** \fn int zebra_errCode(ZebraHandle zh)
 141     \brief returns error code for last error
 142     \param zh zebra session handle.
 143 */
 144 YAZ_EXPORT int zebra_errCode(ZebraHandle zh);
 145
 146 /** \fn const char *zebra_errString(ZebraHandle zh)
 147     \brief returns error string for last error
 148     \param zh zebra session handle.
 149 */
 150 YAZ_EXPORT const char *zebra_errString(ZebraHandle zh);
 151
 152 /** \fn char *zebra_errAdd(ZebraHandle zh)
 153     \brief returns additional info for last error
 154     \param zh zebra session handle.
 155 */
 156 YAZ_EXPORT char *zebra_errAdd(ZebraHandle zh);
 157
 158 /** \fn int zebra_result(ZebraHandle zh, int *code, char **addinfo)
 159     \brief returns error code and additional info for last error
 160     \param zh zebra session handle.
 161     \param code pointer to returned error code
 162     \param addinfo pointer to returned additional info
 163 */
 164 YAZ_EXPORT int zebra_result(ZebraHandle zh, int *code, char **addinfo);
 165
 166 /** \fn void zebra_clearError(ZebraHandle zh)
 167     \brief clears last error.
 168     \param zh zebra session handle.
 169  */
 170 YAZ_EXPORT void zebra_clearError(ZebraHandle zh);
 171
 172 /** \fn int zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
 173     const char *setname, int *hits)
 174     \brief Search using PQF Query
 175     \param zh session handle
 176     \param pqf_query query
 177     \param setname name of resultset
 178     \param hits of hits is returned
 179  */
 180 YAZ_EXPORT int zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
 181                                 const char *setname, zint *hits);
 182
 183 /** \fn int zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
 184     const char *setname, zint *hits)
 185     \brief Search using RPN Query
 186     \param zh session handle
 187     \param o ODR handle
 188     \param query RPN query using YAZ structure
 189     \param setname name of resultset
 190     \param hits number of hits is returned
 191  */
 192 YAZ_EXPORT int zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
 193                                 const char *setname, zint *hits);
 194
 195 /**
 196     \fn int zebra_records_retrieve(ZebraHandle zh, ODR stream,
 197     const char *setname, Z_RecordComposition *comp, oid_value input_format,
 198     int num_recs, ZebraRetrievalRecord *recs)
 199     \brief retrieve records from result set (after search)
 200     \param zh session handle
 201     \param stream allocate records returned using this ODR
 202     \param setname name of result set to retrieve records from
 203     \param comp Z39.50 record composition
 204     \param input_format transfer syntax (OID)
 205     \param num_recs number of records to retrieve
 206     \param recs store records in this structure (size is num_recs)
 207 */
 208 YAZ_EXPORT int zebra_records_retrieve(ZebraHandle zh, ODR stream,
 209                        const char *setname, Z_RecordComposition *comp,
 210                        oid_value input_format,
 211                        int num_recs, ZebraRetrievalRecord *recs);
 212
 213 /**
 214    \fn int zebra_deleteResultSet(ZebraHandle zh, int function,
 215    int num_setnames, char **setnames, int *statuses)
 216    \brief delete one or more resultsets
 217    \param zh session handle
 218    \param function Z_DeleteResultSetRequest_{list,all}
 219    \param num_setnames number of result sets
 220    \param setnames result set names
 221    \param statuses status result
 222 */
 223 YAZ_EXPORT int zebra_deleteResultSet(ZebraHandle zh, int function,
 224                                      int num_setnames, char **setnames,
 225                                      int *statuses);
 226
 227
 228 /**
 229    \fn int zebra_scan(ZebraHandle zh, ODR stream,
 230    Z_AttributesPlusTerm *zapt, oid_value attributeset,
 231    int *position, int *num_entries, ZebraScanEntry **list, int *is_partial)
 232    \brief performs Scan (Z39.50 style)
 233    \param zh session handle
 234    \param stream ODR handle for result
 235    \param zapt Attribute plus Term (start term)
 236    \param attributeset Attributeset for Attribute plus Term
 237    \param position input/output position
 238    \param num_entries number of terms requested / returned
 239    \param list list of resulting terms (ODR allocated)
 240    \param is_partial upon return 1=partial, 0=complete
 241 */
 242 YAZ_EXPORT int zebra_scan(ZebraHandle zh, ODR stream,
 243                           Z_AttributesPlusTerm *zapt,
 244                           oid_value attributeset,
 245                           int *position, int *num_entries,
 246                           ZebraScanEntry **list,
 247                           int *is_partial);
 248
 249
 250 /**
 251    \fn int zebra_auth(ZebraHandle zh, const char *user, const char *pass)
 252    \brief authenticate user. Returns 0 if OK, != 0 on failure
 253    \param zh session handle
 254    \param user user name
 255    \param pass password
 256  */
 257 YAZ_EXPORT int zebra_auth(ZebraHandle zh, const char *user, const char *pass);
 258
 259
 260 /**
 261    \fn int zebra_string_norm(ZebraHandle zh, unsigned reg_id,
 262    const char *input_str, int input_len,
 263    char *output_str, int output_len)
 264    \brief normalize zebra term for register (subject to change!)
 265    \param zh session handle
 266    \param reg_id register ID, 'w', 'p',..
 267    \param input_str input string buffer
 268    \param input_len input string length
 269    \param output_str output string buffer
 270    \param output_len output string length
 271  */
 272 YAZ_EXPORT int zebra_string_norm(ZebraHandle zh, unsigned reg_id,
 273                                   const char *input_str, int input_len,
 274                                   char *output_str, int output_len);
 275
 276 /**
 277    \fn int zebra_create_database(ZebraHandle zh, const char *db)
 278    \brief creates a database
 279    \param zh session handle
 280    \param db database to be created
 281 */
 282 YAZ_EXPORT int zebra_create_database(ZebraHandle zh, const char *db);
 283
 284 /**
 285    \fn int zebra_drop_database(ZebraHandle zh, const char *db)
 286    \brief deletes a database (drop)
 287    \param zh session handle
 288    \param db database to be deleted
 289 */
 290 YAZ_EXPORT int zebra_drop_database(ZebraHandle zh, const char *db);
 291
 292 YAZ_EXPORT int zebra_admin_shutdown(ZebraHandle zh);
 293 YAZ_EXPORT int zebra_admin_start(ZebraHandle zh);
 294
 295 YAZ_EXPORT int zebra_shutdown(ZebraService zs);
 296
 297 YAZ_EXPORT int zebra_admin_import_begin(ZebraHandle zh, const char *database,
 298                                           const char *record_type);
 299
 300 YAZ_EXPORT int zebra_admin_import_segment(ZebraHandle zh,
 301                                             Z_Segment *segment);
 302
 303 YAZ_EXPORT int zebra_admin_import_end(ZebraHandle zh);
 304
 305 YAZ_EXPORT int zebra_admin_exchange_record(ZebraHandle zh,
 306                                  const char *rec_buf,
 307                                  size_t rec_len,
 308                                  const char *recid_buf, size_t recid_len,
 309                                  int action);
 310
 311 YAZ_EXPORT int zebra_begin_trans(ZebraHandle zh, int rw);
 312 YAZ_EXPORT int zebra_end_trans(ZebraHandle zh);
 313 YAZ_EXPORT int zebra_end_transaction(ZebraHandle zh, ZebraTransactionStatus *stat);
 314
 315 YAZ_EXPORT int zebra_commit(ZebraHandle zh);
 316 YAZ_EXPORT int zebra_clean(ZebraHandle zh);
 317
 318 YAZ_EXPORT int zebra_init(ZebraHandle zh);
 319 YAZ_EXPORT int zebra_compact(ZebraHandle zh);
 320 YAZ_EXPORT int zebra_repository_update(ZebraHandle zh, const char *path);
 321 YAZ_EXPORT int zebra_repository_delete(ZebraHandle zh, const char *path);
 322 YAZ_EXPORT int zebra_repository_show(ZebraHandle zh, const char *path);
 323
 324 YAZ_EXPORT int zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
 325
 326 YAZ_EXPORT int zebra_insert_record(ZebraHandle zh,
 327                          const char *recordType,
 328                          SYSNO *sysno, const char *match, const char *fname,
 329                          const char *buf, int buf_size,
 330                          int force_update);
 331 YAZ_EXPORT int zebra_update_record(ZebraHandle zh,
 332                          const char *recordType,
 333                          SYSNO *sysno, const char *match, const char *fname,
 334                          const char *buf, int buf_size,
 335                          int force_update);
 336 YAZ_EXPORT int zebra_delete_record(ZebraHandle zh,
 337                          const char *recordType,
 338                          SYSNO *sysno, const char *match, const char *fname,
 339                          const char *buf, int buf_size,
 340                          int force_update);
 341
 342 YAZ_EXPORT int zebra_resultSetTerms(ZebraHandle zh, const char *setname,
 343                                      int no, zint *count,
 344                                      int *type, char *out, size_t *len);
 345
 346 YAZ_EXPORT int zebra_sort(ZebraHandle zh, ODR stream,
 347                            int num_input_setnames,
 348                            const char **input_setnames,
 349                            const char *output_setname,
 350                            Z_SortKeySpecList *sort_sequence,
 351                            int *sort_status);
 352
 353 YAZ_EXPORT
 354 int zebra_select_databases(ZebraHandle zh, int num_bases,
 355                             const char **basenames);
 356
 357 YAZ_EXPORT
 358 int zebra_select_database(ZebraHandle zh, const char *basename);
 359
 360 YAZ_EXPORT
 361 int zebra_shadow_enable(ZebraHandle zh, int value);
 362
 363 YAZ_EXPORT
 364 int zebra_register_statistics(ZebraHandle zh, int dumpdict);
 365
 366 YAZ_EXPORT
 367 int zebra_record_encoding(ZebraHandle zh, const char *encoding);
 368
 369 YAZ_EXPORT
 370 int zebra_record_encoding(ZebraHandle zh, const char *encoding);
 371
 372 YAZ_EXPORT
 373 int zebra_octet_term_encoding(ZebraHandle zh, const char *encoding);
 374
 375 /* Resources */
 376 YAZ_EXPORT
 377 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
 378 YAZ_EXPORT
 379 const char *zebra_get_resource(ZebraHandle zh,
 380                 const char *name, const char *defaultvalue);
 381
 382
 383 YAZ_EXPORT void zebra_pidfname(ZebraService zs, char *path);
 384
 385 typedef struct {
 386     char *term;
 387     char *db;
 388     zint sysno;
 389     int score;
 390 } ZebraMetaRecord;
 391
 392 YAZ_EXPORT
 393 ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh,
 394                                            const char *name,
 395                                            int num, zint *positions);
 396
 397
 398 YAZ_EXPORT
 399 ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
 400                                                  const char *name,
 401                                                  zint start, int num);
 402
 403 YAZ_EXPORT
 404 void zebra_meta_records_destroy(ZebraHandle zh, ZebraMetaRecord *records,
 405                                 int num);
 406 YAZ_END_CDECL
 407 #endif