1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
|
// Package drivers handles the registration, default implementation, and
// handles hooks for usql database drivers.
package drivers
import (
"context"
"database/sql"
"encoding/json"
"fmt"
"io"
"reflect"
"regexp"
"strings"
"time"
"unicode"
"github.com/alecthomas/chroma/v2"
"github.com/alecthomas/chroma/v2/lexers"
"github.com/gohxs/readline"
"github.com/xo/dburl"
"github.com/xo/usql/drivers/completer"
"github.com/xo/usql/drivers/metadata"
"github.com/xo/usql/stmt"
"github.com/xo/usql/text"
)
// DB is the common interface for database operations, compatible with
// database/sql.DB and database/sql.Tx.
type DB interface {
Exec(string, ...interface{}) (sql.Result, error)
ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
Query(string, ...interface{}) (*sql.Rows, error)
QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error)
QueryRow(string, ...interface{}) *sql.Row
QueryRowContext(context.Context, string, ...interface{}) *sql.Row
Prepare(string) (*sql.Stmt, error)
PrepareContext(context.Context, string) (*sql.Stmt, error)
}
// Driver holds funcs for a driver.
type Driver struct {
// Name is a name to override the driver name with.
Name string
// AllowDollar will be passed to query buffers to enable dollar ($$) style
// strings.
AllowDollar bool
// AllowMultilineComments will be passed to query buffers to enable
// multiline (/**/) style comments.
AllowMultilineComments bool
// AllowCComments will be passed to query buffers to enable C (//) style
// comments.
AllowCComments bool
// AllowHashComments will be passed to query buffers to enable hash (#)
// style comments.
AllowHashComments bool
// RequirePreviousPassword will be used by RequirePreviousPassword.
RequirePreviousPassword bool
// LexerName is the name of the syntax lexer to use.
LexerName string
// LowerColumnNames will cause column names to be lowered cased.
LowerColumnNames bool
// UseColumnTypes will cause database's ColumnTypes func to be used for
// types.
UseColumnTypes bool
// ForceParams will be used to force parameters if defined.
ForceParams func(*dburl.URL)
// Open will be used by Open if defined.
Open func(context.Context, *dburl.URL, func() io.Writer, func() io.Writer) (func(string, string) (*sql.DB, error), error)
// Version will be used by Version if defined.
Version func(context.Context, DB) (string, error)
// User will be used by User if defined.
User func(context.Context, DB) (string, error)
// ChangePassword will be used by ChangePassword if defined.
ChangePassword func(DB, string, string, string) error
// IsPasswordErr will be used by IsPasswordErr if defined.
IsPasswordErr func(error) bool
// Process will be used by Process if defined.
Process func(*dburl.URL, string, string) (string, string, bool, error)
// ColumnTypes is a callback that will be used if
ColumnTypes func(*sql.ColumnType) (interface{}, error)
// RowsAffected will be used by RowsAffected if defined.
RowsAffected func(sql.Result) (int64, error)
// Err will be used by Error.Error if defined.
Err func(error) (string, string)
// ConvertBytes will be used by ConvertBytes to convert a raw []byte
// slice to a string if defined.
ConvertBytes func([]byte, string) (string, error)
// ConvertMap will be used by ConvertMap to convert a map[string]interface{}
// to a string if defined.
ConvertMap func(map[string]interface{}) (string, error)
// ConvertSlice will be used by ConvertSlice to convert a []interface{} to
// a string if defined.
ConvertSlice func([]interface{}) (string, error)
// ConvertDefault will be used by ConvertDefault to convert a interface{}
// to a string if defined.
ConvertDefault func(interface{}) (string, error)
// BatchAsTransaction will cause batched queries to be done in a
// transaction block.
BatchAsTransaction bool
// BatchQueryPrefixes will be used by BatchQueryPrefixes if defined.
BatchQueryPrefixes map[string]string
// NewMetadataReader returns a db metadata introspector.
NewMetadataReader func(db DB, opts ...metadata.ReaderOption) metadata.Reader
// NewMetadataWriter returns a db metadata printer.
NewMetadataWriter func(db DB, w io.Writer, opts ...metadata.ReaderOption) metadata.Writer
// NewCompleter returns a db auto-completer.
NewCompleter func(db DB, opts ...completer.Option) readline.AutoCompleter
// Copy rows into the database table
Copy func(ctx context.Context, db *sql.DB, rows *sql.Rows, table string) (int64, error)
}
// drivers are registered drivers.
var drivers = make(map[string]Driver)
// Available returns the available drivers.
func Available() map[string]Driver {
return drivers
}
// Register registers driver d with name and associated aliases.
func Register(name string, d Driver, aliases ...string) {
if _, ok := drivers[name]; ok {
panic(fmt.Sprintf("driver %s is already registered", name))
}
drivers[name] = d
for _, alias := range aliases {
if _, ok := drivers[alias]; ok {
panic(fmt.Sprintf("alias %s is already registered", name))
}
drivers[alias] = d
}
}
// Registered returns whether or not a driver is registered.
func Registered(name string) bool {
_, ok := drivers[name]
return ok
}
// LowerColumnNames returns whether or not column names should be converted to
// lower case for a driver.
func LowerColumnNames(u *dburl.URL) bool {
if d, ok := drivers[u.Driver]; ok {
return d.LowerColumnNames
}
return false
}
// UseColumnTypes returns whether or not a driver should uses column types.
func UseColumnTypes(u *dburl.URL) bool {
if d, ok := drivers[u.Driver]; ok {
return d.UseColumnTypes
}
return false
}
// ForceParams forces parameters on the DSN for a driver.
func ForceParams(u *dburl.URL) {
d, ok := drivers[u.Driver]
if ok && d.ForceParams != nil {
d.ForceParams(u)
}
}
// Open opens a sql.DB connection for a driver.
func Open(ctx context.Context, u *dburl.URL, stdout, stderr func() io.Writer) (*sql.DB, error) {
d, ok := drivers[u.Driver]
if !ok {
return nil, WrapErr(u.Driver, text.ErrDriverNotAvailable)
}
f := sql.Open
if d.Open != nil {
var err error
if f, err = d.Open(ctx, u, stdout, stderr); err != nil {
return nil, WrapErr(u.Driver, err)
}
}
driver := u.Driver
if u.GoDriver != "" {
driver = u.GoDriver
}
db, err := f(driver, u.DSN)
if err != nil {
return nil, WrapErr(u.Driver, err)
}
return db, nil
}
// stmtOpts returns statement options for a driver.
func stmtOpts(u *dburl.URL) []stmt.Option {
if u != nil {
if d, ok := drivers[u.Driver]; ok {
return []stmt.Option{
stmt.WithAllowDollar(d.AllowDollar),
stmt.WithAllowMultilineComments(d.AllowMultilineComments),
stmt.WithAllowCComments(d.AllowCComments),
stmt.WithAllowHashComments(d.AllowHashComments),
}
}
}
return []stmt.Option{
stmt.WithAllowDollar(true),
stmt.WithAllowMultilineComments(true),
stmt.WithAllowCComments(true),
stmt.WithAllowHashComments(true),
}
}
// NewStmt wraps creating a new stmt.Stmt for a driver.
func NewStmt(u *dburl.URL, f func() ([]rune, error), opts ...stmt.Option) *stmt.Stmt {
return stmt.New(f, append(opts, stmtOpts(u)...)...)
}
// ConfigStmt sets the stmt.Stmt options for a driver.
func ConfigStmt(u *dburl.URL, s *stmt.Stmt) {
if u == nil {
return
}
for _, o := range stmtOpts(u) {
o(s)
}
}
// Version returns information about the database connection for a driver.
func Version(ctx context.Context, u *dburl.URL, db DB) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.Version != nil {
ver, err := d.Version(ctx, db)
return ver, WrapErr(u.Driver, err)
}
var ver string
err := db.QueryRowContext(ctx, `SELECT version();`).Scan(&ver)
if err != nil || ver == "" {
ver = "<unknown>"
}
return ver, nil
}
// User returns the current database user for a driver.
func User(ctx context.Context, u *dburl.URL, db DB) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.User != nil {
user, err := d.User(ctx, db)
return user, WrapErr(u.Driver, err)
}
var user string
_ = db.QueryRowContext(ctx, `SELECT current_user`).Scan(&user)
return user, nil
}
// Process processes the sql query for a driver.
func Process(u *dburl.URL, prefix, sqlstr string) (string, string, bool, error) {
if d, ok := drivers[u.Driver]; ok && d.Process != nil {
a, b, c, err := d.Process(u, prefix, sqlstr)
return a, b, c, WrapErr(u.Driver, err)
}
typ, q := QueryExecType(prefix, sqlstr)
return typ, sqlstr, q, nil
}
// ColumnTypes returns the column types callback for a driver.
func ColumnTypes(u *dburl.URL) func(*sql.ColumnType) (interface{}, error) {
return drivers[u.Driver].ColumnTypes
}
// IsPasswordErr returns true if an err is a password error for a driver.
func IsPasswordErr(u *dburl.URL, err error) bool {
drv := u.Driver
if e, ok := err.(*Error); ok {
drv, err = e.Driver, e.Err
}
if d, ok := drivers[drv]; ok && d.IsPasswordErr != nil {
return d.IsPasswordErr(err)
}
return false
}
// RequirePreviousPassword returns true if a driver requires a previous
// password when changing a user's password.
func RequirePreviousPassword(u *dburl.URL) bool {
if d, ok := drivers[u.Driver]; ok {
return d.RequirePreviousPassword
}
return false
}
// CanChangePassword returns whether or not the a driver supports changing
// passwords.
func CanChangePassword(u *dburl.URL) error {
if d, ok := drivers[u.Driver]; ok && d.ChangePassword != nil {
return nil
}
return text.ErrPasswordNotSupportedByDriver
}
// ChangePassword initiates a user password change for the a driver. If user is
// not supplied, then the current user will be retrieved from User.
func ChangePassword(u *dburl.URL, db DB, user, new, old string) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.ChangePassword != nil {
if user == "" {
var err error
if user, err = User(context.Background(), u, db); err != nil {
return "", err
}
}
return user, d.ChangePassword(db, user, new, old)
}
return "", text.ErrPasswordNotSupportedByDriver
}
// Columns returns the column names for the SQL row result for a driver.
func Columns(u *dburl.URL, rows *sql.Rows) ([]string, error) {
cols, err := rows.Columns()
if err != nil {
return nil, WrapErr(u.Driver, err)
}
if drivers[u.Driver].LowerColumnNames {
for i, s := range cols {
if j := strings.IndexFunc(s, func(r rune) bool {
return unicode.IsLetter(r) && unicode.IsLower(r)
}); j == -1 {
cols[i] = strings.ToLower(s)
}
}
}
for i, c := range cols {
if strings.TrimSpace(c) == "" {
cols[i] = fmt.Sprintf("col%d", i)
}
}
return cols, nil
}
// ConvertBytes returns a func to handle converting bytes for a driver.
func ConvertBytes(u *dburl.URL) func([]byte, string) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.ConvertBytes != nil {
return d.ConvertBytes
}
return func(buf []byte, _ string) (string, error) {
return string(buf), nil
}
}
// ConvertMap returns a func to handle converting a map[string]interface{} for
// a driver.
func ConvertMap(u *dburl.URL) func(map[string]interface{}) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.ConvertMap != nil {
return d.ConvertMap
}
return func(v map[string]interface{}) (string, error) {
buf, err := json.Marshal(v)
if err != nil {
return "", err
}
return string(buf), nil
}
}
// ConvertSlice returns a func to handle converting a []interface{} for a
// driver.
func ConvertSlice(u *dburl.URL) func([]interface{}) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.ConvertSlice != nil {
return d.ConvertSlice
}
return func(v []interface{}) (string, error) {
buf, err := json.Marshal(v)
if err != nil {
return "", err
}
return string(buf), nil
}
}
// ConvertDefault returns a func to handle converting a interface{} for a
// driver.
func ConvertDefault(u *dburl.URL) func(interface{}) (string, error) {
if d, ok := drivers[u.Driver]; ok && d.ConvertDefault != nil {
return d.ConvertDefault
}
return func(v interface{}) (string, error) {
return fmt.Sprintf("%v", v), nil
}
}
// BatchAsTransaction returns whether or not a driver requires batched queries
// to be done within a transaction block.
func BatchAsTransaction(u *dburl.URL) bool {
if d, ok := drivers[u.Driver]; ok {
return d.BatchAsTransaction
}
return false
}
// IsBatchQueryPrefix returns whether or not the supplied query prefix is a
// batch query prefix, and the closing prefix. Used to direct the handler to
// continue accumulating statements.
func IsBatchQueryPrefix(u *dburl.URL, prefix string) (string, string, bool) {
// normalize
typ, q := QueryExecType(prefix, "")
d, ok := drivers[u.Driver]
if q || !ok || d.BatchQueryPrefixes == nil {
return typ, "", false
}
end, ok := d.BatchQueryPrefixes[typ]
return typ, end, ok
}
// RowsAffected returns the rows affected for the SQL result for a driver.
func RowsAffected(u *dburl.URL, res sql.Result) (int64, error) {
var count int64
var err error
if d, ok := drivers[u.Driver]; ok && d.RowsAffected != nil {
count, err = d.RowsAffected(res)
} else {
count, err = res.RowsAffected()
}
if err != nil && err.Error() == "no RowsAffected available after DDL statement" {
return 0, nil
}
if err != nil {
return 0, WrapErr(u.Driver, err)
}
return count, nil
}
// Ping pings the database for a driver.
func Ping(ctx context.Context, u *dburl.URL, db *sql.DB) error {
return WrapErr(u.Driver, db.PingContext(ctx))
}
// Lexer returns the syntax lexer for a driver.
func Lexer(u *dburl.URL) chroma.Lexer {
var l chroma.Lexer
if u != nil {
if d, ok := drivers[u.Driver]; ok && d.LexerName != "" {
l = lexers.Get(d.LexerName)
}
}
if l == nil {
l = lexers.Get("sql")
}
l.Config().EnsureNL = false
return l
}
// ForceQueryParameters is a utility func that wraps forcing params of name,
// value pairs.
func ForceQueryParameters(params []string) func(*dburl.URL) {
if len(params)%2 != 0 {
panic("invalid query params")
}
return func(u *dburl.URL) {
if len(params) != 0 {
v := u.Query()
for i := 0; i < len(params); i += 2 {
v.Set(params[i], params[i+1])
}
u.RawQuery = v.Encode()
}
}
}
// NewMetadataReader wraps creating a new database introspector for a driver.
func NewMetadataReader(ctx context.Context, u *dburl.URL, db DB, w io.Writer, opts ...metadata.ReaderOption) (metadata.Reader, error) {
d, ok := drivers[u.Driver]
if !ok || d.NewMetadataReader == nil {
return nil, fmt.Errorf(text.NotSupportedByDriver, `describe commands`, u.Driver)
}
return d.NewMetadataReader(db, opts...), nil
}
// NewMetadataWriter wraps creating a new database metadata printer for a driver.
func NewMetadataWriter(ctx context.Context, u *dburl.URL, db DB, w io.Writer, opts ...metadata.ReaderOption) (metadata.Writer, error) {
d, ok := drivers[u.Driver]
if !ok {
return nil, fmt.Errorf(text.NotSupportedByDriver, `describe commands`, u.Driver)
}
if d.NewMetadataWriter != nil {
return d.NewMetadataWriter(db, w, opts...), nil
}
if d.NewMetadataReader == nil {
return nil, fmt.Errorf(text.NotSupportedByDriver, `describe commands`, u.Driver)
}
newMetadataWriter := metadata.NewDefaultWriter(d.NewMetadataReader(db, opts...))
return newMetadataWriter(db, w), nil
}
// NewCompleter creates a metadata completer for a driver and database
// connection.
func NewCompleter(ctx context.Context, u *dburl.URL, db DB, readerOpts []metadata.ReaderOption, opts ...completer.Option) readline.AutoCompleter {
d, ok := drivers[u.Driver]
if !ok {
return nil
}
if d.NewCompleter != nil {
return d.NewCompleter(db, opts...)
}
if d.NewMetadataReader == nil {
return nil
}
// prepend to allow to override default options
readerOpts = append([]metadata.ReaderOption{
// this needs to be relatively low, since autocomplete is very interactive
metadata.WithTimeout(3 * time.Second),
metadata.WithLimit(1000),
}, readerOpts...)
opts = append([]completer.Option{
completer.WithReader(d.NewMetadataReader(db, readerOpts...)),
completer.WithDB(db),
}, opts...)
return completer.NewDefaultCompleter(opts...)
}
// Copy copies the result set to the destination sql.DB.
func Copy(ctx context.Context, u *dburl.URL, stdout, stderr func() io.Writer, rows *sql.Rows, table string) (int64, error) {
d, ok := drivers[u.Driver]
if !ok {
return 0, WrapErr(u.Driver, text.ErrDriverNotAvailable)
}
if d.Copy == nil {
return 0, fmt.Errorf(text.NotSupportedByDriver, "copy", u.Driver)
}
db, err := Open(ctx, u, stdout, stderr)
if err != nil {
return 0, err
}
defer db.Close()
return d.Copy(ctx, db, rows, table)
}
// CopyWithInsert builds a copy handler based on insert.
func CopyWithInsert(placeholder func(int) string) func(ctx context.Context, db *sql.DB, rows *sql.Rows, table string) (int64, error) {
if placeholder == nil {
placeholder = func(n int) string { return fmt.Sprintf("$%d", n) }
}
return func(ctx context.Context, db *sql.DB, rows *sql.Rows, table string) (int64, error) {
columns, err := rows.Columns()
if err != nil {
return 0, fmt.Errorf("failed to fetch source rows columns: %w", err)
}
clen := len(columns)
query := table
if !strings.HasPrefix(strings.ToLower(query), "insert into") {
leftParen := strings.IndexRune(table, '(')
if leftParen == -1 {
colRows, err := db.QueryContext(ctx, "SELECT * FROM "+table+" WHERE 1=0")
if err != nil {
return 0, fmt.Errorf("failed to execute query to determine target table columns: %w", err)
}
columns, err := colRows.Columns()
_ = colRows.Close()
if err != nil {
return 0, fmt.Errorf("failed to fetch target table columns: %w", err)
}
table += "(" + strings.Join(columns, ", ") + ")"
}
// TODO if the db supports multiple rows per insert, create batches of 100 rows
placeholders := make([]string, clen)
for i := 0; i < clen; i++ {
placeholders[i] = placeholder(i + 1)
}
query = "INSERT INTO " + table + " VALUES (" + strings.Join(placeholders, ", ") + ")"
}
tx, err := db.BeginTx(ctx, nil)
if err != nil {
return 0, fmt.Errorf("failed to begin transaction: %w", err)
}
stmt, err := tx.PrepareContext(ctx, query)
if err != nil {
return 0, fmt.Errorf("failed to prepare insert query: %w", err)
}
defer stmt.Close()
columnTypes, err := rows.ColumnTypes()
if err != nil {
return 0, fmt.Errorf("failed to fetch source column types: %w", err)
}
values := make([]interface{}, clen)
valueRefs := make([]reflect.Value, clen)
actuals := make([]interface{}, clen)
for i := 0; i < len(columnTypes); i++ {
valueRefs[i] = reflect.New(columnTypes[i].ScanType())
values[i] = valueRefs[i].Interface()
}
var n int64
for rows.Next() {
err = rows.Scan(values...)
if err != nil {
return n, fmt.Errorf("failed to scan row: %w", err)
}
//We can't use values... in Exec() below, because some drivers
//don't accept pointer to an argument instead of the arg itself.
for i := range values {
actuals[i] = valueRefs[i].Elem().Interface()
}
res, err := stmt.ExecContext(ctx, actuals...)
if err != nil {
return n, fmt.Errorf("failed to exec insert: %w", err)
}
rn, err := res.RowsAffected()
if err != nil {
return n, fmt.Errorf("failed to check rows affected: %w", err)
}
n += rn
}
// TODO if using batches, flush the last batch,
// TODO prepare another statement and count remaining rows
err = tx.Commit()
if err != nil {
return n, fmt.Errorf("failed to commit transaction: %w", err)
}
return n, rows.Err()
}
}
func init() {
dburl.OdbcIgnoreQueryPrefixes = []string{"usql_"}
}
var endRE = regexp.MustCompile(`;?\s*$`)
func StripTrailingSemicolon(_ *dburl.URL, prefix string, sqlstr string) (string, string, bool, error) {
sqlstr = endRE.ReplaceAllString(sqlstr, "")
typ, q := QueryExecType(prefix, sqlstr)
return typ, sqlstr, q, nil
}
|