Skip to content

Rename

obstore.rename 

rename(
    store: ObjectStore, from_: str, to: str, *, overwrite: bool = True
) -> None

Move an object from one path to another in the same object store.

By default, this is implemented as a copy and then delete source. It may not check when deleting source that it was the same object that was originally copied.

Parameters:

  • store (ObjectStore) –

    The ObjectStore instance to use.

  • from_ (str) –

    Source path

  • to (str) –

    Destination path

Other Parameters:

  • overwrite (bool) –

    If True, if there exists an object at the destination, it will be overwritten. If False, will return an error if the destination already has an object.

obstore.rename_async async 

rename_async(
    store: ObjectStore, from_: str, to: str, *, overwrite: bool = True
) -> None

Call rename asynchronously.

Refer to the documentation for rename.