Module ffi 

Structs

VldbSqliteByteBuffer

可释放字节缓冲区结构，供 QueryStream chunk getter 返回。 Releasable byte-buffer structure returned by QueryStream chunk getters.

VldbSqliteByteView

字节视图结构，供 FFI 输入 bytes 参数使用。 Byte-view structure used by the FFI for input bytes parameters.

VldbSqliteCustomWordListHandle

FFI 自定义词列表句柄，供调用方通过 getter 读取。 FFI custom-word list handle read by callers through getter functions.

VldbSqliteDatabaseHandle

FFI 数据库句柄，负责复用指定数据库的打开选项与连接策略。 FFI database handle used to reuse open options and connection rules for a specific database.

VldbSqliteDictionaryMutationResultPod

自定义词修改结果结构。 Custom-word mutation result structure.

VldbSqliteEnsureFtsIndexResultPod

FTS 索引确保结果结构。 FTS ensure-index result structure.

VldbSqliteExecuteResultHandle

FFI 通用 SQL 执行结果句柄。 FFI shared SQL execution-result handle.

VldbSqliteFfiValue

FFI SQL 参数值结构。 FFI SQL parameter value structure.

VldbSqliteFfiValueSlice

FFI SQL 参数切片结构。 FFI SQL parameter-slice structure.

VldbSqliteFtsMutationResultPod

FTS 文档写入/删除结果结构。 FTS document mutation result structure.

VldbSqliteQueryJsonResultHandle

FFI JSON 查询结果句柄。 FFI JSON-query result handle.

VldbSqliteQueryStreamHandle

FFI Arrow IPC chunk 查询结果句柄。 FFI Arrow IPC chunk query-result handle.

VldbSqliteRebuildFtsIndexResultPod

FTS 索引重建结果结构。 FTS rebuild-index result structure.

VldbSqliteRuntimeHandle

FFI Runtime 句柄，负责纯库多库管理。 FFI runtime handle responsible for pure-library multi-database management.

VldbSqliteSearchResultHandle

FFI FTS 检索结果句柄，供调用方通过 getter 读取。 FFI FTS search-result handle read by callers through getter functions.

VldbSqliteTokenizeResultHandle

FFI 分词结果句柄，供调用方通过 getter 读取。 FFI tokenize-result handle read by callers through getter functions.

Enums

VldbSqliteFfiTokenizerMode

FFI 分词模式枚举，作为非 JSON 主接口的稳定入参。 FFI tokenizer-mode enum used as a stable input for the non-JSON main interface.

VldbSqliteFfiValueKind

FFI SQL 值类型枚举。 FFI SQL value-kind enum.

VldbSqliteStatusCode

FFI 状态码，供 Go / C 调用方判断调用是否成功。 FFI status code used by Go / C callers to determine whether an invocation succeeded.

Functions

vldb_sqlite_bytes_free

释放由 QueryStream chunk getter 返回的字节缓冲区。 Free a byte buffer returned by a QueryStream chunk getter.

vldb_sqlite_clear_last_error

清理最近一次 FFI 错误消息。 Clear the latest FFI error message.

vldb_sqlite_custom_word_list_destroy

释放自定义词列表句柄。 Destroy a custom-word list handle.

vldb_sqlite_custom_word_list_get_weight

返回指定自定义词条目的权重。 Return the weight of a specific custom-word entry.

vldb_sqlite_custom_word_list_get_word

返回指定自定义词条目的词文本。 Return the word text of a specific custom-word entry.

vldb_sqlite_custom_word_list_len

返回自定义词列表长度。 Return the number of custom words in the list.

vldb_sqlite_database_db_path

返回数据库句柄绑定的路径字符串。 Return the bound database path string for a database handle.

vldb_sqlite_database_delete_fts_document

通过数据库句柄删除 FTS 文档。 Delete an FTS document through a database handle.

vldb_sqlite_database_destroy

释放数据库句柄。 Destroy a database handle.

vldb_sqlite_database_ensure_fts_index

通过数据库句柄确保 FTS 索引存在。 Ensure an FTS index exists through a database handle.

vldb_sqlite_database_execute_batch

通过数据库句柄执行批量 SQL。 Execute batch SQL through a database handle.

vldb_sqlite_database_execute_script

通过数据库句柄执行脚本或单条 SQL。 Execute a script or a single SQL statement through a database handle.

vldb_sqlite_database_list_custom_words

