scdb.h

Go to the documentation of this file.

/*
Copyright 2011 Massachusetts Institute of Technology.
All rights reserved. Use of this source code is governed by a
BSD-style license that can be found in the LICENSE file.
*/
 
#ifndef SCDB_H__
#define SCDB_H__
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct scdb_index;
typedef struct scdb_index scdb_index;
 
struct scdb_iterator;
typedef struct scdb_iterator scdb_iterator;
 
typedef enum scdb_status {
    SCDB_OK,
    SCDB_NOT_FOUND,
    SCDB_KEY_BUFFER_TOO_SMALL,
    SCDB_VALUE_BUFFER_TOO_SMALL,
    SCDB_COMPARE_FAILED,
    SCDB_ERROR,
} scdb_status;
 
#define SCDB_MAX_KEY_LENGTH 1024
#define SCDB_MAX_VALUE_LENGTH 4096
 
scdb_index* scdb_open(size_t max_disk_bytes, const char* disk_path);
 
void scdb_close(scdb_index* index);
 
scdb_status scdb_read(scdb_index* index, const char* key, size_t key_length,
        char* value_buffer, size_t* value_buffer_length);
 
 
scdb_status scdb_write(scdb_index* index, const char* key, size_t key_length,
        const char* value_buffer, size_t value_length);
 
scdb_status scdb_delete(scdb_index* index, const char* key, size_t key_length);
 
scdb_status scdb_cas(scdb_index* index, const char* key, size_t key_length,
        const char* current_value, size_t current_value_length,
        const char* new_value, size_t new_value_length);
 
scdb_iterator* scdb_iterate(scdb_index* index,
        const char* key, size_t key_length);
 
void scdb_iterator_close(scdb_iterator* iterator);
 
scdb_status scdb_next(scdb_iterator* iterator,
        char* key_buffer, size_t* key_buffer_length,
        char* value_buffer, size_t* value_buffer_length);
 
 
#ifdef __cplusplus
}  /* extern "C" */
#endif
 
#endif