LuceData

LuceData Documentation

LuceData Documentation

Welcome to the LuceData documentation! This guide will help you get started and master all features of the AI-powered SQL desktop application.

🚀 Getting Started

Installation Guide

Learn how to install LuceData on macOS or Windows, system requirements, and first-launch setup.

Topics:

  • System requirements
  • Download and installation
  • First launch configuration
  • Updating and uninstalling
  • Troubleshooting installation issues

🔧 Configuration

Add a New AI Engine

Configure AI providers to power natural language to SQL generation. LuceData supports OpenAI, Azure OpenAI, Anthropic Claude, Google Gemini, and Ollama.

Topics:

  • Supported AI providers
  • Obtaining API keys
  • Provider-specific configuration
  • BYOM (Bring Your Own Model)
  • Managing multiple AI engines
  • Cost management tips

Add a New Connection

Connect to SQL Server, PostgreSQL, and SQLite databases. Learn about connection security, permissions, and troubleshooting.

Topics:

  • SQL Server connections
  • PostgreSQL connections
  • SQLite connections
  • Connection security best practices
  • Setting permissions (read/write/DDL)
  • Managing and organizing connections

💻 Using LuceData

Using the Connections Tree

Navigate your database objects with the visual Connections Tree. Explore servers, databases, schemas, tables, columns, keys, indexes, and more.

Topics:

  • Tree structure and hierarchy
  • Expanding and navigating objects
  • Table and column actions
  • Working with keys and indexes
  • Searching and filtering
  • Keyboard shortcuts
  • Customization options

Using the Work Area

Write, execute, and manage SQL queries in the powerful Work Area with Monaco-based editor, IntelliSense, and multiple tabs.

Topics:

  • Creating and managing query tabs
  • SQL editor features (syntax highlighting, autocomplete)
  • Executing queries (full script, selection, to cursor)
  • Viewing and exporting results
  • Query history
  • Saving and opening queries
  • Snippets and templates
  • Keyboard shortcuts

🤖 AI Features

Using the AI Assistant (Coming Soon)

Generate SQL queries from natural language, optimize query performance, and get intelligent suggestions powered by your AI engine.

Topics:

  • Natural language to SQL
  • Schema-aware suggestions
  • Query optimization
  • Conversation history
  • Best practices

📚 Additional Resources

Keyboard Shortcuts (Coming Soon)

Complete reference of all keyboard shortcuts to boost your productivity.

Query Optimization (Coming Soon)

Learn how to write efficient SQL queries and use execution plans.

Security Best Practices (Coming Soon)

Guidelines for secure database management and credential handling.

🔒 Legal

Privacy Policy

How we collect, use, and protect your data.

Terms of Use

Terms and conditions for using LuceData.

License Agreement

Software license terms for beta and commercial use.

🆘 Support

Need Help?

Email: support@lucedata.com
Website: https://lucedata.com
Documentation: https://lucedata.com/docs

Beta Feedback

We'd love to hear from you! As a beta user, your feedback is invaluable:

  • Report bugs and issues
  • Request features
  • Share your use cases
  • Suggest improvements

Email us at: beta@lucedata.com

📋 Quick Links

TopicLink
InstallationInstallation Guide
AI ConfigurationAdd a New AI Engine
Database ConnectionsAdd a New Connection
NavigationUsing the Connections Tree
Query EditingUsing the Work Area
PrivacyPrivacy Policy
TermsTerms of Use
LicenseLicense Agreement

📱 What's New

Beta Version Features

  • ✅ SQL Server, PostgreSQL, and SQLite support
  • ✅ BYOM (Bring Your Own Model) - OpenAI, Azure, Claude, Gemini, Ollama
  • ✅ Monaco-based SQL editor with IntelliSense
  • ✅ Visual Connections Tree
  • ✅ Multiple query tabs
  • ✅ Results grid with export to CSV
  • ✅ AI-powered natural language to SQL
  • ✅ Execution confirmations for write/DDL operations
  • ✅ Cross-platform (macOS and Windows)

Coming Soon

  • 🚧 Oracle and MySQL support
  • 🚧 Linux installer
  • 🚧 Custom database-specialized AI model (commercial version)
  • 🚧 Advanced export formats (Excel, JSON, Parquet)
  • 🚧 Query execution plans and optimization
  • 🚧 Schema migrations and versioning
  • 🚧 Team collaboration features

🎯 Common Tasks

First-Time Setup

  1. Install LuceData
  2. Configure your first AI engine
  3. Add your first database connection
  4. Explore the Connections Tree
  5. Write your first query

Daily Workflow

  1. Open LuceData
  2. Connect to your database (Connections Tree)
  3. Create a new query tab (Cmd+N or Ctrl+N)
  4. Write SQL with autocomplete
  5. Execute query (Cmd+Enter or F5)
  6. View results and export if needed

Using AI Features

  1. Configure your AI engine (if not done yet)
  2. Open the AI Assistant panel
  3. Describe what you want in natural language
  4. Review the generated SQL
  5. Execute with confirmation

© 2025 LuceData. All rights reserved.