SQLTools

SQLTools

Your swiss knife SQL for Sublime Text.

Write your SQL with smart completions and handy table and function definitions, execute SQL and explain queries, format your queries and save them in history.

Project website: https://code.mteixeira.dev/SublimeText-SQLTools/

Donate

SQLTools was developed with ♥ to save us time during our programming journey. But It also takes me time and efforts to develop SQLTools.

SQLTools will save you (for sure) a lot of time and help you to increase your productivity so, I hope you can donate and help SQLTools to become more awesome than ever.

Features

• Smart auto completions (for PostgreSQL, MySQL, Oracle, MSSQL, Vertica, Firebird)
• Run SQL Queries (CTRL+e, CTRL+e)
• View table schemas (CTRL+e, CTRL+d)
• View Queries history (CTRL+e, CTRL+h)
• Show table records (CTRL+e, CTRL+s)
• Show explain plan for queries (PostgreSQL, MySQL, Oracle, Vertica, SQLite) (CTRL+e, CTRL+x)
• Formatting SQL Queries (CTRL+e, CTRL+b)
• Threading Support (prevent ST lockups)
• Query timeout (Kill thread if query takes too long)
• Unescape chars for languages (PHP " is replace by “)
• Prompt for connection parameters
• Save queries (CTRL+e, CTRL+q)
• List and Run saved queries (CTRL+e, CTRL+a)
• Remove saved queries (CTRL+e, CTRL+r)

Installing

Using Sublime Package Control

If you are using Sublime Package Control, you can easily install SQLTools via the Package Control: Install Package menu item.

1. Press CTRL+SHIFT+p
2. Type “Install Package”
3. Find SQLTools
4. Wait & Done!

Download Manually

I strongly recommend you to use Package Control. It helps you to keep the package updated with the last version.

1. Download the files zip file here
2. Unzip the files and rename the folder to SQLTools
3. Find your Packages directory using the menu item Preferences -> Browse Packages...
4. Copy the folder into your Sublime Text Packages directory

Settings

Show records options

SQL Formatting

Path to CLI

In case your database command is not in your PATH environment var, you can set the path here.

Connections

You can setup your connections using the Preferences menu or CTRL+SHIFT+P and searching for ST: Setup Connections.

When you set any of the connection parameter value to null you will be prompted for this value upon connecting.

Below you can see an example of the SQLToolsConnections.sublime-settings:

{
    "connections": {
        "Connection MySQL": {
            "type"    : "mysql",
            "host"    : "127.0.0.1",
            "port"    : 3306,
            "database": "dbname",
            "username": "user",
            "password": "password",  // you will get a security warning in the output
            // "defaults-extra-file": "/path/to/defaults_file_with_password",  // use [client] or [mysql] section
            // "login-path": "your_login_path",  // login path in your ".mylogin.cnf"
            "encoding": "utf-8"
        },
        "Connection PostgreSQL": {
            "type"    : "pgsql",
            "host"    : "127.0.0.1",
            "port"    :  5432,
            "database": "dbname",
            "username": "anotheruser",
            // for PostgreSQL "password" is optional (setup "pgpass.conf" file instead)
            "password": "password",
            "encoding": "utf-8"
        },
        "Connection Oracle": {
            "type"    : "oracle",
            "host"    : "127.0.0.1",
            "port"    :  1522,
            "database": "dbname",
            "username": "anotheruser",
            "password": "password",
            "service" : "servicename",
            "encoding": "utf-8"
        },
        "Connection SQLite": {
            "type"    : "sqlite",
            "database": "d:/sqlite/sample_db/chinook.db",
            "encoding": "utf-8"
        }
    },
    "default": "Connection MySQL"
}

You can also add connections to your .sublime-project files to use per-project connections.

Auto Complete

After you select one connection, SQLTools will prepare auto completions for you.

PS: For a better experience, add this line to your sublime settings file

1. CTRL+SHIFT+p, select “Preferences: Settings - User”
2. add this option:

{
  "auto_complete_triggers": [
    {"selector": "text.html", "characters": "<" },
    {"selector": "source.sql", "characters": "."}
  ]
}

Using SQLTools with MacOS

Sublime Text has it’s environment variable PATH set from launchctl, not by your shell. Binaries installed by packages such as homebrew, for instance psql DB CLI for PostgreSQL, cannot be found by Sublime Text and results in error in Sublime Text console by SQLTools. Installing the package Fix Mac Path or setting the full path to your DB CLI binary in SQLTools.sublime-settings resolves this issue. Package can be downloaded via PackageControl or github.