X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=include%2Fzebraapi.h;h=b83f79e029dc37ba427c3b174771330d6c201f8a;hb=881b9293d6699c85195142af3f4a957f4982e6e2;hp=18c18ba585e8255ddfe0b56cb9bbb9664e8f8a2c;hpb=8e6c661870cbd78853147ab1f83bbea91cf8263f;p=idzebra-moved-to-github.git diff --git a/include/zebraapi.h b/include/zebraapi.h index 18c18ba..b83f79e 100644 --- a/include/zebraapi.h +++ b/include/zebraapi.h @@ -1,4 +1,4 @@ -/* $Id: zebraapi.h,v 1.1 2003-03-04 23:36:29 adam Exp $ +/* $Id: zebraapi.h,v 1.11 2004-01-15 13:31:31 adam Exp $ Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003 Index Data Aps @@ -20,6 +20,12 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ +/* Return codes: + * Most functions return an int. Unix-like, 0 means OK, + * non-zero means an error. The error info should be available + * via zebra_errCode and friends. + */ + #ifndef ZEBRAAPI_H #define ZEBRAAPI_H @@ -93,7 +99,7 @@ typedef struct zebra_service *ZebraService; YAZ_EXPORT ZebraService zebra_start (const char *configName); /* Close the whole Zebra */ -YAZ_EXPORT void zebra_stop (ZebraService zs); +YAZ_EXPORT int zebra_stop (ZebraService zs); /* Open a ZebraHandle */ @@ -103,7 +109,7 @@ YAZ_EXPORT void zebra_stop (ZebraService zs); YAZ_EXPORT ZebraHandle zebra_open (ZebraService zs); /* Close handle */ -YAZ_EXPORT void zebra_close (ZebraHandle zh); +YAZ_EXPORT int zebra_close (ZebraHandle zh); /********* * Error handling @@ -119,21 +125,26 @@ YAZ_EXPORT const char *zebra_errString (ZebraHandle zh); YAZ_EXPORT char *zebra_errAdd (ZebraHandle zh); /* get the result code and addinfo from zh */ -YAZ_EXPORT void zebra_result (ZebraHandle zh, int *code, char **addinfo); +YAZ_EXPORT int zebra_result (ZebraHandle zh, int *code, char **addinfo); /* FIXME - why is this needed?? -H */ +/* clear them error things */ +YAZ_EXPORT void zebra_clearError(ZebraHandle zh); /************** * Searching */ -/* Search using RPN-Query */ -YAZ_EXPORT void zebra_search_rpn (ZebraHandle zh, ODR input, ODR output, - Z_RPNQuery *query, - const char *setname, int *hits); +/* Search using PQF Query */ +YAZ_EXPORT int zebra_search_PQF (ZebraHandle zh, const char *pqf_query, + const char *setname, int *numhits); + +/* Search using RPN Query */ +YAZ_EXPORT int zebra_search_RPN (ZebraHandle zh, ODR o, Z_RPNQuery *query, + const char *setname, int *hits); /* Retrieve record(s) */ -YAZ_EXPORT void zebra_records_retrieve (ZebraHandle zh, ODR stream, +YAZ_EXPORT int zebra_records_retrieve (ZebraHandle zh, ODR stream, const char *setname, Z_RecordComposition *comp, oid_value input_format, int num_recs, ZebraRetrievalRecord *recs); @@ -145,7 +156,7 @@ YAZ_EXPORT int zebra_deleleResultSet(ZebraHandle zh, int function, /* Browse */ -YAZ_EXPORT void zebra_scan (ZebraHandle zh, ODR stream, +YAZ_EXPORT int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt, oid_value attributeset, int *position, int *num_entries, @@ -172,21 +183,21 @@ YAZ_EXPORT int zebra_string_norm (ZebraHandle zh, unsigned reg_id, * Admin */ -YAZ_EXPORT void zebra_admin_create (ZebraHandle zh, const char *db); +YAZ_EXPORT int zebra_create_database (ZebraHandle zh, const char *db); +YAZ_EXPORT int zebra_drop_database (ZebraHandle zh, const char *db); +YAZ_EXPORT int zebra_admin_shutdown (ZebraHandle zh); +YAZ_EXPORT int zebra_admin_start (ZebraHandle zh); -YAZ_EXPORT void zebra_admin_shutdown (ZebraHandle zh); -YAZ_EXPORT void zebra_admin_start (ZebraHandle zh); +YAZ_EXPORT int zebra_shutdown (ZebraService zs); -YAZ_EXPORT void zebra_shutdown (ZebraService zs); - -YAZ_EXPORT void zebra_admin_import_begin (ZebraHandle zh, const char *database, +YAZ_EXPORT int zebra_admin_import_begin (ZebraHandle zh, const char *database, const char *record_type); -YAZ_EXPORT void zebra_admin_import_segment (ZebraHandle zh, +YAZ_EXPORT int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment); -void zebra_admin_import_end (ZebraHandle zh); +YAZ_EXPORT int zebra_admin_import_end (ZebraHandle zh); int zebra_admin_exchange_record (ZebraHandle zh, const char *database, @@ -196,26 +207,27 @@ int zebra_admin_exchange_record (ZebraHandle zh, int action); int zebra_begin_trans (ZebraHandle zh, int rw); -void zebra_end_trans (ZebraHandle zh); -void zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat); +int zebra_end_trans (ZebraHandle zh); +int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *stat); int zebra_commit (ZebraHandle zh); +int zebra_clean (ZebraHandle zh); int zebra_init (ZebraHandle zh); int zebra_compact (ZebraHandle zh); -void zebra_repository_update (ZebraHandle zh); -void zebra_repository_delete (ZebraHandle zh); -void zebra_repository_show (ZebraHandle zh); -int zebra_record_insert (ZebraHandle zh, const char *buf, int len); +int zebra_repository_update (ZebraHandle zh); +int zebra_repository_delete (ZebraHandle zh); +int zebra_repository_show (ZebraHandle zh); +int zebra_record_insert (ZebraHandle zh, const char *buf, int len, int *sysno); -YAZ_EXPORT void zebra_set_group (ZebraHandle zh, struct recordGroup *rg); +YAZ_EXPORT int zebra_set_group (ZebraHandle zh, struct recordGroup *rg); YAZ_EXPORT int zebra_resultSetTerms (ZebraHandle zh, const char *setname, int no, int *count, int *type, char *out, size_t *len); -YAZ_EXPORT void zebra_sort (ZebraHandle zh, ODR stream, +YAZ_EXPORT int zebra_sort (ZebraHandle zh, ODR stream, int num_input_setnames, const char **input_setnames, const char *output_setname, @@ -231,21 +243,23 @@ YAZ_EXPORT int zebra_select_database (ZebraHandle zh, const char *basename); YAZ_EXPORT -void zebra_shadow_enable (ZebraHandle zh, int value); +int zebra_shadow_enable (ZebraHandle zh, int value); YAZ_EXPORT -void zebra_register_statistics (ZebraHandle zh, int dumpdict); +int zebra_register_statistics (ZebraHandle zh, int dumpdict); YAZ_EXPORT int zebra_record_encoding (ZebraHandle zh, const char *encoding); /* Resources */ YAZ_EXPORT -void zebra_set_resource(ZebraHandle zh, const char *name, const char *value); +int zebra_set_resource(ZebraHandle zh, const char *name, const char *value); YAZ_EXPORT const char *zebra_get_resource(ZebraHandle zh, const char *name, const char *defaultvalue); +YAZ_EXPORT void zebra_pidfname(ZebraService zs, char *path); + YAZ_END_CDECL #endif