client

Documentation

Index

• type Connect
  • func NewConnection(options ...Options) *Connect
  • func (conn *Connect) CreateDocument(collectionName string, props interface{}) error
  • func (conn *Connect) DeleteByID(collectionName string, id string) (deleteCount int64, err error)
  • func (conn *Connect) FindByID(collectionName string, ID string) (result bson.M, err error)
  • func (conn *Connect) FindOne(collectionName string, q interface{}) (result bson.M, err error)
  • func (conn *Connect) Search(collectionName string, q interface{}, skip int, limit int) (searchResults []bson.M, err error)
  • func (conn *Connect) UpdateDocByID(collection string, id string, data interface{}) (updatedDoc bson.M, err error)
• type Options
  • func WithCtx(ctx context.Context) Options
  • func WithDatabase(database string) Options
  • func WithLogLevel(level string) Options
  • func WithURL(url string) Options

Types

type Connect

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

Connect used to initialize the connection.

func NewConnection

func NewConnection(options ...Options) *Connect

NewConnection function used to initialize the connection client.

func (*Connect) CreateDocument

func (conn *Connect) CreateDocument(collectionName string, props interface{}) error

CreateDocument function was create the new document record in given collection.

func (*Connect) DeleteByID

func (conn *Connect) DeleteByID(collectionName string, id string) (deleteCount int64, err error)

DeleteByID function was delete the document record from given collection.

func (*Connect) FindByID

func (conn *Connect) FindByID(collectionName string, ID string) (result bson.M, err error)

FindByID function find the first matching document in collection based on given ID.

func (*Connect) FindOne

func (conn *Connect) FindOne(collectionName string, q interface{}) (result bson.M, err error)

FindOne function find the first matching document in collection based on given query.

func (*Connect) Search

func (conn *Connect) Search(collectionName string, q interface{}, skip int, limit int) (searchResults []bson.M, err error)

Search function search the document based on given search query.

func (*Connect) UpdateDocByID

func (conn *Connect) UpdateDocByID(collection string, id string, data interface{}) (updatedDoc bson.M, err error)

UpdateDocByID function update the document by given id

type Options

type Options func(c *Connect)

Options the self referenceing function to set the config

func WithCtx

func WithCtx(ctx context.Context) Options

WithCtx self referenceing function to set the context

func WithDatabase

func WithDatabase(database string) Options

WithDatabase self referenceing function to set the database name.

func WithLogLevel

func WithLogLevel(level string) Options

WithLogLevel self referenceing function to set the log level for the logrus.

func WithURL

func WithURL(url string) Options

WithURL self referenceing function to set the url