跳到内容

管理员工具 API

本页文档介绍了 arcticdb.version_store.admin_tools 模块。它提供了面向高级用户和 DBA 的管理功能。

这些工具仅供临时使用。该 API 目前不稳定,并且不受 ArcticDB 版本号的 semver 约定约束。

要获取 arcticdb.version_store.admin_tools.AdminTools 实例,请使用 arcticdb.version_store.Library.get_admin_tools

arcticdb.version_store.admin_tools.Size dataclass

关于对象大小的信息。

属性 描述
bytes_compressed

压缩后的大小(字节)。

类型: int

count

构成该大小的对象数量。

类型: int

bytes_compressed instance-attribute

bytes_compressed: int

压缩后的大小(字节)。

count instance-attribute

count: int

构成该大小的对象数量。

arcticdb.version_store.admin_tools.KeyType

基类: Enum

这是 ArcticDB 使用的所有键类型的一个子集,涵盖了最重要的类型。

有关 ArcticDB 数据布局的更多信息可在此处获取。here

属性 描述
APPEND_DATA

仅用于暂存写入。已暂存但尚未最终确定的数据。

LOG

仅用于企业版复制。记录库更改流的小对象。

LOG_COMPACTED

仅用于某些企业版复制安装。是 LOG 键的压缩形式。

MULTI_KEY

仅用于“递归规范化”数据,目前无法通过 Library API 写入。

SNAPSHOT_REF

ArcticDB 用于存储快照内容(调用 lib.snapshot 时创建的结构)的元数据。

SYMBOL_LIST

一组键,共同存储库中存储的符号总集。用于 list_symbols

TABLE_DATA

数据内容的存储位置,采用分块格式。

TABLE_INDEX

ArcticDB 用于选择要读取的 TABLE_DATA 块的元数据。每个未删除的符号版本有一个。

VERSION

ArcticDB 用于存储与符号关联的版本链的元数据。可能存在

VERSION_REF

指向符号最新版本的指针。每个符号一个。

APPEND_DATA class-attribute instance-attribute

APPEND_DATA = 5

仅用于暂存写入。已暂存但尚未最终确定的数据。

LOG class-attribute instance-attribute

LOG = 8

仅用于企业版复制。记录库更改流的小对象。

LOG_COMPACTED class-attribute instance-attribute

LOG_COMPACTED = 9

仅用于某些企业版复制安装。是 LOG 键的压缩形式。

MULTI_KEY class-attribute instance-attribute

MULTI_KEY = 6

仅用于“递归规范化”数据,目前无法通过 Library API 写入。

记录用于构成整体结构的所有 TABLE_INDEX 键。例如,如果您保存一个包含两个使用递归规范化器的数据帧的列表,则此键将引用用于序列化这两个数据帧的两个索引键。

SNAPSHOT_REF class-attribute instance-attribute

SNAPSHOT_REF = 7

ArcticDB 用于存储快照内容(调用 lib.snapshot 时创建的结构)的元数据。

SYMBOL_LIST class-attribute instance-attribute

SYMBOL_LIST = 10

一组键,共同存储库中存储的符号总集。用于 list_symbols

TABLE_DATA class-attribute instance-attribute

TABLE_DATA = 1

数据内容的存储位置,采用分块格式。

TABLE_INDEX class-attribute instance-attribute

TABLE_INDEX = 2

ArcticDB 用于选择要读取的 TABLE_DATA 块的元数据。每个未删除的符号版本有一个。

VERSION class-attribute instance-attribute

VERSION = 3

ArcticDB 用于存储与符号关联的版本链的元数据。VERSION 键的数量可能多于符号的版本号,因为我们在删除数据时也会写入一个 VERSION 键。

VERSION_REF class-attribute instance-attribute

VERSION_REF = 4

指向符号最新版本的指针。每个符号一个。

arcticdb.version_store.admin_tools.AdminTools

用于对 ArcticDB 库执行管理任务的工具集合。

该 API 目前不稳定,并且不受 ArcticDB 版本号的 semver 约定约束。

另请参阅

Library.admin_tools: 从库中获取此对象的 API。

方法 描述
get_sizes

库中压缩大小(字节)的明细,按键类型分组。

get_sizes_by_symbol

库中压缩大小(字节)的明细,按符号分组,然后再按键类型分组。

get_sizes_for_symbol

给定符号使用的压缩大小(字节)的明细,按键类型分组。

get_sizes

get_sizes() -> Dict[KeyType, Size]

库中压缩大小(字节)的明细,按键类型分组。

KeyType 中的所有键类型都始终包含在输出中。

get_sizes_by_symbol

get_sizes_by_symbol() -> Dict[str, Dict[KeyType, Size]]

库中压缩大小(字节)的明细,按符号分组,然后再按键类型分组。

输出中始终包含以下键类型(且仅包含这些),

VERSION_REF
VERSION
TABLE_INDEX
TABLE_DATA
APPEND_DATA

get_sizes_for_symbol

get_sizes_for_symbol(symbol: str) -> Dict[KeyType, Size]

给定符号使用的压缩大小(字节)的明细,按键类型分组。

输出中始终包含以下键类型(且仅包含这些)

VERSION_REF
VERSION
TABLE_INDEX
TABLE_DATA
APPEND_DATA

如果符号不存在,则不引发异常。