| title | azdata arc postgres server reference |
|---|---|
| titleSuffix | SQL Server big data clusters |
| description | Reference article for azdata arc postgres server commands. |
| author | MikeRayMSFT |
| ms.author | mikeray |
| ms.reviewer | seanw |
| ms.date | 09/22/2020 |
| ms.topic | reference |
| ms.prod | sql |
| ms.technology | big-data-cluster |
Applies to [!INCLUDE azure-data-cli-azdata]
The following article provides reference for the sql commands in the azdata tool. For more information about other azdata commands, see azdata reference
| Command | Description |
|---|---|
| azdata arc postgres server create | Create a PostgreSQL server group. |
| azdata arc postgres server edit | Edit the configuration of a PostgreSQL server group. |
| azdata arc postgres server delete | Delete a PostgreSQL server group. |
| azdata arc postgres server show | Show the details of a PostgreSQL server group. |
| azdata arc postgres server list | List PostgreSQL server groups. |
| azdata arc postgres server config | Configuration commands. |
| azdata arc postgres server backup | Manage PostgreSQL server group backups. |
To set the password of the server group, please set the environment variable AZDATA_PASSWORD
azdata arc postgres server create --name -n
[--path]
[--cores-limit -cl]
[--cores-request -cr]
[--memory-limit -ml]
[--memory-request -mr]
[--storage-class-data -scd]
[--storage-class-logs -scl]
[--storage-class-backups -scb]
[--extensions]
[--volume-size-data -vsd]
[--volume-size-logs -vsl]
[--volume-size-backups -vsb]
[--workers -w]
[--engine-version -ev]
[--no-external-endpoint]
[--dev]
[--port]
[--no-wait]
[--engine-settings -e]Create a PostgreSQL server group.
azdata arc postgres server create -n pg1Create a PostgreSQL server group with engine settings. Both below examples are valid.
azdata arc postgres server create -n pg1 --engine-settings "key1=val1"
azdata arc postgres server create -n pg1 --engine-settings "key2=val2"Name of the instance.
The path to the source json file for the PostgreSQL server group. This is optional.
The maximum number of CPU cores for postgres instance that can be used per node. Fractional cores are supported.
The minimum number of CPU cores that must be available per node to schedule the service. Fractional cores are supported.
The memory limit of the postgres instance as a number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).
The memory request of the postgres instance as a number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).
The storage class to be used for data persistent volumes.
The storage class to be used for logs persistent volumes.
The storage class to be used for backup persistent volumes.
A comma-separated list of the Postgres extensions that should be loaded on startup. Please refer to the postgres documentation for supported values.
The size of the storage volume to be used for data as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).
The size of the storage volume to be used for logs as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).
The size of the storage volume to be used for backups as a positive number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes).
The number of worker nodes to provision in a sharded cluster, or zero (the default) for single-node Postgres.
Must be 11 or 12. The default value is 12.
If specified, no external service will be created. Otherwise, an external service will be created using the same service type as the data controller.
If this is specified, then it is considered a dev instance and will not be billed for.
Optional.
If given, the command will not wait for the instance to be in a ready state before returning.
A comma separated list of Postgres engine settings in the format 'key1=val1, key2=val2'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Edit the configuration of a PostgreSQL server group.
azdata arc postgres server edit --name -n
[--path]
[--workers -w]
[--engine-version -ev]
[--cores-limit -cl]
[--cores-request -cr]
[--memory-limit -ml]
[--memory-request -mr]
[--extensions]
[--dev]
[--port]
[--no-wait]
[--engine-settings -e]
[--replace-engine-settings -re]
[--admin-password]Edit the configuration of a PostgreSQL server group.
azdata arc postgres server edit --src ./spec.json -n pg1Edit a PostgreSQL server group with engine settings.
azdata arc postgres server edit -n pg1 --engine-settings "key2=val2"Edits a PostgreSQL server group and replaces existing engine settings with new setting key1=val1.
azdata arc postgres server edit -n pg1 --engine-settings "key1=val1" --replace-engine-settingsName of the PostgreSQL server group that is being edited. The name under which your instance is deployed cannot be changed.
The path to the source json file for the PostgreSQL server group. This is optional.
The number of worker nodes to provision in a sharded cluster, or zero (the default) for single-node Postgres.
Engine version cannot be changed. --engine-version can be used in conjunction with --name to identify a PostgreSQL Hyperscale server group when two server groups of different engine version have the same name. --engine-version is optional and when used to identify a server group, it must be 11 or 12.
The maximum number of CPU cores for postgres instance that can be used per node, fractional cores are supported. To remove the cores_limit, specify its value as empty string.
The minimum number of CPU cores that must be available per node to schedule the service, fractional cores are supported. To remove the cores_request, specify its value as empty string.
The memory limit for postgres instance as a number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes). To remove the memory_limit, specify its value as empty string.
The memory request for postgres instance as a number followed by Ki (kilobytes), Mi (megabytes), or Gi (gigabytes). To remove the memory_request, specify its value as empty string.
A comma-separated list of the Postgres extensions that should be loaded on startup. Please refer to the postgres documentation for supported values.
If this is specified, then it is considered a dev instance and will not be billed for.
Optional.
If given, the command will not wait for the instance to be in a ready state before returning.
A comma separated list of Postgres engine settings in the format 'key1=val1, key2=val2'. The provided settings will be merged with the existing settings. To remove a setting, provide an empty value like 'removedKey='. If you change an engine setting that requires a restart, the service will be restarted to apply the settings immediately.
When specified with --engine-settings, will replace all existing custom engine settings with new set of settings and values.
If given, the Postgres server's admin password will be set to the value of the AZDATA_PASSWORD environment variable if present and a prompted value otherwise.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Delete a PostgreSQL server group.
azdata arc postgres server delete --name -n
[--engine-version -ev]Delete a PostgreSQL server group.
azdata arc postgres server delete -n pg1Name of the PostgreSQL server group.
--engine-version can be used in conjunction with --name to identify a PostgreSQL Hyperscale server group when two server groups of different engine version have the same name. --engine-version is optional and when used to identify a server group, it must be 11 or 12.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Show the details of a PostgreSQL server group.
azdata arc postgres server show --name -n
[--engine-version -ev]
[--path -p]Show the details of a PostgreSQL server group.
azdata arc postgres server show -n pg1Name of the PostgreSQL server group.
--engine-version can be used in conjunction with --name to identify a PostgreSQL Hyperscale server group when two server groups of different engine version have the same name. --engine-version is optional and when used to identify a server group, it must be 11 or 12.
A path where the full specification for the PostgreSQL server group should be written. If omitted, the specification will be written to standard output.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
List PostgreSQL server groups.
azdata arc postgres server list List PostgreSQL server groups.
azdata arc postgres server listIncrease logging verbosity to show all debug logs.
Show this help message and exit.
Output format. Allowed values: json, jsonc, table, tsv. Default: json.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
For more information about other azdata commands, see azdata reference.
For more information about how to install the azdata tool, see Install azdata.