search

Documentation

Index

• Constants
• func UpgradeRegexpArgFromQuery(arg chat1.SearchRegexpArg, username string) chat1.SearchRegexpArg
• type Indexer
  • func NewIndexer(g *globals.Context) *Indexer
  • func (idx *Indexer) Add(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID, ...) (err error)
  • func (idx *Indexer) GetConvIndex(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID) (*chat1.ConversationIndex, error)
  • func (idx *Indexer) IndexInbox(ctx context.Context, uid gregor1.UID) (res map[string]chat1.ProfileSearchConvStats, err error)
  • func (idx *Indexer) Remove(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID, ...) (err error)
  • func (idx *Indexer) Search(ctx context.Context, uid gregor1.UID, query string, opts chat1.SearchOpts, ...) (res *chat1.ChatSearchInboxResults, err error)
  • func (idx *Indexer) SelectiveSync(ctx context.Context, uid gregor1.UID, forceReindex bool)
  • func (idx *Indexer) SetConsumeCh(ch chan chat1.ConversationID)
  • func (idx *Indexer) SetMaxBoostConvs(x int)
  • func (idx *Indexer) SetMaxBoostMsgs(x int)
  • func (idx *Indexer) SetMaxSyncConvs(x int)
  • func (idx *Indexer) SetPageSize(pageSize int)
  • func (idx *Indexer) SetReindexCh(ch chan chat1.ConversationID)
  • func (idx *Indexer) Start(ctx context.Context, uid gregor1.UID)
  • func (idx *Indexer) Stop(ctx context.Context) chan struct{}
• type RegexpSearcher
  • func NewRegexpSearcher(g *globals.Context) *RegexpSearcher
  • func (s *RegexpSearcher) Search(ctx context.Context, uid gregor1.UID, convID chat1.ConversationID, ...) (hits []chat1.ChatSearchHit, err error)
  • func (s *RegexpSearcher) SetPageSize(pageSize int)

Constants

const IndexVersion = 3

Bumped whenever there are tokenization or structural changes to building the index

const MaxAllowedSearchHits = 10000

const MaxAllowedSearchMessages = 100000

Only used by RegexpSearcher

const MaxContext = 15

Paging context around a search hit

Functions

func UpgradeRegexpArgFromQuery

func UpgradeRegexpArgFromQuery(arg chat1.SearchRegexpArg, username string) chat1.SearchRegexpArg

Types

type Indexer

type Indexer struct {
	globals.Contextified
	utils.DebugLabeler
	sync.Mutex
	// contains filtered or unexported fields
}

func NewIndexer

func NewIndexer(g *globals.Context) *Indexer

func (*Indexer) Add

func (idx *Indexer) Add(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID,
	msgs []chat1.MessageUnboxed) (err error)

func (*Indexer) GetConvIndex

func (idx *Indexer) GetConvIndex(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID) (*chat1.ConversationIndex, error)

func (*Indexer) IndexInbox

func (idx *Indexer) IndexInbox(ctx context.Context, uid gregor1.UID) (res map[string]chat1.ProfileSearchConvStats, err error)

IndexInbox is only exposed in devel for debugging/profiling the indexing process.

func (*Indexer) Remove

func (idx *Indexer) Remove(ctx context.Context, convID chat1.ConversationID, uid gregor1.UID,
	msgs []chat1.MessageUnboxed) (err error)

func (*Indexer) Search

func (idx *Indexer) Search(ctx context.Context, uid gregor1.UID, query string, opts chat1.SearchOpts,
	hitUICh chan chat1.ChatSearchInboxHit, indexUICh chan chat1.ChatSearchIndexStatus) (res *chat1.ChatSearchInboxResults, err error)

Search tokenizes the given query and finds the intersection of all matches for each token, returning matches.

func (*Indexer) SelectiveSync

func (idx *Indexer) SelectiveSync(ctx context.Context, uid gregor1.UID, forceReindex bool)

SelectiveSync queues up a small number of jobs on the background loader periodically so our index can cover all conversations. The number of jobs varies between desktop and mobile so mobile can be more conservative.

func (*Indexer) SetConsumeCh

func (idx *Indexer) SetConsumeCh(ch chan chat1.ConversationID)

func (*Indexer) SetMaxBoostConvs

func (idx *Indexer) SetMaxBoostConvs(x int)

func (*Indexer) SetMaxBoostMsgs

func (idx *Indexer) SetMaxBoostMsgs(x int)

func (*Indexer) SetMaxSyncConvs

func (idx *Indexer) SetMaxSyncConvs(x int)

func (*Indexer) SetPageSize

func (idx *Indexer) SetPageSize(pageSize int)

func (*Indexer) SetReindexCh

func (idx *Indexer) SetReindexCh(ch chan chat1.ConversationID)

func (*Indexer) Start

func (idx *Indexer) Start(ctx context.Context, uid gregor1.UID)

func (*Indexer) Stop

func (idx *Indexer) Stop(ctx context.Context) chan struct{}

type RegexpSearcher

type RegexpSearcher struct {
	globals.Contextified
	utils.DebugLabeler
	// contains filtered or unexported fields
}

func NewRegexpSearcher

func NewRegexpSearcher(g *globals.Context) *RegexpSearcher

func (*RegexpSearcher) Search

func (s *RegexpSearcher) Search(ctx context.Context, uid gregor1.UID, convID chat1.ConversationID,
	queryRe *regexp.Regexp, uiCh chan chat1.ChatSearchHit, opts chat1.SearchOpts) (hits []chat1.ChatSearchHit, err error)

func (*RegexpSearcher) SetPageSize

func (s *RegexpSearcher) SetPageSize(pageSize int)