Collections
Methods for you to manage collections.
alterAlias() [READ MORE]
This operation reassigns the alias of one collection to another.
CollectionSchema [READ MORE]
A CollectionSchema instance represents the schema of a collection. A schema sketches the structure of a collection.
EmbeddingList [READ MORE]
An EmbeddingList instance represents a list of vector embeddings. You can use an EmbeddingList instance to build the query vectors in a search against a vector field in an Array of Structs field.
alterCollectionField() [READ MORE]
This operation modifies the properties of a specified collection field.
Function [READ MORE]
A `Function` instance for generating vector embeddings from user-provided raw data or configuring rerankers for searches.
alterCollectionProperties() [READ MORE]
This operation modifies the properties of a specified collection.
ConsistencyLevel [READ MORE]
This is an enumeration that provides the following constants.
createAlias() [READ MORE]
This operation creates an alias for an existing collection.
createCollection() [READ MORE]
This operation creates a collection either with default or customized settings.
StructFieldSchema [READ MORE]
A StructFieldSchema instance represents the schema of the Struct elements in an Array of Structs field. A schema sketches the structure of its Struct elements.
DataType [READ MORE]
This is an enumeration that provides the following constants.
describeAlias() [READ MORE]
This operation displays the details of an alias.
describeCollection() [READ MORE]
This operation lists detailed information about a specific collection.
dropAlias() [READ MORE]
This operation drops a specified collection alias.
dropCollection() [READ MORE]
This operation drops a collection.
dropCollectionProperties() [READ MORE]
This operation resets the properties of a specified collection to their default values.
FieldSchema [READ MORE]
A FieldSchema instance defines the data type and related attributes of a specific field in a collection.
getCollectionStats() [READ MORE]
This operation lists the statistics collected on a specific collection.
hasCollection() [READ MORE]
This operation checks whether a specific collection exists.
listAliases() [READ MORE]
This operation lists all existing aliases for a specific collection.
listCollections() [READ MORE]
This operation lists all existing collections.
renameCollection() [READ MORE]
This operation renames an existing collection.
addCollectionField() [READ MORE]
This operation adds a new scalar field to an existing collection without recreating it. The field becomes available almost immediately with minimal delay due to internal schema synchronization.
CreateSchema() [READ MORE]
This operation creates a collection schema.
describeReplicas() [READ MORE]
This operation returns information about the replicas of a specific collection.
dropCollectionFieldProperties() [READ MORE]
This operation drops the specified properties of a field.
ListCollectionsV2() [READ MORE]
This operation lists all existing collections in a specified database.
addCollectionFunction() [READ MORE]
This operation adds a function to a collection. Functions allow you to define custom processing logic, such as BM25 scoring or embedding generation.
alterCollectionFunction() [READ MORE]
This operation alters an existing function in a collection by replacing it with a new function definition.
batchDescribeCollection() [READ MORE]
This operation gets the descriptions of multiple collections in a batch.
dropCollectionFunction() [READ MORE]
This operation drops an existing function from a collection.
truncateCollection() [READ MORE]
This operation removes all data from a collection while preserving the collection schema, indexes, and aliases.