contact | forum | legal | impressum | privacy

Home · About · Download · Documentation · Licensing · Store

Overview API Tutorial Samples FAQ

hamsterdb API Documentation

 

hamsterdb.h

Go to the documentation of this file.

#ifndef HAM_HAMSTERDB_H__
#define HAM_HAMSTERDB_H__

#ifdef __cplusplus
extern "C" {
#endif

#include <ham/types.h>

struct ham_db_t;
typedef struct ham_db_t ham_db_t;

struct ham_env_t;
typedef struct ham_env_t ham_env_t;

struct ham_cursor_t;
typedef struct ham_cursor_t ham_cursor_t;

typedef struct
{
    ham_size_t size;

    void *data;

    ham_u32_t flags;

    ham_u32_t _intflags;

    ham_u64_t _rid;

} ham_record_t;

#define HAM_RECORD_USER_ALLOC   1

typedef struct
{
    ham_u16_t size;

    void *data;

    ham_u32_t flags;

    ham_u32_t _flags;
} ham_key_t;

#define HAM_KEY_USER_ALLOC      1

typedef struct {
    ham_u32_t name;

    ham_u64_t value;

} ham_parameter_t;

#define HAM_SUCCESS                  (  0)

#define HAM_INV_KEYSIZE              ( -3)

#define HAM_INV_PAGESIZE             ( -4)

#define HAM_OUT_OF_MEMORY            ( -6)

#define HAM_NOT_INITIALIZED          ( -7)

#define HAM_INV_PARAMETER            ( -8)

#define HAM_INV_FILE_HEADER          ( -9)

#define HAM_INV_FILE_VERSION         (-10)

#define HAM_KEY_NOT_FOUND            (-11)

#define HAM_DUPLICATE_KEY            (-12)

#define HAM_INTEGRITY_VIOLATED       (-13)

#define HAM_INTERNAL_ERROR           (-14)

#define HAM_DB_READ_ONLY             (-15)

#define HAM_BLOB_NOT_FOUND           (-16)

#define HAM_PREFIX_REQUEST_FULLKEY   (-17)

#define HAM_IO_ERROR                 (-18)

#define HAM_CACHE_FULL               (-19)

#define HAM_NOT_IMPLEMENTED          (-20)

#define HAM_FILE_NOT_FOUND           (-21)

#define HAM_WOULD_BLOCK              (-22)

#define HAM_NOT_READY                (-23)

#define HAM_LIMITS_REACHED           (-24)

#define HAM_ACCESS_DENIED            (-25)

#define HAM_ALREADY_INITIALIZED      (-27)

#define HAM_NEED_RECOVERY            (-28)

#define HAM_CURSOR_STILL_OPEN        (-29)

#define HAM_CURSOR_IS_NIL           (-100)

#define HAM_DATABASE_NOT_FOUND      (-200)

#define HAM_DATABASE_ALREADY_EXISTS (-201)

#define HAM_DATABASE_ALREADY_OPEN   (-202)

#define HAM_LOG_INV_FILE_HEADER     (-300)

typedef void (HAM_CALLCONV *ham_errhandler_fun)
                    (int level, const char *message);

HAM_EXPORT void HAM_CALLCONV
ham_set_errhandler(ham_errhandler_fun f);

HAM_EXPORT const char * HAM_CALLCONV
ham_strerror(ham_status_t status);

HAM_EXPORT void HAM_CALLCONV
ham_get_version(ham_u32_t *major, ham_u32_t *minor,
        ham_u32_t *revision);

HAM_EXPORT void HAM_CALLCONV
ham_get_license(const char **licensee, const char **product);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_new(ham_env_t **env);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_delete(ham_env_t *env);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_create(ham_env_t *env, const char *filename,
        ham_u32_t flags, ham_u32_t mode);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_create_ex(ham_env_t *env, const char *filename,
        ham_u32_t flags, ham_u32_t mode, ham_parameter_t *param);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_open(ham_env_t *env, const char *filename, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_open_ex(ham_env_t *env, const char *filename,
        ham_u32_t flags, ham_parameter_t *param);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_create_db(ham_env_t *env, ham_db_t *db,
        ham_u16_t name, ham_u32_t flags, ham_parameter_t *params);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_open_db(ham_env_t *env, ham_db_t *db,
        ham_u16_t name, ham_u32_t flags, ham_parameter_t *params);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_rename_db(ham_env_t *env, ham_u16_t oldname, 
                ham_u16_t newname, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_erase_db(ham_env_t *env, ham_u16_t name, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_enable_encryption(ham_env_t *env, ham_u8_t key[16], ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_get_database_names(ham_env_t *env, ham_u16_t *names, ham_size_t *count);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_env_close(ham_env_t *env, ham_u32_t flags);

struct ham_txn_t;
typedef struct ham_txn_t ham_txn_t;

extern ham_status_t
ham_txn_begin(ham_txn_t **txn, ham_db_t *db, ham_u32_t flags);

#define HAM_TXN_READ_ONLY                                       1

extern ham_status_t
ham_txn_commit(ham_txn_t *txn, ham_u32_t flags);

extern ham_status_t
ham_txn_abort(ham_txn_t *txn, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_new(ham_db_t **db);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_delete(ham_db_t *db);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_create(ham_db_t *db, const char *filename,
        ham_u32_t flags, ham_u32_t mode);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_create_ex(ham_db_t *db, const char *filename,
        ham_u32_t flags, ham_u32_t mode, ham_parameter_t *param);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_open(ham_db_t *db, const char *filename, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_open_ex(ham_db_t *db, const char *filename,
        ham_u32_t flags, ham_parameter_t *param);

#define HAM_WRITE_THROUGH            0x00000001

#define HAM_READ_ONLY                0x00000004

/* unused                            0x00000008 */

#define HAM_USE_BTREE                0x00000010

/* reserved                          0x00000020 */

#define HAM_DISABLE_VAR_KEYLEN       0x00000040

#define HAM_IN_MEMORY_DB             0x00000080

/* reserved                          0x00000100 */

#define HAM_DISABLE_MMAP             0x00000200

#define HAM_CACHE_STRICT             0x00000400

/* Flag for @a ham_open, @a ham_open_ex, @a ham_create, @a ham_create_ex 
 * (deprecated) */
#define HAM_DISABLE_FREELIST_FLUSH   0x00000800

#define HAM_LOCK_EXCLUSIVE           0x00001000

#define HAM_RECORD_NUMBER            0x00002000

#define HAM_ENABLE_DUPLICATES        0x00004000

#define HAM_ENABLE_RECOVERY          0x00008000

#define HAM_AUTO_RECOVERY            0x00010000

#define HAM_ENABLE_TRANSACTIONS      0x00020000

#define HAM_PARAM_CACHESIZE          0x00000100

#define HAM_PARAM_PAGESIZE           0x00000101

#define HAM_PARAM_KEYSIZE            0x00000102

#define HAM_PARAM_MAX_ENV_DATABASES  0x00000103

HAM_EXPORT ham_u32_t HAM_CALLCONV
ham_get_flags(ham_db_t *db);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_get_error(ham_db_t *db);

typedef int (*ham_prefix_compare_func_t)
                                 (ham_db_t *db, 
                                  const ham_u8_t *lhs, ham_size_t lhs_length, 
                                  ham_size_t lhs_real_length,
                                  const ham_u8_t *rhs, ham_size_t rhs_length,
                                  ham_size_t rhs_real_length);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_set_prefix_compare_func(ham_db_t *db, ham_prefix_compare_func_t foo);

typedef int (*ham_compare_func_t)(ham_db_t *db, 
                                  const ham_u8_t *lhs, ham_size_t lhs_length, 
                                  const ham_u8_t *rhs, ham_size_t rhs_length);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_set_compare_func(ham_db_t *db, ham_compare_func_t foo);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_enable_compression(ham_db_t *db, ham_u32_t level, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_find(ham_db_t *db, ham_txn_t *txn, ham_key_t *key,
        ham_record_t *record, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_insert(ham_db_t *db, ham_txn_t *txn, ham_key_t *key,
        ham_record_t *record, ham_u32_t flags);

#define HAM_OVERWRITE                   1

#define HAM_DUPLICATE                   2

#define HAM_DUPLICATE_INSERT_BEFORE     4

#define HAM_DUPLICATE_INSERT_AFTER      8

#define HAM_DUPLICATE_INSERT_FIRST     16

#define HAM_DUPLICATE_INSERT_LAST      32

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_erase(ham_db_t *db, ham_txn_t *txn, ham_key_t *key, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_flush(ham_db_t *db, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_close(ham_db_t *db, ham_u32_t flags);

#define HAM_AUTO_CLEANUP            1

/* (Internal) flag for @a ham_close, @a ham_env_close */
#define HAM_DONT_CLEAR_LOG          2

#define HAM_TXN_AUTO_ABORT          4

#define HAM_TXN_AUTO_COMMIT         8

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_create(ham_db_t *db, ham_txn_t *txn, ham_u32_t flags,
        ham_cursor_t **cursor);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_clone(ham_cursor_t *src, ham_cursor_t **dest);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_move(ham_cursor_t *cursor, ham_key_t *key,
        ham_record_t *record, ham_u32_t flags);

#define HAM_CURSOR_FIRST            1

#define HAM_CURSOR_LAST             2

#define HAM_CURSOR_NEXT             4

#define HAM_CURSOR_PREVIOUS         8

#define HAM_SKIP_DUPLICATES        16

#define HAM_ONLY_DUPLICATES        32

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_overwrite(ham_cursor_t *cursor, ham_record_t *record,
            ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_find(ham_cursor_t *cursor, ham_key_t *key, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_insert(ham_cursor_t *cursor, ham_key_t *key,
            ham_record_t *record, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_erase(ham_cursor_t *cursor, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_get_duplicate_count(ham_cursor_t *cursor, 
        ham_size_t *count, ham_u32_t flags);

HAM_EXPORT ham_status_t HAM_CALLCONV
ham_cursor_close(ham_cursor_t *cursor);

/*
 * @}
 */

#ifdef __cplusplus
} // extern "C"
#endif

#endif /* HAM_HAMSTERDB_H__ */

 

 

The hamsterdb API

• Main Page
• Data Structures
• Directories
• File List
• Data Fields
• Globals
• The C++ API

 

Help us!

Found an information that is missing on this page? Please send a mail.

 

Copyright © 2005-2008 Christoph Rupp