Search engine hook base class for Postgres. More...

Inheritance diagram for SearchPostgres:

Collaboration diagram for SearchPostgres:

[legend]

Public Member Functions
	update ( $pageid, $title, $text)
	Create or update the search index record for the given page. More...

	updateTitle ( $id, $title)
	Update a search index record's title only. More...

Public Member Functions inherited from SearchDatabase
	__construct (ILoadBalancer $lb)

	doSearchText ( $term)

	doSearchTitle ( $term)

Public Member Functions inherited from SearchEngine
	augmentSearchResults (ISearchResultSet $resultSet)
	Augment search results with extra data. More...

	completionSearch ( $search)
	Perform a completion search. More...

	completionSearchWithVariants ( $search)
	Perform a completion search with variants. More...

	defaultPrefixSearch ( $search)
	Simple prefix search for subpages. More...

	delete ( $id, $title)
	Delete an indexed page Title should be pre-processed. More...

	extractTitles (SearchSuggestionSet $completionResults)
	Extract titles from completion results. More...

	getFeatureData ( $feature)
	Way to retrieve custom data set by setFeatureData or by the engine itself. More...

	getNearMatcher (Config $config)
	Get service class to finding near matches. More...

	getProfiles ( $profileType, User $user=null)
	Get a list of supported profiles. More...

	getSearchIndexFields ()
	Get fields for search index. More...

	getSort ()
	Get the sort direction of the search results. More...

	getTextFromContent (Title $t, Content $c=null)
	Get the raw text for updating the index from a content object Nicer search backends could possibly do something cooler than just returning raw text. More...

	getValidSorts ()
	Get the valid sort directions. More...

	legalSearchChars ( $type=self::CHARS_ALL)
	Get chars legal for search. More...

	makeSearchFieldMapping ( $name, $type)
	Create a search field definition. More...

	normalizeText ( $string)
	When overridden in derived class, performs database-specific conversions on text to be used for searching or updating search index. More...

	replacePrefixes ( $query)
	Parse some common prefixes: all (search everything) or namespace names and set the list of namespaces of this class accordingly. More...

	searchArchiveTitle ( $term)
	Perform a title search in the article archive. More...

	searchText ( $term)
	Perform a full text search query and return a result set. More...

	searchTitle ( $term)
	Perform a title-only search query and return a result set. More...

	setFeatureData ( $feature, $data)
	Way to pass custom data for engines. More...

	setLimitOffset ( $limit, $offset=0)
	Set the maximum number of results to return and how many to skip before returning the first. More...

	setNamespaces ( $namespaces)
	Set which namespaces the search should include. More...

	setShowSuggestion ( $showSuggestion)
	Set whether the searcher should try to build a suggestion. More...

	setSort ( $sort)
	Set the sort direction of the search results. More...

	supports ( $feature)

	textAlreadyUpdatedForIndex ()
	If an implementation of SearchEngine handles all of its own text processing in getTextFromContent() and doesn't require SearchUpdate::updateText()'s rather silly handling, it should return true here instead. More...

Protected Member Functions
	doSearchTextInDB ( $term)
	Perform a full text search query and return a result set. More...

	doSearchTitleInDB ( $term)
	Perform a full text search query via tsearch2 and return a result set. More...

Protected Member Functions inherited from SearchDatabase
	extractNamespacePrefix ( $term)
	Extract the optional namespace prefix and set self::namespaces accordingly and return the query string. More...

	filter ( $text)
	Return a 'cleaned up' search string. More...

Protected Member Functions inherited from SearchEngine
	completionSearchBackend ( $search)
	Perform a completion search. More...

	completionSearchBackendOverfetch ( $search)
	Perform an overfetch of completion search results. More...

	doSearchArchiveTitle ( $term)
	Perform a title search in the article archive. More...

	normalizeNamespaces ( $search)
	Makes search simple string if it was namespaced. More...

	processCompletionResults ( $search, SearchSuggestionSet $suggestions)
	Process completion search results. More...

	simplePrefixSearch ( $search)
	Call out to simple search backend. More...

Private Member Functions
	parseQuery ( $term)
	Transform the user's search string into a better form for tsearch2 Returns an SQL fragment consisting of quoted text to search for. More...

	searchQuery ( $term, $fulltext, $colname)
	Construct the full SQL query to do the search. More...

