mirror of
https://github.com/featurebasedb/featurebase.git
synced 2026-08-28 02:44: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
131 lines
3.5 KiB
Go
131 lines
3.5 KiB
Go
package fbcloud
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
featurebase "github.com/featurebasedb/featurebase/v3"
|
|
"github.com/pkg/errors"
|
|
)
|
|
|
|
// TokenRefreshTimeout is currently hardcoded to be just under the
|
|
// Cognito token timeout for cloud which is 15 minutes (I think I
|
|
// heard that somewhere anyway). It seems to work.
|
|
const TokenRefreshTimeout = time.Minute * 13
|
|
|
|
type Queryer struct {
|
|
Host string
|
|
|
|
ClientID string
|
|
Region string
|
|
Email string
|
|
Password string
|
|
|
|
token string
|
|
lastRefresh time.Time
|
|
}
|
|
|
|
func (cq *Queryer) tokenRefresh() error {
|
|
token, err := authenticate(cq.ClientID, cq.Region, cq.Email, cq.Password)
|
|
if err != nil {
|
|
return errors.Wrap(err, "getting token")
|
|
}
|
|
cq.token = token
|
|
cq.lastRefresh = time.Now()
|
|
return nil
|
|
}
|
|
|
|
// Query issues a SQL query formatted for the FeatureBase cloud query endpoint.
|
|
func (cq *Queryer) Query(org string, db string, sql io.Reader) (*featurebase.WireQueryResponse, error) {
|
|
if time.Since(cq.lastRefresh) > TokenRefreshTimeout {
|
|
if err := cq.tokenRefresh(); err != nil {
|
|
return nil, errors.Wrap(err, "refreshing token")
|
|
}
|
|
}
|
|
url := fmt.Sprintf("%s/databases/%s/sql", cq.Host, db)
|
|
if db == "" {
|
|
url = fmt.Sprintf("%s/sql", cq.Host)
|
|
}
|
|
|
|
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("Authorization", cq.token)
|
|
|
|
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 cloud response")
|
|
}
|
|
if resp.StatusCode/100 != 2 {
|
|
return nil, errors.Errorf("unexpected status: %s, full body: '%s'", resp.Status, fullbod)
|
|
}
|
|
|
|
var sqlResponse featurebase.WireQueryResponse
|
|
if err := json.Unmarshal(fullbod, &sqlResponse); err != nil {
|
|
return nil, errors.Wrapf(err, "decoding cloud response, body:\n%s", fullbod)
|
|
}
|
|
return &sqlResponse, nil
|
|
}
|
|
|
|
// HTTPRequest can make an arbitrary http request to the host and
|
|
// tries to json unmarshal the response body into v if v is
|
|
// non-nil. This is handy for hitting cloud endpoints other than the
|
|
// query endpoint which is handled by Query. I don't think this is
|
|
// currently used, but I'd like to keep it around for debugging.
|
|
func (cq *Queryer) HTTPRequest(method, path, body string, v interface{}) ([]byte, error) {
|
|
if time.Since(cq.lastRefresh) > TokenRefreshTimeout {
|
|
if err := cq.tokenRefresh(); err != nil {
|
|
return nil, errors.Wrap(err, "refreshing token")
|
|
}
|
|
}
|
|
var bod io.Reader
|
|
if body == "" {
|
|
bod = nil
|
|
} else {
|
|
bod = strings.NewReader(body)
|
|
}
|
|
req, err := http.NewRequest(method, fmt.Sprintf("%s%s", cq.Host, path), bod)
|
|
if err != nil {
|
|
return nil, errors.Errorf("creating request: %v", err)
|
|
}
|
|
// fmt.Printf("%+v\n", req)
|
|
|
|
req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", cq.token))
|
|
if bod != nil {
|
|
req.Header.Add("Content-Type", "application/json")
|
|
}
|
|
resp, err := http.DefaultClient.Do(req)
|
|
if err != nil {
|
|
return nil, errors.Errorf("doing request: %v", err)
|
|
}
|
|
bodbytes, err := io.ReadAll(resp.Body)
|
|
if err != nil {
|
|
return nil, errors.Errorf("reading response body: %v", err)
|
|
}
|
|
if resp.StatusCode/100 != 2 {
|
|
return nil, errors.Errorf("bad status: %s. body: '%s'", resp.Status, bodbytes)
|
|
}
|
|
|
|
if v != nil {
|
|
err = json.Unmarshal(bodbytes, v)
|
|
if err != nil {
|
|
return nil, errors.Errorf("unmarshaling: %v", err)
|
|
}
|
|
}
|
|
|
|
return bodbytes, nil
|
|
}
|