A Sublime Text plugin to help users connect to and interact with ODBC-compatible DBMS (such as SQL Server and Snowflake) directly from the editor. It provides a rich set of features for running queries, managing metadata, formatting SQL, and leveraging context-aware auto-completion.

• ODBC Connection Management: Easily connect to SQL Server, Snowflake, or any ODBC-compatible database.
• Run SQL Queries: Execute queries and view results in new tabs or output panels.
• Auto-Completion: Context-aware SQL completion for databases, schemas, tables, columns, and even table aliases.
• Metadata Management: Initialize, update, and browse metadata for fast and accurate completions.
• Query Formatting: Format SQL queries for readability.
• UI Utilities: Rename tabs, resize panes, sort tabs, and more.
• Export & Transpose: Export query results to CSV and transpose tables for analysis.
• Cache: Query results are cached for quick retrieval and reduced DB load.

1. Dependencies:

   • Python 3.x
   • pyodbc
   • tabulate
   • sqlparse
   • (These are included in the lib/ folder for plugin use.)

2. Setup:

   • Place the plugin folder (e.g., SQLOdbc) in your Sublime Text Packages directory.
   • Ensure your ODBC drivers are installed for your target DBMS.

3. Configuration:

   • Edit config.json to add or modify DBMS connection strings and metadata queries.
   • Edit SQL.settings to set your default DBMS and connection group.

Follow this onboarding guide to get up and running with SQLOdbc:

First, you need to configure your ODBC connection string and database queries:

1. Open Settings:

   • Via Command Palette: Press Ctrl+Shift+P, type "ODBC: Edit Setting"
   • Via Menu: Go to SQLOdbc > View > Edit setting
   • Via Keyboard: Press Ctrl+U, Ctrl+S to view current settings (read-only)

2. Edit Connection Details: Configure your ODBC connection string and database-specific queries in the settings file. This includes:

   • ODBC connection strings for your database
   • Database-specific metadata queries
   • Default connection preferences

Personalize your keyboard shortcuts:

1. Open KeyMap:

   • Via Command Palette: Press Ctrl+Shift+P, type "ODBC: Edit KeyMap"
   • Via Menu: Go to SQLOdbc > View > Edit KeyMap

2. Customize: Modify key bindings to match your preferences

Configure your database username and password:

• Press Ctrl+M, Ctrl+P to set your DBMS credentials
• Credentials are stored as environment variables (base64-encoded for security)
• Don't change SQL_USERNAME_ENCODED and SQL_PW_ENCODED as they are reserved for environmental variable for password setup
• skip or overwrite the entire connection string if you don't want to store your password as environmental variable

Connect to your database using any of these methods:

• Keyboard: Press Ctrl+E, Ctrl+O
• Command Palette: Press Ctrl+Shift+P, type "ODBC: Start Connection"
• Menu: Go to SQLOdbc > Connection > Start Connection

Try running a basic query to confirm everything works:

1. For Snowflake users: Type select current_user() in a new file
2. For SQL Server users: Try SELECT @@VERSION
3. Execute: Select your query text and press Ctrl+E, Ctrl+E
4. Results: View results in a new tab or output panel

The plugin includes example database schema for testing auto-completion:

1. Start typing SQL: Begin with SELECT * FROM
2. Trigger completion: Press Ctrl+Space to see available databases, schemas, tables, and columns
3. Explore: Try typing table aliases and see column suggestions appear automatically
4. Example: The plugin includes sample connection groups you can use to test completions
5. To view the example auto completion, see SQLOdbc > View > Edit Conn Group Schema

Get comprehensive metadata from your database for full auto-completion support:

1. Initialize Metadata:

   • Keyboard: Press Ctrl+M, Ctrl+I
   • Command Palette: "ODBC: Get All metadata from DBMS"
   • Menu: SQLOdbc > Metadata > Get All metadata from DBMS

2. Wait for completion: This process will scan your entire database environment (can take a few minutes for large databases)

3. Enjoy full completions: Once complete, you'll have auto-completion for all accessible databases, schemas, tables, and columns in your environment

Connection Groups are collections of database objects (schemas, tables, columns) organized for efficient metadata management and auto-completion. Each connection group belongs to a specific DBMS and contains curated sets of tables and their metadata.

Switching Between DBMS: To work with different database systems (e.g., SQL Server vs Snowflake):

1. Choose DBMS Connection:

   • Keyboard: Press Ctrl+M, Ctrl+C
   • Command Palette: "ODBC: Choose DBMS Connection"
   • Menu: SQLOdbc > Connection > Choose DBMS Connection

2. Select Connection Group: After switching DBMS, choose the appropriate connection group:

   • Keyboard: Press Ctrl+M, Ctrl+S
   • Command Palette: "ODBC: Select Conn Group"

Important Notes:

• Connection groups are managed separately per DBMS - your Snowflake groups won't appear when connected to SQL Server
• Each DBMS maintains its own metadata structure and connection groups
• You can have multiple connection groups per DBMS for different projects or data domains

Organize your database objects into connection groups for better management:

• Create groups: Press Ctrl+M, Ctrl+N to create new connection groups
• Add specific tables: Press Ctrl+M, Ctrl+A to add tables to a group
• Browse metadata: Press Ctrl+M, Ctrl+B to explore your connection group's metadata
• Switch groups: Press Ctrl+M, Ctrl+S to select different connection groups

