库相关对象

arcticdb.version_store.library.NormalizableType 模块属性

NormalizableType = Union[NORMALIZABLE_TYPES]

可以规范化为 Arctic 内部存储结构的类型。

另请参阅

Library.write：查看有关规范化的更多文档。

arcticdb.ReadInfoRequest

基类：NamedTuple

ReadInfoRequest 对于 read_metadata_batch 和 get_description_batch 等批量方法很有用，在这些方法中，我们只需指定符号和版本信息。因此，仅在这些批量操作中才需要构造此对象。

属性	描述
symbol	请参阅 read_metadata 方法。 类型： str
as_of	请参阅 read_metadata 方法。 类型： Optional[AsOf]，默认值=none

另请参阅

Library.read：有关参数的文档。

arcticdb.ReadRequest

基类：NamedTuple

ReadRequest 旨在通过镜像单一 read API 的 API 来实现读取操作的批量处理。因此，仅在批量读取操作中才需要构造此对象。

属性	描述
symbol	请参阅 read 方法。 类型： str
as_of	请参阅 read 方法。 类型： Optional[AsOf]，默认值=none
date_range	请参阅 read方法。 类型： Optional[Tuple[Optional[Timestamp], Optional[Timestamp]]]，默认值=none
row_range	请参阅 read 方法。 类型： Optional[Tuple[int, int]]，默认值=none
columns	请参阅 read 方法。 类型： Optional[List[str]]，默认值=none
query_builder	请参阅 read 方法。 类型： Optional[Querybuilder]，默认值=none

另请参阅

Library.read：有关参数的文档。

arcticdb.version_store.library.SymbolDescription

基类：NamedTuple

一个命名元组。有关存储在特定符号下的数据的描述性信息。

属性	描述
columns	存储在符号下的列。 类型： Tuple[NameWithDType]
index	符号的索引。 类型： Tuple[NameWithDType]
index_type	索引是简单索引还是 multi_index。NA 表示存储的数据没有索引。 类型： str {"NA", "index", "multi_index"}
row_count	行数，如果符号已 pickled，则为 None。 类型： Optional[int]
last_update_time	符号最后更新的时间，采用 UTC。 类型： datetime
date_range	此符号第一行和最后一行的索引列值。如果出现以下情况，两个值都将是 NaT：- 符号未按时间戳索引 - 符号按时间戳索引，但此类的 sorted 字段为 UNSORTED（见下文） 类型： Tuple[Union[Timestamp], Union[Timestamp]]
sorted	以下值之一：“ASCENDING”、“DESCENDING”、“UNSORTED”或“UNKNOWN”：ASCENDING - 数据具有时间戳索引，并按升序排序。保证 append、update 和带 date_range 的 read 等操作按预期工作。DESCENDING - 数据具有时间戳索引，并按降序排序。Update 和带 date_range 的 read 将不起作用。UNSORTED - 数据具有时间戳索引，并且未排序。只能通过将 validate_index 设置为 False 调用 write、write_batch、append 或 append_batch 来创建。Update 和带 date_range 的 read 将不起作用。UNKNOWN - 数据没有时间戳索引，或者数据有时间戳索引，但由早于存储此信息的客户端写入。 类型： str

arcticdb.version_store.library.SymbolVersion

基类：NamedTuple

一个命名元组。一个符号名 - 版本对。

属性	描述
symbol	符号名。 类型： str
version	符号的版本。 类型： int

arcticdb.version_store.library.StagedDataFinalizeMethod

基类：Enum

arcticdb.VersionedItem

许多操作的返回值，捕获结果和相关信息。

属性	描述
library	此结果相关的库。 类型： str
symbol	读取或修改的符号。 类型： str
data	对于数据检索（读取）操作，包含读取的数据。对于数据修改操作，该值可能未填充。 类型： Any
version	对于数据检索操作，as_of 参数解析到的版本。在尚未写入任何版本但数据仅从不完整段落读取的特殊情况下，此值将为 2^64-1。对于数据修改操作，数据写入的版本。 类型： int
metadata	与 data 一起保存的元数据。可用性取决于所使用的方法，并且可能与 data 的可用性不同。 类型： Any
host	信息性 / 用于向后兼容性。 类型： Optional[str]
timestamp	此版本写入以来经过的纳秒时间（自 epoch 起）。在尚未写入任何版本但数据仅从不完整段落读取的特殊情况下，此值将为 0。 类型： Optional[int]

arcticdb.version_store.library.VersionInfo

基类：NamedTuple

一个命名元组。有关符号特定版本的描述性信息。

属性	描述
date	版本写入的时间，采用 UTC。 类型： datetime
deleted	如果版本已删除并且仅通过快照保留，则为 True。 类型： bool
snapshots	引用此版本的快照。 类型： List[str]

arcticdb.WritePayload

WritePayload 旨在通过镜像单一 write API 的 API 来实现多个操作的批量处理。

仅在批量写入操作中才需要构造 WritePayload 对象。

WritePayload 的一个实例表示可以写入 ArcticDB 的一个单元。

方法	描述
__init__	构造函数。

__init__

__init__(
    symbol: str,
    data: Union[Any, NormalizableType],
    metadata: Any = None,
)

构造函数。

参数	描述
symbol	符号名。限长 255 个字符。符号中不支持以下字符："*"、"&"、"<"、">" 类型： str
data	要写入的数据。如果数据不是 NormalizableType 类型，则将被 pickled。 类型： Any
metadata	要与符号一起持久化的可选元数据。 类型： Any 默认值： None

另请参阅

Library.write_pickle：有关提供需要 pickled 的数据的影响的信息。