Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FilterOperatorAnd ¶
type FilterOperatorAnd struct {
// The filter interface implementation.
IQuery
// All filter conditions checked by the 'and' operator.
And []IQuery
}
Description:
The 'and' filter. Allows a combination of multiple filter conditions.
func (FilterOperatorAnd) Compile ¶
func (filter FilterOperatorAnd) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorEq ¶
type FilterOperatorEq struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value which should be matched.
Value interface{}
}
Description:
The 'equals' filter. Allows to filter documents which match a specific field value.
func (FilterOperatorEq) Compile ¶
func (filter FilterOperatorEq) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorGt ¶
type FilterOperatorGt struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value should be greater than this value.
Value interface{}
}
Description:
The 'greater than' filter. Allows to filter documents for fields with a value greater than the given value.
func (FilterOperatorGt) Compile ¶
func (filter FilterOperatorGt) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorGte ¶
type FilterOperatorGte struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value should be greater than or equal this value.
Value interface{}
}
Description:
The 'greater than equals' filter. Allows to filter documents for fields with a value which is greater than or equals the given value.
func (FilterOperatorGte) Compile ¶
func (filter FilterOperatorGte) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorLt ¶
type FilterOperatorLt struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value should be less than this value.
Value interface{}
}
Description:
The 'less than' filter. Allows to filter documents for fields with a value less than the given value.
func (FilterOperatorLt) Compile ¶
func (filter FilterOperatorLt) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorLte ¶
type FilterOperatorLte struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value should be less than or equal this value.
Value interface{}
}
Description:
The 'less than equals' filter. Allows to filter documents for fields with a value which is less than or equals the given value.
func (FilterOperatorLte) Compile ¶
func (filter FilterOperatorLte) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorNeq ¶
type FilterOperatorNeq struct {
// The filter interface implementation.
IQuery
// The document key to refer to.
Key string
// The document value which should not be matched.
Value interface{}
}
Description:
The 'not equals' filter. Allows to filter documents which do not match a specific field value.
func (FilterOperatorNeq) Compile ¶
func (filter FilterOperatorNeq) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type FilterOperatorOr ¶
type FilterOperatorOr struct {
// The filter interface implementation.
IQuery
// All filter conditions checked by the 'or' operator.
Or []IQuery
}
Description:
The 'or' filter. Allows a combination of multiple filter conditions.
func (FilterOperatorOr) Compile ¶
func (filter FilterOperatorOr) Compile() bson.M
Description:
Compiles the filter and potential sub filters into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this filter.
type IQuery ¶
type IQuery interface {
// Description:
//
// Compiles the filter into a bson document for MongoDB.
//
// Returns:
//
// The filter represented as a MongoDB bson document.
Compile() bson.M
}
Description:
The filter interface.
type Update ¶
type Update struct {
// The root query.
Root IQuery
}
Description:
Used to update documents in a store.
type UpdateOperatorSet ¶
type UpdateOperatorSet struct {
// The query interface implementation.
IQuery
// The key-value mappings to set.
Set map[string]interface{}
}
Description:
Updates a specific field by updating a specific field.
func (UpdateOperatorSet) Compile ¶
func (update UpdateOperatorSet) Compile() bson.M
Description:
Compiles the update operator and potential sub operators into a MongoDB BSON document.
Returns:
A MongoDB bson document representing this update operator.
Source Files
Click to show internal directories.
Click to hide internal directories.