databases

Creates, updates, deletes, gets or lists a databases resource.

Overview

Name	databases
Type	Resource
Id	azure.postgresql_flexible_servers.databases

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
charset	string	Character set of the database.
collation	string	Collation of the database.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_server

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
charset	string	Character set of the database.
collation	string	Collation of the database.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, server_name, database_name, subscription_id		Gets information about an existing database.
list_by_server	select	resource_group_name, server_name, subscription_id		Lists all databases in a server.
create	insert	resource_group_name, server_name, database_name, subscription_id		Creates a new database.
delete	delete	resource_group_name, server_name, database_name, subscription_id		Deletes an existing database.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
database_name	string	Name of the database (case-sensitive). Exact database names can be retrieved by getting the list of all existing databases in a server. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
server_name	string	The name of the server. Required.
subscription_id	string

SELECT examples

get

Gets information about an existing database.

SELECT
id,
name,
charset,
collation,
systemData,
type
FROM azure.postgresql_flexible_servers.databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND database_name = '{{ database_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_server

Lists all databases in a server.

SELECT
id,
name,
charset,
collation,
systemData,
type
FROM azure.postgresql_flexible_servers.databases
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND server_name = '{{ server_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Creates a new database.

INSERT INTO azure.postgresql_flexible_servers.databases (
properties,
resource_group_name,
server_name,
database_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ server_name }}',
'{{ database_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: databases
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the databases resource.
  - name: server_name
    value: "{{ server_name }}"
    description: Required parameter for the databases resource.
  - name: database_name
    value: "{{ database_name }}"
    description: Required parameter for the databases resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the databases resource.
  - name: properties
    description: |
      Properties of a database.
    value:
      charset: "{{ charset }}"
      collation: "{{ collation }}"

DELETE examples

delete

Deletes an existing database.

DELETE FROM azure.postgresql_flexible_servers.databases
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND server_name = '{{ server_name }}' --required
AND database_name = '{{ database_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;