Key Commands

Ozone shell supports the following key commands.

Get

The key get command downloads a key from Ozone cluster to local file system.

Params:

Arguments Comment
Uri The name of the key in /volume/bucket/key format.
FileName Local file to download the key to.

ozone sh key get /hive/jan/sales.orc sales.orc
Downloads the file sales.orc from the /hive/jan bucket and writes to the local file sales.orc.

Put

Uploads a file from the local file system to the specified bucket.

Params:

Arguments Comment
Uri The name of the key in /volume/bucket/key format.
FileName Local file to upload.
-r, –replication Optional, Number of copies, ONE or THREE are the options. Picks up the default from cluster configuration.

ozone sh key put /hive/jan/corrected-sales.orc sales.orc
The above command will put the sales.orc as a new key into /hive/jan/corrected-sales.orc.

Delete

The key delete command removes the key from the bucket.

Params:

Arguments Comment
Uri The name of the key.
ozone sh key delete /hive/jan/corrected-sales.orc

The above command deletes the key /hive/jan/corrected-sales.orc.

Info

The key info commands returns the information about the key. Params:

Arguments Comment
Uri The name of the key.
ozone sh key info /hive/jan/sales.orc

The above command will print out the information about /hive/jan/sales.orc key.

List

The key list command allows user to list all keys in a bucket.

Params:

Arguments Comment
-l, –length Maximum number of results to return. Default: 1000
-p, –prefix Optional, Only buckets that match this prefix will be returned.
-s, –start The listing will start from key after the start key.
Uri The name of the volume.
ozone sh key list /hive/jan

This command will list all keys in the bucket /hive/jan.

Rename

The key rename command changes the name of an existing key in the specified bucket.

Params:

Arguments Comment
Uri The name of the bucket in /volume/bucket format.
FromKey The existing key to be renamed
ToKey The new desired name of the key

ozone sh key rename /hive/jan sales.orc new_name.orc
The above command will rename sales.orc to new_name.orc in the bucket /hive/jan.

You can try out these commands from the docker instance of the Alpha Cluster.