Skip to content

Local file ​

Reads files from path. Use it for a laptop sample, a nightly drop directory, or CI fixtures.

Before you begin ​

  • A file or directory Skipprd can read.
  • Format is inferred from the extension when you omit format.

Configure ​

python
from skippr import Config, DataSourceFile, Pipeline

cfg = Config.discover()
src = cfg.data_source("sample", DataSourceFile(path="./data/events.jsonl", format="json"))
cfg.pipeline("sample", Pipeline(data_source=src))
cfg.save()
bash
skipprd connect data-source file \
  --pipeline sample \
  --name sample \
  --path ./data/events.jsonl \
  --format json
yaml
data_sources:
  sample:
    File:
      path: ./data/events.jsonl
      format: json

Options ​

KeyTypeRequired/DefaultDescription
pathpathRequiredFile or directory
formatstringInferredjson, csv, or parquet
batch_size_secondsintegerNot setMax seconds per batch
batch_size_bytesintegerNot setMax bytes per batch

What gets synced ​

Each file becomes records. If path is a directory, Skipprd reads the files in it. Progress is per file; a file that changes after a commit is read again.

Troubleshooting ​

SymptomFix
File not foundUse a path relative to the working directory, or an absolute path
Parse errorsSet format, and check the file is UTF-8
Permission deniedGrant read on path

Next steps ​