include/idzebra/api.h

   1 /* $Id: api.h,v 1.12 2005-01-21 19:07:25 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 ZEBRAAPI_H
  33 #define ZEBRAAPI_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, int *hits);
 182
 183 /** \fn int zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
 184     const char *setname, int *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, int *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 /* Browse */
 229 YAZ_EXPORT int zebra_scan(ZebraHandle zh, ODR stream,
 230                           Z_AttributesPlusTerm *zapt,
 231                           oid_value attributeset,
 232                           int *position, int *num_entries,
 233                           ZebraScanEntry **list,
 234                           int *is_partial);
 235
 236
 237 /*********
 238  * Other
 239  */
 240
 241 /* do authentication */
 242 YAZ_EXPORT int zebra_auth(ZebraHandle zh, const char *user, const char *pass);
 243
 244 /* Character normalisation on specific register .
 245    This routine is subject to change - do not use. */
 246 YAZ_EXPORT int zebra_string_norm(ZebraHandle zh, unsigned reg_id,
 247                                   const char *input_str, int input_len,
 248                                   char *output_str, int output_len);
 249
 250
 251 /******
 252  * Admin
 253  */
 254
 255 YAZ_EXPORT int zebra_create_database(ZebraHandle zh, const char *db);
 256 YAZ_EXPORT int zebra_drop_database(ZebraHandle zh, const char *db);
 257
 258 YAZ_EXPORT int zebra_admin_shutdown(ZebraHandle zh);
 259 YAZ_EXPORT int zebra_admin_start(ZebraHandle zh);
 260
 261 YAZ_EXPORT int zebra_shutdown(ZebraService zs);
 262
 263 YAZ_EXPORT int zebra_admin_import_begin(ZebraHandle zh, const char *database,
 264                                           const char *record_type);
 265
 266 YAZ_EXPORT int zebra_admin_import_segment(ZebraHandle zh,
 267                                             Z_Segment *segment);
 268
 269 YAZ_EXPORT int zebra_admin_import_end(ZebraHandle zh);
 270
 271 int zebra_admin_exchange_record(ZebraHandle zh,
 272                                  const char *rec_buf,
 273                                  size_t rec_len,
 274                                  const char *recid_buf, size_t recid_len,
 275                                  int action);
 276
 277 int zebra_begin_trans(ZebraHandle zh, int rw);
 278 int zebra_end_trans(ZebraHandle zh);
 279 int zebra_end_transaction(ZebraHandle zh, ZebraTransactionStatus *stat);
 280
 281 int zebra_commit(ZebraHandle zh);
 282 int zebra_clean(ZebraHandle zh);
 283
 284 int zebra_init(ZebraHandle zh);
 285 int zebra_compact(ZebraHandle zh);
 286 int zebra_repository_update(ZebraHandle zh, const char *path);
 287 int zebra_repository_delete(ZebraHandle zh, const char *path);
 288 int zebra_repository_show(ZebraHandle zh, const char *path);
 289
 290 int zebra_add_record(ZebraHandle zh, const char *buf, int buf_size);
 291
 292 int zebra_insert_record(ZebraHandle zh,
 293                          const char *recordType,
 294                          SYSNO *sysno, const char *match, const char *fname,
 295                          const char *buf, int buf_size,
 296                          int force_update);
 297 int zebra_update_record(ZebraHandle zh,
 298                          const char *recordType,
 299                          SYSNO *sysno, const char *match, const char *fname,
 300                          const char *buf, int buf_size,
 301                          int force_update);
 302 int zebra_delete_record(ZebraHandle zh,
 303                          const char *recordType,
 304                          SYSNO *sysno, const char *match, const char *fname,
 305                          const char *buf, int buf_size,
 306                          int force_update);
 307
 308 YAZ_EXPORT int zebra_resultSetTerms(ZebraHandle zh, const char *setname,
 309                                      int no, zint *count,
 310                                      int *type, char *out, size_t *len);
 311
 312 YAZ_EXPORT int zebra_sort(ZebraHandle zh, ODR stream,
 313                            int num_input_setnames,
 314                            const char **input_setnames,
 315                            const char *output_setname,
 316                            Z_SortKeySpecList *sort_sequence,
 317                            int *sort_status);
 318
 319 YAZ_EXPORT
 320 int zebra_select_databases(ZebraHandle zh, int num_bases,
 321                             const char **basenames);
 322
 323 YAZ_EXPORT
 324 int zebra_select_database(ZebraHandle zh, const char *basename);
 325
 326 YAZ_EXPORT
 327 int zebra_shadow_enable(ZebraHandle zh, int value);
 328
 329 YAZ_EXPORT
 330 int zebra_register_statistics(ZebraHandle zh, int dumpdict);
 331
 332 YAZ_EXPORT
 333 int zebra_record_encoding(ZebraHandle zh, const char *encoding);
 334
 335 YAZ_EXPORT
 336 int zebra_record_encoding(ZebraHandle zh, const char *encoding);
 337
 338 YAZ_EXPORT
 339 int zebra_octet_term_encoding(ZebraHandle zh, const char *encoding);
 340
 341 /* Resources */
 342 YAZ_EXPORT
 343 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value);
 344 YAZ_EXPORT
 345 const char *zebra_get_resource(ZebraHandle zh,
 346                 const char *name, const char *defaultvalue);
 347
 348
 349 YAZ_EXPORT void zebra_pidfname(ZebraService zs, char *path);
 350
 351 typedef struct {
 352     char *term;
 353     char *db;
 354     zint sysno;
 355     int score;
 356 } ZebraMetaRecord;
 357
 358 YAZ_EXPORT
 359 ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh,
 360                                            const char *name,
 361                                            int num, zint *positions);
 362
 363
 364 YAZ_EXPORT
 365 ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
 366                                                  const char *name,
 367                                                  zint start, int num);
 368
 369 YAZ_EXPORT
 370 void zebra_meta_records_destroy(ZebraHandle zh, ZebraMetaRecord *records,
 371                                 int num);
 372 YAZ_END_CDECL
 373 #endif