Run ZOQL queries through AQuA from the command line
Project description
zuora-aqua-client-cli
Run ZOQL queries through AQuA from the command line
Installation
Mac
pip3 install zuora-aqua-client-cli
The executable will be installed to /usr/local/bin/zacc
Linux
pip3 install zuora-aqua-client-cli
The executable will be installed to ~/.local/bin/zacc
Make sure ~/.local/bin/
is added to your $PATH
Configuration
Configuration should be provided by the -c /path/to/file
option.
Example config
[prod]
production = true
client_id = <client_id>
client_secret = <client_secret>
[sandbox]
production = false
client_id = <client_id>
client_secret = <client_secret>
Usage
Cheatsheet
# List fiels for resource
$ zacc describe -c ~/.config.ini -e sandbox Account
Account
AccountNumber - Account Number
AdditionalEmailAddresses - Additional Email Addresses
AllowInvoiceEdit - Allow Invoice Editing
AutoPay - Auto Pay
Balance - Account Balance
...
Related Objects
BillToContact<Contact> - Bill To
DefaultPaymentMethod<PaymentMethod> - Default Payment Method
ParentAccount<Account> - Parent Account
SoldToContact<Contact> - Sold To
# Request a bearer token, then exit
$ zacc bearer -c ~/.config.ini -e sandbox
Bearer <bearer token>
# Execute an AQuA job
$ zacc query -c ~/.config.ini -e sandbox -z "select Account.Name from Account where Account.CreatedDate > '2019-01-10'"
Account.Name
John Doe
Jane Doe
# Execute an AQuA job from a ZOQL query file
$ zacc query -c ~/.config.ini -e sandbox -z ~/query_names.zoql
Account.Name
John Doe
Jane Doe
Zacc
Usage: zacc [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Commands:
bearer Prints bearer than exits
describe List available fields of Zuora resource
query Run ZOQL Query
Query
Usage: zacc query [OPTIONS]
Run ZOQL Query
Options:
-c, --config-filename PATH Config file containing Zuora ouath
credentials [default: zuora_oauth.ini]
-z, --zoql PATH ZOQL file to be executed [default:
input.zoql]
-o, --output PATH Where to write the output to, default is
STDOUT
-e, --environment [prod|preprod|local]
Zuora environment to execute on [default:
local]
-m, --max-retries INTEGER Maximum retries for query
--help Show this message and exit.
Describe
Usage: zacc describe [OPTIONS] RESOURCE
List available fields of Zuora resource
Options:
-c, --config-filename PATH Config file containing Zuora ouath
credentials [default: zuora_oauth.ini]
-e, --environment [prod|preprod|local]
Zuora environment to execute on [default:
local]
--help Show this message and exit.
Bearer
Usage: zacc bearer [OPTIONS]
Prints bearer than exits
Options:
-c, --config-filename PATH Config file containing Zuora ouath
credentials [default: zuora_oauth.ini]
-e, --environment [prod|preprod|local]
Zuora environment to execute on [default:
local]
--help Show this message and exit.
Useful stuff
Has a lot of graphs on Resource relationships: https://community.zuora.com/t5/Engineering-Blog/AQUA-An-Introduction-to-Join-Processing/ba-p/13262
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for zuora-aqua-client-cli-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af62b3fcc06e23ce50b7b7085b58fce8f15254a212c9c9eb940464dde0e9941e |
|
MD5 | fcd1d28f7a5e8c5827d2453e3de98818 |
|
BLAKE2b-256 | 1c45437c1853f0fccd290346888990853b50a73972ccf93d0664f7374338ee2d |
Close
Hashes for zuora_aqua_client_cli-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6256af1ce6316a4bc65d220cda5f3d7060c308d6238de151faa577d68b26b08c |
|
MD5 | a77e2d775f429e99de94b6dfa83752a9 |
|
BLAKE2b-256 | ef1aaafd47e320af809a33594e476da2051b8efe92e053cd0948a34d3cacc152 |