usql 2.1.0
CLI for Uptycs platform with auto-completion and syntax highlighting.
License: BSD

# usql

[![Build Status](https://travis-ci.org/dbcli/usql.svg?branch=master)](https://travis-ci.org/dbcli/usql)

A command-line client for Uptycs that has auto-completion and syntax highlighting.
This tool is based on dbcli frame work. We have used Uptycs restcall in the tool

## Installation

If you already know how to install python packages, then you can install it via pip:

You might need sudo on linux.

if you want to install usql, using pip, you can use following command:
```
$ sudo pip install usql
```

if you want to install from source you can use following command:
```
$ git pull usql
$ cd usql
$ python setup.py install
```


## Usage

    $ usql --help

    Usage: usql -k <uptycs key file> [DATABASE]

    Examples:
      - usql -k mykeyfile [global|realtime|timemachine]

A config file is automatically created at `~/.config/usql/config` at first launch. See the file itself for a description of all available options.

Following are the options available through the tool

```
+-------------+----------------------------+------------------------------------------------------------+
| Command     | Shortcut                   | Description                                                |
+-------------+----------------------------+------------------------------------------------------------+
| .databases  | .databases                 | List databases.                                            |
| .open       | .open                      | Change to a new database.                                  |
| .schema     | .schema[+] [table]         | The complete schema for the database or a single table     |
| .status     | \s                         | Show current settings.                                     |
| .tables     | \dt[+] [table]             | List or describe tables.                                   |
| \G          | \G                         | Display current query results vertically.                  |
| \e          | \e                         | Edit command with editor (uses $EDITOR).                   |
| \f          | \f [name [args..]]         | List or execute favorite queries.                          |
| \fd         | \fd [name]                 | Delete a favorite query.                                   |
| \fs         | \fs name query             | Save a favorite query.                                     |
| \once       | \o [-o] filename           | Append next result to an output file (overwrite using -o). |
| exit        | \q                         | Exit.                                                      |
| help        | \?                         | Show this help.                                            |
| nopager     | \n                         | Disable pager, print to stdout.                            |
| notee       | notee                      | Stop writing results to an output file.                    |
| pager       | \P [command]               | Set PAGER. Print the query results via PAGER.              |
| prompt      | \R                         | Change prompt format.                                      |
| quit        | \q                         | Quit.                                                      |
| rehash      | \#                         | Refresh auto-completions.                                  |
| source      | \. filename                | Execute commands from file.                                |
| system      | system [command]           | Execute a system shell commmand.                           |
| tableformat | \T                         | Change the table format used to output results.            |
| tee         | tee [-o] filename          | Append all results to an output file (overwrite using -o). |
| watch       | watch [seconds] [-c] query | Executes the query every [seconds] seconds (by default 5). |
+-------------+----------------------------+------------------------------------------------------------+
```