cp

Copies file within a file system or between two file systems.

Copies a file within a file system or between two file systems. If the destination filepath points to a file system other than DSEFS, the block size and redundancy options are ignored.

Synopsis

cp [-o] [-b size_in_bytes] [-n num_nodes] 
[--no-force-sync] [--force-sync]
source_filepath [source_filepath ...] destination_filepath
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a valid option or user-defined value.
[ ] Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key:value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[ -- ] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

Definition

The short form and long form parameters are comma-separated.

Command arguments

-b, --block-size size_in_bytes
Preferred block size in bytes for files. Ignored when the destination path is a file system other than DSEFS.
destination_filepath
Explicit or relative filepath.
  • If destination path ends with name, destination entry is given that name.
  • If the destination path ends with a backslash (/), original source file name is used.
  • Wildcard characters are supported.
  • Explicit file system prefixes dsefs: and file: are supported.
  • .. is the parent directory.
--force-sync
Synchronize files in this directory with the storage device when closed. Files created in the directory inherit the option.
--no-force-sync
Do not synchronize files in this directory with the storage device when closed. Files created in the directory inherit the option.
-n, --redundancy-factor num_nodes
Set the number of replicas of file data, similar to the replication factor in the database keyspaces, but more granular.
  • Set this to one number greater than the number of nodes that are allowed to fail before data loss occurs. For example, set this value to 3 to allow 2 nodes to fail.
  • For simple replication, use a value that is equivalent to the replication factor.
  • Default value is inherited from the parent directory if set, otherwise it is 3.
-o, --overwrite
If destination file exists, overwrite.
source_filepath
Explicit or relative filepath.
  • Wildcard characters are supported.
  • Explicit file system prefixes dsefs: and file: are supported.
  • .. is the parent directory.

Examples

Copy file from source to overwrite file in destination

dsefs file:/home/user1/test > cp -o dsefs:archive.tgz another-archive-copy.tgz