Text to Report

Text to Report VS Code Extension allows you to query your database using natural language.

Features

• AI-powered database querying
• Natural language queries
• Tabular result visualization
• SQL query explanation and code display
• SQL Editor: Expand, edit and execute SQL queries directly
• Results Viewer: View and export query results
• Chat History: Automatically save and reopen previous conversations
• Cancel / Stop: Cancel long-running requests from the chat UI
• Secure token management
• Fast and user-friendly interface

Getting Started

1. Install the extension from VS Code Marketplace
2. Set your settings in VS Code (Configuration)
3. Open the Text to Report view from the Activity Bar
4. Select a schema from the dropdown
5. Start asking questions about your data!

Configuration

• text-to-report.baseUrl: Base URL for Text to Report API (e.g. http://localhost:3000)
• text-to-report.authToken: Bearer Token for API Authorization (Optional)
• text-to-report.ignoreSSLErrors: Ignore SSL certificate errors (insecure; intended for development/internal tools)

Usage

1. Select Schema: Choose the database schema you want to query from the dropdown list.
2. Ask a Question: Type your question in natural language (e.g., "Show me the active sites in Ankara").
3. View Results: The extension will display:
   • An explanation of the query.
   • The generated SQL query.
   • The results in a table format.
4. SQL Editor: Click the expand button next to SQL code to open it in a dedicated editor where you can:
   • View the SQL query in a larger, more readable format
   • Edit the query as needed
   • Execute the modified query (Ctrl+Enter)
   • View results in a table below the editor
   • Export results to Excel
5. Chat History:
   • Use the History button in the header to open the history panel.
   • Click a past session to restore its messages and schema selection.
   • Use New chat to start a fresh session.
6. Cancel / Stop:
   • While a request is running, the send button becomes a Stop button.
   • Clicking it cancels the current request.

Support

If you encounter any questions:

• Email Support

License

MIT License - See LICENSE file

Developed by Osman Koc - GitHub | Website