[Python] Document-extensions pages batch - Time series [Replace C# samples] #1879
Conversation
|
|
||
| {NOTE: } | ||
|
|
||
| * Use `time_series_for.append` for the following actions: |
There was a problem hiding this comment.
| * Use `time_series_for.append` for the following actions: | |
| * Use `time_series_for.append_single` for the following actions: |
There was a problem hiding this comment.
done (now referencing both append_single and append)
| Appending a new entry to an existing time series | ||
| will add the entry to the series at the specified timestamp. | ||
| * **Modifying an existing time series entry** | ||
| Use `append` to update the data of an existing entry with the specified timestamp. |
There was a problem hiding this comment.
In Python, append_single appends single-value entry, append can append list of entries at the same timestamp (as a single entry).
| Use `append` to update the data of an existing entry with the specified timestamp. | |
| Use `append_single` to update the data of an existing entry with the specified timestamp. |
There was a problem hiding this comment.
append may be correct here too, but just to let you know that we have two methods for it in Python, depending what type of value single entry represents - single value or multiple values
There was a problem hiding this comment.
thanks, now referencing both methods
|
|
||
| * [document_query](../../../client-api/session/querying/how-to-query#query-overview) | ||
|
|
||
| {CODE-BLOCK: JSON} |
There was a problem hiding this comment.
in Python, a document query is more like a piece of trivia as the simple query works the same way and many variants of this method help with querying (query_index_type, query_collection, etc.)
There was a problem hiding this comment.
we should care where we want to include it in the docs
as it may be misleading
query methods are more comfortable to use than document_query
There was a problem hiding this comment.
changed the document_query link so it would reference the query-vs-document_query page, where your basic explanation of this point appears
|
|
||
| | Property | Type | Description | | ||
| |-----------------|------|-------------| | ||
| | **collections** | `Dict` | Populate this `Dictionary` with the collection names and their corresponding `TimeSeriesCollectionConfiguration` objects. | |
There was a problem hiding this comment.
| | **collections** | `Dict` | Populate this `Dictionary` with the collection names and their corresponding `TimeSeriesCollectionConfiguration` objects. | | |
| | **collections** | `Dict[str, TimeSeriesCollectionConfiguration]` | Populate this `Dictionary` with the collection names and their corresponding `TimeSeriesCollectionConfiguration` objects. | |
Related issues:
RDoc-2894 Time series > Client API > Session > Append
RDoc-2895 Time series > Client API > Session > Delete
RDoc-2897 Time series > Client API > Session > Get > Get entries
RDoc-2898 Time series > Client API > Session > Get > Get names
RDoc-2899 Time series > Querying > Overview & syntax
RDoc-2896 Time series > Client API > Session > Patch
RDoc-2900 Time series > Querying > Choosing query range
RDoc-2904 Time series > Rollups and retentions
RDoc-2903 Time series > Indexing timeseries
RDoc-2901 Time series > Querying > Filtering
RDoc-2902 Time series > Querying > Using indexes