Skip to main content

Build Status Latest Version

A Vertica client that does auto-completion and syntax highlighting, based on pgcli.

screenshots/vcli.gif

Installation

Just install it like a regular Python package:

$ pip install vcli

You’ll probably see some permission errors if you’re installing it on the system-wide Python. If that’s what you want to do, you need to sudo:

$ sudo pip install vcli

To upgrade vcli, do:

$ pip install -U vcli

Usage

Connecting to a Database

$ vcli --help
Usage: vcli [OPTIONS] [DATABASE]

Options:
  -h, --host TEXT        Database server host address  [default: localhost]
  -p, --port INTEGER     Database server port  [default: 5433]
  -U, --user TEXT        Database username  [default: CURRENT_USER]
  -W, --prompt-password  Prompt for password  [default: False]
  -w, --password TEXT    Database password  [default: ]
  -v, --version          Print version and exit
  --vclirc TEXT          Location of .vclirc file  [default: ~/.vclirc]
  --help                 Show this message and exit.

Examples

Use URL to connect:

$ vcli vertica://dbadmin:pass@localhost:5433/mydb

Prompt for password:

$ vcli -h localhost -U dbadmin -W -p 5433 mydb

Don’t prompt for password:

$ vcli -h localhost -U dbadmin -w pass -p 5433 mydb

Use VERTICA_URL environment variable:

$ VERTICA_URL=vertica://dbadmin:pass@localhost:5433/mydb vcli

Special Commands

vcli_demo=> \h
+---------------------+--------------------------------------+
| Command             | Description                          |
|---------------------+--------------------------------------|
| \#                  | Refresh auto-completions             |
| \?                  | Show help                            |
| \a                  | Aligned or unaligned                 |
| \c[onnect] [DBNAME] | Connect to a new database            |
| \d [PATTERN]        | List or describe tables              |
| \dS [PATTERN]       | List system tables                   |
| \dT [PATTERN]       | List data types                      |
| \df [PATTERN]       | List functions                       |
| \dj [PATTERN]       | List projections                     |
| \dn [PATTERN]       | List schemas                         |
| \dp [PATTERN]       | List access privileges               |
| \ds [PATTERN]       | List sequences                       |
| \dt [PATTERN]       | List tables                          |
| \dtv [PATTERN]      | List tables and views                |
| \du [PATTERN]       | List users                           |
| \dv [PATTERN]       | List views                           |
| \e [FILE]           | Edit the query with external editor  |
| \h                  | Show help                            |
| \i FILE             | Execute commands from file           |
| \l                  | List databases                       |
| \n[+] [NAME]        | List or execute named queries        |
| \nd [NAME]          | Delete a named query                 |
| \ns NAME QUERY      | Save a named query                   |
| \o [FILE]           | Output to file or stdout             |
| \q                  | Quit vcli                            |
| \refresh            | Refresh auto-completions             |
| \t                  | Toggle header                        |
| \timing             | Toggle timing of commands            |
| \x                  | Toggle expanded output               |
| \z [PATTERN]        | List access privileges (same as \dp) |
+---------------------+--------------------------------------+

Thanks

Thanks to pgcli. Most of the hard work, especially the auto-completion part, were already done well by the pgcli core team. vcli wouldn’t be possible if it weren’t for them.

Metadata

Release files for vcli 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vcli 0.1.2
File Size Uploaded Provenance
vcli-0.1.2.tar.gz 53.0 kB Without provenance Details

Release files / vcli-0.1.2.tar.gz

Download URL vcli-0.1.2.tar.gz
Size 53.0 kB
Tags Source
SHA-256 checksum
How to use checksums
65bf8914152a88679bd62bb7a4928fe310a0251a72e23f6563d3d3e97706a54a
BLAKE2b-256 checksum
How to use checksums
a70e5d907cb5c2a010b15d659d02fd3a3ac396962f48d49707f2ff9f164e196e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for vcli 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page