# sql-language-server

**Repository Path**: mirrors_mattn/sql-language-server

## Basic Information

- **Project Name**: sql-language-server
- **Description**: SQL Language Server
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SQLLanguageServer

SQL Language Server

![completion](https://user-images.githubusercontent.com/4954534/47268897-36b70500-d589-11e8-98b2-65cffdcd60b8.gif)

## Installation & How to setup

### Visual Studio Code

Install [vsc extension](https://marketplace.visualstudio.com/items?itemName=joe-re.sql-language-server).

### Other Editors

```
npm i -g sql-language-server
```

#### Neovim example([LanguageClient-neovim](https://github.com/autozimu/LanguageClient-neovim))

- .vimrc

```
let g:LanguageClient_serverCommands = {
    \ 'sql': ['sql-language-server', 'up', '--method', 'stdio'],
    \ }
```

## Usage

### CLI

```
$ sql-language-server up [options]        run sql-language-server
```

#### Options

```
  --version      Show version number                                   [boolean]
  --help         Show help                                             [boolean]
  --method, -m  What use to communicate with sql language server
                   [string] [choices: "stdio", "node-ipc"] [default: "node-ipc"]
  --debug, -d    Enable debug logging                 [boolean] [default: false]
```

- Example

```
$ sql-language-server up --method stdio
```

### Connect to database

#### Create .sqllsrc.json on your project root

- Examples

```json
{
  "adapter": "mysql",
  "host": "localhost",
  "port": 3306,
  "user": "username",
  "password": "password",
  "database": "mysql-development"
}
```

- Details
  - adapter: "mysql" | "postgres"
  - host: string
  - port: number
  - user: string
  - password: string
  - database: string

Please restart sql-language-server process after create .sqlrc.json.

### TODO

Now only support select statement, we are planning to support other statements in the future.