# SQL contribution layer for Spacemacs

![logo](img/sql.png)

<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
**Table of Contents**

- [SQL contribution layer for Spacemacs](#sql-contribution-layer-for-spacemacs)
    - [Description](#description)
    - [Install](#install)
    - [Key bindings](#key-bindings)
        - [Highlighting](#highlighting)
        - [Inferior Process Interactions (SQLi)](#inferior-process-interactions-sqli)
        - [SQLi buffer](#sqli-buffer)

<!-- markdown-toc end -->

## Description

This layer adds key bindings and configuration for `sql-mode`, which manages
interactive SQL buffers and highlights a wide range of SQL dialects.

## Install

To use this contribution layer add it to your `~/.spacemacs`

```elisp
(set-default dotspacemacs-configuration-layers '(sql))
```

## Key bindings

### Highlighting

Key Binding          | Description
---------------------|--------------------------------------------------------------------
<kbd>SPC m h k</kbd> | select a SQL dialect to highlight

### Inferior Process Interactions (SQLi)

Key Binding          | Description
---------------------|--------------------------------------------------------------------
<kbd>SPC m b b</kbd> | show the SQLi buffer name
<kbd>SPC m b s</kbd> | set the SQLi buffer
<kbd>SPC m l a</kbd> | List all objects
<kbd>SPC m l t</kbd> | list all objects in a table

Send SQL queries to SQLi:

Key Binding          | Description
---------------------|--------------------------------------------------------------------
<kbd>SPC m s b</kbd> | Send the whole buffer to the SQLi buffer
<kbd>SPC m s B</kbd> | Send the whole buffer to the SQLi buffer and switch to it in `insert state`
<kbd>SPC m s i</kbd> | Start the SQLi process
<kbd>SPC m s f</kbd> | Send the paragraph under the point to the SQLi buffer
<kbd>SPC m s F</kbd> | Send the paragraph under the point to the SQLi buffer and switch to it in `insert state`
<kbd>SPC m s q</kbd> | Prompt for a string to send to the SQLi buffer
<kbd>SPC m s Q</kbd> | Prompt for a string to send to the SQLi buffer and switch to it in `insert state`
<kbd>SPC m s r</kbd> | Send the selected region to the SQLi buffer
<kbd>SPC m s R</kbd> | Send the selected region to the SQLi buffer and switch to it in `insert state`

### SQLi buffer

Key Binding          | Description
---------------------|----------------------------------------------------------------------
<kbd>SPC m b r</kbd> | rename buffer (follow up in the SQL buffer with <kbd>SPC m b s</kbd>)
<kbd>SPC m b S</kbd> | save the current connection