mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-08-28 10:54:59 +00:00
* Refactor CLI to mimic psql's meta-commands
This PR adds support for meta-commands (also known as "backslash
commands") like those in psql, Postgres's CLI. Only a few meta-commands
are currently implemented, but this was meant to demonstrate how we
could use something like `\i file.csv` to insert local files into SQL
statements.
* Meta-commands: \file and \include
The initial implementation used `\i` as a streaming file handle.
This commit changes that to `\file`, and then implements `\i` (or
`\include`) as handling multiple sql commands.
* Add meta-command "help" (\?)
This is basically a copy of the psql help output, but includes only
those options we currently support.
* Add support for \o [file], and \timing
The \o meta-command writes query output to a file.
The \timing meta-command turns on/off the timing display sent to stdout.
* Add meta-commands: \l (show databases) and \dt (show tables)
* Add meta-command: \watch [period]
* Update meta-command \connect to take database name instead of ID
* Add support for \echo, \qecho, and \warn
This commit contains an known issue in that the `-n` option will exclude
the line feed, but if the output is the terminal, the readline package
clobbers any content on the current line (i.e. anything without a line
feed). That will need to be addressed at some point.
* Add support for \w [FILE] (write query buffer to file)
* Add SchemaAPI no-op implementation
* Refactor query handler to align with /sql and /databases endpoints
We want to standardize on:
/sql
/databases/{databaseID}/sql
* Add CLI support for expanded, border, tuples_only (and pset)
* Add help text for \pset and \t
146 lines
2.6 KiB
Go
146 lines
2.6 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestSplitter(t *testing.T) {
|
|
s := newSplitter()
|
|
t.Run("Split", func(t *testing.T) {
|
|
tests := []struct {
|
|
line string
|
|
expQueryParts []queryPart
|
|
expMetaCommands []metaCommand
|
|
expError string
|
|
}{
|
|
{
|
|
line: `foo`,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
},
|
|
},
|
|
{
|
|
line: `foo;`,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
newPartTerminator(),
|
|
},
|
|
},
|
|
{
|
|
line: `foo; `,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
newPartTerminator(),
|
|
},
|
|
},
|
|
{
|
|
line: `foo; ; `,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
newPartTerminator(),
|
|
},
|
|
},
|
|
{
|
|
line: `foo; bar`,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
newPartTerminator(),
|
|
newPartRaw("bar"),
|
|
},
|
|
},
|
|
{
|
|
line: `foo; bar;`,
|
|
expQueryParts: []queryPart{
|
|
newPartRaw("foo"),
|
|
newPartTerminator(),
|
|
newPartRaw("bar"),
|
|
newPartTerminator(),
|
|
},
|
|
},
|
|
{
|
|
line: `\q`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaQuit{},
|
|
},
|
|
},
|
|
{
|
|
line: ` \p`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaPrint{},
|
|
},
|
|
},
|
|
{
|
|
line: `\q \p`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaQuit{},
|
|
&metaPrint{},
|
|
},
|
|
},
|
|
{
|
|
line: `\q \p arg1 arg2`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaQuit{},
|
|
&metaPrint{},
|
|
},
|
|
},
|
|
{
|
|
line: `\set`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaSet{
|
|
args: []string{},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
line: `\set arg1 arg2`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaSet{
|
|
args: []string{"arg1", "arg2"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
line: `\set 'arg1' 'arg2'`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaSet{
|
|
args: []string{"arg1", "arg2"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
line: `\set 'arg1' '"arg2"'`,
|
|
expMetaCommands: []metaCommand{
|
|
&metaSet{
|
|
args: []string{"arg1", "\"arg2\""},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
line: `\`,
|
|
expError: "unsupported meta-command:",
|
|
},
|
|
{
|
|
line: `\xyzxyz`,
|
|
expError: "unsupported meta-command:",
|
|
},
|
|
}
|
|
for i, tt := range tests {
|
|
t.Run(fmt.Sprintf("test-%d-%s", i, tt.line), func(t *testing.T) {
|
|
qps, mcs, err := s.split(tt.line)
|
|
if tt.expError != "" {
|
|
if assert.Error(t, err) {
|
|
assert.Contains(t, err.Error(), tt.expError)
|
|
}
|
|
return
|
|
}
|
|
|
|
assert.NoError(t, err)
|
|
assert.ElementsMatch(t, tt.expQueryParts, qps)
|
|
assert.ElementsMatch(t, tt.expMetaCommands, mcs)
|
|
})
|
|
}
|
|
})
|
|
}
|