api:environments:database-list
Returns a list of databases.
For more help, see https://cloudapi-docs.acquia.com/ or https://dev.acquia.com/api-documentation/acquia-cloud-site-factory-api for acsf commands.
Usage
acli api:environments:database-list [--sort SORT] [--filter FILTER] [--limit LIMIT] [--offset OFFSET] [--] <environmentId>
acli api:environments:database-list 12-d314739e-296f-11e9-b210-d663bd873d93 --sort="field1,-field2" --limit="10" --offset="10"
acli api:environments:database-list myapp.dev --sort="field1,-field2" --limit="10" --offset="10"
Arguments
environmentId
Required
The environment identifier. The identifier is a compound key consisting of the internal database ID of the environment and the application UUID. You may also use an environment alias or UUID.
Options
--sort
Required
A comma-delimited string with fields used for sorting. The order of the fields is significant. A leading - in the field indicates the field should be sorted in a descending order. Not all fields are sortable.
--filter
Required
The filters query string parameter restricts the data returned from your request. Filtered queries restrict the rows that do (or do not) get included in the result by testing each row in the result against the filters. Not all fields are filterable. There are eight filter operators that can be used and they must be URL encoded in order to be included. The operators are: * Equals: `= (%3D)` * Does not equal: `!= (!%3D)` * Greater than: `> (%3E)` * Less than: `< (%3C)` * Greater than or equal to: `>= (%3E%3D)` * Less than or equal to: `<= (%3C%3D)` * Contains substring: `=@ (%3D@)` * Does not contain substring: `!@ (!@)` Filters can be combined using `OR` and `AND` boolean logic. The `OR` operator is defined using a comma (`,`) and the `AND` operator is defined using a semi-colon (`;`). Some examples: * `filter=field%3Dvalue` (`field` equals `'value'`) * `filter=field%3D@*partialmatch` (`field` ends with `'partialmatch'`) * `filter=field%3D@*partialmatch,field%3Dvalue` (`field` ends with `'partialmatch'` OR `field` equals `'value'`) * `filter=field%3D@*partialmatch,field%3Dvalue;field2%3C5` (`field` ends with `'partialmatch'` OR `field` equals `'value'` AND `field2` > `5`)
--limit
Required
The maximum number of items to return.
--offset
Required
An integer to signify the offset to paginate from.
--help | -h
Optional
Display help for the given command. When no command is given display help for the `list` command
Defaults to
false--quiet | -q
Optional
Do not output any message
Defaults to
false--verbose | -v|-vv|-vvv
Optional
Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
Defaults to
false--version | -V
Optional
Display this application version
Defaults to
false--ansi
Optional
Force (or disable --no-ansi) ANSI output
--no-ansi
Optional
Negate the "--ansi" option
Defaults to
false--no-interaction | -n
Optional
Do not ask any interactive question
Defaults to
false