🕸️ SnowFlake

二、API 接口说明

alcedo_pdbc.datawarehouse.SnowFlake

Functions

alcedo_pdbc.datawarehouse.SnowFlake.download_as_file(query, filename, database=None, schema=None, protocol='https') method descriptor

SnowFlake.download_as_file(self, str query: str, str filename: str, str database: str = None, str schema: str = None, str protocol: str = 'https') -> None

Takes query, filename as arguments and download the data as file

Parameters:

Name	Type	Description	Default
query	str	select query	required
filename	str	filename to save the file	required
database	str	database name, if None, it take it from config. Defaults to None.	None
schema	str	schema name, if None, it take it from config. Defaults to None.	None

Returns:

Name	Type	Description
file	``CSV``、``Excel``、 ``JSON``、``HTML``、 ``HDF5``、 ``Feather``、 ``Parquet`` 、``Apache Avro``	根据参数filename文件类型导出文件保存至指定的目录下

alcedo_pdbc.datawarehouse.SnowFlake.read_as_dataframe(query, database=None, schema=None, protocol='https', return_type='pandas') method descriptor

SnowFlake.read_as_dataframe(self, str query: str, str database: str = None, str schema: str = None, str protocol: str = 'https', str return_type: str = 'pandas')

Takes query as arguments and return dataframe

Parameters:

Name	Type	Description	Default
query	str	select query	required
database	str	database name, if None, it take it from config. Defaults to None.	None
schema	str	schema name, if None, it take it from config. Defaults to None.	None
protocol	str	protocol Defaults to 'https'.	'https'
return_type	str	which dataframe you want to return (pandas, polars, dask etc). Defaults to	'pandas'

Returns:

Name	Type	Description
DataFrame	``Pandas``、``Polars`` or ``Dask``	根据 return_type 参数返回对应的数据帧 Dataframe

alcedo_pdbc.datawarehouse.SnowFlake.write_dataframe(df, table_name, database=None, schema=None, protocol='https') method descriptor

SnowFlake.write_dataframe(self, df, str table_name: str, str database: str = None, str schema: str = None, str protocol: str = 'https')

Takes dataframe, table name as arguments and write the dataframe to SnowFlake

Parameters:

Name	Type	Description	Default
df	Dataframe	Dataframe which need to be loaded	required
table_name	str	table name	required
database	str	database name. Defaults to None.	None
schema	str	schema name. Defaults to None.	None
protocol	str	protocol used. Defaults to 'https'.	'https'