通过数据库句柄列出自定义词，返回列表句柄。 List custom words through a database handle and return a list handle.

vldb_sqlite_database_query_json

通过数据库句柄执行 JSON 查询。 Execute a JSON query through a database handle.

vldb_sqlite_database_query_stream

通过数据库句柄执行 Arrow IPC chunk 查询。 Execute an Arrow IPC chunk query through a database handle.

vldb_sqlite_database_rebuild_fts_index

通过数据库句柄重建 FTS 索引。 Rebuild an FTS index through a database handle.

vldb_sqlite_database_remove_custom_word

通过数据库句柄删除自定义词。 Remove a custom word through a database handle.

vldb_sqlite_database_search_fts

通过数据库句柄执行 FTS 检索并返回结果句柄。 Execute FTS search through a database handle and return a result handle.

vldb_sqlite_database_tokenize_text

通过数据库句柄执行分词主接口，返回结果句柄。 Execute the main tokenize interface from a database handle and return a result handle.

vldb_sqlite_database_upsert_custom_word

通过数据库句柄热更新自定义词。 Hot-update a custom word through a database handle.

vldb_sqlite_database_upsert_fts_document

通过数据库句柄写入或更新 FTS 文档。 Upsert an FTS document through a database handle.

vldb_sqlite_delete_fts_document_json

通过 JSON 请求删除 FTS 文档。 Delete an FTS document from a JSON request.

vldb_sqlite_ensure_fts_index_json

通过 JSON 请求确保 FTS 索引存在。 Ensure an FTS index exists from a JSON request.

vldb_sqlite_execute_batch_json

通过 JSON 请求执行批量 SQL。 Execute batch SQL from a JSON request.

vldb_sqlite_execute_result_destroy

释放通用 SQL 执行结果句柄。 Destroy a shared SQL execution-result handle.

vldb_sqlite_execute_result_last_insert_rowid

返回通用 SQL 执行结果中的 last_insert_rowid。 Return last_insert_rowid from a shared SQL execution result.

vldb_sqlite_execute_result_message

返回通用 SQL 执行结果中的 message。 Return the message from a shared SQL execution result.

vldb_sqlite_execute_result_rows_changed

返回通用 SQL 执行结果中的 rows_changed。 Return rows_changed from a shared SQL execution result.

vldb_sqlite_execute_result_statements_executed

返回通用 SQL 执行结果中的 statements_executed。 Return statements_executed from a shared SQL execution result.

vldb_sqlite_execute_result_success

返回通用 SQL 执行结果中的 success 标志。 Return the success flag from a shared SQL execution result.

vldb_sqlite_execute_script_json

通过 JSON 请求执行脚本或单条 SQL。 Execute a script or a single SQL statement from a JSON request.

vldb_sqlite_json_is_null

返回 JSON 指针是否为空，便于上层快速探测调用是否成功。 Return whether the JSON pointer is null so callers can quickly detect failure.

vldb_sqlite_last_error_message

获取最近一次 FFI 错误消息。 Get the latest FFI error message.

vldb_sqlite_library_info_json

导出库模式基础元信息。 Export bootstrap library metadata as a JSON string.

vldb_sqlite_list_custom_words_json

通过 JSON 请求列出当前库中的自定义词。 List custom dictionary words from a JSON request.

vldb_sqlite_query_json_json

通过 JSON 请求执行 JSON 查询。 Execute a JSON query from a JSON request.

vldb_sqlite_query_json_result_destroy

释放 JSON 查询结果句柄。 Destroy a JSON-query result handle.

vldb_sqlite_query_json_result_json_data

返回 JSON 查询结果中的 JSON 行集字符串。 Return the JSON row-set string from a JSON-query result.

vldb_sqlite_query_json_result_row_count

返回 JSON 查询结果中的行数。 Return the row count from a JSON-query result.

vldb_sqlite_query_stream_chunk_count

返回 Arrow IPC chunk 数量。 Return the number of Arrow IPC chunks.

vldb_sqlite_query_stream_chunk_json

通过 JSON 请求读取指定 QueryStream 句柄中的单个 chunk。 Read a single chunk from a JSON QueryStream handle.

vldb_sqlite_query_stream_close_json

通过 JSON 请求关闭 QueryStream 句柄。 Close a JSON QueryStream handle.

vldb_sqlite_query_stream_destroy

