[](https://github.com/joe-re/sql-language-server/actions/workflows/test.yaml)

SQL Language Server

TheSQL Language Server offers autocompletion, error/warning notifications, and other editor support. It includes a linting feature, an SQL parser, and a Visual Studio Code extension. It supports MySQL, PostgreSQL, and SQLite3 databases.


- Autocompletion andnotifywarnings and errorsand some other editor support ([sql-language-server](https://github.com/joe-re/sql-language-server/tree/release/packages/server))

-Lint ([sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint))

-[VSC extension](https://github.com/joe-re/sql-language-server/tree/release/packages/client)

-[SQL parser](https://github.com/joe-re/sql-language-server/tree/release/packages/sql-parser)

-**sql-language-server**:Autocompletion andnotification ofwarnings and errors[GitHub link](https://github.com/joe-re/sql-language-server/tree/release/packages/server)

-**VSC extension**:[Github link](https://github.com/joe-re/sql-language-server/tree/release/packages/client)

-**SQL parser**:[Github link](https://github.com/joe-re/sql-language-server/tree/release/packages/sql-parser)

- MySQL

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

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

Add the following to the init.vim file (.vimrc)

Add the following to the`init.vim` file (`.vimrc`):

Run the following command, reference the[nvim-lsp documentation](https://github.com/neovim/nvim-lspconfig#sqlls) for more information.

Run the following command and reference the[nvim-lsp documentation](https://github.com/neovim/nvim-lspconfig#sqlls) for more information.

It's also used to develop sql-language-server.

You can follow[development section](#development) to check Mocaco Editor working.

Follow the[development section](#development) section to check Mocaco Editor working.

There are two ways to use configuration files.

- Set personal configuration file(~/.config/sql-language-server/.sqllsrc.json)

- Set project configuration file on your project root(\${YOUR_PROJECT/.sqllsrc.json})

- Set personal configuration file (`~/.config/sql-language-server/.sqllsrc.json`)

- Set project configuration file on your project root (`${YOUR_PROJECT}/.sqllsrc.json`)

- Use workspace/configuration according to LSP specification

}

Please restart sql-language-server process aftercreate.sqllsrc.json.

Please restart sql-language-server process aftercreating`.sqllsrc.json`.

| Key| Description| value| required| default|

| ------------| -------------------------------------------------------------------------------------------------------------------------| -----------------------| --------| ---------------------------------|

| remotePort| Port number of the server for ssh| number| false| 22|

| user| User name on the server| string| false||

| dbHost| Database host on the server| string| false| 127.0.0.1|

| dbPort|Databse port on the server| number| false| mysql:3306, postgres:5432|

| dbPort|Database port on the server| number| false| mysql:3306, postgres:5432|

| identityFile| Identity file for ssh| string| false|~/.ssh/config/id_rsa|

| passphrase| Passphrase to allow to use identity file| string| false||

Personal configuration file is located on`~/.config/sql-language-server/.sqllsrc.json`.

sql-language-server will try to read when it's started.

The personal configuration file is located at`~/.config/sql-language-server/.sqllsrc.json`. When the SQL Language Server starts, it will try to read this file.

Projectconfiguration file is locatedon`${YOUR_PROJECT_ROOT}/.sqllsrc.json`.

The projectconfiguration file is locatedat`${YOUR_PROJECT_ROOT}/.sqllsrc.json`. This file has the same settings as the personal configuration file, with a few exceptions:

All setting items are similarly to personal configuration file, with some exceptions:

- The connection property is specified directly, rather than as an array.

- The project path does not need to be set. If it is set, it will be ignored.

- The project configuration file is merged with the personal configuration file, if it exists.

- Specify under`connection` property element directly(you don't need to set array)

- You don't need to set project path.(if you set it it will be ignored)

- It's merged to personal configuration if you have it.

Example:

Here is an example project configuration file for a PostgreSQL database:

{

"name":"postgres-project",

}

And also ifyou have set personal configuration and both of them's names are matched, it's mergedautomatically.

Ifyou havealsosetapersonal configuration, the project configuration and personal configure will be mergedif they have the same name.

Personal configuration example:

}

It will merge them asfollowing:

It will merge them asfollows:

{

}

- connections: It'sthe same as`connections` params ofpersonalconfig file

- lint: It'sthe same as configuration of[sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint#configuration).

-`connections`: This parameter isthe same astheconnections parameter in thepersonalconfiguration file. It allows you to specify the connections for your workspace.

-`lint`: This parameter isthe same astheconfiguration of[sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint#configuration). It allows you to configure the linting rules for your workspace.

}

-vscode workspace setting

-VS Code workspace setting

"settings": {

${env:VARIABLE_NAME} syntax allows you to replace configuration value withenviroment variable.

This is usefulwhen you don't want towrite actual valueon the configuration file.

`${env:VARIABLE_NAME}` syntax allows you to replace configuration value withan environment variable.

This is usefulif you don't want tostore the valuein the configuration file.

{

If you have multiple connectioninformation onpersonal config file, you canswtich database connection.

If you have multiple connectionentries in yourpersonal config file, you canswitch the database connection.


If you get error when you use sqlite3 connection, you may need to rebuild sqlite3on your environment.

If you get error when you use sqlite3 connection, you may need to rebuild sqlite3to your environment.

VSC extension provides the command to rebuild it.(Name:`Rebuild SQLite3 Client`)


If you're using sql-language-server directly,aftergo to thedirectry of itandcall`npm rebuild sqlite` to rebuild it.

If you're using sql-language-server directly, go to theinstall directoryandrun`npm rebuild sqlite` to rebuild it.

You can use lint rules that are provided[sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint).

Please refer this to know how to use and how to configure to make them be matched your case.

You can use lint rules provided by[sqlint](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint) to ensure your SQL code follows best practices and avoid potential errors. Refer to the[sqlint configuraton documentation](https://github.com/joe-re/sql-language-server/tree/release/packages/sqlint#configuration) to learn how to use and configure the linter to match your use case.


Also youcan useit to fixyour problem if it's possible.

Youcanalsousesqlint toautomaticallyfixany problems it can identify in your code.


[GitHub Issues](https://github.com/joe-re/sql-language-server/issues) are opening for asking question, reporting problems,andsuggests improvement.

You can start adisccustionabout newrule for SQLint there also.

If you have any questions, problems or suggestions for improvements, feel free to create a new issue on[GitHub Issues](https://github.com/joe-re/sql-language-server/issues).You canalsostart adiscussion thereabout newrules for SQLint.

Code contributions are always appreciated. Feel free to fork the repo and submit pull requests.

Code contributions are always appreciated, so feel free to fork the repo and submit pull requests.

You can start to develop sql-language-server on docker compose.

Start development process on your docker by the bellow:

You can start developing sql-language-server using Docker Compose. To begin the development process in your Docker container, run the following command:

$ docker compose up

Open`http://localhost:3000` on your browser.

To migrate the database, follow these steps:

1. Login into developmentdocker container

1. Login into developmentDocker container

$ docker composeexec assets bash

2. Migrate database

2. Migratethedatabase

$cd example/monaco_editor