Documentation
¶
Index ¶
- type Create
- type CreateBundle
- type CreateIndexSession
- type CreateOption
- type Drop
- type DropBundle
- type DropIndexSession
- type DropOption
- type IndexSessionOpt
- type List
- type ListBundle
- func (lb *ListBundle) BatchSize(i int32) *ListBundle
- func (lb *ListBundle) ConvertListOption() option.ListIndexesOptioner
- func (lb *ListBundle) MaxTime(d time.Duration) *ListBundle
- func (lb *ListBundle) String() string
- func (lb *ListBundle) Unbundle(deduplicate bool) ([]option.ListIndexesOptioner, *session.Client, error)
- type ListIndexSession
- type ListOption
- type OptBatchSize
- type OptMaxTime
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Create ¶
type Create interface {
// contains filtered or unexported methods
}
Create represents all passable params for the create() function.
type CreateBundle ¶
type CreateBundle struct {
// contains filtered or unexported fields
}
CreateBundle is a bundle of Create options
func BundleCreate ¶
func BundleCreate(opts ...Create) *CreateBundle
BundleCreate bundles Create options
func (*CreateBundle) ConvertCreateOption ¶
func (cb *CreateBundle) ConvertCreateOption() option.CreateIndexesOptioner
ConvertCreateOption implements the Create interface.
func (*CreateBundle) MaxTime ¶
func (cb *CreateBundle) MaxTime(d time.Duration) *CreateBundle
MaxTime adds an option to specify the maximum amount of time to allow the query to run.
func (*CreateBundle) String ¶
func (cb *CreateBundle) String() string
String implements the Stringer interface
func (*CreateBundle) Unbundle ¶
func (cb *CreateBundle) Unbundle(deduplicate bool) ([]option.CreateIndexesOptioner, *session.Client, error)
Unbundle unwinds and deduplicates the options used to create it and those added after creation into a single slice of options.
The deduplicate parameter is used to determine if the bundle is just flattened or if we actually deduplicate options.
type CreateIndexSession ¶
CreateIndexSession is the session for the create() function
type CreateOption ¶
type CreateOption interface {
Create
ConvertCreateOption() option.CreateIndexesOptioner
}
CreateOption represents the options for the create() function.
type Drop ¶
type Drop interface {
// contains filtered or unexported methods
}
Drop represents all passable params for the drop() function.
type DropBundle ¶
type DropBundle struct {
// contains filtered or unexported fields
}
DropBundle is a bundle of Drop options
func (*DropBundle) ConvertDropOption ¶
func (db *DropBundle) ConvertDropOption() option.DropIndexesOptioner
ConvertDropOption implements the Drop interface
func (*DropBundle) MaxTime ¶
func (db *DropBundle) MaxTime(d time.Duration) *DropBundle
MaxTime adds an option to specify the maximum amount of time to allow the query to run.
func (*DropBundle) String ¶
func (db *DropBundle) String() string
String implements the Stringer interface
func (*DropBundle) Unbundle ¶
func (db *DropBundle) Unbundle(deduplicate bool) ([]option.DropIndexesOptioner, *session.Client, error)
Unbundle unwinds and deduplicates the options used to create it and those added after creation into a single slice of options.
The deduplicate parameter is used to determine if the bundle is just flattened or if we actually deduplicate options.
type DropIndexSession ¶
DropIndexSession is the session for the drop() function
type DropOption ¶
type DropOption interface {
Drop
ConvertDropOption() option.DropIndexesOptioner
}
DropOption represents the options for the drop() function.
type IndexSessionOpt ¶
type IndexSessionOpt struct{}
IndexSessionOpt is an indexSession option.
func (IndexSessionOpt) ConvertIndexSession ¶
func (IndexSessionOpt) ConvertIndexSession() *session.Client
ConvertIndexSession implements the DropIndexSession interface.
type List ¶
type List interface {
// contains filtered or unexported methods
}
List represents all passable params for the list() function.
type ListBundle ¶
type ListBundle struct {
// contains filtered or unexported fields
}
ListBundle is a bundle of List options.
func (*ListBundle) BatchSize ¶
func (lb *ListBundle) BatchSize(i int32) *ListBundle
BatchSize adds an option to specify the number of documents to return in every batch
func (*ListBundle) ConvertListOption ¶
func (lb *ListBundle) ConvertListOption() option.ListIndexesOptioner
ConvertListOption implements the List interface.
func (*ListBundle) MaxTime ¶
func (lb *ListBundle) MaxTime(d time.Duration) *ListBundle
MaxTime adds an option to specify the maximum amount of time to allow the query to run.
func (*ListBundle) String ¶
func (lb *ListBundle) String() string
String implements the Stringer interface
func (*ListBundle) Unbundle ¶
func (lb *ListBundle) Unbundle(deduplicate bool) ([]option.ListIndexesOptioner, *session.Client, error)
Unbundle unwinds and deduplicates the options used to create it and those added after creation into a single slice of options.
The deduplicate parameter is used to determine if the bundle is just flattened or if we actually deduplicate options.
type ListIndexSession ¶
ListIndexSession is the session for the list() function
type ListOption ¶
type ListOption interface {
List
ConvertListOption() option.ListIndexesOptioner
}
ListOption represents the options for the list() function.
type OptBatchSize ¶
type OptBatchSize option.OptBatchSize
OptBatchSize specifies the number of documents to return in every batch.
func BatchSize ¶
func BatchSize(i int32) OptBatchSize
BatchSize specifes the number of documents to return in each batch. List
func (OptBatchSize) ConvertListOption ¶
func (opt OptBatchSize) ConvertListOption() option.ListIndexesOptioner
ConvertListOption implements the List interface.
type OptMaxTime ¶
type OptMaxTime option.OptMaxTime
OptMaxTime specifies the maximum amount of time to allow the query to run.
func MaxTime ¶
func MaxTime(d time.Duration) OptMaxTime
MaxTime specifies the amount of time to allow the query to run. Create, Drop, List
func (OptMaxTime) ConvertCreateOption ¶
func (opt OptMaxTime) ConvertCreateOption() option.CreateIndexesOptioner
ConvertCreateOption implements the Create interface.
func (OptMaxTime) ConvertDropOption ¶
func (opt OptMaxTime) ConvertDropOption() option.DropIndexesOptioner
ConvertDropOption implements the Drop interface.
func (OptMaxTime) ConvertListOption ¶
func (opt OptMaxTime) ConvertListOption() option.ListIndexesOptioner
ConvertListOption implements the List interface.
Source Files