zcollection.open_collection

zcollection.open_collection(path, *, mode=None, **kwargs)

Open a collection.

Parameters:

• path (str) – The path to the collection.

• mode (Literal['r', 'w'] | None) – The mode to open the collection.

• **kwargs – Additional parameters are passed through the method zcollection.collection.Collection.from_config().

Returns:

The collection.

Return type:

Collection

Example

>>> import zcollection
>>> collection = zcollection.open_collection(
...     "/tmp/mycollection", mode="r")