Search History#

Graviti Data Platform stores the search histories.

Graviti SDK use class SearchHistory to represent a search history. The search ID is used as the unique identifier of a search history. It can be accessed through SDK attr SearchHistory.search_id or copied from Graviti website.

Search History is a dataset level resource, it is necessary to get a dataset first:

from graviti import Workspace

ws = Workspace(f"{YOUR_ACCESSKEY}")

dataset = ws.datasets.get(f"{DATASET_NAME}")

List Search Histories#

SDK provides method list() to list search histories:

dataset.searches.list()

Get a Search History#

SDK provides method get() to get a search history:

dataset.searches.get(f"{SEARCH_ID}")

Delete a Search History#

SDK provides method delete() to delete a search history:

dataset.searches.delete(f"{SEARCH_ID}")

Run a Search#

SDK provides method SearchHistory.run() to run and get the search result.

search_history = dataset.searches.get(f"{SEARCH_ID}")

search_result_df = search_history.run()