docarray.array.storage.milvus package

Submodules

• docarray.array.storage.milvus.backend module
  • MilvusConfig
    • MilvusConfig.n_dim
    • MilvusConfig.collection_name
    • MilvusConfig.host
    • MilvusConfig.port
    • MilvusConfig.distance
    • MilvusConfig.index_type
    • MilvusConfig.index_params
    • MilvusConfig.collection_config
    • MilvusConfig.serialize_config
    • MilvusConfig.consistency_level
    • MilvusConfig.batch_size
    • MilvusConfig.columns
    • MilvusConfig.list_like
    • MilvusConfig.root_id
  • BackendMixin
    • BackendMixin.TYPE_MAP
    • BackendMixin.loaded_collection()
• docarray.array.storage.milvus.find module
  • FindMixin
• docarray.array.storage.milvus.getsetdel module
  • GetSetDelMixin
    • GetSetDelMixin.sync()
• docarray.array.storage.milvus.seqlike module
  • SequenceLikeMixin
    • SequenceLikeMixin.insert()
    • SequenceLikeMixin.append()
    • SequenceLikeMixin.clear()
    • SequenceLikeMixin.count()
    • SequenceLikeMixin.extend()
    • SequenceLikeMixin.index()
    • SequenceLikeMixin.pop()
    • SequenceLikeMixin.remove()
    • SequenceLikeMixin.reverse()

Module contents

class docarray.array.storage.milvus.StorageMixins(*args, **kwds)

Bases: FindMixin, BackendMixin, GetSetDelMixin, SequenceLikeMixin, ABC

TYPE_MAP: Dict[str, TypeMap] = {'bool': TypeMap(type=<DataType.BOOL: 1>, converter=<class 'bool'>), 'double': TypeMap(type=<DataType.DOUBLE: 11>, converter=<class 'float'>), 'float': TypeMap(type=<DataType.DOUBLE: 11>, converter=<class 'float'>), 'int': TypeMap(type=<DataType.INT64: 5>, converter=<function _safe_cast_int>), 'str': TypeMap(type=<DataType.VARCHAR: 21>, converter=<class 'str'>)}

append(value, **kwargs)

Append doc to the end of the array.

Parameters:

value (Document) – The doc needs to be appended.

clear()

Clear the data of DocumentArray

count(value) → integer -- return number of occurrences of value

extend(values, **kwargs)

S.extend(iterable) – extend sequence by appending elements from the iterable

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value, **kwargs)

Insert doc at index.

Parameters:

• index (int) – Position of the insertion.

• value (Document) – The doc needs to be inserted.

• kwargs – Additional Arguments that are passed to the Document Store. This has no effect for in-memory DocumentArray.

loaded_collection(collection=None)

Context manager to load a collection and release it after the context is exited. If the collection is already loaded when entering, it will not be released while exiting.

Parameters:

collection – the collection to load. If None, the main collection of this indexer is used.

Returns:

Context manager for the provided collection.

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

sync()

class docarray.array.storage.milvus.MilvusConfig(n_dim, collection_name=None, host='localhost', port=19530, distance='IP', index_type='HNSW', index_params=<factory>, collection_config=<factory>, serialize_config=<factory>, consistency_level='Session', batch_size=-1, columns=None, list_like=True, root_id=True)

Bases: object

n_dim: int

collection_name: str = None

host: str = 'localhost'

port: Optional[Union[str, int]] = 19530

distance: str = 'IP'

index_type: str = 'HNSW'

index_params: Dict

collection_config: Dict

serialize_config: Dict

consistency_level: str = 'Session'

batch_size: int = -1

columns: Optional[Union[List[Tuple[str, str]], Dict[str, str]]] = None

list_like: bool = True

root_id: bool = True