LanceDB C API

Contents:

  • API Reference
    • Complete API
      • LanceDBConnectBuilder
      • LanceDBConnection
      • LanceDBTable
      • LanceDBTableNamesBuilder
      • LanceDBQuery
      • LanceDBVectorQuery
      • LanceDBQueryResult
      • LanceDBRecordBatchReader
      • FFI_ArrowSchema
      • FFI_ArrowArray
      • LanceDBError
        • LANCEDB_SUCCESS
        • LANCEDB_INVALID_ARGUMENT
        • LANCEDB_INVALID_TABLE_NAME
        • LANCEDB_INVALID_INPUT
        • LANCEDB_TABLE_NOT_FOUND
        • LANCEDB_DATABASE_NOT_FOUND
        • LANCEDB_DATABASE_ALREADY_EXISTS
        • LANCEDB_INDEX_NOT_FOUND
        • LANCEDB_EMBEDDING_FUNCTION_NOT_FOUND
        • LANCEDB_TABLE_ALREADY_EXISTS
        • LANCEDB_CREATE_DIR
        • LANCEDB_SCHEMA
        • LANCEDB_RUNTIME
        • LANCEDB_TIMEOUT
        • LANCEDB_OBJECT_STORE
        • LANCEDB_LANCE
        • LANCEDB_HTTP
        • LANCEDB_RETRY
        • LANCEDB_ARROW
        • LANCEDB_NOT_SUPPORTED
        • LANCEDB_OTHER
        • LANCEDB_UNKNOWN
      • LanceDBDistanceType
        • LANCEDB_DISTANCE_L2
        • LANCEDB_DISTANCE_COSINE
        • LANCEDB_DISTANCE_DOT
        • LANCEDB_DISTANCE_HAMMING
      • LanceDBIndexType
        • LANCEDB_INDEX_AUTO
        • LANCEDB_INDEX_BTREE
        • LANCEDB_INDEX_BITMAP
        • LANCEDB_INDEX_LABELLIST
        • LANCEDB_INDEX_FTS
        • LANCEDB_INDEX_IVF_FLAT
        • LANCEDB_INDEX_IVF_PQ
        • LANCEDB_INDEX_IVF_HNSW_PQ
        • LANCEDB_INDEX_IVF_HNSW_SQ
      • LanceDBOptimizeType
        • LANCEDB_OPTIMIZE_ALL
        • LANCEDB_OPTIMIZE_COMPACT
        • LANCEDB_OPTIMIZE_PRUNE
        • LANCEDB_OPTIMIZE_INDEX
      • lancedb_error_to_message()
      • lancedb_connect()
      • lancedb_connect_builder_execute()
      • lancedb_connect_builder_storage_option()
      • lancedb_connect_builder_free()
      • lancedb_connection_uri()
      • lancedb_connection_table_names()
      • lancedb_free_table_names()
      • lancedb_connection_table_names_builder()
      • lancedb_table_names_builder_limit()
      • lancedb_table_names_builder_start_after()
      • lancedb_table_names_builder_execute()
      • lancedb_table_names_builder_free()
      • lancedb_connection_open_table()
      • lancedb_connection_drop_table()
      • lancedb_connection_rename_table()
      • lancedb_connection_drop_all_tables()
      • lancedb_connection_create_namespace()
      • lancedb_connection_drop_namespace()
      • lancedb_connection_list_namespaces()
      • lancedb_free_namespace_list()
      • lancedb_connection_free()
      • lancedb_table_free()
      • lancedb_table_create()
      • lancedb_table_arrow_schema()
      • lancedb_table_version()
      • lancedb_table_count_rows()
      • lancedb_table_add()
      • lancedb_table_merge_insert()
      • lancedb_table_delete()
      • lancedb_query_new()
      • lancedb_vector_query_new()
      • lancedb_query_limit()
      • lancedb_query_offset()
      • lancedb_query_select()
      • lancedb_query_where_filter()
      • lancedb_vector_query_limit()
      • lancedb_vector_query_offset()
      • lancedb_vector_query_column()
      • lancedb_vector_query_select()
      • lancedb_vector_query_where_filter()
      • lancedb_vector_query_distance_type()
      • lancedb_vector_query_nprobes()
      • lancedb_vector_query_refine_factor()
      • lancedb_vector_query_ef()
      • lancedb_query_execute()
      • lancedb_vector_query_execute()
      • lancedb_query_result_to_arrow()
      • lancedb_query_free()
      • lancedb_vector_query_free()
      • lancedb_query_result_free()
      • lancedb_table_nearest_to()
      • lancedb_record_batch_reader_from_arrow()
      • lancedb_record_batch_reader_free()
      • lancedb_free_arrow_schema()
      • lancedb_table_create_vector_index()
      • lancedb_table_create_scalar_index()
      • lancedb_table_create_fts_index()
      • lancedb_table_list_indices()
      • lancedb_table_drop_index()
      • lancedb_table_optimize()
      • lancedb_free_index_list()
      • lancedb_free_arrow_arrays()
      • lancedb_free_string()
      • LANCEDB_ERROR_MESSAGES
      • LanceDBVectorIndexConfig
        • num_partitions
        • num_sub_vectors
        • max_iterations
        • sample_rate
        • distance_type
        • accelerator
        • replace
      • LanceDBScalarIndexConfig
        • replace
        • force_update_statistics
      • LanceDBFtsIndexConfig
        • base_tokenizer
        • language
        • max_tokens
        • lowercase
        • stem
        • remove_stop_words
        • ascii_folding
        • replace
      • LanceDBMergeInsertConfig
        • when_matched_update_all
        • when_not_matched_insert_all
LanceDB C API
  • Search


© Copyright 2025, The LanceDB Authors.

Built with Sphinx using a theme provided by Read the Docs.