Record

The record service provides access to the on-disk dataset. It locates the dataset files, reads their raw records through a configurable reader, and serves them. Components and other services obtain records and dataset attributes from this service.

Usage

Configured under services.record. The reader is a selectable plugin.

services:
  record:
    source:
      - /path/to/dataset_a
      - /path/to/dataset_b
    reader:
      name: lmdb
      kwargs: {}
    cache_size: 32

How it works

The reader defines the on-disk format and knows how to read records and attributes from a single file. It presents the collection of files as one indexable sequence and manages how much is held in memory at once.

Configuration

Option

Description

Type

Default

source

One or more paths to dataset files or directories.

path | list[path]

required

reader

Reader plugin selection (name / kwargs).

mapping

required

cache_size

Number of file shards kept resident in memory at once.

int

required

ignore_checksum

Skip dataset checksum verification.

bool

false

Sub-slots