@@ -37,6 +37,9 @@ class Historical {
3737 * Batch API
3838 */
3939
40+ // Submits a new batch job and returns a description of the job.
41+ //
42+ // WARNING: Calling this method will incur a cost.
4043 BatchJob BatchSubmitJob (const std::string& dataset,
4144 const std::vector<std::string>& symbols,
4245 Schema schema,
@@ -63,11 +66,13 @@ class Historical {
6366 bool split_symbols, SplitDuration split_duration,
6467 std::uint64_t split_size, Delivery delivery,
6568 SType stype_in, SType stype_out, std::uint64_t limit);
69+ // Lists previous batch jobs.
6670 std::vector<BatchJob> BatchListJobs ();
6771 std::vector<BatchJob> BatchListJobs (const std::vector<JobState>& states,
6872 UnixNanos since);
6973 std::vector<BatchJob> BatchListJobs (const std::vector<JobState>& states,
7074 const std::string& since);
75+ // Lists all files associated with a batch job.
7176 std::vector<BatchFileDesc> BatchListFiles (const std::string& job_id);
7277 // Returns the paths of the downloaded files.
7378 std::vector<std::string> BatchDownload (const std::string& output_dir,
@@ -160,12 +165,15 @@ class Historical {
160165 * Timeseries API
161166 */
162167
163- // Stream historical market data to `record_callback`. This method will
164- // return only after all data has been returned or `record_callback` returns
165- // `KeepGoing::Stop`.
168+ // Stream historical market data to `record_callback`. `metadata_callback`
169+ // will be called exactly once, before any calls to `record_callback`.
170+ // This method will return only after all data has been returned or
171+ // `record_callback` returns `KeepGoing::Stop`.
166172 //
167173 // NOTE: This method spawns a thread, however, the callbacks will be called
168174 // from the current thread.
175+ //
176+ // WARNING: Calling this method will incur a cost.
169177 void TimeseriesGetRange (const std::string& dataset,
170178 const DateTimeRange<UnixNanos>& datetime_range,
171179 const std::vector<std::string>& symbols,
@@ -174,13 +182,6 @@ class Historical {
174182 const DateTimeRange<std::string>& datetime_range,
175183 const std::vector<std::string>& symbols,
176184 Schema schema, const RecordCallback& record_callback);
177- // Stream historical market data to `record_callback`. `metadata_callback`
178- // will be called exactly once, before any calls to `record_callback`.
179- // This method will return only after all data has been returned or
180- // `record_callback` returns `KeepGoing::Stop`.
181- //
182- // NOTE: This method spawns a thread, however, the callbacks will be called
183- // from the current thread.
184185 void TimeseriesGetRange (const std::string& dataset,
185186 const DateTimeRange<UnixNanos>& datetime_range,
186187 const std::vector<std::string>& symbols,
@@ -199,6 +200,8 @@ class Historical {
199200 // object for replaying the data in `file_path`.
200201 //
201202 // If a file at `file_path` already exists, it will be overwritten.
203+ //
204+ // WARNING: Calling this method will incur a cost.
202205 DbnFileStore TimeseriesGetRangeToFile (
203206 const std::string& dataset,
204207 const DateTimeRange<UnixNanos>& datetime_range,
0 commit comments