SqlDataReference Class

Represents a reference to data in a datastore that saves connection information to a SQL database.

Initialize sql data reference.

Inheritance

DataReference

SqlDataReference

Constructor

SqlDataReference(datastore, data_reference_name=None, sql_table=None, sql_query=None, sql_stored_procedure=None, sql_stored_procedure_params=None)

Parameters

Name	Description
datastore Required	AzureSqlDatabaseDatastore or AzurePostgreSqlDatastore or AzureMySqlDatastore The Datastore to reference.
data_reference_name	str The name of the data reference. Default value: None
sql_table	str, <xref:optional> The name of the table in SQL database. Default value: None
sql_query	str, <xref:optional> The SQL query to use with the SQL database. Default value: None
sql_stored_procedure	str, <xref:optional> The name of the stored procedure invoke in the SQL database. Default value: None
sql_stored_procedure_params	[StoredProcedureParameter], <xref:optional> An optional list of parameters to pass to the stored procedure. Default value: None
datastore Required	AzureSqlDatabaseDatastore or AzurePostgreSqlDatastore or AzureMySqlDatastore The Datastore to reference.
data_reference_name Required	str The name of the data reference.
sql_table Required	str, <xref:optional> The name of the table in SQL database.
sql_query Required	str, <xref:optional> The SQL query to use with the SQL database.
sql_stored_procedure Required	str, <xref:optional> The name of the stored procedure invoke in the SQL database.
sql_stored_procedure_params Required	[StoredProcedureParameter], <xref:optional> An optional list of parameters to pass to stored procedure.

Methods

as_download	Switch data reference operation to download. Not supported for SqlDataReference.
as_mount	Switch data reference operation to mount. Not supported for SqlDataReference.
as_upload	Switch data reference operation to upload. Not supported for SqlDataReference.
path	Create a SqlDataReference instance based on the given path. Not supported for SqlDataReference.
to_config	Convert the DataReference object to DataReferenceConfiguration object. Not supported for SqlDataReference.

as_download

Switch data reference operation to download. Not supported for SqlDataReference.

as_download(path_on_compute=None, overwrite=False)

Parameters

Name	Description
path_on_compute	str The path on the compute for the data reference. Default value: None
overwrite	bool Indicates whether to overwrite existing data. Default value: False

Returns

Type	Description
DataReference	A new data reference object.

as_mount

Switch data reference operation to mount. Not supported for SqlDataReference.

as_mount()

Returns

Type	Description
DataReference	A new data reference object.

as_upload

Switch data reference operation to upload. Not supported for SqlDataReference.

as_upload(path_on_compute=None, overwrite=False)

Parameters

Name	Description
path_on_compute	str The path on the compute for the data reference. Default value: None
overwrite	bool Indicates whether to overwrite existing data. Default value: False

Returns

Type	Description
DataReference	A new data reference object.

path

Create a SqlDataReference instance based on the given path. Not supported for SqlDataReference.

path(path=None, data_reference_name=None)

Parameters

Name	Description
path	str The path on the datastore. Default value: None
data_reference_name	str The name of the data reference. Default value: None

Returns

Type	Description
DataReference	A new data reference object.

to_config

Convert the DataReference object to DataReferenceConfiguration object. Not supported for SqlDataReference.

to_config()

Returns

Type	Description
DataReferenceConfiguration	A new DataReferenceConfiguration object.