geodesic.boson.dataset.Dataset.command#

Dataset.command(command, force=False, **kwargs)[source]#

Issue a command to this dataset’s provider.

Commands can be used to perform operations on a dataset such as reindexing. Most commands run in the background and will return immediately. If a command is successfully submitted, this should return a message {“success”: True}, otherwise it will raise an exception with the error message.

Parameters:
  • command (str) – the name of the command to issue. Providers supporting “reindex” will accept this command.

  • force (bool) – if True, will force the command to run even when it has previously completed

  • **kwargs – additional arguments passed to this command.

Returns:

metadata about the submitted command

Return type:

dict