释放 Arrow IPC chunk 查询结果句柄。 Destroy an Arrow IPC chunk query-result handle.

vldb_sqlite_query_stream_get_chunk

返回指定下标的 Arrow IPC chunk。 Return the Arrow IPC chunk at the specified index.

vldb_sqlite_query_stream_json

通过 JSON 请求执行 Arrow IPC chunk 查询。 Execute an Arrow IPC chunk query from a JSON request.

vldb_sqlite_query_stream_row_count

返回 Arrow IPC chunk 查询结果中的行数。 Return the row count from an Arrow IPC chunk query result.

vldb_sqlite_query_stream_total_bytes

返回 Arrow IPC chunk 查询结果的总字节数。 Return the total byte count from an Arrow IPC chunk query result.

vldb_sqlite_rebuild_fts_index_json

通过 JSON 请求重建 FTS 索引。 Rebuild an FTS index from a JSON request.

vldb_sqlite_remove_custom_word_json

通过 JSON 请求删除自定义词。 Remove a custom dictionary word from a JSON request.

vldb_sqlite_runtime_close_database

关闭 runtime 中缓存的数据库。 Close a cached database from the runtime.

vldb_sqlite_runtime_create_default

创建默认多库 runtime 句柄。 Create a default multi-database runtime handle.

vldb_sqlite_runtime_destroy

释放多库 runtime 句柄。 Destroy a multi-database runtime handle.

vldb_sqlite_runtime_open_database

打开或复用指定路径的数据库句柄。 Open or reuse a database handle for the specified path.

vldb_sqlite_search_fts_json

通过 JSON 请求执行标准化 FTS 检索。 Execute normalized FTS search from a JSON request.

vldb_sqlite_search_result_destroy

释放 FTS 检索结果句柄。 Destroy an FTS search-result handle.

vldb_sqlite_search_result_get_content_snippet

返回指定命中的内容片段。 Return the content snippet of the specified hit.

vldb_sqlite_search_result_get_file_path

返回指定命中的文件路径。 Return the file path of the specified hit.

vldb_sqlite_search_result_get_id

返回指定命中的业务 ID。 Return the business ID of the specified hit.

vldb_sqlite_search_result_get_rank

返回指定命中的名次。 Return the rank of the specified hit.

vldb_sqlite_search_result_get_raw_score

返回指定命中的原始 BM25 分数。 Return the raw BM25 score of the specified hit.

vldb_sqlite_search_result_get_score

返回指定命中的标准化分数。 Return the normalized score of the specified hit.

vldb_sqlite_search_result_get_title

返回指定命中的标题。 Return the title of the specified hit.

vldb_sqlite_search_result_get_title_highlight

返回指定命中的高亮标题。 Return the highlighted title of the specified hit.

vldb_sqlite_search_result_len

返回 FTS 检索当前页命中数。 Return the page hit count of an FTS search result.

vldb_sqlite_search_result_query_mode

返回检索结果的查询模式标签。 Return the query-mode label of a search result.

vldb_sqlite_search_result_source

返回检索结果的来源标签。 Return the source label of a search result.

vldb_sqlite_search_result_total

返回 FTS 检索总命中数。 Return the total hit count of an FTS search result.

vldb_sqlite_string_free

释放由本库分配的 JSON/C 字符串。 Free a JSON/C string allocated by this library.

vldb_sqlite_tokenize_result_destroy

释放分词结果句柄。 Destroy a tokenize-result handle.

vldb_sqlite_tokenize_result_fts_query

返回分词结果中的 FTS 查询表达式。 Return the FTS query expression from a tokenize result.

vldb_sqlite_tokenize_result_get_token

返回指定下标的词元字符串。 Return the token string at the specified index.

vldb_sqlite_tokenize_result_normalized_text

返回分词结果中的规范化文本。 Return the normalized text from a tokenize result.

vldb_sqlite_tokenize_result_token_count

返回分词结果中的词元数量。 Return the token count from a tokenize result.

vldb_sqlite_tokenize_text_json

通过 JSON 请求执行分词，并返回 JSON 结果。 Execute tokenization from a JSON request and return a JSON response.

vldb_sqlite_upsert_custom_word_json

通过 JSON 请求热更新自定义词。 Hot-update a custom dictionary word from a JSON request.

vldb_sqlite_upsert_fts_document_json

通过 JSON 请求写入 FTS 文档。 Upsert an FTS document from a JSON request.