Command Line Interface (CLI)

Contents

Installing 

Binary releases can be downloaded from the Releases page (under Assets).

These binary releases do not require V to be installed.

You can compile from source with:

make bin/vsql       # macOS and linux
make bin/vsql.exe   # windows

bench is used to run benchmarks:

vsql bench                    # on disk
vsql bench -file ':memory:'   # in memory

cli provides a command prompt for running SQL commands (ctrl+c to exit):

$ vsql cli test.vsql
vsql> select * from foo;
A: 1234
1 row (1 ms)

vsql> select * from bar;
0 rows (0 ms)

in is used to load a SQL file into a database:

$ vsql in mydatabase.vsql < myfile.sql
0 errors, 8 statements, 98.042ms

You can generate a valid SQL file from an existing database with vsql out.

Options are:

-continue-on-error: Show errors, but continue to process the input. A non-zero exit code will be returned if any of the statements failed.
-verbose or -v: When enabled, the output of each statement (such as CREATE TABLE 1) will be shown.

out will export schema and data in SQL format:

$ vsql out mydatabase.vsql > myfile.sql
$ cat myfile.sql
CREATE TABLE PUBLIC.BAR (
   X INTEGER
);

INSERT INTO PUBLIC.BAR (X) VALUES (1234);

The output can be loaded into a database with the in command.

Options are:

-create-public-schema: When enabled, CREATE SCHEMA PUBLIC; will be included in the output. By default it not included because it is provided implicitly with a vsql database.

server will start the PostgreSQL-compatible server. You may connect to it with on of the supported PostgreSQL clients here.

vsql server

Options are:

Is used to display the current version:

vsql version