SqlDataReference Class

  • Reference

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

datastore
AzureSqlDatabaseDatastore or AzurePostgreSqlDatastore or AzureMySqlDatastore
Required

The Datastore to reference.

data_reference_name
str
default value: None

The name of the data reference.

sql_table
str, <xref:optional>
default value: None

The name of the table in SQL database.

sql_query
str, <xref:optional>
default value: None

The SQL query to use with the SQL database.

sql_stored_procedure
str, <xref:optional>
default value: None

The name of the stored procedure invoke in the SQL database.

sql_stored_procedure_params
[StoredProcedureParameter], <xref:optional>
default value: None

An optional list of parameters to pass to the stored procedure.

datastore
AzureSqlDatabaseDatastore or AzurePostgreSqlDatastore or AzureMySqlDatastore
Required

The Datastore to reference.

data_reference_name
str
Required

The name of the data reference.

sql_table
str, <xref:optional>
Required

The name of the table in SQL database.

sql_query
str, <xref:optional>
Required

The SQL query to use with the SQL database.

sql_stored_procedure
str, <xref:optional>
Required

The name of the stored procedure invoke in the SQL database.

sql_stored_procedure_params
[StoredProcedureParameter], <xref:optional>
Required

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

path_on_compute
str
default value: None

The path on the compute for the data reference.

overwrite
bool
default value: False

Indicates whether to overwrite existing data.

Returns

A new data reference object.

Return type

DataReference

as_mount

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

as_mount()

Returns

A new data reference object.

Return type

DataReference

as_upload

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

as_upload(path_on_compute=None, overwrite=False)

Parameters

path_on_compute
str
default value: None

The path on the compute for the data reference.

overwrite
bool
default value: False

Indicates whether to overwrite existing data.

Returns

A new data reference object.

Return type

DataReference

path

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

path(path=None, data_reference_name=None)

Parameters

path
str
default value: None

The path on the datastore.

data_reference_name
str
default value: None

The name of the data reference.

Returns

A new data reference object.

Return type

DataReference

to_config

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

to_config()

Returns

A new DataReferenceConfiguration object.

Return type

DataReferenceConfiguration