SqlDataReference 类

参考

表示对数据存储中将连接信息保存到 SQL 数据库的数据的引用。

初始化 sql 数据引用。

继承: DataReference

SqlDataReference

构造函数

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

参数

名称	说明
datastore 必需	AzureSqlDatabaseDatastore 或 AzurePostgreSqlDatastore 或 AzureMySqlDatastore 要引用的数据存储。
data_reference_name	str 数据引用的名称。默认值: None
sql_table	str, <xref:optional> SQL 数据库中的表的名称。默认值: None
sql_query	str, <xref:optional> 要与 SQL 数据库配合使用的 SQL 查询。默认值: None
sql_stored_procedure	str, <xref:optional> SQL 数据库中的存储过程调用的名称。默认值: None
sql_stored_procedure_params	[StoredProcedureParameter], <xref:optional> 要传递到存储过程的可选的参数列表。默认值: None
datastore 必需	AzureSqlDatabaseDatastore 或 AzurePostgreSqlDatastore 或 AzureMySqlDatastore 要引用的数据存储。
data_reference_name 必需	str 数据引用的名称。
sql_table 必需	str, <xref:optional> SQL 数据库中的表的名称。
sql_query 必需	str, <xref:optional> 要与 SQL 数据库配合使用的 SQL 查询。
sql_stored_procedure 必需	str, <xref:optional> SQL 数据库中的存储过程调用的名称。
sql_stored_procedure_params 必需	[StoredProcedureParameter], <xref:optional> 要传递给存储过程的参数的可选列表。

方法

as_download	将数据引用操作切换为下载。不支持用于 SqlDataReference。
as_mount	将数据引用操作切换为装载。不支持用于 SqlDataReference。
as_upload	将数据引用操作切换为上传。不支持用于 SqlDataReference。
path	基于给定路径创建 SqlDataReference 实例。不支持用于 SqlDataReference。
to_config	将 DataReference 对象转换为 DataReferenceConfiguration 对象。不支持用于 SqlDataReference。

as_download

将数据引用操作切换为下载。不支持用于 SqlDataReference。

as_download(path_on_compute=None, overwrite=False)

参数

名称	说明
path_on_compute	str 用于数据引用的计算的路径。默认值: None
overwrite	bool 指示是否覆盖现有数据。默认值: False

类型	说明
DataReference	新的数据引用对象。

as_mount

将数据引用操作切换为装载。不支持用于 SqlDataReference。

as_mount()

类型	说明
DataReference	新的数据引用对象。

as_upload

将数据引用操作切换为上传。不支持用于 SqlDataReference。

as_upload(path_on_compute=None, overwrite=False)

参数

名称	说明
path_on_compute	str 用于数据引用的计算的路径。默认值: None
overwrite	bool 指示是否覆盖现有数据。默认值: False

类型	说明
DataReference	新的数据引用对象。

path

基于给定路径创建 SqlDataReference 实例。不支持用于 SqlDataReference。

path(path=None, data_reference_name=None)

参数

名称	说明
path	str 数据存储上的路径。默认值: None
data_reference_name	str 数据引用的名称。默认值: None

类型	说明
DataReference	新的数据引用对象。

to_config

将 DataReference 对象转换为 DataReferenceConfiguration 对象。不支持用于 SqlDataReference。

to_config()

类型	说明
DataReferenceConfiguration	新的 DataReferenceConfiguration 对象。

通过