Skip to content

Commit 6ac9bb0

Browse files
authored
fix: refact c struct name (#302)
1 parent e2b0903 commit 6ac9bb0

File tree

12 files changed

+1806
-1760
lines changed

12 files changed

+1806
-1760
lines changed

examples/c/basic_example.c

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
/**
2121
* @brief Print error message and return error code
2222
*/
23-
static ZVecErrorCode handle_error(ZVecErrorCode error, const char *context) {
23+
static zvec_error_code_t handle_error(zvec_error_code_t error,
24+
const char *context) {
2425
if (error != ZVEC_OK) {
2526
char *error_msg = NULL;
2627
zvec_get_last_error(&error_msg);
@@ -34,27 +35,28 @@ static ZVecErrorCode handle_error(ZVecErrorCode error, const char *context) {
3435
/**
3536
* @brief Create a simple test collection using CollectionSchema
3637
*/
37-
static ZVecErrorCode create_simple_test_collection(
38-
ZVecCollection **collection) {
38+
static zvec_error_code_t create_simple_test_collection(
39+
zvec_collection_t **collection) {
3940
// Create collection schema using C API
40-
ZVecCollectionSchema *schema =
41+
zvec_collection_schema_t *schema =
4142
zvec_collection_schema_create("test_collection");
4243
if (!schema) {
4344
return ZVEC_ERROR_INTERNAL_ERROR;
4445
}
4546

46-
ZVecErrorCode error = ZVEC_OK;
47+
zvec_error_code_t error = ZVEC_OK;
4748

4849
// Create index parameters using new API
49-
ZVecIndexParams *invert_params =
50+
zvec_index_params_t *invert_params =
5051
zvec_index_params_create(ZVEC_INDEX_TYPE_INVERT);
5152
if (!invert_params) {
5253
zvec_collection_schema_destroy(schema);
5354
return ZVEC_ERROR_RESOURCE_EXHAUSTED;
5455
}
5556
zvec_index_params_set_invert_params(invert_params, true, false);
5657

57-
ZVecIndexParams *hnsw_params = zvec_index_params_create(ZVEC_INDEX_TYPE_HNSW);
58+
zvec_index_params_t *hnsw_params =
59+
zvec_index_params_create(ZVEC_INDEX_TYPE_HNSW);
5860
if (!hnsw_params) {
5961
zvec_index_params_destroy(invert_params);
6062
zvec_collection_schema_destroy(schema);
@@ -64,7 +66,7 @@ static ZVecErrorCode create_simple_test_collection(
6466
zvec_index_params_set_hnsw_params(hnsw_params, 16, 200);
6567

6668
// Create and add ID field (primary key)
67-
ZVecFieldSchema *id_field =
69+
zvec_field_schema_t *id_field =
6870
zvec_field_schema_create("id", ZVEC_DATA_TYPE_STRING, false, 0);
6971
zvec_field_schema_set_index_params(id_field, invert_params);
7072
error = zvec_collection_schema_add_field(schema, id_field);
@@ -76,7 +78,7 @@ static ZVecErrorCode create_simple_test_collection(
7678
}
7779

7880
// Create text field (inverted index)
79-
ZVecFieldSchema *text_field =
81+
zvec_field_schema_t *text_field =
8082
zvec_field_schema_create("text", ZVEC_DATA_TYPE_STRING, true, 0);
8183
zvec_field_schema_set_index_params(text_field, invert_params);
8284
error = zvec_collection_schema_add_field(schema, text_field);
@@ -88,7 +90,7 @@ static ZVecErrorCode create_simple_test_collection(
8890
}
8991

9092
// Create embedding field (HNSW index)
91-
ZVecFieldSchema *embedding_field = zvec_field_schema_create(
93+
zvec_field_schema_t *embedding_field = zvec_field_schema_create(
9294
"embedding", ZVEC_DATA_TYPE_VECTOR_FP32, false, 3);
9395
zvec_field_schema_set_index_params(embedding_field, hnsw_params);
9496
error = zvec_collection_schema_add_field(schema, embedding_field);
@@ -104,7 +106,7 @@ static ZVecErrorCode create_simple_test_collection(
104106
zvec_index_params_destroy(hnsw_params);
105107

106108
// Use default options
107-
ZVecCollectionOptions *options = zvec_collection_options_create();
109+
zvec_collection_options_t *options = zvec_collection_options_create();
108110
if (!options) {
109111
zvec_collection_schema_destroy(schema);
110112
return ZVEC_ERROR_RESOURCE_EXHAUSTED;
@@ -127,10 +129,10 @@ static ZVecErrorCode create_simple_test_collection(
127129
int main() {
128130
printf("=== ZVec C API Basic Example ===\n\n");
129131

130-
ZVecErrorCode error;
132+
zvec_error_code_t error;
131133

132134
// Create collection using simplified function
133-
ZVecCollection *collection = NULL;
135+
zvec_collection_t *collection = NULL;
134136
error = create_simple_test_collection(&collection);
135137
if (handle_error(error, "creating collection") != ZVEC_OK) {
136138
return 1;
@@ -141,7 +143,7 @@ int main() {
141143
float vector1[] = {0.1f, 0.2f, 0.3f};
142144
float vector2[] = {0.4f, 0.5f, 0.6f};
143145

144-
ZVecDoc *docs[2];
146+
zvec_doc_t *docs[2];
145147
for (int i = 0; i < 2; ++i) {
146148
docs[i] = zvec_doc_create();
147149
if (!docs[i]) {
@@ -175,7 +177,7 @@ int main() {
175177
// Insert documents
176178
size_t success_count = 0;
177179
size_t error_count = 0;
178-
error = zvec_collection_insert(collection, (const ZVecDoc **)docs, 2,
180+
error = zvec_collection_insert(collection, (const zvec_doc_t **)docs, 2,
179181
&success_count, &error_count);
180182
if (handle_error(error, "inserting documents") != ZVEC_OK) {
181183
zvec_collection_destroy(collection);
@@ -196,7 +198,7 @@ int main() {
196198
}
197199

198200
// Get collection statistics
199-
ZVecCollectionStats *stats = NULL;
201+
zvec_collection_stats_t *stats = NULL;
200202
error = zvec_collection_get_stats(collection, &stats);
201203
if (handle_error(error, "getting collection stats") == ZVEC_OK) {
202204
printf("✓ Collection stats - Document count: %llu\n",
@@ -207,7 +209,7 @@ int main() {
207209

208210
printf("Testing vector query...\n");
209211
// Query documents
210-
ZVecVectorQuery *query = zvec_vector_query_create();
212+
zvec_vector_query_t *query = zvec_vector_query_create();
211213
if (!query) {
212214
fprintf(stderr, "Failed to create vector query\n");
213215
zvec_collection_destroy(collection);
@@ -221,9 +223,9 @@ int main() {
221223
zvec_vector_query_set_include_vector(query, true);
222224
zvec_vector_query_set_include_doc_id(query, true);
223225

224-
ZVecDoc **results = NULL;
226+
zvec_doc_t **results = NULL;
225227
size_t result_count = 0;
226-
error = zvec_collection_query(collection, (const ZVecVectorQuery *)query,
228+
error = zvec_collection_query(collection, (const zvec_vector_query_t *)query,
227229
&results, &result_count);
228230

229231
if (error != ZVEC_OK) {
@@ -242,7 +244,7 @@ int main() {
242244

243245
// Process query results
244246
for (size_t i = 0; i < result_count && i < 5; ++i) {
245-
const ZVecDoc *doc = results[i];
247+
const zvec_doc_t *doc = results[i];
246248
const char *pk = zvec_doc_get_pk_copy(doc);
247249

248250
printf(" Result %zu: PK=%s, DocID=%llu, Score=%.4f\n", i + 1,

examples/c/collection_schema_example.c

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
/**
2121
* @brief Print error message and return error code
2222
*/
23-
static ZVecErrorCode handle_error(ZVecErrorCode error, const char *context) {
23+
static zvec_error_code_t handle_error(zvec_error_code_t error,
24+
const char *context) {
2425
if (error != ZVEC_OK) {
2526
char *error_msg = NULL;
2627
zvec_get_last_error(&error_msg);
@@ -37,10 +38,10 @@ static ZVecErrorCode handle_error(ZVecErrorCode error, const char *context) {
3738
int main() {
3839
printf("=== ZVec Collection Schema Example ===\n\n");
3940

40-
ZVecErrorCode error;
41+
zvec_error_code_t error;
4142

4243
// 1. Create collection schema
43-
ZVecCollectionSchema *schema =
44+
zvec_collection_schema_t *schema =
4445
zvec_collection_schema_create("schema_example_collection");
4546
if (!schema) {
4647
fprintf(stderr, "Failed to create collection schema\n");
@@ -55,7 +56,7 @@ int main() {
5556
zvec_collection_schema_get_max_doc_count_per_segment(schema));
5657

5758
// 3. Create index parameters
58-
ZVecIndexParams *invert_params =
59+
zvec_index_params_t *invert_params =
5960
zvec_index_params_create(ZVEC_INDEX_TYPE_INVERT);
6061
if (!invert_params) {
6162
fprintf(stderr, "Failed to create invert index parameters\n");
@@ -64,7 +65,8 @@ int main() {
6465
}
6566
zvec_index_params_set_invert_params(invert_params, true, false);
6667

67-
ZVecIndexParams *hnsw_params = zvec_index_params_create(ZVEC_INDEX_TYPE_HNSW);
68+
zvec_index_params_t *hnsw_params =
69+
zvec_index_params_create(ZVEC_INDEX_TYPE_HNSW);
6870
if (!hnsw_params) {
6971
fprintf(stderr, "Failed to create HNSW index parameters\n");
7072
zvec_index_params_destroy(invert_params);
@@ -75,7 +77,7 @@ int main() {
7577
zvec_index_params_set_hnsw_params(hnsw_params, 16, 200);
7678

7779
// 4. Create and add ID field (primary key)
78-
ZVecFieldSchema *id_field =
80+
zvec_field_schema_t *id_field =
7981
zvec_field_schema_create("id", ZVEC_DATA_TYPE_STRING, false, 0);
8082
if (!id_field) {
8183
fprintf(stderr, "Failed to create ID field\n");
@@ -91,7 +93,7 @@ int main() {
9193
printf("✓ ID field added successfully\n");
9294

9395
// 5. Create and add text field with inverted index
94-
ZVecFieldSchema *text_field =
96+
zvec_field_schema_t *text_field =
9597
zvec_field_schema_create("content", ZVEC_DATA_TYPE_STRING, true, 0);
9698
if (!text_field) {
9799
fprintf(stderr, "Failed to create text field\n");
@@ -108,7 +110,7 @@ int main() {
108110
printf("✓ Text field with inverted index added successfully\n");
109111

110112
// 6. Create and add vector field with HNSW index
111-
ZVecFieldSchema *vector_field = zvec_field_schema_create(
113+
zvec_field_schema_t *vector_field = zvec_field_schema_create(
112114
"embedding", ZVEC_DATA_TYPE_VECTOR_FP32, false, 128);
113115
if (!vector_field) {
114116
fprintf(stderr, "Failed to create vector field\n");
@@ -130,13 +132,13 @@ int main() {
130132
// printf("✓ Total field count: %zu\n", field_count);
131133

132134
// 8. Create collection with schema
133-
ZVecCollectionOptions *options = zvec_collection_options_create();
135+
zvec_collection_options_t *options = zvec_collection_options_create();
134136
if (!options) {
135137
fprintf(stderr, "Failed to create collection options\n");
136138
zvec_collection_schema_destroy(schema);
137139
return 1;
138140
}
139-
ZVecCollection *collection = NULL;
141+
zvec_collection_t *collection = NULL;
140142

141143
error = zvec_collection_create_and_open("./schema_example_collection", schema,
142144
options, &collection);
@@ -157,7 +159,7 @@ int main() {
157159
}
158160

159161
// 10. Create documents
160-
ZVecDoc *docs[2];
162+
zvec_doc_t *docs[2];
161163
for (int i = 0; i < 2; i++) {
162164
docs[i] = zvec_doc_create();
163165
if (!docs[i]) {
@@ -194,7 +196,7 @@ int main() {
194196

195197
// 11. Insert documents
196198
size_t success_count = 0, error_count = 0;
197-
error = zvec_collection_insert(collection, (const ZVecDoc **)docs, 2,
199+
error = zvec_collection_insert(collection, (const zvec_doc_t **)docs, 2,
198200
&success_count, &error_count);
199201
if (handle_error(error, "inserting documents") != ZVEC_OK) {
200202
// Cleanup
@@ -220,7 +222,7 @@ int main() {
220222
}
221223

222224
// 13. Query test
223-
ZVecVectorQuery *query = zvec_vector_query_create();
225+
zvec_vector_query_t *query = zvec_vector_query_create();
224226
if (!query) {
225227
fprintf(stderr, "Failed to create vector query\n");
226228
zvec_collection_destroy(collection);
@@ -234,9 +236,9 @@ int main() {
234236
zvec_vector_query_set_include_vector(query, true);
235237
zvec_vector_query_set_include_doc_id(query, true);
236238

237-
ZVecDoc **results = NULL;
239+
zvec_doc_t **results = NULL;
238240
size_t result_count = 0;
239-
error = zvec_collection_query(collection, (const ZVecVectorQuery *)query,
241+
error = zvec_collection_query(collection, (const zvec_vector_query_t *)query,
240242
&results, &result_count);
241243
if (error == ZVEC_OK) {
242244
printf("✓ Vector query successful - Returned %zu results\n", result_count);

0 commit comments

Comments
 (0)