SqlServerTableDataset Class

  • Reference
Package:
com.azure.analytics.synapse.artifacts.models
Maven Artifact:
com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.14

public class SqlServerTableDataset
extends Dataset

The on-premises SQL Server dataset.

Constructor Summary

Constructor Description
SqlServerTableDataset()

Creates an instance of SqlServerTableDataset class.

Method Summary

Modifier and Type Method and Description
Object getSchemaTypePropertiesSchema()

Get the schemaTypePropertiesSchema property: The schema name of the SQL Server dataset.
Object getTable()

Get the table property: The table name of the SQL Server dataset.
Object getTableName()

Get the tableName property: This property will be retired.
SqlServerTableDataset setAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.
SqlServerTableDataset setDescription(String description)

Set the description property: Dataset description.
SqlServerTableDataset setFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in.
SqlServerTableDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.
SqlServerTableDataset setParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for dataset.
SqlServerTableDataset setSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset.
SqlServerTableDataset setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)

Set the schemaTypePropertiesSchema property: The schema name of the SQL Server dataset.
SqlServerTableDataset setStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset.
SqlServerTableDataset setTable(Object table)

Set the table property: The table name of the SQL Server dataset.
SqlServerTableDataset setTableName(Object tableName)

Set the tableName property: This property will be retired.

Methods inherited from Dataset

getAdditionalProperties getAnnotations getDescription getFolder getLinkedServiceName getParameters getSchema getStructure setAdditionalProperties setAnnotations setDescription setFolder setLinkedServiceName setParameters setSchema setStructure

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SqlServerTableDataset

public SqlServerTableDataset()

Creates an instance of SqlServerTableDataset class.

Method Details

getSchemaTypePropertiesSchema

public Object getSchemaTypePropertiesSchema()

Get the schemaTypePropertiesSchema property: The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

Returns:

the schemaTypePropertiesSchema value.

getTable

public Object getTable()

Get the table property: The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

Returns:

the table value.

getTableName

public Object getTableName()

Get the tableName property: This property will be retired. Please consider using schema + table properties instead.

Returns:

the tableName value.

setAnnotations

public SqlServerTableDataset setAnnotations(List annotations)

Set the annotations property: List of tags that can be used for describing the Dataset.

Overrides:

SqlServerTableDataset.setAnnotations(List<Object> annotations)

Parameters:

annotations

setDescription

public SqlServerTableDataset setDescription(String description)

Set the description property: Dataset description.

Overrides:

SqlServerTableDataset.setDescription(String description)

Parameters:

description

setFolder

public SqlServerTableDataset setFolder(DatasetFolder folder)

Set the folder property: The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

Overrides:

SqlServerTableDataset.setFolder(DatasetFolder folder)

Parameters:

folder

setLinkedServiceName

public SqlServerTableDataset setLinkedServiceName(LinkedServiceReference linkedServiceName)

Set the linkedServiceName property: Linked service reference.

Overrides:

SqlServerTableDataset.setLinkedServiceName(LinkedServiceReference linkedServiceName)

Parameters:

linkedServiceName

setParameters

public SqlServerTableDataset setParameters(Map parameters)

Set the parameters property: Parameters for dataset.

Overrides:

SqlServerTableDataset.setParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

setSchema

public SqlServerTableDataset setSchema(Object schema)

Set the schema property: Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

Overrides:

SqlServerTableDataset.setSchema(Object schema)

Parameters:

schema

setSchemaTypePropertiesSchema

public SqlServerTableDataset setSchemaTypePropertiesSchema(Object schemaTypePropertiesSchema)

Set the schemaTypePropertiesSchema property: The schema name of the SQL Server dataset. Type: string (or Expression with resultType string).

Parameters:

schemaTypePropertiesSchema - the schemaTypePropertiesSchema value to set.

Returns:

the SqlServerTableDataset object itself.

setStructure

public SqlServerTableDataset setStructure(Object structure)

Set the structure property: Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

Overrides:

SqlServerTableDataset.setStructure(Object structure)

Parameters:

structure

setTable

public SqlServerTableDataset setTable(Object table)

Set the table property: The table name of the SQL Server dataset. Type: string (or Expression with resultType string).

Parameters:

table - the table value to set.

Returns:

the SqlServerTableDataset object itself.

setTableName

public SqlServerTableDataset setTableName(Object tableName)

Set the tableName property: This property will be retired. Please consider using schema + table properties instead.

Parameters:

tableName - the tableName value to set.

Returns:

the SqlServerTableDataset object itself.

Applies to