dataset

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

Overview

Name	dataset
Type	Resource
Id	azure.synapse_artifacts.dataset

Fields

The following fields are returned by SELECT queries:

get_dataset

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.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
etag	string	Resource Etag.
folder	object	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	object	Linked service reference. Required.
parameters	object	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

get_datasets_by_workspace

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.
	object	Unmatched properties from the message are deserialized to this collection.
annotations	array	List of tags that can be used for describing the Dataset.
description	string	Dataset description.
etag	string	Resource Etag.
folder	object	The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
linkedServiceName	object	Linked service reference. Required.
parameters	object	Parameters for dataset.
schema	object	Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
structure	object	Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
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_dataset	select	dataset_name, endpoint	If-None-Match	Gets a dataset.
get_datasets_by_workspace	select	endpoint		Lists datasets.
create_or_update_dataset	insert	dataset_name, endpoint, type, linkedServiceName	If-Match	Creates or updates a dataset.
create_or_update_dataset	replace	dataset_name, endpoint, type, linkedServiceName	If-Match	Creates or updates a dataset.
delete_dataset	delete	dataset_name, endpoint		Deletes a dataset.
rename_dataset	exec	dataset_name, endpoint		Renames a dataset.

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
dataset_name	string	The dataset name. Required.
endpoint	string	The service endpoint host (no scheme). (default: )
If-Match	string	ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
If-None-Match	string	ETag of the dataset entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. Default value is None.

SELECT examples

get_dataset

Gets a dataset.

SELECT
id,
name,
,
annotations,
description,
etag,
folder,
linkedServiceName,
parameters,
schema,
structure,
type
FROM azure.synapse_artifacts.dataset
WHERE dataset_name = '{{ dataset_name }}' -- required
AND endpoint = '{{ endpoint }}' -- required
AND If-None-Match = '{{ If-None-Match }}'
;

get_datasets_by_workspace

Lists datasets.

SELECT
id,
name,
,
annotations,
description,
etag,
folder,
linkedServiceName,
parameters,
schema,
structure,
type
FROM azure.synapse_artifacts.dataset
WHERE endpoint = '{{ endpoint }}' -- required
;

INSERT examples

create_or_update_dataset

Creates or updates a dataset.

INSERT INTO azure.synapse_artifacts.dataset (
,
type,
description,
structure,
schema,
linkedServiceName,
parameters,
annotations,
folder,
dataset_name,
endpoint,
If-Match
)
SELECT 
'{{  }}',
'{{ type }}' /* required */,
'{{ description }}',
'{{ structure }}',
'{{ schema }}',
'{{ linkedServiceName }}' /* required */,
'{{ parameters }}',
'{{ annotations }}',
'{{ folder }}',
'{{ dataset_name }}',
'{{ endpoint }}',
'{{ If-Match }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: dataset
props:
  - name: dataset_name
    value: "{{ dataset_name }}"
    description: Required parameter for the dataset resource.
  - name: endpoint
    value: "{{ endpoint }}"
    description: Required parameter for the dataset resource.
  - name: 
    value: "{{  }}"
    description: |
      Unmatched properties from the message are deserialized to this collection.
  - name: type
    value: "{{ type }}"
    description: |
      Type of dataset. Required.
  - name: description
    value: "{{ description }}"
    description: |
      Dataset description.
  - name: structure
    value: "{{ structure }}"
    description: |
      Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.
  - name: schema
    value: "{{ schema }}"
    description: |
      Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.
  - name: linkedServiceName
    description: |
      Linked service reference. Required.
    value:
      type: "{{ type }}"
      referenceName: "{{ referenceName }}"
      parameters: "{{ parameters }}"
  - name: parameters
    value: "{{ parameters }}"
    description: |
      Parameters for dataset.
  - name: annotations
    value: "{{ annotations }}"
    description: |
      List of tags that can be used for describing the Dataset.
  - name: folder
    description: |
      The folder that this Dataset is in. If not specified, Dataset will appear at the root level.
    value:
      name: "{{ name }}"
  - name: If-Match
    value: "{{ If-Match }}"
    description: ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.
    description: ETag of the dataset entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update. Default value is None.

REPLACE examples

create_or_update_dataset

Creates or updates a dataset.

REPLACE azure.synapse_artifacts.dataset
SET 
 = '{{  }}',
type = '{{ type }}',
description = '{{ description }}',
structure = '{{ structure }}',
schema = '{{ schema }}',
linkedServiceName = '{{ linkedServiceName }}',
parameters = '{{ parameters }}',
annotations = '{{ annotations }}',
folder = '{{ folder }}'
WHERE 
dataset_name = '{{ dataset_name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND type = '{{ type }}' --required
AND linkedServiceName = '{{ linkedServiceName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete_dataset

Deletes a dataset.

DELETE FROM azure.synapse_artifacts.dataset
WHERE dataset_name = '{{ dataset_name }}' --required
AND endpoint = '{{ endpoint }}' --required
;

Lifecycle Methods

rename_dataset

Renames a dataset.

EXEC azure.synapse_artifacts.dataset.rename_dataset 
@dataset_name='{{ dataset_name }}' --required, 
@endpoint='{{ endpoint }}' --required
;