Books#

Iterate over entry names in the order the platform lists them.

Look up one entry by name, raising EntryNotFoundError for a name the book does not index.

Return the canonical resource type, from memory or disk before the platform.

Return what the platform records about the resource, fetching it at most once.

Return the declared sha256: digest, from memory or disk before the platform.

Return every selected row as pandas, using wide indexed form for timeseries.

Values listed for one filter are alternatives, and separate filters must all hold. The year window is inclusive. order names columns to sort by, each prefixed with - to sort descending, with missing values first either way and no promised order among ties. By default the selection applies to the verified cached file, and server_side has the platform select instead, which transfers only the selected rows. Both pick the same rows, but without order the platform returns them in its own order. int_years labels a timeseries' year columns as integers rather than strings.

Return tidy pandas timeseries data, with integer year and a value column.

Every series has a row for every year, missing values included. dropna leaves out the rows with no value, without ever building them, which keeps a sparse resource far smaller in memory. legacy_columns reproduces the 0.4 long format instead: a values column, a year column of YYYY-01-01 00:00:00 strings, and rows sorted by the dimensions and then the year. It is deprecated and will be removed in bookshelf 2.0.

Return the selection as a Polars DataFrame, with the dimensions as columns.

Return the selection as a PyArrow table, with the dimensions as columns.

Return timeseries data as an scmdata ScmRun.

scmdata rejects rows with duplicate metadata.

Return up to limit selected rows, selected on the platform, and whether that is all.

order names columns to sort by first, each prefixed with - to sort descending. top_n keeps the timeseries with the largest latest values, and cannot take an order. drop_constant drops the dimensions that hold one value across the returned series.

Return verified bytes, using memory proportional to the resource size.

Use download() to write large resources to disk without loading them into memory.

Stream and verify the resource, then copy it to destination and return that path.

Stream and verify the resource, then return its path in the cache.

The cache may evict the file later, so use download() for a copy that stays.

Drop book context and return the lean resource handle.

Return the distinct values of each column, within the book.

Return a page of the timeseries' series, one record of dimension values per series.