databases

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

Overview

Name	databases
Type	Resource
Id	azure.mysql.databases

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
properties	object	The properties of a database.

list_by_server

Name	Datatype	Description
properties	object	The properties of a database.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, serverName, databaseName		Gets information about a database.
list_by_server	select	subscriptionId, resourceGroupName, serverName		List all the databases in a given server.
create_or_update	insert	subscriptionId, resourceGroupName, serverName, databaseName		Creates a new database or updates an existing database.
delete	delete	subscriptionId, resourceGroupName, serverName, databaseName		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
databaseName	string	The name of the database.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serverName	string	The name of the server.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about a database.

SELECT
properties
FROM azure.mysql.databases
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
AND databaseName = '{{ databaseName }}' -- required
;

list_by_server

List all the databases in a given server.

SELECT
properties
FROM azure.mysql.databases
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND serverName = '{{ serverName }}' -- required
;

INSERT examples

create_or_update

Creates a new database or updates an existing database.

INSERT INTO azure.mysql.databases (
data__properties,
subscriptionId,
resourceGroupName,
serverName,
databaseName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ serverName }}',
'{{ databaseName }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: databases
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the databases resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the databases resource.
    - name: serverName
      value: string
      description: Required parameter for the databases resource.
    - name: databaseName
      value: string
      description: Required parameter for the databases resource.
    - name: properties
      value: object
      description: |
        The properties of a database.

DELETE examples

delete

Deletes a database.

DELETE FROM azure.mysql.databases
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND serverName = '{{ serverName }}' --required
AND databaseName = '{{ databaseName }}' --required
;