DataSourceDef Class

  • Reference

Definition of a datasource.

Initialize DataSourceDef.

Inheritance
builtins.object
DataSourceDef

Constructor

DataSourceDef(name, description=None, data_type_id=None, datastore_name=None, path_on_datastore=None, sql_table=None, sql_query=None, sql_stored_procedure=None, sql_stored_procedure_params=None, pipeline_dataset=None)

Parameters

name
str
Required

The name of the datasource.

description
str
default value: None

The description of the datasource.

data_type_id
str
default value: None

The data type ID of the datasource.

datastore_name
str
default value: None

The datastore name the datasource resides on.

path_on_datastore
str
default value: None

The path on the datastore that corresponds to the datasource.

sql_table
str
default value: None

The name of the table in SQL database

sql_query
str
default value: None

The SQL query when using an SQL database

sql_stored_procedure
str
default value: None

The name of the stored procedure when using an SQL database.

sql_stored_procedure_params
[StoredProcedureParameter]
default value: None

The optional list of parameters to pass to stored procedure.

pipeline_dataset
PipelineDataset
default value: None

The PipelineDataset containing the AzureML Dataset that will be used.

name
str
Required

Name of the datasource.

description
str
Required

Description of the datasource.

data_type_id
str
Required

The data type id of the datasource.

datastore_name
str
Required

The datastore name the datasource resides on.

path_on_datastore
str
Required

The path on the datastore that corresponds to the datasource.

sql_table
str
Required

the name of the table in SQL database

sql_query
str
Required

the sql query when using an SQL database

sql_stored_procedure
str
Required

the name of the stored procedure when using an SQL database

sql_stored_procedure_params
[StoredProcedureParameter]
Required

the optional list of parameters to pass to stored procedure.

pipeline_dataset
PipelineDataset
Required

The PipelineDataset containing the AzureML Dataset that will be used.

Methods

calculate_hash

Calculate hash of the datasource.
create_from_data_reference

Create a DataSourceDef using a DataReference.

calculate_hash

Calculate hash of the datasource.

calculate_hash()

Returns

The hexdigest hash.

Return type

str

create_from_data_reference

Create a DataSourceDef using a DataReference.

static create_from_data_reference(data_reference)

Parameters

data_reference
DataReference
Required

A data reference object.

Returns

A DataSourceDef object.

Return type

DataSourceDef

Attributes

data_type_id

Get the data type id of the datasource.

Returns

The data type id of the datasource.

Return type

str

description

Get the description of the datasource.

Returns

The description of the datasource.

Return type

str

name

Get the name of the datasource.

Returns

The name of the datasource.

Return type

str

output_port_def

Get the output port definition.

Returns

The output port definition.

Return type

OutputPortDef