types.DataSource

DataSource()

An abstract class defining the interface for data sources used by QueryChat.

Attributes

Name	Type	Description
table_name	str	Name of the table to be used in SQL queries.

Name	Description
cleanup	Clean up resources associated with the data source.
execute_query	Execute SQL query and return results as DataFrame.
get_data	Return the unfiltered data as a DataFrame.
get_db_type	Name for the database behind the SQL execution.
get_schema	Return schema information about the table as a string.

types.DataSource.cleanup()

Clean up resources associated with the data source.

This method should clean up any connections or resources used by the data source.

Name	Type	Description
	None

types.DataSource.execute_query(query)

Execute SQL query and return results as DataFrame.

Name	Type	Description	Default
query	str	SQL query to execute	required

Name	Type	Description
	`pd`.`DataFrame`	Query results as a pandas DataFrame

types.DataSource.get_data()

Return the unfiltered data as a DataFrame.

Name	Type	Description
	`pd`.`DataFrame`	The complete dataset as a pandas DataFrame

types.DataSource.get_db_type()

Name for the database behind the SQL execution.

types.DataSource.get_schema(categorical_threshold)

Return schema information about the table as a string.

Name	Type	Description	Default
categorical_threshold	int	Maximum number of unique values for a text column to be considered categorical	required

Name	Type	Description
	str	A string containing the schema information in a format suitable for prompting an LLM about the data structure