RNT_C_API.h

Go to the documentation of this file.

#pragma once

 
#include <stddef.h>
#include <stdint.h>
 
#include "Api.h"
#include "VM.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef void* rnt_handle_t;

typedef void* rnt_cursor_t;
 
/* ------------------------------------------------------------------ */
/* Runtime lifecycle                                                  */
/* ------------------------------------------------------------------ */

NT_API int rnt_init(const char* driver, const char* storage_path);
 
/* ------------------------------------------------------------------ */
/* Authentication                                                       */
/* ------------------------------------------------------------------ */

NT_API int rnt_firewall(const char* auth_method, char** claims_out);
 
/* ------------------------------------------------------------------ */
/* Session lifecycle                                                    */
/* ------------------------------------------------------------------ */

NT_API int rnt_session_open(void* connection_context, char** session_hash_out);

NT_API int rnt_session_close(const char* session_hash);

NT_API int rnt_session_set_branch(const char* session_hash, const char* branch_name,
                                  const char* target_hash);
 
/* ------------------------------------------------------------------ */
/* Ephemeral relations                                                  */
/* ------------------------------------------------------------------ */

typedef void* rnt_tuple_sink_t;

typedef int (*rnt_generator_fn)(void* ctx, const char* args, size_t offset, size_t limit,
                                rnt_tuple_sink_t sink);

NT_API int rnt_sink_emit(rnt_tuple_sink_t sink, const char* tuple_kv);

NT_API int rnt_register_ephemeral_relation(const char* session_hash, int named, const char* name,
                                           rnt_generator_fn generator, void* generator_ctx,
                                           int cardinality, const char* generator_identity,
                                           const char* schema_kv, const char* dependencies,
                                           char** path_out);

NT_API int rnt_drop_ephemeral_relation(const char* session_hash, const char* name);
 
/* ------------------------------------------------------------------ */
/* Handle lifecycle                                                     */
/* ------------------------------------------------------------------ */

NT_API rnt_handle_t rnt_open_handle(const char* path, const char* claims);

NT_API int rnt_close_handle(rnt_handle_t handle);

NT_API int rnt_branch_target(rnt_handle_t handle, char** target_hash_out);

NT_API int rnt_branch_advance(const char* branch_path, const char* new_hash);
 
/* ------------------------------------------------------------------ */
/* Object registration                                                  */
/* ------------------------------------------------------------------ */

NT_API int rnt_register_relation(const char* path);

NT_API int rnt_register_branch(const char* path, const char* target_hash);

NT_API int rnt_list_relations(const char* branch_mg_path, char** out);

NT_API int rnt_list_branch_multigroups(const char* branch_path, char** out);

NT_API int rnt_list_snapshot_relations(const char* snapshot_hash, char** out);
 
/* ------------------------------------------------------------------ */
/* Tuple storage                                                        */
/* ------------------------------------------------------------------ */

NT_API int rnt_link_tuple(const char* relation_path, const char* kv_attrs, char** hash_out);

NT_API int rnt_unlink_tuple(const char* relation_path, const char* tuple_hash);

NT_API int rnt_clear_relation(const char* relation_path);

NT_API int rnt_relation_root(const char* relation_path, char** root_hash_out);
 
/* ------------------------------------------------------------------ */
/* Cursor and VM                                                        */
/* ------------------------------------------------------------------ */

NT_API rnt_cursor_t rnt_cursor_open(rnt_handle_t handle);

NT_API int rnt_cursor_next(rnt_cursor_t cursor, char** tuple_out);

NT_API int rnt_cursor_close(rnt_cursor_t cursor);
 
/* ------------------------------------------------------------------ */
/* VM plan builder                                                      */
/* ------------------------------------------------------------------ */

typedef void* rnt_plan_t;

typedef struct {
    const char* relation_path;
} PlanArgsScan;

typedef struct {
    rnt_plan_t left;
    rnt_plan_t right;
    const char** attrs;
} PlanArgsJoin;

typedef struct {
    rnt_plan_t source;
    size_t limit;
} PlanArgsTake;

typedef struct {
    rnt_plan_t source;
    const char** attrs;
} PlanArgsProject;

typedef struct {
    rnt_plan_t source;
} PlanArgsMaterialize;

 
typedef struct {
    rnt_plan_t source;
    const char** pairs;
} PlanArgsRename;

 
typedef struct {
    rnt_plan_t *sources;
} PlanArgsUnion;

typedef struct {
    nt::Operation operation;
    PlanArgsScan scan;
    PlanArgsJoin join;
    PlanArgsTake take;
    PlanArgsProject project;
    PlanArgsMaterialize materialize;
    PlanArgsRename rename;
    PlanArgsUnion union_;
} PlanAction;

NT_API rnt_plan_t rnt_plan_assemble(PlanAction action);

NT_API void rnt_plan_free(rnt_plan_t plan);

NT_API rnt_cursor_t rnt_vm_execute_plan(rnt_plan_t plan);

NT_API int rnt_vm_cursor_next(rnt_cursor_t vm_cursor, char** tuple_out);

NT_API int rnt_vm_cursor_close(rnt_cursor_t vm_cursor);
 
/* ------------------------------------------------------------------ */
/* Memory management                                                    */
/* ------------------------------------------------------------------ */

NT_API void rnt_free_string(char* s);

NT_API void rnt_free_bytes(uint8_t* p);
 
#ifdef __cplusplus
}
#endif