document

May 15, 2025

Changes in this version

type GeoShapeField

+ func NewGeoShapeFieldFromShapeWithIndexingOptions(name string, arrayPositions []uint64, geoShape *geojson.GeoShape, ...) *GeoShapeField

+ func NewGeometryCollectionFieldFromShapesWithIndexingOptions(name string, arrayPositions []uint64, geoShapes []*geojson.GeoShape, ...) *GeoShapeField

Apr 2, 2025

Changes in this version

+ const DefaultSynonymIndexingOptions

type Document

+ func NewSynonymDocument(id string) *Document

+ func (d *Document) Indexed() bool

+ func (d *Document) SetIndexed()

+ func (d *Document) VisitSynonymFields(visitor index.SynonymFieldVisitor)

type GeoShapeField

+ func (n *GeoShapeField) EncodedShape() []byte

+ type SynonymField struct

+ func NewSynonymField(name string, analyzer analysis.Analyzer, input []string, synonyms []string) *SynonymField

+ func (s *SynonymField) Analyze()

+ func (s *SynonymField) AnalyzedLength() int

+ func (s *SynonymField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (s *SynonymField) ArrayPositions() []uint64

+ func (s *SynonymField) EncodedFieldType() byte

+ func (s *SynonymField) IterateSynonyms(visitor func(term string, synonyms []string))

+ func (s *SynonymField) Name() string

+ func (s *SynonymField) NumPlainTextBytes() uint64

+ func (s *SynonymField) Options() index.FieldIndexingOptions

+ func (s *SynonymField) Size() int

+ func (s *SynonymField) Value() []byte

Dec 17, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Nov 13, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jul 26, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 13, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Mar 20, 2024 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Sep 13, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jul 12, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

May 4, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Mar 17, 2023 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Dec 15, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

type Document

+ StoredFieldsSize uint64

+ func (d *Document) StoredFieldsBytes() uint64

Oct 20, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Aug 18, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

type GeoShapeField

+ func NewGeoShapeFieldFromBytes(name string, arrayPositions []uint64, value []byte) *GeoShapeField

+ func (n *GeoShapeField) GeoShape() (index.GeoJSON, error)

Jun 16, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ const DefaultGeoShapeIndexingOptions

type GeoPointField

+ func (n *GeoPointField) SetSpatialAnalyzerPlugin(plugin index.SpatialAnalyzerPlugin)

+ type GeoShapeField struct

+ func NewGeoCircleFieldWithIndexingOptions(name string, arrayPositions []uint64, centerPoint []float64, radius float64, ...) *GeoShapeField

+ func NewGeoShapeField(name string, arrayPositions []uint64, coordinates [][][][]float64, typ string) *GeoShapeField

+ func NewGeoShapeFieldWithIndexingOptions(name string, arrayPositions []uint64, coordinates [][][][]float64, typ string, ...) *GeoShapeField

+ func NewGeometryCollectionFieldWithIndexingOptions(name string, arrayPositions []uint64, coordinates [][][][][]float64, ...) *GeoShapeField

+ func (n *GeoShapeField) Analyze()

+ func (n *GeoShapeField) AnalyzedLength() int

+ func (n *GeoShapeField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (n *GeoShapeField) ArrayPositions() []uint64

+ func (n *GeoShapeField) EncodedFieldType() byte

+ func (n *GeoShapeField) GoString() string

+ func (n *GeoShapeField) Name() string

+ func (n *GeoShapeField) NumPlainTextBytes() uint64

+ func (n *GeoShapeField) Options() index.FieldIndexingOptions

+ func (n *GeoShapeField) Size() int

+ func (n *GeoShapeField) Value() []byte

Mar 22, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 24, 2022 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Dec 16, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ const DefaultIPIndexingOptions

+ type IPField struct

+ func NewIPField(name string, arrayPositions []uint64, v net.IP) *IPField

+ func NewIPFieldFromBytes(name string, arrayPositions []uint64, value []byte) *IPField

+ func NewIPFieldWithIndexingOptions(name string, arrayPositions []uint64, b net.IP, ...) *IPField

+ func (b *IPField) Analyze()

+ func (b *IPField) ArrayPositions() []uint64

+ func (b *IPField) GoString() string

+ func (b *IPField) IP() (net.IP, error)

+ func (b *IPField) Name() string

+ func (b *IPField) NumPlainTextBytes() uint64

+ func (b *IPField) Options() index.FieldIndexingOptions

+ func (b *IPField) Size() int

+ func (b *IPField) Value() []byte

+ func (n *IPField) AnalyzedLength() int

+ func (n *IPField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (n *IPField) EncodedFieldType() byte

Oct 28, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Oct 4, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Sep 17, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Sep 8, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Aug 9, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jul 28, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 11, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 6, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jun 6, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 18, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Feb 12, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jan 14, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Jan 12, 2021 GO-2022-0470

  GO-2022-0470: No access control in github.com/blevesearch/bleve and bleve/v2

Changes in this version

+ const DefaultBooleanIndexingOptions

+ const DefaultCompositeIndexingOptions

+ const DefaultDateTimeIndexingOptions

+ const DefaultDateTimePrecisionStep

+ const DefaultNumericIndexingOptions

+ const DefaultPrecisionStep

+ const DefaultTextIndexingOptions

+ var GeoPrecisionStep uint = 9

+ var MaxTimeRepresentable = time.Unix(0, math.MaxInt64)

+ var MinTimeRepresentable = time.Unix(0, math.MinInt64)

+ type BooleanField struct

+ func NewBooleanField(name string, arrayPositions []uint64, b bool) *BooleanField

+ func NewBooleanFieldFromBytes(name string, arrayPositions []uint64, value []byte) *BooleanField

+ func NewBooleanFieldWithIndexingOptions(name string, arrayPositions []uint64, b bool, ...) *BooleanField

+ func (b *BooleanField) Analyze()

+ func (b *BooleanField) AnalyzedLength() int

+ func (b *BooleanField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (b *BooleanField) ArrayPositions() []uint64

+ func (b *BooleanField) Boolean() (bool, error)

+ func (b *BooleanField) EncodedFieldType() byte

+ func (b *BooleanField) GoString() string

+ func (b *BooleanField) Name() string

+ func (b *BooleanField) NumPlainTextBytes() uint64

+ func (b *BooleanField) Options() index.FieldIndexingOptions

+ func (b *BooleanField) Size() int

+ func (b *BooleanField) Value() []byte

+ type CompositeField struct

+ func NewCompositeField(name string, defaultInclude bool, include []string, exclude []string) *CompositeField

+ func NewCompositeFieldWithIndexingOptions(name string, defaultInclude bool, include []string, exclude []string, ...) *CompositeField

+ func (c *CompositeField) Analyze()

+ func (c *CompositeField) AnalyzedLength() int

+ func (c *CompositeField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (c *CompositeField) ArrayPositions() []uint64

+ func (c *CompositeField) Compose(field string, length int, freq index.TokenFrequencies)

+ func (c *CompositeField) EncodedFieldType() byte

+ func (c *CompositeField) Name() string

+ func (c *CompositeField) NumPlainTextBytes() uint64

+ func (c *CompositeField) Options() index.FieldIndexingOptions

+ func (c *CompositeField) Size() int

+ func (c *CompositeField) Value() []byte

+ type DateTimeField struct

+ func NewDateTimeField(name string, arrayPositions []uint64, dt time.Time) (*DateTimeField, error)

+ func NewDateTimeFieldFromBytes(name string, arrayPositions []uint64, value []byte) *DateTimeField

+ func NewDateTimeFieldWithIndexingOptions(name string, arrayPositions []uint64, dt time.Time, ...) (*DateTimeField, error)

+ func (n *DateTimeField) Analyze()

+ func (n *DateTimeField) AnalyzedLength() int

+ func (n *DateTimeField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (n *DateTimeField) ArrayPositions() []uint64

+ func (n *DateTimeField) DateTime() (time.Time, error)

+ func (n *DateTimeField) EncodedFieldType() byte

+ func (n *DateTimeField) GoString() string

+ func (n *DateTimeField) Name() string

+ func (n *DateTimeField) NumPlainTextBytes() uint64

+ func (n *DateTimeField) Options() index.FieldIndexingOptions

+ func (n *DateTimeField) Size() int

+ func (n *DateTimeField) Value() []byte

+ type Document struct

+ CompositeFields []*CompositeField

+ Fields []Field

+ func NewDocument(id string) *Document

+ func (d *Document) AddField(f Field) *Document

+ func (d *Document) AddIDField()

+ func (d *Document) GoString() string

+ func (d *Document) HasComposite() bool

+ func (d *Document) ID() string

+ func (d *Document) NumPlainTextBytes() uint64

+ func (d *Document) SetID(id string)

+ func (d *Document) Size() int

+ func (d *Document) VisitComposite(visitor index.CompositeFieldVisitor)

+ func (d *Document) VisitFields(visitor index.FieldVisitor)

+ type Field interface

+ Analyze func()

+ AnalyzedLength func() int

+ AnalyzedTokenFrequencies func() index.TokenFrequencies

+ ArrayPositions func() []uint64

+ EncodedFieldType func() byte

+ Name func() string

+ NumPlainTextBytes func() uint64

+ Options func() index.FieldIndexingOptions

+ Size func() int

+ Value func() []byte

+ type GeoPointField struct

+ func NewGeoPointField(name string, arrayPositions []uint64, lon, lat float64) *GeoPointField

+ func NewGeoPointFieldFromBytes(name string, arrayPositions []uint64, value []byte) *GeoPointField

+ func NewGeoPointFieldWithIndexingOptions(name string, arrayPositions []uint64, lon, lat float64, ...) *GeoPointField

+ func (n *GeoPointField) Analyze()

+ func (n *GeoPointField) AnalyzedLength() int

+ func (n *GeoPointField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (n *GeoPointField) ArrayPositions() []uint64

+ func (n *GeoPointField) EncodedFieldType() byte

+ func (n *GeoPointField) GoString() string

+ func (n *GeoPointField) Lat() (float64, error)

+ func (n *GeoPointField) Lon() (float64, error)

+ func (n *GeoPointField) Name() string

+ func (n *GeoPointField) NumPlainTextBytes() uint64

+ func (n *GeoPointField) Options() index.FieldIndexingOptions

+ func (n *GeoPointField) Size() int

+ func (n *GeoPointField) Value() []byte

+ type NumericField struct

+ func NewNumericField(name string, arrayPositions []uint64, number float64) *NumericField

+ func NewNumericFieldFromBytes(name string, arrayPositions []uint64, value []byte) *NumericField

+ func NewNumericFieldWithIndexingOptions(name string, arrayPositions []uint64, number float64, ...) *NumericField

+ func (n *NumericField) Analyze()

+ func (n *NumericField) AnalyzedLength() int

+ func (n *NumericField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (n *NumericField) ArrayPositions() []uint64

+ func (n *NumericField) EncodedFieldType() byte

+ func (n *NumericField) GoString() string

+ func (n *NumericField) Name() string

+ func (n *NumericField) NumPlainTextBytes() uint64

+ func (n *NumericField) Number() (float64, error)

+ func (n *NumericField) Options() index.FieldIndexingOptions

+ func (n *NumericField) Size() int

+ func (n *NumericField) Value() []byte

+ type TextField struct

+ func NewTextField(name string, arrayPositions []uint64, value []byte) *TextField

+ func NewTextFieldCustom(name string, arrayPositions []uint64, value []byte, ...) *TextField

+ func NewTextFieldWithAnalyzer(name string, arrayPositions []uint64, value []byte, ...) *TextField

+ func NewTextFieldWithIndexingOptions(name string, arrayPositions []uint64, value []byte, ...) *TextField

+ func (t *TextField) Analyze()

+ func (t *TextField) AnalyzedLength() int

+ func (t *TextField) AnalyzedTokenFrequencies() index.TokenFrequencies

+ func (t *TextField) Analyzer() *analysis.Analyzer

+ func (t *TextField) ArrayPositions() []uint64

+ func (t *TextField) EncodedFieldType() byte

+ func (t *TextField) GoString() string

+ func (t *TextField) Name() string

+ func (t *TextField) NumPlainTextBytes() uint64

+ func (t *TextField) Options() index.FieldIndexingOptions

+ func (t *TextField) Size() int

+ func (t *TextField) Text() string

+ func (t *TextField) Value() []byte