Function open

python/zvec/zvec.py:227–246

Open an existing collection from disk. The collection must have been previously created with ``create_and_open``. Args: path (str): Path or name of the existing collection. option (CollectionOption): Configuration options for opening the collection. Defaults to

(path: str, option: CollectionOption = CollectionOption())

def open(path: str, option: CollectionOption = CollectionOption()) -> Collection:
    """Open an existing collection from disk.

    The collection must have been previously created with ``create_and_open``.

    Args:
        path (str): Path or name of the existing collection.
        option (CollectionOption): Configuration options
            for opening the collection. Defaults to a default-constructed
            ``CollectionOption()`` if not provided.

    Returns:
        Collection: An opened collection instance.

    Examples:
        >>> import zvec
        >>> coll = zvec.open("./my_collection")
    """
    _collection = _Collection.Open(path, option)
    return Collection._from_core(_collection)