DataSourceDef Class

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	Description
name Required	str The name of the datasource.
description	str The description of the datasource. default value: None
data_type_id	str The data type ID of the datasource. default value: None
datastore_name	str The datastore name the datasource resides on. default value: None
path_on_datastore	str The path on the datastore that corresponds to the datasource. default value: None
sql_table	str The name of the table in SQL database default value: None
sql_query	str The SQL query when using an SQL database default value: None
sql_stored_procedure	str The name of the stored procedure when using an SQL database. default value: None
sql_stored_procedure_params	[StoredProcedureParameter] The optional list of parameters to pass to stored procedure. default value: None
pipeline_dataset	PipelineDataset The PipelineDataset containing the AzureML Dataset that will be used. default value: None
name Required	str Name of the datasource.
description Required	str Description of the datasource.
data_type_id Required	str The data type id of the datasource.
datastore_name Required	str The datastore name the datasource resides on.
path_on_datastore Required	str The path on the datastore that corresponds to the datasource.
sql_table Required	str the name of the table in SQL database
sql_query Required	str the sql query when using an SQL database
sql_stored_procedure Required	str the name of the stored procedure when using an SQL database
sql_stored_procedure_params Required	[StoredProcedureParameter] the optional list of parameters to pass to stored procedure.
pipeline_dataset Required	PipelineDataset 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

Type	Description
str	The hexdigest hash.

create_from_data_reference

Create a DataSourceDef using a DataReference.

static create_from_data_reference(data_reference)

Parameters

Name	Description
data_reference Required	DataReference A data reference object.

Returns

Type	Description
DataSourceDef	A DataSourceDef object.

Attributes

data_type_id

Get the data type id of the datasource.

Returns

Type	Description
str	The data type id of the datasource.

description

Get the description of the datasource.

Returns

Type	Description
str	The description of the datasource.

name

Get the name of the datasource.

Returns

Type	Description
str	The name of the datasource.

output_port_def

Get the output port definition.

Returns

Type	Description
OutputPortDef	The output port definition.