From ff37170693ce1cc4ee5d2d9962b5b811e0f60340 Mon Sep 17 00:00:00 2001 From: Edwin Jose Date: Thu, 22 May 2025 15:47:14 -0400 Subject: [PATCH] ref: SQL component (#8185) * update sql * [autofix.ci] apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> --- .../base/langflow/components/data/sql_executor.py | 11 +++++++---- .../tests/unit/components/data/test_sql_executor.py | 4 ++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/src/backend/base/langflow/components/data/sql_executor.py b/src/backend/base/langflow/components/data/sql_executor.py index 741fe9a5a..06ec6db73 100644 --- a/src/backend/base/langflow/components/data/sql_executor.py +++ b/src/backend/base/langflow/components/data/sql_executor.py @@ -16,10 +16,13 @@ if TYPE_CHECKING: class SQLComponent(ComponentWithCache): """A sql component.""" - display_name = "SQL Query" - description = "Execute SQL Query" + display_name = "SQL Database" + description = ( + "Executes SQL queries on any SQLAlchemy-compatible database and returns the result as a structured dataframe." + ) icon = "database" name = "SQLComponent" + metadata = {"keywords": ["sql", "database", "query", "db", "fetch"]} def __init__(self, **kwargs) -> None: super().__init__(**kwargs) @@ -54,7 +57,7 @@ class SQLComponent(ComponentWithCache): ] outputs = [ - Output(display_name="Query Results", name="sql_query_results", method="sql_query_results"), + Output(display_name="Result Table", name="run_sql_query", method="run_sql_query"), ] def build_component( @@ -90,7 +93,7 @@ class SQLComponent(ComponentWithCache): self.log(msg) raise ValueError(msg) from e - def sql_query_results(self) -> DataFrame: + def run_sql_query(self) -> DataFrame: result = self.__execute_query() df_result = DataFrame(result) self.status = df_result diff --git a/src/backend/tests/unit/components/data/test_sql_executor.py b/src/backend/tests/unit/components/data/test_sql_executor.py index b312d85bd..45e5ab90e 100644 --- a/src/backend/tests/unit/components/data/test_sql_executor.py +++ b/src/backend/tests/unit/components/data/test_sql_executor.py @@ -89,11 +89,11 @@ class TestSQLComponent(ComponentTestBaseWithoutClient): assert "Error:" in result.text assert "Query: SELECT * FROM non_existent_table" in result.text - def test_sql_query_results(self, component_class: type[SQLComponent], default_kwargs): + def test_run_sql_query(self, component_class: type[SQLComponent], default_kwargs): """Test building a DataFrame from a SQL query.""" component = component_class(**default_kwargs) - result = component.sql_query_results() + result = component.run_sql_query() assert isinstance(result, DataFrame) assert len(result) == 1