Welcome to the AstraSQL Agent documentation! This comprehensive guide will help you get started, understand features, and make the most of AstraSQL.
- Quick Start Guide - Get up and running in 5 minutes
- Installation Guide - Detailed installation instructions
- Configuration - Environment variables and settings
- First Query - Write your first natural language query
- How It Works - Understanding metadata-only AI processing
- Database Connections - Connecting to your databases
- Query Generation - How natural language becomes SQL
- Security Model - Privacy and security architecture
- Natural Language Queries - Writing effective queries
- Dashboards - Creating and managing dashboards
- Data Visualization - Charts, graphs, and exports
- Query History - Managing your queries
- API Usage - Using the REST API
- User Management - Adding users and roles
- Access Control - Configuring permissions
- Audit Logging - Monitoring and compliance
- Database Management - Managing connections
- System Settings - Configuration options
- BI Tools - Connecting to Tableau, Power BI, etc.
- Data Warehouses - Snowflake, BigQuery, Redshift
- API Integration - REST API guide
- Webhooks - Setting up webhooks
- SDKs - Python, JavaScript, Go SDKs
- Self-Hosted Deployment - On-premises installation
- Docker Deployment - Container deployment
- Kubernetes - K8s deployment guide
- Cloud Deployment - AWS, GCP, Azure
- Scaling - Performance and scaling
- Security Best Practices - Security guidelines
- Authentication - Setting up authentication
- Data Privacy - Privacy features
- Compliance - GDPR, HIPAA, SOC 2
- Common Issues - FAQ and solutions
- Performance Tuning - Optimization tips
- Error Codes - Error reference
- Logs & Debugging - Debugging guide
- REST API - Complete API documentation
- GraphQL API - GraphQL endpoint (coming soon)
- Authentication - API authentication
- Rate Limits - API usage limits
- Use Cases - Real-world examples
- Query Examples - Sample queries
- Dashboard Templates - Pre-built dashboards
- Integration Examples - Code samples
| Section | Status | Last Updated |
|---|---|---|
| Getting Started | ✅ Complete | Nov 2025 |
| Core Concepts | ✅ Complete | Nov 2025 |
| User Guide | 🔄 In Progress | - |
| Administration | 🔄 In Progress | - |
| Integrations | 📝 Planned | - |
| Deployment | ✅ Complete | Nov 2025 |
| Security | ✅ Complete | Nov 2025 |
| API Reference | 🔄 In Progress | - |
We welcome contributions to improve our documentation! See CONTRIBUTING.md for guidelines.
Found an error or have a suggestion? Please open an issue with the documentation label.
Last Updated: November 15, 2025