upscaledb_uqi.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2017 Christoph Rupp (chris@crupp.de).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * See the file COPYING for License information.
 */

#ifndef UPS_UPSCALEDB_UQI_H
#define UPS_UPSCALEDB_UQI_H

#include <ups/upscaledb.h>

#ifdef __cplusplus
extern "C" {
#endif

struct uqi_result_t;
typedef struct uqi_result_t uqi_result_t;

UPS_EXPORT uint32_t UPS_CALLCONV
uqi_result_get_row_count(uqi_result_t *result);

UPS_EXPORT uint32_t UPS_CALLCONV
uqi_result_get_key_type(uqi_result_t *result);

UPS_EXPORT uint32_t UPS_CALLCONV
uqi_result_get_record_type(uqi_result_t *result);

UPS_EXPORT void UPS_CALLCONV
uqi_result_get_key(uqi_result_t *result, uint32_t row, ups_key_t *key);

UPS_EXPORT void UPS_CALLCONV
uqi_result_get_record(uqi_result_t *result, uint32_t row, ups_record_t *record);

UPS_EXPORT void *UPS_CALLCONV
uqi_result_get_key_data(uqi_result_t *result, uint32_t *size);

UPS_EXPORT void *UPS_CALLCONV
uqi_result_get_record_data(uqi_result_t *result, uint32_t *size);

UPS_EXPORT void UPS_CALLCONV
uqi_result_close(uqi_result_t *result);

UPS_EXPORT void UPS_CALLCONV
uqi_result_initialize(uqi_result_t *result, int key_type, int record_type);

UPS_EXPORT void UPS_CALLCONV
uqi_result_add_row(uqi_result_t *result,
                    const void *key_data, uint32_t key_size,
                    const void *record_data, uint32_t record_size);

UPS_EXPORT void UPS_CALLCONV
uqi_result_move(uqi_result_t *destination, uqi_result_t *source);


typedef void *(*uqi_plugin_init_function)(int flags, int key_type,
                    uint32_t key_size, int record_type, uint32_t record_size,
                    const char *reserved);

#define UQI_STREAM_KEY                  1

#define UQI_STREAM_RECORD               2

typedef void (*uqi_plugin_cleanup_function)(void *state);

typedef void (*uqi_plugin_aggregate_single_function)(void *state,
                    const void *key_data, uint32_t key_size,
                    const void *record_data, uint32_t record_size);

typedef void (*uqi_plugin_aggregate_many_function)(void *state,
                    const void *key_data_list, const void *record_data_list,
                    size_t list_length);

typedef int (*uqi_plugin_predicate_function)(void *state,
                    const void *key_data, uint32_t key_size,
                    const void *record_data, uint32_t record_size);

typedef void (*uqi_plugin_result_function)(void *state, uqi_result_t *result);

#define UQI_PLUGIN_PREDICATE                    1

#define UQI_PLUGIN_AGGREGATE                    2

#define UQI_PLUGIN_REQUIRE_BOTH_STREAMS         1

typedef struct {
  const char *name;

  uint32_t type;

  uint32_t flags;

  uint32_t plugin_version;

  uqi_plugin_init_function init;

  uqi_plugin_cleanup_function cleanup;

  uqi_plugin_aggregate_single_function agg_single;

  uqi_plugin_aggregate_many_function agg_many;

  uqi_plugin_predicate_function pred;

  uqi_plugin_result_function results;

} uqi_plugin_t;


UPS_EXPORT ups_status_t UPS_CALLCONV
uqi_register_plugin(uqi_plugin_t *descriptor);

UPS_EXPORT ups_status_t UPS_CALLCONV
uqi_select(ups_env_t *env, const char *query, uqi_result_t **result);

UPS_EXPORT ups_status_t UPS_CALLCONV
uqi_select_range(ups_env_t *env, const char *query, ups_cursor_t *begin,
                            const ups_cursor_t *end, uqi_result_t **result);

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

#endif /* UPS_UPSCALEDB_UQI_H */