databases

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

Overview

Name	databases
Type	Resource
Id	azure_extras.rdbms.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}. # pylint: disable=line-too-long
name	string	The name of the resource.
charset	string	The charset of the database.
collation	string	The collation of the database.
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}. # pylint: disable=line-too-long
name	string	The name of the resource.
charset	string	The charset of the database.
collation	string	The collation of the database.
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 a database.
list_by_server	select	resource_group_name, server_name, subscription_id		List all the databases in a given server.
create_or_update	insert	resource_group_name, server_name, database_name, subscription_id		Creates a new database or updates an existing database.
create_or_update	replace	resource_group_name, server_name, database_name, subscription_id		Creates a new database or updates an existing database.
delete	delete	resource_group_name, server_name, database_name, subscription_id		Deletes a 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	The name of the database. 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 a database.

SELECT
id,
name,
charset,
collation,
type
FROM azure_extras.rdbms.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

List all the databases in a given server.

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

INSERT examples

create_or_update

Creates a new database or updates an existing database.

INSERT INTO azure_extras.rdbms.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,
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
    value:
      charset: "{{ charset }}"
      collation: "{{ collation }}"

REPLACE examples

create_or_update

Creates a new database or updates an existing database.

REPLACE azure_extras.rdbms.databases
SET 
properties = '{{ properties }}'
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
RETURNING
id,
name,
properties,
type;

DELETE examples

delete

Deletes a database.

DELETE FROM azure_extras.rdbms.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
;