arcticdb.version_store.library.SymbolDescription

class arcticdb.version_store.library.SymbolDescription(columns: Tuple[NameWithDType], index: NameWithDType, index_type: str, row_count: int, last_update_time: datetime, date_range: Tuple[datetime, datetime])[source]

A named tuple. Descriptive information about the data stored under a particular symbol.

columns

Columns stored under the symbol.

Type:

Tuple[NameWithDType]

index

Index of the symbol.

Type:

NameWithDType

index_type

Whether the index is a simple index or a multi_index. NA indicates that the stored data does not have an index.

Type:

str {“NA”, “index”, “multi_index”}

row_count

Number of rows.

Type:

int

last_update_time

The time of the last update to the symbol, in UTC.

Type:

datetime64

date_range

The times in UTC that data for this symbol spans. If the data is not timeseries indexed then this value will be (datetime.datetime(1970, 1, 1), datetime.datetime(1970, 1, 1)).

Type:

Tuple[datetime.datetime, datetime.datetime]

__init__()

Methods

__init__()

count(value, /)

Return number of occurrences of value.

Attributes

columns

Alias for field number 0

date_range

Alias for field number 5

index

Alias for field number 1

index_type

Alias for field number 2

last_update_time

Alias for field number 4

row_count

Alias for field number 3