diff --git a/source/reference/minio-mc/mc-undo.rst b/source/reference/minio-mc/mc-undo.rst index 98f291bd..0da72484 100644 --- a/source/reference/minio-mc/mc-undo.rst +++ b/source/reference/minio-mc/mc-undo.rst @@ -25,7 +25,7 @@ The :mc:`mc undo` command reverses changes due to either a ``PUT`` or ``DELETE`` .. tab-item:: EXAMPLE - The following command undoes the last three uploads and/or removals of the ``file.zip`` object on the ``myminio`` deployment in the ``data`` bucket: + The following command reverts the last three uploads and/or deletions of the ``file.zip`` object on the ``myminio`` deployment in the ``data`` bucket: .. code-block:: shell :class: copyable @@ -39,17 +39,19 @@ The :mc:`mc undo` command reverses changes due to either a ``PUT`` or ``DELETE`` .. code-block:: shell :class: copyable - mc [GLOBALFLAGS] undo \ - TARGET \ - [--last "integer"] \ - [--recursive, r] \ - [--force] \ + mc [GLOBALFLAGS] undo \ + TARGET \ + [--action "type"] \ + [--force] \ + [--last "integer"] \ + [--recursive, r] \ [--dry-run] .. include:: /includes/common-minio-mc.rst :start-after: start-minio-syntax :end-before: end-minio-syntax + Parameters ~~~~~~~~~~ @@ -59,23 +61,30 @@ Parameters The full path to the object or prefix where the command should run. The path must include the :ref:`ALIAS `, bucket, and prefix or object name. -.. mc-cmd:: --last +.. mc-cmd:: --action :optional: - Accepts an integer value specifying the number of ``PUT`` and/or ``DELETE`` changes to undo. - - If not specified, the command undoes one (``1``) operation. + Undo the most recent change of the specified type. + Accepted values are ``DELETE`` or ``PUT``. -.. mc-cmd:: --recursive, r - :optional: + By default, :mc:`mc undo` reverses both ``DELETE`` and ``PUT`` operations. + Use :mc-cmd:`~mc undo --action` to choose one or the other, but only for the most recent operation of the specified type. - Performs the command in a recursive fashion. - Use this flag to undo changes on a prefix, for example. + The following command reverts the most recent ``PUT`` for the object ``today.zip`` in bucket ``data``, reverting to the previous object version: -.. mc-cmd:: --force - :optional: + .. code-block:: shell + :class: copyable - Force a recursive operation. + mc undo myminio/data/today.zip --action "PUT" + + This example reverts the most recent ``DELETE`` for the prefix ``archive``, recursively restoring it and any child objects: + + .. code-block:: shell + :class: copyable + + mc undo myminio/data/archive --recursive --action "DELETE" + + Mutually exclusive with :mc-cmd:`~mc undo --last`. .. mc-cmd:: --dry-run :optional: @@ -83,6 +92,25 @@ Parameters Output the results of the command without actually performing the operations. Use this flag to test the outcome of running the command in a particular way. +.. mc-cmd:: --force + :optional: + + Force a recursive operation. + +.. mc-cmd:: --last + :optional: + + Accepts an integer value specifying the number of ``PUT`` and/or ``DELETE`` changes to undo. + + If not specified, the command reverses one (``1``) operation. + Mutually exclusive with :mc-cmd:`~mc undo --action`. + +.. mc-cmd:: --recursive, r + :optional: + + Performs the command in a recursive fashion. + Use this flag to undo changes on a prefix, for example. + Global Flags ~~~~~~~~~~~~ @@ -97,7 +125,7 @@ Examples Undo the Last Three Uploads or Deletions on an Object ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The following command undoes the last three uploads and/or removals of the ``file.zip`` object on the ``myminio`` deployment in the ``data`` bucket: +The following command reverts the last three uploads and/or deletions of the ``file.zip`` object on the ``myminio`` deployment in the ``data`` bucket: .. code-block:: shell :class: copyable