mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-08-28 10:54:59 +00:00
87011e4294
* 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
103 lines
3 KiB
Go
103 lines
3 KiB
Go
package cli
|
|
|
|
import (
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"time"
|
|
|
|
featurebase "github.com/featurebasedb/featurebase/v3"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
type Queryer interface {
|
|
Query(org string, db string, sql io.Reader) (*featurebase.WireQueryResponse, error)
|
|
}
|
|
|
|
// Ensure type implements interface.
|
|
var _ Queryer = (*nopQueryer)(nil)
|
|
|
|
type nopQueryer struct{}
|
|
|
|
func (qryr *nopQueryer) Query(org string, db string, sql io.Reader) (*featurebase.WireQueryResponse, error) {
|
|
return nil, errors.Errorf("no-op queryer")
|
|
}
|
|
|
|
// Ensure type implements interface.
|
|
var _ Queryer = (*standardQueryer)(nil)
|
|
|
|
// standardQueryer supports a standard featurebase deployment hitting the /sql
|
|
// endpoint with a payload containing only the sql statement.
|
|
type standardQueryer struct {
|
|
Host string
|
|
Port string
|
|
}
|
|
|
|
func (qryr *standardQueryer) Query(org string, db string, sql io.Reader) (*featurebase.WireQueryResponse, error) {
|
|
url := fmt.Sprintf("%s/sql", hostPort(qryr.Host, qryr.Port))
|
|
|
|
resp, err := http.Post(url, "application/json", sql)
|
|
if err != nil {
|
|
return nil, errors.Wrapf(err, "posting query")
|
|
}
|
|
|
|
fullbod, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "reading response")
|
|
}
|
|
sqlResponse := &featurebase.WireQueryResponse{}
|
|
// TODO(tlt): switch this back once all responses are typed
|
|
// if err := json.Unmarshal(fullbod, sqlResponse); err != nil {
|
|
if err := sqlResponse.UnmarshalJSONTyped(fullbod, true); err != nil {
|
|
return nil, errors.Wrapf(err, "unmarshaling query response, body:\n'%s'\n", fullbod)
|
|
}
|
|
|
|
return sqlResponse, nil
|
|
}
|
|
|
|
// Ensure type implements interface.
|
|
var _ Queryer = (*serverlessQueryer)(nil)
|
|
|
|
// serverlessQueryer is similar to the standardQueryer except that it hits a
|
|
// different endpoint, and its payload is database-aware.
|
|
type serverlessQueryer struct {
|
|
Host string
|
|
Port string
|
|
}
|
|
|
|
func (qryr *serverlessQueryer) Query(org string, db string, sql io.Reader) (*featurebase.WireQueryResponse, error) {
|
|
// buf := bytes.Buffer{}
|
|
url := fmt.Sprintf("%s/queryer/databases/%s/sql", hostPort(qryr.Host, qryr.Port), db)
|
|
if db == "" {
|
|
url = fmt.Sprintf("%s/queryer/sql", hostPort(qryr.Host, qryr.Port))
|
|
}
|
|
|
|
client := &http.Client{
|
|
Timeout: time.Second * 30,
|
|
}
|
|
|
|
req, err := http.NewRequest(http.MethodPost, url, sql)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "creating new post request")
|
|
}
|
|
req.Header.Add("Content-Type", "text/plain")
|
|
req.Header.Add("OrganizationID", org)
|
|
|
|
var resp *http.Response
|
|
if resp, err = client.Do(req); err != nil {
|
|
return nil, errors.Wrap(err, "executing post request")
|
|
}
|
|
|
|
fullbod, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "reading response")
|
|
}
|
|
sqlResponse := &featurebase.WireQueryResponse{}
|
|
// TODO(tlt): switch this back once all responses are typed
|
|
// if err := json.Unmarshal(fullbod, sqlResponse); err != nil {
|
|
if err := sqlResponse.UnmarshalJSONTyped(fullbod, true); err != nil {
|
|
return nil, errors.Wrapf(err, "unmarshaling query response, body:\n'%s'\n", fullbod)
|
|
}
|
|
|
|
return sqlResponse, nil
|
|
}
|