deleteopt

Documentation

Index

• type Delete
• type DeleteBundle
  • func BundleDelete(opts ...Delete) *DeleteBundle
  • func (db *DeleteBundle) Collation(c *mongoopt.Collation) *DeleteBundle
  • func (db *DeleteBundle) ConvertDeleteOption() option.DeleteOptioner
  • func (db *DeleteBundle) String() string
  • func (db *DeleteBundle) Unbundle(deduplicate bool) ([]option.DeleteOptioner, *session.Client, error)
• type DeleteOption
• type DeleteSession
• type DeleteSessionOpt
  • func (DeleteSessionOpt) ConvertDeleteSession() *session.Client
• type OptCollation
  • func Collation(c *mongoopt.Collation) OptCollation
  • func (opt OptCollation) ConvertDeleteOption() option.DeleteOptioner

Types

type Delete

type Delete interface {
	// contains filtered or unexported methods
}

Delete represents all passable params for the delete() function.

type DeleteBundle

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

DeleteBundle is a bundle of Delete options

func BundleDelete

func BundleDelete(opts ...Delete) *DeleteBundle

BundleDelete bundles Delete options.

func (*DeleteBundle) Collation

func (db *DeleteBundle) Collation(c *mongoopt.Collation) *DeleteBundle

Collation adds an option to specify a collation.

func (*DeleteBundle) ConvertDeleteOption

func (db *DeleteBundle) ConvertDeleteOption() option.DeleteOptioner

ConvertDeleteOption implements the Delete interface.

func (*DeleteBundle) String

func (db *DeleteBundle) String() string

String implements the Stringer interface

func (*DeleteBundle) Unbundle

func (db *DeleteBundle) Unbundle(deduplicate bool) ([]option.DeleteOptioner, *session.Client, error)

Unbundle transforms a bundle into a slice of options, optionally deduplicating

type DeleteOption

type DeleteOption interface {
	Delete
	ConvertDeleteOption() option.DeleteOptioner
}

DeleteOption represents the options for the delete() function.

type DeleteSession

type DeleteSession interface {
	Delete
	ConvertDeleteSession() *session.Client
}

DeleteSession is the session for the delete() function

type DeleteSessionOpt

type DeleteSessionOpt struct{}

DeleteSessionOpt is an delete session option.

func (DeleteSessionOpt) ConvertDeleteSession

func (DeleteSessionOpt) ConvertDeleteSession() *session.Client

ConvertDeleteSession implements the DeleteSession interface.

type OptCollation

type OptCollation option.OptCollation

OptCollation specifies a collation.

func Collation

func Collation(c *mongoopt.Collation) OptCollation

Collation specifies a collation.

func (OptCollation) ConvertDeleteOption

func (opt OptCollation) ConvertDeleteOption() option.DeleteOptioner

ConvertDeleteOption implements the Delete interface.