The skysqlcli Utility
This page is part of MariaDB's Documentation.
The parent of this page is: MariaDB SkySQL previous release DBaaS API Reference
Topics on this page:
Overview
The skysqlcli utility provides a way of controlling your MariaDB SkySQL deployment from the command-line using the MariaDB SkySQL REST API.
Command Summary
The following are the available skysqlcli commands:
Command | Description |
|---|---|
Generate the autocompletion script for the bash shell | |
Generate the autocompletion script for the fish shell | |
Generate the autocompletion script for powershell | |
Generate the autocompletion script for the zsh shell | |
Adds a new allowed address for service in MariaDB SkySQL | |
Creates a new configuration for user in MariaDB SkySQL | |
Submits request to MariaDB SkySQL to deploy a new service | |
Deletes an allowed address for user on service in MariaDB SkySQL | |
Deletes a service configuration for user in MariaDB SkySQL | |
Submits request to MariaDB SkySQL to delete an existing service. Specify a service using the service id (e.g., db00000000) | |
Queries for list of allowed IP addresses for a specific service | |
Queries for the provisioning status of an allowlist for a specific service | |
Retrieves one or more custom service configurations owned by the user | |
Queries for default credentials configured for a service. Specify a service using the service id (e.g., db00000000) | |
Queries a list of cloud providers supported by MariaDB SkySQL | |
Queries for quota limits, and progress towards those quotas | |
Retrieves list of provider regions available for use with MariaDB SkySQL | |
Queries information for service-type offerings from MariaDB SkySQL | |
Queries for information about deployed service resources in SkySQL. Specify a service using the service id (e.g., db00000000) | |
Retrieves list of machine sizes available for use with MariaDB SkySQL | |
Retrieve the current status of a service in MariaDB SkySQL | |
Retrieves list of account tiers available for use with MariaDB SkySQL | |
Retrieves list of service topologies available for use with MariaDB SkySQL | |
Retrieves list of service versions available for use with MariaDB SkySQL | |
Updates a configuration for user in MariaDB SkySQL | |
Submits request to MariaDB SkySQL to update an existing service. Specify a service using the service id (e.g., db00000000) | |
Updates status for service belonging user in MariaDB SkySQL | |
Print the version number of the cli |
Option Summary
The following options are global to the skysqlcli utility across all its commands:
Option | Description |
|---|---|
Long-lived JWT issued from MariaDB ID | |
config file (default $HOME/.skysqlcli.yaml) | |
help for skysqlcli | |
URL for the SkySQL API (default: https://api.skysql.net) | |
URL for MariaDB ID (default: https://id.mariadb.com) | |
version for skysqlcli |
skysqlcli completion bash options
In addition to the global options above, the skysqlcli completion bash command accepts the following options:
Option | Description |
|---|---|
disable completion descriptions |
skysqlcli completion fish options
In addition to the global options above, the skysqlcli completion fish command accepts the following options:
Option | Description |
|---|---|
disable completion descriptions |
skysqlcli completion powershell options
In addition to the global options above, the skysqlcli completion powershell command accepts the following options:
Option | Description |
|---|---|
disable completion descriptions |
skysqlcli completion zsh options
In addition to the global options above, the skysqlcli completion zsh command accepts the following options:
Option | Description |
|---|---|
disable completion descriptions |
skysqlcli create allowed-address options
In addition to the global options above, the skysqlcli create allowed-address command accepts the following options:
Option | Description |
|---|---|
Additional comment to help identify address |
skysqlcli create configuration options
In addition to the global options above, the skysqlcli create configuration command accepts the following options:
Option | Description |
|---|---|
JSON object containing configuration | |
Name used to identify the configuration (default: HA) | |
Configuration topology to select (default: Replicated Transactions) |
skysqlcli create service options
In addition to the global options above, the skysqlcli create service command accepts the following options:
Option | Description |
|---|---|
Configurations for maxscale | |
Whether to set up a proxy for maxscale (default: false) | |
Whether to deploy a monitoring cluster alongside the service (default: false) | |
Name used to identify the service | |
Cloud provider to host the service | |
Geographic region to deploy the service | |
Release version to deploy | |
Number of replicas to deploy (default: 0) | |
Size of the nodes running the service (default: Sky-2x4) | |
Specify whether to use SSL/TLS encryption (default: Enabled) | |
Size of the persistent storage disk (default: 100) | |
Tier in which to provision service | |
Service topology to select (default: Single Node Transactions) | |
Amount of IOPS for the volume (e.g., 100). Required for Amazon AWS |
skysqlcli get allowlist options
In addition to the global options above, the skysqlcli get allowlist command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli get configurations options
In addition to the global options above, the skysqlcli get configurations command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) |
skysqlcli get providers options
In addition to the global options above, the skysqlcli get providers command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli get regions options
In addition to the global options above, the skysqlcli get regions command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) | |
MariaDB SkySQL provider to query for regions |
skysqlcli get service-types options
In addition to the global options above, the skysqlcli get service-types command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli get services options
In addition to the global options above, the skysqlcli get services command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Search string to match any services containing the name | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli get sizes options
In addition to the global options above, the skysqlcli get sizes command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) | |
MariaDB SkySQL provider to query for machine sizes | |
MariaDB SkySQL service-type to query for machine sizes (default: t) | |
MariaDB SkySQL tier to query for machine sizes |
skysqlcli get tiers options
In addition to the global options above, the skysqlcli get tiers command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli get topologies options
In addition to the global options above, the skysqlcli get topologies command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) | |
MariaDB SkySQL service-type used to filter list of topologies |
skysqlcli get versions options
In addition to the global options above, the skysqlcli get versions command accepts the following options:
Option | Description |
|---|---|
Number of records to return. Can be used for paginating results in conjuntion with offset. (default: 100) | |
Number of records to skip when retrieved. Can be used for paginating results in conjunction with limit. (default: 0) |
skysqlcli update configuration options
In addition to the global options above, the skysqlcli update configuration command accepts the following options:
Option | Description |
|---|---|
JSON object containing configuration | |
Name used to identify the configuration |
skysqlcli update service options
In addition to the global options above, the skysqlcli update service command accepts the following options:
Option | Description |
|---|---|
Name used to identify the service |