Management
Methods for you to index, load, and release a collection.
add_index() [READ MORE]
This operation adds index parameters for a specific field in a collection.
compact() [READ MORE]
This operation compacts the collection by merging small segments into larger ones. It is recommended to call this operation after inserting a large amount of data into a collection.
create_index() [READ MORE]
This operation creates an index for a specific collection.
describe_index() [READ MORE]
This operation describes a specific index.
drop_index() [READ MORE]
This operation drops an index from a specific collection.
flush() [READ MORE]
This operation flushes the streaming data and seals segments. It is recommended to call this operation after all the data has been inserted into a collection.
get_compact_state() [READ MORE]
This operation returns the status of the specified compaction job.
get_load_state() [READ MORE]
This operation displays whether a specified collection or partition is loaded or not.
list_indexes() [READ MORE]
This operation lists all indexes of a specific collection.
load_collection() [READ MORE]
This operation loads the data of a specific collection into memory.
prepare_index_params() [READ MORE]
This operation prepares index parameters to build indexes for a specific collection.
refresh_load() [READ MORE]
This operation loads the unloaded data of a loaded collection into memory.
release_collection() [READ MORE]
This operation releases the data of a specific collection from memory.
alter_index_properties() [READ MORE]
This operation changes the specified index properties.
drop_index_properties() [READ MORE]
This operation drops the specified index properties.
flush_all() [READ MORE]
This operation flushes all collections in the current database. This ensures all inserted data is written to persistent storage.
get_compaction_plans() [READ MORE]
This operation returns the compaction plans for a specific compaction job, including the merge plans showing which segments will be combined.
get_compaction_state() [READ MORE]
This operation returns the current state of a compaction job. Use this after calling `compact()` to verify that compaction has completed.
get_flush_all_state() [READ MORE]
This operation returns whether a flush-all operation has completed. Use this after calling `flushall()` to check the flush status.
list_loaded_segments() [READ MORE]
This operation lists all currently loaded segments for a collection, including information about row count, sort status, storage level, and memory size.
list_persistent_segments() [READ MORE]
This operation lists all persistent (flushed) segments for a collection, including information about row count, sort status, and storage level.
optimize() [READ MORE]
This operation optimizes a collection by adjusting segment sizes to improve query performance. This method performs a sequence of operations waiting for index building, triggering force-merge compaction, waiting for completion, rebuilding indexes, and refreshing the collection load.