cadet-cli/README.md

cadet-cli

Cosmos Automated Data Exchange Tool - A cross-platform utility to synchronize data with a DocumentDB-backed Azure Cosmos DB instance. 👩‍🚀☁

You can install the latest version of cadet from the Releases page, right here on GitHub.

How it works

Note: at this time, cadet does not support downloading data from Azure Cosmos DB.

Cadet is designed to make it simple to exchange data with Azure Cosmos DB instances that are using the DocumentDB backing store. It is a cross-platform python CLI that leverages the Azure Cosmos DB python SDK under the hood. Here are some common things you can do using cadet:

Import data from csv

The following command will import a comma-separated values file into the Azure Cosmos DB server located at your-server-connection-string into the collection your-collection-name. It will read the data from path/to/csv.csv, and will output progress as data uploads.

cadet import --type csv --uri "your-server-connection-string" --collection "your-collection-name" path/to/csv.csv

Import data from tsv

The following command will import a tab-separated values file into the Azure Cosmos DB server located at your-server-connection-string into the collection your-collection-name. It will read the data from path/to/tsv.tsv, and will output progress as data uploads.

cadet import --type tsv --uri "your-server-connection-string" --collection "your-collection-name" path/to/tsv.tsv

Contributing

For more information - including how to get started - see the CONTRIBUTING document.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.