Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add c api documentation #1608

Merged
merged 1 commit into from
Jun 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/c_api/data_type.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
using namespace kuzu::main;
using namespace kuzu::common;

kuzu_data_type* kuzu_data_type_create(
kuzu_data_type_id id, kuzu_data_type* child_type, uint64_t fixed_num_elements_in_list) {
auto* c_data_type = (kuzu_data_type*)malloc(sizeof(kuzu_data_type));
kuzu_logical_type* kuzu_data_type_create(
kuzu_data_type_id id, kuzu_logical_type* child_type, uint64_t fixed_num_elements_in_list) {
auto* c_data_type = (kuzu_logical_type*)malloc(sizeof(kuzu_logical_type));
uint8_t data_type_id_u8 = id;
LogicalType* data_type;
auto logicalTypeID = static_cast<LogicalTypeID>(data_type_id_u8);
Expand All @@ -26,13 +26,13 @@ kuzu_data_type* kuzu_data_type_create(
return c_data_type;
}

kuzu_data_type* kuzu_data_type_clone(kuzu_data_type* data_type) {
auto* c_data_type = (kuzu_data_type*)malloc(sizeof(kuzu_data_type));
kuzu_logical_type* kuzu_data_type_clone(kuzu_logical_type* data_type) {
auto* c_data_type = (kuzu_logical_type*)malloc(sizeof(kuzu_logical_type));
c_data_type->_data_type = new LogicalType(*static_cast<LogicalType*>(data_type->_data_type));
return c_data_type;
}

void kuzu_data_type_destroy(kuzu_data_type* data_type) {
void kuzu_data_type_destroy(kuzu_logical_type* data_type) {
if (data_type == nullptr) {
return;
}
Expand All @@ -42,18 +42,18 @@ void kuzu_data_type_destroy(kuzu_data_type* data_type) {
free(data_type);
}

bool kuzu_data_type_equals(kuzu_data_type* data_type1, kuzu_data_type* data_type2) {
bool kuzu_data_type_equals(kuzu_logical_type* data_type1, kuzu_logical_type* data_type2) {
return *static_cast<LogicalType*>(data_type1->_data_type) ==
*static_cast<LogicalType*>(data_type2->_data_type);
}

kuzu_data_type_id kuzu_data_type_get_id(kuzu_data_type* data_type) {
kuzu_data_type_id kuzu_data_type_get_id(kuzu_logical_type* data_type) {
auto data_type_id_u8 =
static_cast<uint8_t>(static_cast<LogicalType*>(data_type->_data_type)->getLogicalTypeID());
return static_cast<kuzu_data_type_id>(data_type_id_u8);
}

uint64_t kuzu_data_type_get_fixed_num_elements_in_list(kuzu_data_type* data_type) {
uint64_t kuzu_data_type_get_fixed_num_elements_in_list(kuzu_logical_type* data_type) {
auto parent_type = static_cast<LogicalType*>(data_type->_data_type);
if (parent_type->getLogicalTypeID() != LogicalTypeID::FIXED_LIST) {
return 0;
Expand Down
4 changes: 2 additions & 2 deletions src/c_api/query_result.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ char* kuzu_query_result_get_column_name(kuzu_query_result* query_result, uint64_
return column_name_c;
}

kuzu_data_type* kuzu_query_result_get_column_data_type(
kuzu_logical_type* kuzu_query_result_get_column_data_type(
kuzu_query_result* query_result, uint64_t index) {
auto column_data_types =
static_cast<QueryResult*>(query_result->_query_result)->getColumnDataTypes();
if (index >= column_data_types.size()) {
return nullptr;
}
auto column_data_type = column_data_types[index];
auto* column_data_type_c = (kuzu_data_type*)malloc(sizeof(kuzu_data_type));
auto* column_data_type_c = (kuzu_logical_type*)malloc(sizeof(kuzu_logical_type));
column_data_type_c->_data_type = new LogicalType(column_data_type);
return column_data_type_c;
}
Expand Down
20 changes: 10 additions & 10 deletions src/c_api/value.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ kuzu_value* kuzu_value_create_null() {
return c_value;
}

kuzu_value* kuzu_value_create_null_with_data_type(kuzu_data_type* data_type) {
kuzu_value* kuzu_value_create_null_with_data_type(kuzu_logical_type* data_type) {
auto* c_value = (kuzu_value*)calloc(1, sizeof(kuzu_value));
c_value->_value =
new Value(Value::createNullValue(*static_cast<LogicalType*>(data_type->_data_type)));
Expand All @@ -29,7 +29,7 @@ void kuzu_value_set_null(kuzu_value* value, bool is_null) {
static_cast<Value*>(value->_value)->setNull(is_null);
}

kuzu_value* kuzu_value_create_default(kuzu_data_type* data_type) {
kuzu_value* kuzu_value_create_default(kuzu_logical_type* data_type) {
auto* c_value = (kuzu_value*)calloc(1, sizeof(kuzu_value));
c_value->_value =
new Value(Value::createDefaultValue(*static_cast<LogicalType*>(data_type->_data_type)));
Expand Down Expand Up @@ -177,8 +177,8 @@ kuzu_value* kuzu_value_get_struct_field_value(kuzu_value* value, uint64_t index)
return kuzu_value_get_list_element(value, index);
}

kuzu_data_type* kuzu_value_get_data_type(kuzu_value* value) {
auto* c_data_type = (kuzu_data_type*)malloc(sizeof(kuzu_data_type));
kuzu_logical_type* kuzu_value_get_data_type(kuzu_value* value) {
auto* c_data_type = (kuzu_logical_type*)malloc(sizeof(kuzu_logical_type));
c_data_type->_data_type = new LogicalType(static_cast<Value*>(value->_value)->getDataType());
return c_data_type;
}
Expand Down Expand Up @@ -341,9 +341,9 @@ kuzu_value* kuzu_node_val_get_property_value_at(kuzu_node_val* node_val, uint64_
return c_value;
}

void kuzu_node_val_add_property(kuzu_node_val* node_val, const char* key, kuzu_value* value) {
auto value_ = std::make_unique<Value>(*static_cast<Value*>(value->_value));
static_cast<NodeVal*>(node_val->_node_val)->addProperty(std::string(key), std::move(value_));
void kuzu_node_val_add_property(kuzu_node_val* node_val, const char* name, kuzu_value* property) {
auto value_ = std::make_unique<Value>(*static_cast<Value*>(property->_value));
static_cast<NodeVal*>(node_val->_node_val)->addProperty(std::string(name), std::move(value_));
}

char* kuzu_node_val_to_string(kuzu_node_val* node_val) {
Expand Down Expand Up @@ -437,9 +437,9 @@ kuzu_value* kuzu_rel_val_get_property_value_at(kuzu_rel_val* rel_val, uint64_t i
return c_value;
}

void kuzu_rel_val_add_property(kuzu_rel_val* rel_val, char* key, kuzu_value* value) {
auto value_ = std::make_unique<Value>(*static_cast<Value*>(value->_value));
static_cast<RelVal*>(rel_val->_rel_val)->addProperty(std::string(key), std::move(value_));
void kuzu_rel_val_add_property(kuzu_rel_val* rel_val, char* name, kuzu_value* property) {
auto value_ = std::make_unique<Value>(*static_cast<Value*>(property->_value));
static_cast<RelVal*>(rel_val->_rel_val)->addProperty(std::string(name), std::move(value_));
}

char* kuzu_rel_val_to_string(kuzu_rel_val* rel_val) {
Expand Down
Loading