Keys - VheissuLabs/tql GitHub Wiki

Every key tql answers to, by where you are. ? shows an abridged version of this inside the application.

The bindings are vim's where vim has an opinion, and a letter that says what it does where it does not. They can be changed, see Rebinding.

Y copies the row as JSON, which is the shape you want for a bug report or a test fixture:

{
    "id": 1,
    "name": "cherry",
    "qty": 3
}

esc is contextual, in this order: go back where you followed a link from, clear the filter, then put the table back after a hand-written query replaced the grid with its results. It never quits. q and :q do that.

ctrl+k opens one list of everything you can do from here: every action, with the key that does it, the : commands that have no key, the tables, the other databases on a server, and your other connections. Type to narrow it (exact and prefix matches first, then words, then letters in order) and ↵ runs the one you are on, exactly as its key would.

The key shown beside an action is the one it is bound to, so a key you rebind is the one it offers. palette = "ctrl+p" in [keys] moves the palette itself.

: opens it. Commands are exact, with short forms where it helps. The full list is on Commands.

A command that belongs to the other screen says so: :sql on the connection list says it works once a connection is open.

i on a row opens the inspector; I opens the value under the cursor.

↵ never runs the statement, so a long query can take as many lines as it needs. In the simple style ctrl+r runs it; in the vim style :r does, and ctrl+r is redo. The full guide is on The SQL editor.

In vim insert mode the cursor is a line, like vim's, and back to a block in normal and visual mode. A terminal that ignores cursor shapes shows its own.

With several statements in the editor, separated by ;, only the one the cursor is in runs, and the status line says which: statement 2 of 3. A ; inside quotes, a comment or a Postgres $$ body does not count.

The editor opens in normal mode, and its title says which mode you are in. :r or :run runs the statement under the cursor. The full motion, operator, text object, visual and insert tables are on The SQL editor.

now() typed into a cell means the same as ctrl+t. Both write UTC unless [ui] time_zone says otherwise, and the status line names the zone.

N opens one for a new row, E for the row under the cursor.

While typing, ↵ or tab keeps the field and moves on, shift+tab moves back, ctrl+t types the time and esc puts the field back.

f opens the filter, already typing in the value, on the column you were on, with contains as the operator.

Any other letter typed on the value goes straight into it. On a filtered table, esc clears the filter. See Filtering rows.

It opens over everything and takes every key until it is closed, so nothing happens behind it.

Every list answers the same way, whether it holds columns, operators, databases, links, files or tags.

The database list does two things more, unless the connection is read-only. Type a name that is not there and the last row offers + create it. On a connection tagged production, taking it puts :create database and the name on the command line instead, so nothing is created until ↵ there (confirm_create_on_production in the config turns that off). ctrl+d on a database puts :drop database and its name on the command line, so nothing is dropped until ↵ there.

A Redis or Valkey connection opens the key browser. See Redis and Valkey.

Give a connection a Group in its form and it sits under that group's header, which folds shut; tql remembers which ones you folded. The number in brackets on a header is how many connections the group holds.

e on a header renames the group for every connection in it: ↵ renames, esc cancels. A name another group already has merges the two.

:settings, tql settings or Settings in the palette.

A value you have changed from the default is drawn in the edited colour.

Every action in the grid has a name, and [keys] in ~/.config/tql/config.toml says which key asks for it:

[keys]
filter_rows = "F"
new_row = "ctrl+n"
ask = "?"

A key is a single character (F is not f), ctrl+<letter>, alt+<key>, or one of tab, shift+tab, enter, escape, space, backspace, delete, up, down, left, right, home, end. A list means several keys that all do the same thing. yank_value = ["y", "ctrl+y"] makes both yank, the way , and < both narrow a column by default. The first one is what help and the hotkey bar show.

Help and the hotkey bar read the same list, so a rebound key is the key they offer. A key two actions both want goes to the first one and tql says so, in the status line when it starts and in tql config. A key it cannot make sense of is ignored and the default stands.

Movement (j k h l, the arrows), ↵, esc, tab, : and ctrl+l are fixed: they are what a terminal and a vim user both already assume, and rebinding them breaks more than it fixes.

On by default; mouse = false in [ui] gives the terminal its selection and scrollback back.

Inside a multiplexer whose tab bar sits above the pane, set mouse_row_offset = 1 or every click lands a row out.