User Manual
Welcome to the DataStoria user manual. This comprehensive guide will help you master all features of the AI-powered ClickHouse management console.
Table of Contents
1. Getting Started
- Introduction to DataStoria
- Installation & Setup
- Building from Source
- Running with Docker
- Online Access
- First Connection
- Connecting to ClickHouse
- Authentication Setup
- Basic Navigation
2. AI-Powered Intelligence
- Natural Language Data Exploration
- How to Use
- Best Practices
- Examples and Use Cases
- Smart Query Optimization
- Understanding AI Recommendations
- Applying Optimizations
- Performance Impact Analysis
- Intelligent Visualization
- Generating Charts from Prompts
- Chart Types Available
- Customizing Visualizations
- Ask AI for Help
- Getting Instant Error Assistance
- Understanding Query Errors
- Receiving AI-Powered Fixes
- AI Model Configuration
- Setting Up API Keys
- Supported Providers
- Privacy and Security
3. Query Experience
- SQL Editor
- Syntax Highlighting
- Auto-completion
- Query Formatting
- Keyboard Shortcuts
- Error Diagnostics
- Understanding Error Messages
- AI-Powered Fix Suggestions
- Syntax Error Resolution
- Query Execution
- Running Queries
- Viewing Results
- Exporting Data
- Query History
- Query Log Inspector
- Timeline Views
- Topology Graphs
- Performance Analysis
- Understanding Execution Metrics
- Query Explain
- Visual AST View
- Pipeline Visualization
- Understanding Execution Plans
- Performance Insights
4. Database Management
- Node Dashboard
- Individual node metrics
- Node health indicators
- Real-time performance monitoring
- Cluster Dashboard
- Cluster-wide metrics
- Multi-node aggregation
- Cluster health overview
- Schema Explorer
- Navigating Databases
- Exploring Tables
- Column Information
- Table Metadata
5. Security & Privacy
- Privacy Features
- Local Execution Model
- Data Privacy Guarantees
- No Data Collection Policy
Quick Start Guide
New to DataStoria? Start here:
- Installation: Follow the Installation & Setup guide
- First Connection: Learn how to connect to your ClickHouse instance
- Try AI Features: Explore Natural Language Data Exploration
- Run Your First Query: Use the SQL Editor
Need Help?
- Visit dataStoria.app for the online version
Last updated: [Date will be updated automatically]