Utils
BATCH_SIZE = 10000
module-attribute
LOG_EVERY_OHLCV = 1000000
module-attribute
LOG_EVERY_SYMBOLOGY = 50000
module-attribute
logger = logging.getLogger(__name__)
module-attribute
create_secmaster_db(db_path, schema_version=1)
Create a new security master SQLite database using a selected schema version.
The database file is created at the given path and initialized by executing the SQL script
located in the schema_versions directory adjacent to this module.
The function expects the schema script to set PRAGMA user_version to the corresponding
schema version and verifies this after execution.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
db_path
|
Path
|
Filesystem path at which the SQLite database file will be created. |
required |
schema_version
|
int
|
Version number selecting the schema script to apply. |
1
|
Returns:
| Type | Description |
|---|---|
Path
|
The path to the created database file. |
Raises:
| Type | Description |
|---|---|
FileExistsError
|
If a file already exists at |
FileNotFoundError
|
If the schema script for |
DatabaseError
|
If the applied schema does not set the expected |
Source code in src/onesecondtrader/secmaster/utils.py
rebuild_symbol_coverage(db_path)
Rebuild the symbol_coverage table from actual OHLCV data.
For each symbology mapping, finds OHLCV data within the valid date range, then aggregates per publisher, symbol and rtype to get overall coverage. This ensures coverage reflects only data accessible via each symbol during its valid period.
The algorithm: 1. Create temp table with OHLCV coverage per (instrument_id, rtype) 2. Create temp table joining instruments with symbology (with ts conversion) 3. Join and compute intersection, aggregate per (publisher_id, symbol, rtype)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
db_path
|
Path
|
Path to the security master SQLite database. |
required |
Returns:
| Type | Description |
|---|---|
int
|
The number of (publisher_id, symbol, rtype) combinations with coverage data. |
Source code in src/onesecondtrader/secmaster/utils.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 | |
ingest_databento_zip(zip_path, db_path, publisher_name='databento', symbol_type='raw_symbol', dataset=None)
Ingest market data from a Databento zip archive into the security master database.
The archive may contain one or more DBN files and an optional symbology.json. The function
ingests OHLCV records from DBN files into ohlcv and ingests symbol-to-instrument mappings
into symbology.
The publisher namespace is created if absent. Publisher identity is determined by the pair
(publisher_name, dataset), where dataset is extracted from metadata.json in the archive.
Ingestion is idempotent with respect to primary keys: existing ohlcv and symbology rows are
left unchanged.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
zip_path
|
Path
|
Path to the Databento zip archive. |
required |
db_path
|
Path
|
Path to the security master SQLite database. |
required |
publisher_name
|
str
|
Vendor name stored in |
'databento'
|
symbol_type
|
str
|
Symbol scheme stored in |
'raw_symbol'
|
dataset
|
str | None
|
Optional dataset override. If provided, it is used when |
None
|
Returns:
| Type | Description |
|---|---|
tuple[int, int]
|
A tuple of (ohlcv_record_count_seen, symbology_record_count_seen). |
Source code in src/onesecondtrader/secmaster/utils.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | |
ingest_databento_dbn(dbn_path, db_path, publisher_name='databento')
Ingest market data from a Databento DBN file into the security master database.
Reads OHLCV records from the DBN file and inserts them into ohlcv. The publisher namespace
is created if absent. Publisher identity is determined by the pair (publisher_name, dataset),
where dataset is read from DBN metadata.
Ingestion is idempotent with respect to primary keys: existing bars are left unchanged.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dbn_path
|
Path
|
Path to the DBN file (.dbn or .dbn.zst). |
required |
db_path
|
Path
|
Path to the security master SQLite database. |
required |
publisher_name
|
str
|
Vendor name stored in |
'databento'
|
Returns:
| Type | Description |
|---|---|
int
|
The number of OHLCV records seen in the DBN stream. |
Source code in src/onesecondtrader/secmaster/utils.py
_extract_dataset_info(zf, dataset_override=None)
Source code in src/onesecondtrader/secmaster/utils.py
_zip_find_member(zf, basename, allow_multiple=False)
Source code in src/onesecondtrader/secmaster/utils.py
_zip_member_to_tempfile(zf, member_name, tmpdir)
Source code in src/onesecondtrader/secmaster/utils.py
_get_or_create_publisher(con, name, dataset, venue)
Source code in src/onesecondtrader/secmaster/utils.py
_get_or_create_instrument(con, publisher_id, source_instrument_id)
Source code in src/onesecondtrader/secmaster/utils.py
_assert_secmaster_db(con, expected_user_version=1)
Source code in src/onesecondtrader/secmaster/utils.py
_ingest_dbn(dbn_path, con, publisher_id)
Source code in src/onesecondtrader/secmaster/utils.py
_ingest_symbology(json_path, con, publisher_id, symbol_type='raw_symbol')
Source code in src/onesecondtrader/secmaster/utils.py
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 | |
_validate_no_overlapping_symbology(con, publisher_id, symbol_type)
Source code in src/onesecondtrader/secmaster/utils.py
_migrate_symbol_coverage(con)
Add symbol_type column to symbol_coverage if it is missing (pre-existing DBs).