• Ctrl+E, Ctrl+O: Start connection
• Ctrl+E, Ctrl+E: Run selected SQL
• Ctrl+M, Ctrl+P: Set credentials
• Ctrl+M, Ctrl+I: Load all metadata
• Ctrl+Space: Trigger auto-completion
• Ctrl+Shift+P: Open Command Palette (access all commands)

The key bindings are organized by their source files:

SQLOdbc/
├── SQLExecute.py              # Main execution logic and connection handling
├── SQLMetaData.py            # Metadata management and connection groups
├── SQLQueryHelper.py         # SQL formatting and selection utilities
├── SQLUIhelper.py            # UI utilities and window management
├── SQLAutoComplete.py        # SQL auto-completion implementation
├── SQL.sublime-completions   # Sublime Text completion definitions
├── SQL.settings              # User settings and preferences
├── config.json              # DBMS connection configurations
├── Main.sublime-menu        # Plugin menu definitions
├── Main.sublime-commands    # Command palette entries
├── Default (Windows).sublime-keymap  # Key bindings
├── Tab Context.sublime-menu # Context menu definitions
├── .no-sublime-package      # Package marker
├── .python-version          # Python version specification
├── .gitignore              # Git ignore rules
│
├── SQLAPI/                  # Core API implementation
│   ├── __init__.py
│   ├── connect.py          # ODBC connection handling
│   └── util.py             # Utility functions
│
├── lib/                     # Third-party dependencies
│   ├── pyodbc/             # ODBC database driver
│   ├── tabulate/           # Table formatting
│   ├── sqlparse/           # SQL parsing
│   └── wcwidth/            # Character width utilities
│
└── metastore/              # Metadata and cache storage
    └── <dbms>/             # Per-DBMS metadata
        └── <group>/        # Connection group metadata

• Metadata is stored in metastore/<dbms>/<group>/ as JSON and text files.
• Auto-completion uses this metadata for fast, context-aware suggestions.
• Use the meta_* commands to manage and refresh metadata as your schema changes.
• There are example connection groups included for reference and testing.

The plugin adds a comprehensive "SQLOdbc" menu to the main menu bar with the following structure:

• Start Connection: Initialize ODBC connection
• Choose DBMS Connection: Select from available database connections
• Run SQL Command: Execute SQL queries with customizable options
• Format SQL: Format SQL code for readability
• Clear Cache: Clear query result cache
• Interrupt Query: Stop currently running queries
• Restart Connection: Restart the database connection
• Remove Cache File: Delete cache files from disk

• Get All metadata from DBMS: Initialize complete metadata from database
• New Conn Group: Create new connection group
• Password: Set database credentials
• Delete Conn Group: Remove connection group
• Browse All Cols in Conn Group: Browse metadata columns
• Refresh Meta in Conn Group: Update connection group metadata
• Add Table to Conn Group: Add specific tables to connection group
• Remove Table from Conn Group: Remove tables from connection group
• Select Conn Group: Choose active connection group
• Select Query split by Semicolon: Expand selection to semicolon

• Rename View: Rename current tab/view
• Zoom In/Out: Adjust view zoom level
• Sort Tabs in Order: Sort tabs alphabetically
• Split Right/Down: Split editor layout
• Max/Min Query Result Panel: Toggle result panel size

• View ConnGroup Schema (Read Only): View current schema
• Edit KeyMap: Customize key bindings
• Edit setting: Modify plugin settings
• Edit ConnGroup Schema: Edit schema configuration
• View Current Conn: Display current connection info

All menu items correspond to commands available in the Command Palette (Ctrl+Shift+P) with "ODBC:" prefix.

All plugin functionality is accessible through the Command Palette (Ctrl+Shift+P). Commands are prefixed with "ODBC:" for easy discovery:

• ODBC: Start Connection
• ODBC: Run SQL Query
• ODBC: Format SQL
• ODBC: Clear Query Cache
• ODBC: Interrupt Query
• ODBC: Restart Connection
• ODBC: Export to CSV
• ODBC: Transpose Table
• ODBC: Remove Cache File

• ODBC: Get All metadata from DBMS
• ODBC: New Connection Group
• ODBC: Set Password
• ODBC: Choose DBMS Connection
• ODBC: Delete Conn Group
• ODBC: Browse All Cols Under Conn Group
• ODBC: Refresh Meta in Group
• ODBC: Add Table to Conn Group
• ODBC: Remove Table from Conn Group
• ODBC: Select Conn Group

• ODBC: View Current Schema
• ODBC: Edit ConnGroup Schema
• ODBC: View Current Connection
• ODBC: Edit KeyMap
• ODBC: Edit Setting

• ODBC: Rename View
• ODBC: Zoom In
• ODBC: Zoom Out
• ODBC: Sort Tabs
• ODBC: Resize Window Group
• ODBC: Split Right
• ODBC: Split Down

• Credentials are stored as user environment variables, base64-encoded.
• Never commit your credentials or sensitive config to version control.

• If you see connection errors, ensure your ODBC driver is installed and your credentials are set.
• If completions are missing, re-initialize metadata (Ctrl+M, Ctrl+I).
• For more logs, check the Sublime Text console (View > Show Console).

Pull requests and issues are welcome! Please ensure your code is well-documented and tested.

MIT License

Enjoy querying your databases from Sublime Text!