sql_pool_table_columns

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

Overview

Name	sql_pool_table_columns
Type	Resource
Id	azure.synapse.sql_pool_table_columns

Fields

The following fields are returned by SELECT queries:

list_by_table_name

Name	Datatype	Description
properties	object	Resource properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_table_name	select	subscriptionId, resourceGroupName, workspaceName, sqlPoolName, schemaName, tableName	$filter	Gets columns in a given table in a 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.
tableName	string	The name of the table.
workspaceName	string	The name of the workspace.
$filter	string	An OData filter expression that filters elements in the collection.

SELECT examples

list_by_table_name

Gets columns in a given table in a SQL pool.

SELECT
properties
FROM azure.synapse.sql_pool_table_columns
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND sqlPoolName = '{{ sqlPoolName }}' -- required
AND schemaName = '{{ schemaName }}' -- required
AND tableName = '{{ tableName }}' -- required
AND $filter = '{{ $filter }}'
;