Documentation
¶
Overview ¶
Params will extract query parameters from the query string of a request into a RequestParams object. RequestParams satisfies the cfmgo.Params interface used by the cfmgo.Collection.Find() method.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type RequestParams ¶
type RequestParams struct {
//RawQuery contains the raw query string Values object
RawQuery url.Values `json:"raw_query"`
//Q (selector) holds the query parameters specified in the request.
//Defaults to bson.M{}.
Q bson.M `json:"selector"`
//S (scope) specifies the fields to be included in the result set.
//Defaults to bson.M{}. A nil scope will return the entire dataset.
S bson.M `json:"scope"`
//L (limit) specifies the maximum number of records to be retrieved
//for a given request. Limit defaults to 10.
L int `json:"limit"`
//F (offset) specifies the number of records to skip in the result set.
//This is useful for paging through large result sets.
//F defaults to 0.
F int `json:"offset"`
}
RequestParams holds state parsed from a given HTTP request. It provides methods that yield components of a MongoDB query and satisfy the cfmgo.Params interface:
func Extract ¶
func Extract(query url.Values) (p *RequestParams)
Extract initializes the RequestParams object. It will interrogate the `url.Values` object of an HTTP request and scan for the following:
scope
Scope is used to build a properly formatted bson.M object off of a provided set of comma-delimited fields to be used as the Select() argument in a MongoDB query. If not provided, an empty bson.M object will be provided which results in all fields being returned in the result set.
limit
The limit value is converted to an integer; if not provided, it will default to 10.
offset
The offset value is converted to an integer; if not provided, it will default to 0.
All other parameters are assumed to represent the selector and will be converted into a bson.M object. if not provided, an empty bson.M object will be provided which results in all records being returned in the result set.
func (*RequestParams) Limit ¶
func (p *RequestParams) Limit() int
Limit returns an integer value indicating the number of records to return return in a result set.
func (*RequestParams) Offset ¶
func (p *RequestParams) Offset() int
Offset returns an integer value indicating the number of records to skip when returning a result set.
func (*RequestParams) Scope ¶
func (p *RequestParams) Scope() bson.M
Scope returns a mongodb bson.M object containing the set of fields to be returned from mongodb. Empty scope objects will return all fields from the database.
func (*RequestParams) Selector ¶
func (p *RequestParams) Selector() bson.M
Selector returns a mongodb bson.M object containing the query parameters supplied in the HTTP request and is used to filter the records returned by a query.
Source Files