| # Copyright 2011 Google Inc. All Rights Reserved. |
| # |
| # Licensed under the Apache License, Version 2.0 (the "License"); |
| # you may not use this file except in compliance with the License. |
| # You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| |
| from gslib.command import Command |
| from gslib.command import COMMAND_NAME |
| from gslib.command import COMMAND_NAME_ALIASES |
| from gslib.command import CONFIG_REQUIRED |
| from gslib.command import FILE_URIS_OK |
| from gslib.command import MAX_ARGS |
| from gslib.command import MIN_ARGS |
| from gslib.command import PROVIDER_URIS_OK |
| from gslib.command import SUPPORTED_SUB_ARGS |
| from gslib.command import URIS_START_ARG |
| from gslib.exception import CommandException |
| from gslib.help_provider import HELP_NAME |
| from gslib.help_provider import HELP_NAME_ALIASES |
| from gslib.help_provider import HELP_ONE_LINE_SUMMARY |
| from gslib.help_provider import HELP_TEXT |
| from gslib.help_provider import HelpType |
| from gslib.help_provider import HELP_TYPE |
| from gslib.util import NO_MAX |
| |
| _detailed_help_text = (""" |
| <B>SYNOPSIS</B> |
| gsutil mv [-p] src_uri dst_uri |
| - or - |
| gsutil mv [-p] uri... dst_uri |
| |
| |
| <B>DESCRIPTION</B> |
| The gsutil mv command allows you to move data between your local file |
| system and the cloud, move data within the cloud, and move data between |
| cloud storage providers. For example, to move all objects from a |
| bucket to a local directory you could use: |
| |
| gsutil mv gs://my_bucket dir |
| |
| Similarly, to move all objects from a local directory to a bucket you could |
| use: |
| |
| gsutil mv ./dir gs://my_bucket |
| |
| |
| <B>RENAMING BUCKET SUBDIRECTORIES</B> |
| You can use the gsutil mv command to rename subdirectories. For example, |
| the command: |
| |
| gsutil mv gs://my_bucket/olddir gs://my_bucket/newdir |
| |
| would rename all objects and subdirectories under gs://my_bucket/olddir to be |
| under gs://my_bucket/newdir, otherwise preserving the subdirectory structure. |
| |
| If you do a rename as specified above and you want to preserve ACLs, you |
| should use the -p option (see OPTIONS). |
| |
| Note that when using mv to rename bucket subdirectories you cannot specify |
| the source URI using wildcards. You need to spell out the complete name: |
| |
| gsutil mv gs://my_bucket/olddir gs://my_bucket/newdir |
| |
| If you have a large number of files to move you might want to use the |
| gsutil -m option, to perform a multi-threaded/multi-processing move: |
| |
| gsutil -m mv gs://my_bucket/olddir gs://my_bucket/newdir |
| |
| |
| <B>NON-ATOMIC OPERATION</B> |
| Unlike the case with many file systems, the gsutil mv command does not |
| perform a single atomic operation. Rather, it performs a copy from source |
| to destination followed by removing the source for each object. |
| |
| |
| <B>OPTIONS</B> |
| -p Causes ACL to be preserved when moving in the cloud. Note that |
| this option has performance and cost implications, because it |
| is essentially performing three requests (getacl, cp, setacl). |
| (The performance issue can be mitigated to some degree by |
| using gsutil -m cp to cause multi-threaded/multi-processing |
| copying.) |
| """) |
| |
| |
| class MvCommand(Command): |
| """Implementation of gsutil mv command. |
| Note that there is no atomic rename operation - this command is simply |
| a shorthand for 'cp' followed by 'rm'. |
| """ |
| |
| # Command specification (processed by parent class). |
| command_spec = { |
| # Name of command. |
| COMMAND_NAME : 'mv', |
| # List of command name aliases. |
| COMMAND_NAME_ALIASES : ['move', 'ren', 'rename'], |
| # Min number of args required by this command. |
| MIN_ARGS : 2, |
| # Max number of args required by this command, or NO_MAX. |
| MAX_ARGS : NO_MAX, |
| # Getopt-style string specifying acceptable sub args. |
| SUPPORTED_SUB_ARGS : 'pv', |
| # True if file URIs acceptable for this command. |
| FILE_URIS_OK : True, |
| # True if provider-only URIs acceptable for this command. |
| PROVIDER_URIS_OK : False, |
| # Index in args of first URI arg. |
| URIS_START_ARG : 0, |
| # True if must configure gsutil before running command. |
| CONFIG_REQUIRED : True, |
| } |
| help_spec = { |
| # Name of command or auxiliary help info for which this help applies. |
| HELP_NAME : 'mv', |
| # List of help name aliases. |
| HELP_NAME_ALIASES : ['move', 'rename'], |
| # Type of help: |
| HELP_TYPE : HelpType.COMMAND_HELP, |
| # One line summary of this help. |
| HELP_ONE_LINE_SUMMARY : 'Move/rename objects and/or subdirectories', |
| # The full help text. |
| HELP_TEXT : _detailed_help_text, |
| } |
| |
| # Command entry point. |
| def RunCommand(self): |
| # Check each source arg up, refusing to delete a bucket src URI (force users |
| # to explicitly do that as a separate operation). |
| for arg_to_check in self.args[0:-1]: |
| if self.suri_builder.StorageUri(arg_to_check).names_bucket(): |
| raise CommandException('You cannot move a source bucket using the mv ' |
| 'command. If you meant to move\nall objects in ' |
| 'the bucket, you can use a command like:\n' |
| '\tgsutil mv %s/* %s' % |
| (arg_to_check, self.args[-1])) |
| |
| # Insert command-line opts in front of args so they'll be picked up by cp |
| # and rm commands (e.g., for -p option). Use undocumented (internal |
| # use-only) cp -M option, which causes each original object to be deleted |
| # after successfully copying to its destination, and also causes naming |
| # behavior consistent with Unix mv naming behavior (see comments in |
| # _ConstructDstUri in cp.py). |
| unparsed_args = ['-M'] |
| if self.recursion_requested: |
| unparsed_args.append('-R') |
| unparsed_args.extend(self.unparsed_args) |
| self.command_runner.RunNamedCommand('cp', unparsed_args, self.headers, |
| self.debug, self.parallel_operations) |
| |
| return 0 |