message

package
v1.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 28, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	IsMaster           = "ismaster"
	BuildInfo          = "buildinfo"
	GetLastError       = "getlasterror"
	SASLStart          = "saslstart"
	SASLMechanism      = "mechanism"
	SASLContinue       = "saslcontinue"
	SASLSupportedMechs = "saslSupportedMechs"
	Hello              = "hello"
	HelloOk            = "helloOk"
)
View Source 
const (
	DefaultMaxBsonObjectSize            = 16 * 1024 * 1024
	DefaultMaxMessageSizeBytes          = 48000000
	DefaultMaxWriteBatchSize            = 100000
	DefaultLogicalSessionTimeoutMinutes = 30
	DefaultMinWireVersion               = 0
	DefaultMaxWireVersion               = 7
)
View Source 
const (
	// CurrentDate sets the value of a field to current date, either as a Date or a Timestamp.
	CurrentDate = "$currentDate"
	// Inc increments the value of the field by the specified amount.
	Inc = "$inc"
	// Min only updates the field if the specified value is less than the existing field value.
	Min = "$min"
	// Max only updates the field if the specified value is greater than the existing field value.
	Max = "$max"
	// Mul multiplies the value of the field by the specified amount.
	Mul = "$mul"
	// Rename renames a field.
	Rename = "$rename"
	// Set ets the value of a field in a document.
	Set = "$set"
	// SetOnInsert sets the value of a field if an update results in an insert of a document. Has no effect on update operations that modify existing documents.
	SetOnInsert = "$setOnInsert"
	// Unset removes the specified field from a document.
	Unset = "$unset"
)
View Source 
const (
	Delete      = "delete"
	Insert      = "insert"
	Find        = "find"
	Update      = "update"
	LsID        = "lsid"
	ID          = "id"
	Binary      = "$binary"
	Base64      = "base64"
	SubType     = "subType"
	DB          = "$db"
	Filter      = "filter"
	Documents   = "documents"
	KillCursors = "killCursors"
)
View Source 
const (
	// DefaultCompatibleVersion = "4.0.12".
	// DefaultCompatibleVersion = "3.6.4".
	DefaultCompatibleVersion = "3.4.22"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BuildConfig 

type BuildConfig interface {
	// Version should return a software version.
	Version() string
}

BuildConfig represents a limit configurations for 'buildInfo' command.

type Command 

type Command struct {
	IsAdmin  bool
	Elements []bson.Element
	// contains filtered or unexported fields
}

Command represents a query command of MongoDB database command.

func NewCommandWithDocument 

func NewCommandWithDocument(doc bson.Document) (*Command, error)

NewCommandWithDocument returns a new command instance with the specified BSON document.

func NewCommandWithMsg 

func NewCommandWithMsg(msg *protocol.Msg) (*Command, error)

NewCommandWithMsg returns a new command instance with the specified BSON document.

func NewCommandWithQuery 

func NewCommandWithQuery(q *protocol.Query) (*Command, error)

NewCommandWithQuery returns a new command instance with the specified BSON document.

func (*Command) IsAdminCommand 

func (cmd *Command) IsAdminCommand() bool

IsAdminCommand returns true when it is a admin command, otherwise false.

func (*Command) IsType 

func (cmd *Command) IsType(typeString string) bool

IsType returns true when the command has the specified element, otherwise false.

func (*Command) String 

func (cmd *Command) String() string

String returns the string description.

func (*Command) Type 

func (cmd *Command) Type() string

Type returns a string type.

type Config 

type Config interface {
	ServerConfig
	BuildConfig
}

Config represents all configurations for MongoDB.

type Query 

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

Query represents a message query.

func NewQuery 

func NewQuery() *Query

NewQuery returns a new query.

func NewQueryWithMessage 

func NewQueryWithMessage(msg *protocol.Msg) (*Query, error)

NewQueryWithMessage returns a new query with the specified OP_MSG.

func NewQueryWithQuery 

func NewQueryWithQuery(msg *protocol.Query) (*Query, error)

NewQueryWithQuery returns a new query with the specified OP_QUERY.

func (*Query) Collection 

func (q *Query) Collection() string

Collection returns the collection name.

func (*Query) Conditions 

func (q *Query) Conditions() []bson.Document

Conditions returns the search conditions.

func (*Query) Database 

func (q *Query) Database() string

Database returns the database name.

func (*Query) Documents 

func (q *Query) Documents() []bson.Document

Documents returns the query documents.

func (*Query) FullCollectionName added in v1.2.0 

func (q *Query) FullCollectionName() string

FullCollectionName returns the full collection name.

func (*Query) HasConditions added in v0.9.4 

func (q *Query) HasConditions() bool

HasConditions returns true if the query has conditions.

func (*Query) Limit 

func (q *Query) Limit() int

Limit returns the limit value.

func (*Query) Operator 

func (q *Query) Operator() string

Operator returns the operator string.

func (*Query) ParseMsg 

func (q *Query) ParseMsg(msg *protocol.Msg) error

ParseMsg parses the specified OP_MSG.

func (*Query) ParseQuery 

func (q *Query) ParseQuery(msg *protocol.Query) error

ParseQuery parses the specified OP_MSG.

func (*Query) Type 

func (q *Query) Type() string

Type returns the query type.

type Response 

type Response struct {
	*bson.Dictionary
}

Response represents response elements.

func NewBadResponse 

func NewBadResponse() *Response

NewBadResponse returns a bad status response.

func NewBuildInfoResponseWithConfig 

func NewBuildInfoResponseWithConfig(config Config) (*Response, error)

NewBuildInfoResponseWithConfig returns a response instance with the specified configuration.

func NewDefaultBuildInfoResponse 

func NewDefaultBuildInfoResponse() (*Response, error)

NewDefaultBuildInfoResponse returns a default response instance.

func NewDefaultIsMasterResponse 

func NewDefaultIsMasterResponse() (*Response, error)

NewDefaultIsMasterResponse returns a default response instance.

func NewDefaultLastErrorResponse 

func NewDefaultLastErrorResponse() (*Response, error)

NewDefaultLastErrorResponse returns a default response instance.

func NewIsMasterResponseWithConfig 

func NewIsMasterResponseWithConfig(config ServerConfig) (*Response, error)

NewIsMasterResponseWithConfig returns a response instance with the specified configuration.

func NewMessageReplyWithParameters 

func NewMessageReplyWithParameters(ok bool, n int32) *Response

NewMessageReplyWithParameters returns a message response instance.

func NewOkResponse 

func NewOkResponse() *Response

NewOkResponse returns a good status response.

func NewResponse 

func NewResponse() *Response

NewResponse returns a new response instance.

func NewResponseWithElements 

func NewResponseWithElements(elements map[string]any) (*Response, error)

NewResponseWithElements returns a new response instance.

func NewResponseWithStatus 

func NewResponseWithStatus(status bool) *Response

NewResponseWithStatus returns a simple response which has only a status element.

func (*Response) SetCursorDocuments 

func (res *Response) SetCursorDocuments(fullCollectionName string, docs []bson.Document)

SetCursorDocuments sets a resultset.

func (*Response) SetErrorStatus added in v0.9.1 

func (res *Response) SetErrorStatus(err error)

SetErrorStatus sets an int32 response result.

func (*Response) SetNumberOfAffectedDocuments 

func (res *Response) SetNumberOfAffectedDocuments(n int32)

SetNumberOfAffectedDocuments sets a number of affected documents.

func (*Response) SetNumberOfModifiedDocuments 

func (res *Response) SetNumberOfModifiedDocuments(n int32)

SetNumberOfModifiedDocuments sets a number of modified documents.

func (*Response) SetStatus 

func (res *Response) SetStatus(flag bool)

SetStatus sets an int32 response result.

func (*Response) SetVersion 

func (res *Response) SetVersion(ver string)

SetVersion sets a version string and array of the specified version string.

type ServerConfig 

type ServerConfig interface {
	// IsMaster should return true when the instance is running as master, otherwise false
	IsMaster() bool
	// MaxBsonObjectSize should return a max limitation value of BSON object size.
	MaxBsonObjectSize() int32
	// MaxMessageSizeBytes should return a max limitation value of message size.
	MaxMessageSizeBytes() int32
	// MaxWriteBatchSize should return a max limitation value of write batch size.
	MaxWriteBatchSize() int32
	// LogicalSessionTimeoutMinutes should return a settion timeout value.
	LogicalSessionTimeoutMinutes() int32
	// MinWireVersion should return a min supported version.
	MinWireVersion() int32
	// MaxWireVersion should return a max supported version.
	MaxWireVersion() int32
	// IsReadOnly should return true when the instance does not support write operations.
	IsReadOnly() bool
	// Compressions should return supported compress strings.
	Compressions() []string
}

ServerConfig represents a limit configurations for 'isMaseter' command.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.