sql_pool_schemas

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

Overview

Name	sql_pool_schemas
Type	Resource
Id	azure.synapse.sql_pool_schemas

Fields

The following fields are returned by SELECT queries:

get

Successfully retrieved Sql Pool schema.

Name	Datatype	Description

list

Name	Datatype	Description
nextLink	string	Link to retrieve next page of results.
value	array	Array of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName		Get Sql Pool schema
list	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName	$filter	Gets schemas of a given SQL pool.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
schemaName	string	The name of the schema.
sqlPoolName	string	SQL pool name
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.
$filter	string	An OData filter expression that filters elements in the collection.

SELECT examples

get

Get Sql Pool schema

SELECT
*
FROM azure.synapse.sql_pool_schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
;

list

Gets schemas of a given SQL pool.

SELECT
nextLink,
value
FROM azure.synapse.sql_pool_schemas
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND $filter = '{{ $filter }}'
;