boom

README

boom

BOOM HEADSHOT!

goon likes interface for go.mercari.io/datastore.

boom doesn't have cache layer. It will be coming to go.mercari.io/datastore package.

boom doing only struct → key and key → struct mapping.

Important Notice

There are incompatible behaviors in the following points.

• *boom.Transaction#Put will not set ID immediate.
  • It will be set after boom.Transaction#Commit.
  • If you want to get ID/Name asap, You should use datastore.Client#AllocatedIDs.

TODO

• namespace

Documentation

Index

• type Batch
  • func (b *Batch) Delete(dst interface{}) chan error
  • func (b *Batch) Exec() error
  • func (b *Batch) Get(dst interface{}) chan error
  • func (b *Batch) Put(src interface{}) chan *datastore.PutResult
• type Boom
  • func FromClient(ctx context.Context, client datastore.Client) *Boom
  • func FromContext(ctx context.Context) (*Boom, error)
  • func (bm *Boom) Batch() *Batch
  • func (bm *Boom) Count(q datastore.Query) (int, error)
  • func (bm *Boom) DecodeCursor(s string) (datastore.Cursor, error)
  • func (bm *Boom) Delete(src interface{}) error
  • func (bm *Boom) DeleteMulti(src interface{}) error
  • func (bm *Boom) Get(dst interface{}) error
  • func (bm *Boom) GetAll(q datastore.Query, dst interface{}) ([]datastore.Key, error)
  • func (bm *Boom) GetMulti(dst interface{}) error
  • func (bm *Boom) Key(src interface{}) datastore.Key
  • func (bm *Boom) KeyError(src interface{}) (datastore.Key, error)
  • func (bm *Boom) Kind(src interface{}) string
  • func (bm *Boom) NewTransaction() (*Transaction, error)
  • func (bm *Boom) Put(src interface{}) (datastore.Key, error)
  • func (bm *Boom) PutMulti(src interface{}) ([]datastore.Key, error)
  • func (bm *Boom) Run(q datastore.Query) *Iterator
  • func (bm *Boom) RunInTransaction(f func(tx *Transaction) error) (datastore.Commit, error)
• type Iterator
  • func (it *Iterator) Cursor() (datastore.Cursor, error)
  • func (it *Iterator) Next(dst interface{}) (datastore.Key, error)
• type Transaction
  • func (tx *Transaction) Batch() *TransactionBatch
  • func (tx *Transaction) Commit() (datastore.Commit, error)
  • func (tx *Transaction) Delete(src interface{}) error
  • func (tx *Transaction) DeleteMulti(src interface{}) error
  • func (tx *Transaction) Get(dst interface{}) error
  • func (tx *Transaction) GetMulti(dst interface{}) error
  • func (tx *Transaction) Put(src interface{}) (datastore.PendingKey, error)
  • func (tx *Transaction) PutMulti(src interface{}) ([]datastore.PendingKey, error)
  • func (tx *Transaction) Rollback() error
• type TransactionBatch
  • func (b *TransactionBatch) Delete(dst interface{}) chan error
  • func (b *TransactionBatch) Exec() error
  • func (b *TransactionBatch) Get(dst interface{}) chan error
  • func (b *TransactionBatch) Put(src interface{}) chan *datastore.TransactionPutResult

Types

type Batch

type Batch struct {
	// contains filtered or unexported fields
}

func (*Batch) Delete

func (b *Batch) Delete(dst interface{}) chan error

func (*Batch) Exec

func (b *Batch) Exec() error

func (*Batch) Get

func (b *Batch) Get(dst interface{}) chan error

func (*Batch) Put

func (b *Batch) Put(src interface{}) chan *datastore.PutResult

type Boom

type Boom struct {
	Context context.Context
	Client  datastore.Client
}

func FromClient

func FromClient(ctx context.Context, client datastore.Client) *Boom

func FromContext

func FromContext(ctx context.Context) (*Boom, error)

func (*Boom) Batch

func (bm *Boom) Batch() *Batch

func (*Boom) Count

func (bm *Boom) Count(q datastore.Query) (int, error)

func (*Boom) DecodeCursor

func (bm *Boom) DecodeCursor(s string) (datastore.Cursor, error)

func (*Boom) Delete

func (bm *Boom) Delete(src interface{}) error

func (*Boom) DeleteMulti

func (bm *Boom) DeleteMulti(src interface{}) error

func (*Boom) Get

func (bm *Boom) Get(dst interface{}) error

func (*Boom) GetAll

func (bm *Boom) GetAll(q datastore.Query, dst interface{}) ([]datastore.Key, error)

func (*Boom) GetMulti

func (bm *Boom) GetMulti(dst interface{}) error

func (*Boom) Key

func (bm *Boom) Key(src interface{}) datastore.Key

func (*Boom) KeyError

func (bm *Boom) KeyError(src interface{}) (datastore.Key, error)

func (*Boom) Kind

func (bm *Boom) Kind(src interface{}) string

func (*Boom) NewTransaction

func (bm *Boom) NewTransaction() (*Transaction, error)

func (*Boom) Put

func (bm *Boom) Put(src interface{}) (datastore.Key, error)

func (*Boom) PutMulti

func (bm *Boom) PutMulti(src interface{}) ([]datastore.Key, error)

func (*Boom) Run

func (bm *Boom) Run(q datastore.Query) *Iterator

func (*Boom) RunInTransaction

func (bm *Boom) RunInTransaction(f func(tx *Transaction) error) (datastore.Commit, error)

type Iterator

type Iterator struct {
	// contains filtered or unexported fields
}

func (*Iterator) Cursor

func (it *Iterator) Cursor() (datastore.Cursor, error)

func (*Iterator) Next

func (it *Iterator) Next(dst interface{}) (datastore.Key, error)

type Transaction

type Transaction struct {
	// contains filtered or unexported fields
}

func (*Transaction) Batch

func (tx *Transaction) Batch() *TransactionBatch

func (*Transaction) Commit

func (tx *Transaction) Commit() (datastore.Commit, error)

func (*Transaction) Delete

func (tx *Transaction) Delete(src interface{}) error

func (*Transaction) DeleteMulti

func (tx *Transaction) DeleteMulti(src interface{}) error

func (*Transaction) Get

func (tx *Transaction) Get(dst interface{}) error

func (*Transaction) GetMulti

func (tx *Transaction) GetMulti(dst interface{}) error

func (*Transaction) Put

func (tx *Transaction) Put(src interface{}) (datastore.PendingKey, error)

func (*Transaction) PutMulti

func (tx *Transaction) PutMulti(src interface{}) ([]datastore.PendingKey, error)

func (*Transaction) Rollback

func (tx *Transaction) Rollback() error

type TransactionBatch

type TransactionBatch struct {
	// contains filtered or unexported fields
}

func (*TransactionBatch) Delete

func (b *TransactionBatch) Delete(dst interface{}) chan error

func (*TransactionBatch) Exec

func (b *TransactionBatch) Exec() error

func (*TransactionBatch) Get

func (b *TransactionBatch) Get(dst interface{}) chan error

func (*TransactionBatch) Put

func (b *TransactionBatch) Put(src interface{}) chan *datastore.TransactionPutResult