![Marty Schoch](/assets/img/avatar_default.png)
as we are a Go library is this the much more natural way to express such queries. support for strings is still supported through json marshal and unmarshal, as well as inside query string queries as before we use the package level QueryDateTimeParser to deterimine which date time parser to use for parsing only serializing out to json, we consult a new package variable: QueryDateTimeFormat this addresses the longstanding PR #255
152 lines
4.4 KiB
Go
152 lines
4.4 KiB
Go
// Copyright (c) 2014 Couchbase, Inc.
|
|
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
|
|
// except in compliance with the License. You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
// Unless required by applicable law or agreed to in writing, software distributed under the
|
|
// License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
|
// either express or implied. See the License for the specific language governing permissions
|
|
// and limitations under the License.
|
|
|
|
package query
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"math"
|
|
"time"
|
|
|
|
"github.com/blevesearch/bleve/analysis/datetime_parsers/datetime_optional"
|
|
"github.com/blevesearch/bleve/index"
|
|
"github.com/blevesearch/bleve/mapping"
|
|
"github.com/blevesearch/bleve/numeric_util"
|
|
"github.com/blevesearch/bleve/registry"
|
|
"github.com/blevesearch/bleve/search"
|
|
"github.com/blevesearch/bleve/search/searchers"
|
|
)
|
|
|
|
// QueryDateTimeParser controls the default query date time parser
|
|
var QueryDateTimeParser = datetime_optional.Name
|
|
|
|
// QueryDateTimeFormat controls the format when Marshaling to JSON
|
|
var QueryDateTimeFormat = time.RFC3339
|
|
|
|
var cache = registry.NewCache()
|
|
|
|
type BleveQueryTime struct {
|
|
time.Time
|
|
}
|
|
|
|
func QueryTimeFromString(t string) (time.Time, error) {
|
|
dateTimeParser, err := cache.DateTimeParserNamed(QueryDateTimeParser)
|
|
if err != nil {
|
|
return time.Time{}, err
|
|
}
|
|
rv, err := dateTimeParser.ParseDateTime(t)
|
|
if err != nil {
|
|
return time.Time{}, err
|
|
}
|
|
return rv, nil
|
|
}
|
|
|
|
func (t *BleveQueryTime) MarshalJSON() ([]byte, error) {
|
|
tt := time.Time(t.Time)
|
|
return []byte(tt.Format(QueryDateTimeFormat)), nil
|
|
}
|
|
|
|
func (t *BleveQueryTime) UnmarshalJSON(data []byte) error {
|
|
var timeString string
|
|
err := json.Unmarshal(data, &timeString)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
dateTimeParser, err := cache.DateTimeParserNamed(QueryDateTimeParser)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
t.Time, err = dateTimeParser.ParseDateTime(timeString)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type DateRangeQuery struct {
|
|
Start BleveQueryTime `json:"start,omitempty"`
|
|
End BleveQueryTime `json:"end,omitempty"`
|
|
InclusiveStart *bool `json:"inclusive_start,omitempty"`
|
|
InclusiveEnd *bool `json:"inclusive_end,omitempty"`
|
|
Field string `json:"field,omitempty"`
|
|
Boost *Boost `json:"boost,omitempty"`
|
|
}
|
|
|
|
// NewDateRangeQuery creates a new Query for ranges
|
|
// of date values.
|
|
// Date strings are parsed using the DateTimeParser configured in the
|
|
// top-level config.QueryDateTimeParser
|
|
// Either, but not both endpoints can be nil.
|
|
func NewDateRangeQuery(start, end time.Time) *DateRangeQuery {
|
|
return NewDateRangeInclusiveQuery(start, end, nil, nil)
|
|
}
|
|
|
|
// NewDateRangeInclusiveQuery creates a new Query for ranges
|
|
// of date values.
|
|
// Date strings are parsed using the DateTimeParser configured in the
|
|
// top-level config.QueryDateTimeParser
|
|
// Either, but not both endpoints can be nil.
|
|
// startInclusive and endInclusive control inclusion of the endpoints.
|
|
func NewDateRangeInclusiveQuery(start, end time.Time, startInclusive, endInclusive *bool) *DateRangeQuery {
|
|
return &DateRangeQuery{
|
|
Start: BleveQueryTime{start},
|
|
End: BleveQueryTime{end},
|
|
InclusiveStart: startInclusive,
|
|
InclusiveEnd: endInclusive,
|
|
}
|
|
}
|
|
|
|
func (q *DateRangeQuery) SetBoost(b float64) {
|
|
boost := Boost(b)
|
|
q.Boost = &boost
|
|
}
|
|
|
|
func (q *DateRangeQuery) SetField(f string) {
|
|
q.Field = f
|
|
}
|
|
|
|
func (q *DateRangeQuery) Searcher(i index.IndexReader, m mapping.IndexMapping, explain bool) (search.Searcher, error) {
|
|
min, max, err := q.parseEndpoints()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
field := q.Field
|
|
if q.Field == "" {
|
|
field = m.DefaultSearchField()
|
|
}
|
|
|
|
return searchers.NewNumericRangeSearcher(i, min, max, q.InclusiveStart, q.InclusiveEnd, field, q.Boost.Value(), explain)
|
|
}
|
|
|
|
func (q *DateRangeQuery) parseEndpoints() (*float64, *float64, error) {
|
|
min := math.Inf(-1)
|
|
max := math.Inf(1)
|
|
if !q.Start.IsZero() {
|
|
min = numeric_util.Int64ToFloat64(q.Start.UnixNano())
|
|
}
|
|
if !q.End.IsZero() {
|
|
max = numeric_util.Int64ToFloat64(q.End.UnixNano())
|
|
}
|
|
|
|
return &min, &max, nil
|
|
}
|
|
|
|
func (q *DateRangeQuery) Validate() error {
|
|
if q.Start.IsZero() && q.End.IsZero() {
|
|
return fmt.Errorf("must specify start or end")
|
|
}
|
|
_, _, err := q.parseEndpoints()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|