How to use SQL Query component

[angelcruijff]

Currently, the SQL Query component under Data is in beta but I can't find examples to use it.
Is there a way to tell the agent to run a query using this component? The use case is: The agent creates a query based on the input request, I expect that the response from the agent (the query) can be use and pass it to the SQL Query component, then, the response from this component can be pass to another agent so it can analyse the data from que database response.

But the SQL Query input is expecting Text, not Message, also, the response from SQL Query is Text, and can't be use directly as input for the new agent.

Any examples or hints I can use? I'm new with langflow.

[dosubot[bot]]

Hey there, @angelcruijff! I'm here to help you with any bugs, questions, or contributions you have. Let me know how I can assist you while you're waiting for a human maintainer.

To use the SQL Query component in Langflow for your use case, you can follow these steps:

1. Configure the SQLGeneratorComponent: Set up this component with the necessary parameters like the database (db), language model (llm), and any specific prompt if needed. Ensure the prompt includes {question} if you're using a custom prompt.

2. Generate the SQL Query: Use the build method of the SQLGeneratorComponent to create the SQL query from your input request. This method will return the SQL query as a text output.

3. Execute the SQL Query: Use the SQLExecutorComponent to run the generated SQL query. Configure it with the database_url and other optional parameters like include_columns, passthrough, and add_error to handle execution and potential errors.

4. Pass the Query Result to Another Agent: Once you have the SQL query result as a text output, you can pass this text to another agent for data analysis. This can be done by using the output text as input to the next component or agent in your flow.

Here's a code snippet to illustrate the process:

# Assuming you have already set up the necessary components and configurations
sql_generator = SQLGeneratorComponent()
sql_executor = SQLExecutorComponent()

# Input request
input_request = "Find the top 5 sales records for the last month."

# Generate SQL query
sql_query = sql_generator.build(
    input_value=input_request,
    db=my_database,  # Your SQLDatabase instance
    llm=my_language_model,  # Your LanguageModel instance
    top_k=5
)

# Execute the SQL query
database_url = "your_database_url_here"
query_result = sql_executor.build(
    query=sql_query,
    database_url=database_url,
    include_columns=True,  # Optional
    passthrough=True,      # Optional
    add_error=True         # Optional
)

# Pass the SQL query result to another agent for data analysis
data_analysis_agent.process(query_result)

This setup allows you to generate an SQL query from a natural language request, execute it, and pass the result to another agent for further processing ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[angelcruijff]

I understand the code but I was expecting something different. Can't this be done only using the UI???

[dosubot[bot]]

Yes, in the Langflow UI, you can visually connect the output of one component to the input of another, which should allow you to set up the flow you described without writing code. The UI supports creating connections between components using a drag-and-drop interface, where you can link the output of the SQLGeneratorComponent to the input of the SQLExecutorComponent, and then pass the result to another agent for analysis ^[1].

However, if the SQL Query component's input and output types (Text vs. Message) are not directly compatible, you might need to use intermediary components or transformations within the UI to convert these types. Unfortunately, specific examples or templates for using the SQL Query component in the UI are not readily available in the repository ^[1].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Other}

[gfaith]

I am also having problems with this component. When I "Run Component" it is successful, however when I click on the text output link start, the view results hover says "Please build the component first" (even though I already have) and the options it gives me for nodes to link to are: "SQL Query", "Retriever Tool", "Listen", "Notify". I simply want the text result of the query and I can't seem to get it.