DataSourceDef Class
Definition of a datasource.
Initialize DataSourceDef.
- Inheritance
-
builtins.objectDataSourceDef
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
|
The name of the datasource. |
description
|
The description of the datasource. Default value: None
|
data_type_id
|
The data type ID of the datasource. Default value: None
|
datastore_name
|
The datastore name the datasource resides on. Default value: None
|
path_on_datastore
|
The path on the datastore that corresponds to the datasource. Default value: None
|
sql_table
|
The name of the table in SQL database Default value: None
|
sql_query
|
The SQL query when using an SQL database Default value: None
|
sql_stored_procedure
|
The name of the stored procedure when using an SQL database. Default value: None
|
sql_stored_procedure_params
|
The optional list of parameters to pass to stored procedure. Default value: None
|
pipeline_dataset
|
The PipelineDataset containing the AzureML Dataset that will be used. Default value: None
|
name
Required
|
Name of the datasource. |
description
Required
|
Description of the datasource. |
data_type_id
Required
|
The data type id of the datasource. |
datastore_name
Required
|
The datastore name the datasource resides on. |
path_on_datastore
Required
|
The path on the datastore that corresponds to the datasource. |
sql_table
Required
|
the name of the table in SQL database |
sql_query
Required
|
the sql query when using an SQL database |
sql_stored_procedure
Required
|
the name of the stored procedure when using an SQL database |
sql_stored_procedure_params
Required
|
the optional list of parameters to pass to stored procedure. |
pipeline_dataset
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
create_from_data_reference
Create a DataSourceDef using a DataReference.
static create_from_data_reference(data_reference)
Parameters
Name | Description |
---|---|
data_reference
Required
|
A data reference object. |
Returns
Type | Description |
---|---|
A DataSourceDef object. |
Attributes
data_type_id
Get the data type id of the datasource.
Returns
Type | Description |
---|---|
The data type id of the datasource. |
description
Get the description of the datasource.
Returns
Type | Description |
---|---|
The description of the datasource. |