SqlDataReference 类

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

初始化 sql 数据引用。

构造函数

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

参数

名称 说明
datastore
必需

要引用的数据存储。

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
必需

要引用的数据存储。

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

指示是否覆盖现有数据。

默认值: False

返回

类型 说明

新的数据引用对象。

as_mount

切换要装载的数据引用作。 SqlDataReference 不支持。

as_mount()

返回

类型 说明

新的数据引用对象。

as_upload

切换要上传的数据引用作。 SqlDataReference 不支持。

as_upload(path_on_compute=None, overwrite=False)

参数

名称 说明
path_on_compute
str

数据引用的计算路径。

默认值: None
overwrite

指示是否覆盖现有数据。

默认值: False

返回

类型 说明

新的数据引用对象。

path

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

path(path=None, data_reference_name=None)

参数

名称 说明
path
str

数据存储上的路径。

默认值: None
data_reference_name
str

数据引用的名称。

默认值: None

返回

类型 说明

新的数据引用对象。

to_config

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

to_config()

返回

类型 说明

新的 DataReferenceConfiguration 对象。