// Copyright (C) 2019 Storj Labs, Inc. // See LICENSE for copying information. package cockroachkv import ( "bytes" "context" "database/sql" "errors" "sort" "github.com/spacemonkeygo/monkit/v3" "github.com/zeebo/errs" "storj.io/storj/private/dbutil" "storj.io/storj/private/dbutil/cockroachutil" "storj.io/storj/private/dbutil/pgutil" "storj.io/storj/private/dbutil/txutil" "storj.io/storj/private/tagsql" "storj.io/storj/storage" "storj.io/storj/storage/cockroachkv/schema" ) var ( mon = monkit.Package() ) // Client is the entrypoint into a cockroachkv data store. type Client struct { db tagsql.DB dbURL string lookupLimit int } // Open connects a new cockroachkv client given db URL. func Open(ctx context.Context, dbURL string) (*Client, error) { dbURL = pgutil.CheckApplicationName(dbURL) db, err := tagsql.Open(ctx, "cockroach", dbURL) if err != nil { return nil, err } dbutil.Configure(ctx, db, "cockroachkv", mon) return NewWith(db, dbURL), nil } // NewWith instantiates a new cockroachkv client given db. func NewWith(db tagsql.DB, dbURL string) *Client { return &Client{db: db, dbURL: dbURL, lookupLimit: storage.DefaultLookupLimit} } // MigrateToLatest migrates to latest schema version. func (client *Client) MigrateToLatest(ctx context.Context) error { return schema.PrepareDB(ctx, client.db) } // SetLookupLimit sets the lookup limit. func (client *Client) SetLookupLimit(v int) { client.lookupLimit = v } // LookupLimit returns the maximum limit that is allowed. func (client *Client) LookupLimit() int { return client.lookupLimit } // Close closes the client. func (client *Client) Close() error { return client.db.Close() } // Put sets the value for the provided key. func (client *Client) Put(ctx context.Context, key storage.Key, value storage.Value) (err error) { defer mon.Task()(&ctx)(&err) if key.IsZero() { return storage.ErrEmptyKey.New("") } q := ` INSERT INTO pathdata (fullpath, metadata) VALUES ($1:::BYTEA, $2:::BYTEA) ON CONFLICT (fullpath) DO UPDATE SET metadata = EXCLUDED.metadata ` _, err = client.db.ExecContext(ctx, q, []byte(key), []byte(value)) return Error.Wrap(err) } // Get looks up the provided key and returns its value (or an error). func (client *Client) Get(ctx context.Context, key storage.Key) (_ storage.Value, err error) { defer mon.Task()(&ctx)(&err) if key.IsZero() { return nil, storage.ErrEmptyKey.New("") } q := "SELECT metadata FROM pathdata WHERE fullpath = $1:::BYTEA" row := client.db.QueryRowContext(ctx, q, []byte(key)) var val []byte err = row.Scan(&val) if errors.Is(err, sql.ErrNoRows) { return nil, storage.ErrKeyNotFound.New("%q", key) } return val, Error.Wrap(err) } // GetAll finds all values for the provided keys (up to LookupLimit). // If more keys are provided than the maximum, an error will be returned. func (client *Client) GetAll(ctx context.Context, keys storage.Keys) (values storage.Values, err error) { defer mon.Task()(&ctx)(&err) if len(keys) > client.lookupLimit { return nil, storage.ErrLimitExceeded.New("lookup limit exceeded") } for { values, err = client.getAllOnce(ctx, keys) if err != nil { if cockroachutil.NeedsRetry(err) { continue } return nil, Error.Wrap(err) } return values, nil } } func (client *Client) getAllOnce(ctx context.Context, keys storage.Keys) (values storage.Values, err error) { defer mon.Task()(&ctx)(&err) q := ` SELECT metadata FROM pathdata pd RIGHT JOIN unnest($1:::BYTEA[]) WITH ORDINALITY pk(request, ord) ON (pd.fullpath = pk.request) ORDER BY pk.ord ` rows, err := client.db.QueryContext(ctx, q, pgutil.ByteaArray(keys.ByteSlices())) if err != nil { return nil, err } defer func() { closeErr := rows.Close() if closeErr != nil { err = errs.Combine(err, closeErr) } }() values = make([]storage.Value, 0, len(keys)) for rows.Next() { var value []byte if err := rows.Scan(&value); err != nil { return nil, err } values = append(values, storage.Value(value)) } if err = rows.Err(); err != nil { return nil, err } return values, nil } // Delete deletes the given key and its associated value. func (client *Client) Delete(ctx context.Context, key storage.Key) (err error) { defer mon.Task()(&ctx)(&err) if key.IsZero() { return storage.ErrEmptyKey.New("") } q := "DELETE FROM pathdata WHERE fullpath = $1:::BYTEA" result, err := client.db.ExecContext(ctx, q, []byte(key)) if err != nil { return err } numRows, err := result.RowsAffected() if err != nil { return err } if numRows == 0 { return storage.ErrKeyNotFound.New("%q", key) } return nil } // DeleteMultiple deletes keys ignoring missing keys. func (client *Client) DeleteMultiple(ctx context.Context, keys []storage.Key) (items storage.Items, err error) { defer mon.Task()(&ctx)(&err) // make sure delete always happen in the same order sort.Slice(keys, func(i, j int) bool { return keys[i].Less(keys[j]) }) for { items, err = client.deleteMultipleOnce(ctx, keys) if err != nil { if cockroachutil.NeedsRetry(err) { continue } return nil, Error.Wrap(err) } return items, nil } } func (client *Client) deleteMultipleOnce(ctx context.Context, keys storage.Keys) (items storage.Items, err error) { defer mon.Task()(&ctx)(&err) rows, err := client.db.QueryContext(ctx, ` DELETE FROM pathdata WHERE fullpath = any($1::BYTEA[]) RETURNING fullpath, metadata`, pgutil.ByteaArray(keys.ByteSlices())) if err != nil { return nil, err } defer func() { closeErr := rows.Close() if closeErr != nil { err = errs.Combine(err, closeErr) } }() items = make([]storage.ListItem, 0, len(keys)) for rows.Next() { var key, value []byte err := rows.Scan(&key, &value) if err != nil { return items, err } items = append(items, storage.ListItem{ Key: key, Value: value, }) } if err = rows.Err(); err != nil { return nil, err } return items, nil } // List returns either a list of known keys, in order, or an error. func (client *Client) List(ctx context.Context, first storage.Key, limit int) (_ storage.Keys, err error) { defer mon.Task()(&ctx)(&err) return storage.ListKeys(ctx, client, first, limit) } // Iterate calls the callback with an iterator over the keys. func (client *Client) Iterate(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error) { defer mon.Task()(&ctx)(&err) if opts.Limit <= 0 || opts.Limit > client.lookupLimit { opts.Limit = client.lookupLimit } return client.IterateWithoutLookupLimit(ctx, opts, fn) } // IterateWithoutLookupLimit calls the callback with an iterator over the keys, but doesn't enforce default limit on opts. func (client *Client) IterateWithoutLookupLimit(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error) { defer mon.Task()(&ctx)(&err) opi, err := newOrderedCockroachIterator(ctx, client, opts) if err != nil { return err } defer func() { err = errs.Combine(err, opi.Close()) }() return fn(ctx, opi) } // CompareAndSwap atomically compares and swaps oldValue with newValue. func (client *Client) CompareAndSwap(ctx context.Context, key storage.Key, oldValue, newValue storage.Value) (err error) { defer mon.Task()(&ctx)(&err) if key.IsZero() { return storage.ErrEmptyKey.New("") } if oldValue == nil && newValue == nil { q := "SELECT metadata FROM pathdata WHERE fullpath = $1:::BYTEA" row := client.db.QueryRowContext(ctx, q, []byte(key)) var val []byte err = row.Scan(&val) if errors.Is(err, sql.ErrNoRows) { return nil } if err != nil { return Error.Wrap(err) } return storage.ErrValueChanged.New("%q", key) } if oldValue == nil { q := ` INSERT INTO pathdata (fullpath, metadata) VALUES ($1:::BYTEA, $2:::BYTEA) ON CONFLICT DO NOTHING RETURNING 1 ` row := client.db.QueryRowContext(ctx, q, []byte(key), []byte(newValue)) var val []byte err = row.Scan(&val) if errors.Is(err, sql.ErrNoRows) { return storage.ErrValueChanged.New("%q", key) } return Error.Wrap(err) } return txutil.WithTx(ctx, client.db, nil, func(ctx context.Context, txn tagsql.Tx) error { q := "SELECT metadata FROM pathdata WHERE fullpath = $1:::BYTEA;" row := txn.QueryRowContext(ctx, q, []byte(key)) var metadata []byte err = row.Scan(&metadata) if errors.Is(err, sql.ErrNoRows) { // Row not found for this fullpath. // Potentially because another concurrent transaction changed the row. return storage.ErrKeyNotFound.New("%q", key) } if err != nil { return Error.Wrap(err) } if equal := bytes.Compare(metadata, oldValue); equal != 0 { // If the row is found but the metadata has been already changed // we can't continue to delete it. return storage.ErrValueChanged.New("%q", key) } var res sql.Result if newValue == nil { q = ` DELETE FROM pathdata WHERE pathdata.fullpath = $1:::BYTEA AND pathdata.metadata = $2:::BYTEA ` res, err = txn.ExecContext(ctx, q, []byte(key), []byte(oldValue)) } else { q = ` UPDATE pathdata SET metadata = $3:::BYTEA WHERE pathdata.fullpath = $1:::BYTEA AND pathdata.metadata = $2:::BYTEA ` res, err = txn.ExecContext(ctx, q, []byte(key), []byte(oldValue), []byte(newValue)) } if err != nil { return Error.Wrap(err) } affected, err := res.RowsAffected() if err != nil { return Error.Wrap(err) } if affected != 1 { return storage.ErrValueChanged.New("%q", key) } return nil }) }