delete.go

// Copyright 2019 Tim Shannon. All rights reserved.
// Use of this source code is governed by the MIT license
// that can be found in the LICENSE file.

package badgerhold

import (
	"github.com/dgraph-io/badger/v4"
)

// Delete deletes a record from the badgerhold, datatype just needs to be an example of the type stored so that
// the proper bucket and indexes are updated
func (s *Store) Delete(key, dataType interface{}) error {
	return s.Badger().Update(func(tx *badger.Txn) error {
		return s.TxDelete(tx, key, dataType)
	})
}

// TxDelete is the same as Delete except it allows you to specify your own transaction
func (s *Store) TxDelete(tx *badger.Txn, key, dataType interface{}) error {
	storer := s.newStorer(dataType)
	gk, err := s.encodeKey(key, storer.Type())

	if err != nil {
		return err
	}

	value := newElemType(dataType)

	item, err := tx.Get(gk)
	if err == badger.ErrKeyNotFound {
		return ErrNotFound
	}
	if err != nil {
		return err
	}

	err = item.Value(func(bVal []byte) error {
		return s.decode(bVal, value)
	})
	if err != nil {
		return err
	}

	// delete data
	err = tx.Delete(gk)

	if err != nil {
		return err
	}

	// remove any indexes
	return s.indexDelete(storer, tx, gk, value)
}

// DeleteMatching deletes all the records that match the passed in query
func (s *Store) DeleteMatching(dataType interface{}, query *Query) error {
	return s.Badger().Update(func(tx *badger.Txn) error {
		return s.TxDeleteMatching(tx, dataType, query)
	})
}

// TxDeleteMatching does the same as DeleteMatching, but allows you to specify your own transaction
func (s *Store) TxDeleteMatching(tx *badger.Txn, dataType interface{}, query *Query) error {
	return s.deleteQuery(tx, dataType, query)
}