Getting Started

The Postgres Language Server can be installed as a development dependency of your project, a standalone executable, or as an extension of your favorite editor.

Configuration

We recommend creating a postgrestools.jsonc configuration file for each project. This eliminates repetitive CLI options and ensures that consistent configuration in your editor. Some options are only available from a configuration file. This step is optional though: if you are happy with the defaults, you don’t need a configuration file. To create the postgrestools.jsonc file, run the init command in the root folder of your project:

postgrestools init

You’ll now have a postgrestools.jsonc file in your directory:

{
  "$schema": "https://pgtools.dev/latest/schema.json",
  "vcs": {
    "enabled": false,
    "clientKind": "git",
    "useIgnoreFile": false
  },
  "files": {
    "ignore": []
  },
  "linter": {
    "enabled": true,
    "rules": {
      "recommended": true
    }
  },
  "db": {
    "host": "127.0.0.1",
    "port": 5432,
    "username": "postgres",
    "password": "postgres",
    "database": "postgres",
    "connTimeoutSecs": 10,
    "allowStatementExecutionsAgainst": ["127.0.0.1/*", "localhost/*"]
  }
}

Make sure to edit the database connection settings to connect to your local development database. To see all options, run postgrestools --help.

You can use your current postgrestools version instead of "latest" in the $schema URL, e.g. https://pgtools.dev/0.8.1/schema.json.

Usage

Lets get a quick overview of how to use the Postgres Language Server in your project.

Command-line interface

The CLI exposes a check command that will run all checks on the given files or paths.

# check a specific file
postgrestools check myfile.sql

# check a directory
postgrestools check supabase/migrations

Run postgrestools --help for all options. The CLI options take precedence over what is loaded from postgrestools.jsonc.

Editor Integrations

The Postgres Language Server is available as an extension in your favorite editors.

• VSCode: The language server is available on the VSCode Marketplace. It's published from this repo.
• Neovim: You will have to install nvim-lspconfig, and follow the instructions.
• Emacs: The language client is available through lsp-mode. For more details, refer to their manual page.
• Zed: The language server is available as an Extension. It's published from this repo.

Continuous Integration

Run postgrestools check in your CI pipeline to lint your schema changes and enforce code quality across your team. We provide a GitHub Action to setup the Postgres Language Server in your runner.

See the Continuous Integration guide for an example.