route/vendor/github.com/asdine/storm/options.go

98 lines
2.1 KiB
Go
Raw Normal View History

2017-04-28 23:28:25 +00:00
package storm
import (
"os"
"github.com/asdine/storm/codec"
"github.com/asdine/storm/index"
2018-01-03 19:29:07 +00:00
"github.com/coreos/bbolt"
2017-04-28 23:28:25 +00:00
)
// BoltOptions used to pass options to BoltDB.
2018-01-03 19:29:07 +00:00
func BoltOptions(mode os.FileMode, options *bolt.Options) func(*Options) error {
return func(opts *Options) error {
opts.boltMode = mode
opts.boltOptions = options
2017-04-28 23:28:25 +00:00
return nil
}
}
// Codec used to set a custom encoder and decoder. The default is JSON.
2018-01-03 19:29:07 +00:00
func Codec(c codec.MarshalUnmarshaler) func(*Options) error {
return func(opts *Options) error {
opts.codec = c
2017-04-28 23:28:25 +00:00
return nil
}
}
// Batch enables the use of batch instead of update for read-write transactions.
2018-01-03 19:29:07 +00:00
func Batch() func(*Options) error {
return func(opts *Options) error {
opts.batchMode = true
2017-04-28 23:28:25 +00:00
return nil
}
}
// Root used to set the root bucket. See also the From method.
2018-01-03 19:29:07 +00:00
func Root(root ...string) func(*Options) error {
return func(opts *Options) error {
opts.rootBucket = root
2017-04-28 23:28:25 +00:00
return nil
}
}
2018-01-03 19:29:07 +00:00
// UseDB allows Storm to use an existing open Bolt.DB.
2017-04-28 23:28:25 +00:00
// Warning: storm.DB.Close() will close the bolt.DB instance.
2018-01-03 19:29:07 +00:00
func UseDB(b *bolt.DB) func(*Options) error {
return func(opts *Options) error {
opts.path = b.Path()
opts.bolt = b
2017-04-28 23:28:25 +00:00
return nil
}
}
// Limit sets the maximum number of records to return
func Limit(limit int) func(*index.Options) {
return func(opts *index.Options) {
opts.Limit = limit
}
}
// Skip sets the number of records to skip
func Skip(offset int) func(*index.Options) {
return func(opts *index.Options) {
opts.Skip = offset
}
}
// Reverse will return the results in descending order
func Reverse() func(*index.Options) {
return func(opts *index.Options) {
opts.Reverse = true
}
}
2018-01-03 19:29:07 +00:00
// Options are used to customize the way Storm opens a database.
type Options struct {
// Handles encoding and decoding of objects
codec codec.MarshalUnmarshaler
// Bolt file mode
boltMode os.FileMode
// Bolt options
boltOptions *bolt.Options
// Enable batch mode for read-write transaction, instead of update mode
batchMode bool
// The root bucket name
rootBucket []string
// Path of the database file
path string
// Bolt is still easily accessible
bolt *bolt.DB
}