🕸️ StarRocks

二、API 接口说明

alcedo_pdbc.datawarehouse.StarRocks

StarRocks class create the ligo starrocks object, through which you can able to read, write, download data from StarRocks.

Parameters:

Name	Type	Description	Default
config	dict	Automatically loaded from the config file (yaml)	required

Functions

alcedo_pdbc.datawarehouse.StarRocks.download_as_file(query, filename, database=None) method descriptor

StarRocks.download_as_file(self, str query: str, str filename: str, str database: str = None) -> 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

Returns:

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

alcedo_pdbc.datawarehouse.StarRocks.read_as_dataframe(query, database=None, return_type='pandas') method descriptor

StarRocks.read_as_dataframe(self, str query: str, str database: str = None, str return_type: str = 'pandas')

Takes query as argument and return a 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
return_type	str	which dataframe you want to return (pandas, polars, dask etc). Defaults to 'pandas'. Defaults to 'pandas'.	'pandas'

Returns:

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

alcedo_pdbc.datawarehouse.StarRocks.write_dataframe(df, table_name, database=None, if_exists='append', index=False) method descriptor

StarRocks.write_dataframe(self, df, str table_name: str, str database: str = None, str if_exists: str = 'append', index=False)

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

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
if_exists	str	operation to do if the table exists. Defaults to 'append'.	'append'
index	bool	Write DataFrame index as a column. Defaults to False.	False