Skip to content

Commit bb301dc

Browse files
update docstring, add experimental for warm storage
1 parent 6de7e93 commit bb301dc

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

fourinsight/engineroom/utils/_datamanage.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,10 +510,11 @@ class DrioDataSource(BaseDataSource):
510510
----------
511511
drio_client : obj
512512
DataReservoir.io client.
513-
lables : dict
513+
labels : dict
514514
Labels and timeseries IDs as key/value pairs.
515515
storage : str, optional
516-
If 'warm' (default), drio is fetched from warm storage. If 'archive', data is fetched from the archive.
516+
Where to fetch data from. If 'archive' (default), data is fetched from the archive.
517+
If 'warm' (experimental), data is fetched from warm storage, which supports aggregated queries.
517518
index_type : str or obj
518519
Index type (see Notes). Should be 'datetime', 'integer' or an `index converter`
519520
object.
@@ -560,6 +561,9 @@ class DrioDataSource(BaseDataSource):
560561
be given as a dtype that the :meth:`index_converter.to_universal_delta` can
561562
parse.
562563
564+
- The 'warm' storage option is experimental and its behavior may change in
565+
future releases.
566+
563567
"""
564568

565569
def __init__(

0 commit comments

Comments
 (0)