Delete Time Series

Flow:

• Open a session.
• Create an instance of time_series_for and pass it the following:
  • Provide an explicit document ID, or -
    pass an entity tracked by the session, e.g. a document object returned from session.query or from session.load.
  • Specify the time series name.
• Call time_series_for.delete_at and provide the timestamp of an entry you want to delete,
  -or-
  Call time_series_for.delete and provide the timestamps range of the entries you want to delete.
• Call session.save_changes for the action to take effect on the server.

Note:

• If the specified document doesn't exist, a DocumentDoesNotExistException will be thrown.
• Attempting to delete nonexistent entries results in a no-op and generates no exception.
• To delete a whole time series simply delete all its entries.
  The series is removed when all its entries are deleted.
• Deleting a document deletes all its time series as well.

In the following example we delete a time series entry appended by sample code in the Append article.

# Delete a single entry
with store.open_session() as session:
    session.time_series_for("users/john", "HeartRates").delete(base_line + timedelta(minutes=1))
    session.save_changes()

def delete_at(self, at: datetime) -> None: ...

def delete(self, datetime_from: Optional[datetime] = None, datetime_to: Optional[datetime] = None): ...