put

Copies a local file to the DSE filesystem.

A special case of cp that copies a local file to the DSE filesystem. If a relative source path is given, it is resolved in the last local working directory, regardless of the current working directory. Similarly, if a relative destination path is given, it is always resolved in the last DSEFS working directory. As in cp, both paths may be absolute and are allowed to point to any file system. If the destination path points to a different file system than DSEFS, the block size and redundancy options are ignored.

Synopsis

put [-o] [-b size_in_bytes] [-n num_nodes] [-c encoder_name] 
[-f frame_size_in_bytes] [-m permission_mode] [--no-force-sync] [--force-sync] 
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.
-c, --compression-encoder encoder_name
The compression encoder name. DSE ships with the lz4 compression encoder.
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.
-f, --compression-frame-size frame_size_in_bytes

Compresses frame to preferred frame size in bytes. Frame is a subject of compression. The bigger the frame,
the bigger chance for high compression ratio.

In most cases, the default value is sufficient. Default frame size in bytes is 131072 bytes.

--force-sync
Synchronizes files in this directory with the storage device when closed. Files created in the directory inherit the option.
-m, --permission-mode permission_mode
Octal representation of permission mode for owner, group, and others:
  • 0 – no permission
  • 1 – execute
  • 2 – write
  • 3 – write and execute
  • 4 – read
  • 5 – read and execute
  • 6 – read and write
  • 7 – read, write, and execute
-n, --redundancy-factor num_nodes
Creates number of replicas of file data, similar to the replication factor in the database keyspaces, but more granular.
  • 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.
--no-force-sync
Does not synchronize files in this directory with the storage device when closed. Files created in the directory inherit the option.
-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 local bluefile to remote greenfile

dsefs dsefs://127.0.0.1:5598/ > put file:/bluefile greenfile