Files
EOS/docs/_generated/configdatabase.md
Christopher Nadler 3ccc25d731
Some checks failed
Bump Version / Bump Version Workflow (push) Has been cancelled
docker-build / platform-excludes (push) Has been cancelled
docker-build / build (push) Has been cancelled
docker-build / merge (push) Has been cancelled
pre-commit / pre-commit (push) Has been cancelled
Run Pytest on Pull Request / test (push) Has been cancelled
Adds inverter AC/DC efficiency and break-even penalty (#888)
* feat: add inverter AC/DC efficiency and break-even penalty

* test: update tests/test_geneticoptimize.py with new ac_charge_break_even parameter

* docs: update documentation

* chore: update version numbers in configuration files to v0.2.0.dev2602272006923535
2026-02-27 23:12:08 +01:00

3.1 KiB

Configuration model for database settings

Attributes: provider: Optional provider identifier (e.g. "LMDB"). max_records_in_memory: Maximum records kept in memory before auto-save. auto_save: Whether to auto-save when threshold exceeded. batch_size: Batch size for batch operations.

:::{table} database :widths: 10 20 10 5 5 30 :align: left

Name Environment Variable Type Read-Only Default Description
autosave_interval_sec EOS_DATABASE__AUTOSAVE_INTERVAL_SEC `int None` rw 10
Set to None to disable automatic saving.
batch_size EOS_DATABASE__BATCH_SIZE int rw 100 Number of records to process in batch operations.
compaction_interval_sec EOS_DATABASE__COMPACTION_INTERVAL_SEC `int None` rw 604800
Compaction downsamples old records to reduce storage while retaining coverage. Set to None to disable automatic compaction.
compression_level EOS_DATABASE__COMPRESSION_LEVEL int rw 9 Compression level for database record data.
initial_load_window_h EOS_DATABASE__INITIAL_LOAD_WINDOW_H `int None` rw None
keep_duration_h EOS_DATABASE__KEEP_DURATION_H `int None` rw None
None indicates forever. Database namespaces may have diverging definitions.
provider EOS_DATABASE__PROVIDER `str None` rw None
providers List[str] ro N/A Return available database provider ids.
:::

Example Input

   {
       "database": {
           "provider": "LMDB",
           "compression_level": 0,
           "initial_load_window_h": 48,
           "keep_duration_h": 48,
           "autosave_interval_sec": 5,
           "compaction_interval_sec": 604800,
           "batch_size": 100
       }
   }

Example Output

   {
       "database": {
           "provider": "LMDB",
           "compression_level": 0,
           "initial_load_window_h": 48,
           "keep_duration_h": 48,
           "autosave_interval_sec": 5,
           "compaction_interval_sec": 604800,
           "batch_size": 100,
           "providers": [
               "LMDB",
               "SQLite"
           ]
       }
   }