Library API

This page documents the arcticdb.version_store.library module. This module is the main interface exposing read/write functionality within a given Arctic instance.

The key functionality is exposed through arcticdb.version_store.library.Library instances. See the Arctic API section for notes on how to create these. The other types exposed in this module are less important and are used as part of the signature of arcticdb.version_store.library.Library instance methods.

arcticdb.version_store.library.Library(...)	The main interface exposing read/write functionality within a given Arctic instance.
arcticdb.version_store.library.NormalizableType	Types that can be normalised into Arctic's internal storage structure.
arcticdb.version_store.library.ArcticInvalidApiUsageException	Exception indicating an invalid call made to the Arctic API.
arcticdb.version_store.library.ArcticDuplicateSymbolsInBatchException	Exception indicating that duplicate symbols were passed to a batch method of this module.
arcticdb.version_store.library.ArcticUnsupportedDataTypeException	Exception indicating that a method does not support the type of data provided.
arcticdb.version_store.library.SymbolVersion(...)	A named tuple.
arcticdb.version_store.library.VersionInfo(...)	A named tuple.
arcticdb.version_store.library.SymbolDescription(...)	A named tuple.
arcticdb.version_store.library.WritePayload(...)	WritePayload is designed to enable batching of multiple operations with an API that mirrors the singular write API.
arcticdb.version_store.library.ReadRequest(symbol)	ReadRequest is designed to enable batching of read operations with an API that mirrors the singular read API.

class arcticdb.version_store.library.Library(arctic_instance_description: str, nvs: NativeVersionStore)

The main interface exposing read/write functionality within a given Arctic instance.

Arctic libraries contain named symbols which are the atomic unit of data storage within Arctic. Symbols contain data that in most cases resembles a DataFrame and are versioned such that all modifying operations can be tracked and reverted.

Instances of this class provide a number of primitives to write, modify and remove symbols, as well as also providing methods to manage library snapshots. For more information on snapshots please see the snapshot method.

Arctic libraries support concurrent writes and reads to multiple symbols as well as concurrent reads to a single symbol. However, concurrent writers to a single symbol are not supported other than for primitives that explicitly state support for single-symbol concurrent writes.

__init__(arctic_instance_description: str, nvs: NativeVersionStore)

Parameters:

• arctic_instance_description – Human readable description of the Arctic instance to which this library belongs. Used for informational purposes only.

• nvs – The native version store that backs this library.