Additional Inherited Members
Static Public Member Functions inherited from SearchEngine
static	parseNamespacePrefixes ( $query, $withAllKeyword=true, $withPrefixSearchExtractNamespaceHook=false)
	Parse some common prefixes: all (search everything) or namespace names. More...

static	userHighlightPrefs ()
	Find snippet highlight settings for all users. More...

Public Attributes inherited from SearchEngine
int[] null	$namespaces = [ NS_MAIN ]

string	$prefix = ''

const	CHARS_ALL = 1
	Integer flag for legalSearchChars: includes all chars allowed in a search query. More...

const	CHARS_NO_SYNTAX = 2
	Integer flag for legalSearchChars: includes all chars allowed in a search term. More...

const	COMPLETION_PROFILE_TYPE = 'completionSearchProfile'
	Profile type for completionSearch. More...

const	DEFAULT_SORT = 'relevance'

const	FT_QUERY_INDEP_PROFILE_TYPE = 'fulltextQueryIndepProfile'
	Profile type for query independent ranking features. More...

Static Protected Member Functions inherited from SearchEngine
static	defaultNearMatcher ()
	Get near matcher for default SearchEngine. More...

Protected Attributes inherited from SearchDatabase
IDatabase	$db
	(backwards compatibility) More...

ILoadBalancer	$lb

string[]	$searchTerms = []
	search terms More...

Protected Attributes inherited from SearchEngine
array	$features = []
	Feature values. More...

int	$limit = 10

int	$offset = 0

string[]	$searchTerms = []

bool	$showSuggestion = true

Detailed Description

Search engine hook base class for Postgres.

Definition at line 33 of file SearchPostgres.php.

Member Function Documentation

◆ doSearchTextInDB()

SearchPostgres::doSearchTextInDB ( $term )

protected

Perform a full text search query and return a result set.

Parameters

string $term Raw search term

Returns: SqlSearchResultSet|null

Reimplemented from SearchDatabase.

Definition at line 51 of file SearchPostgres.php.

References $dbr, DB_REPLICA, and searchQuery().

◆ doSearchTitleInDB()

SearchPostgres::doSearchTitleInDB ( $term )

protected

Perform a full text search query via tsearch2 and return a result set.

Currently searches a page's current title (page.page_title) and latest revision article text (pagecontent.old_text)

Parameters

string $term Raw search term

Returns: SqlSearchResultSet

Reimplemented from SearchDatabase.

Definition at line 42 of file SearchPostgres.php.

References $dbr, DB_REPLICA, and searchQuery().

◆ parseQuery()

SearchPostgres::parseQuery ( $term )

private

Transform the user's search string into a better form for tsearch2 Returns an SQL fragment consisting of quoted text to search for.

Parameters

string $term

Returns: string

Definition at line 68 of file SearchPostgres.php.

References $dbr, DB_REPLICA, and wfDebug().

Referenced by searchQuery().

◆ searchQuery()

SearchPostgres::searchQuery	(	$term,
		$fulltext,
		$colname
	)

private

Construct the full SQL query to do the search.

Parameters

string	$term
string	$fulltext
string	$colname

Returns: string

Definition at line 131 of file SearchPostgres.php.

References $dbr, SearchEngine\$namespaces, $res, DB_REPLICA, parseQuery(), and wfDebug().

Referenced by doSearchTextInDB(), and doSearchTitleInDB().

◆ update()

SearchPostgres::update	(	$id,
		$title,
		$text
	)

Create or update the search index record for the given page.

Title and text should be pre-processed. STUB

Parameters

int	$id
string	$title
string	$text

Reimplemented from SearchEngine.

Definition at line 195 of file SearchPostgres.php.

References DB_MASTER.

◆ updateTitle()

SearchPostgres::updateTitle	(	$id,
		$title
	)

Update a search index record's title only.

Title should be pre-processed. STUB

Parameters

int	$id
string	$title

Reimplemented from SearchEngine.

Definition at line 215 of file SearchPostgres.php.

The documentation for this class was generated from the following file:

includes/search/SearchPostgres.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ doSearchTextInDB()

◆ doSearchTitleInDB()

◆ parseQuery()

◆ searchQuery()

◆ update()

◆ updateTitle()