SearchIndexInfoProvider Class

Class providing SearchIndexInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<SearchIndexInfo, SearchIndexInfoProvider, ObjectQuery<SearchIndexInfo>>
    CMS.DataEngine.AbstractInfoProvider<SearchIndexInfo, SearchIndexInfoProvider>
      CMS.Search.SearchIndexInfoProvider

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131

Syntax

public class SearchIndexInfoProvider : AbstractInfoProvider<SearchIndexInfo, SearchIndexInfoProvider>, 
	ISearchIndexInfoProvider, IInfoProvider<SearchIndexInfo>, IInfoByIdProvider<SearchIndexInfo>, 
	IInfoByNameProvider<SearchIndexInfo>

The SearchIndexInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SearchIndexInfoProvider	Constructor.

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	GeneralIndexTypeList	Collection of index types which are handled using general indexer.
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property Static member	SearchEnabled	Gets or sets a property which indicates if Smart search is enabled.
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ClearHashtables	Clear hashtables. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ClearHashtables(Boolean).)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Delete(TInfo).)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteSearchIndexInfo(Int32)	Deletes specified searchIndex.
Public method Static member	DeleteSearchIndexInfo(SearchIndexInfo)	Deletes specified searchIndex.
Protected method	DeleteSearchIndexInfoInternal	Deletes specified searchIndex.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetIndexIDs	Returns list of index ids for specified object type(s) and searchProvider.
Public method Static member	GetIndexStatus	Gets status of indexInfo. The method gets IndexStatus or IndexStatusLocal based on the following criteria. For shared storage file system based indexes or Azure indexes, the first property is gotten. For local storage file system based indexes, the latter one is gotten.
Protected method	GetIndexStatusInternal	Gets status of indexInfo. The method gets IndexStatus or IndexStatusLocal based on the following criteria. For shared storage file system based indexes or Azure indexes, the first property is gotten. For local storage file system based indexes, the latter one is gotten.
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetLocalizedSearchIndexInfo	Returns the SearchIndexInfo structure for the specified searchIndex. If localized SearchIndex found, then it is returned insted of regular one.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetRelevantIndexes	Returns all indexes which are relevant to the specified ISearchable object and given searchProvider. Check ISearchable object type and with dependence on this type check index settings.
Public method Static member	GetSearchIndexes	Returns all search indexes
Public method Static member	GetSearchIndexInfo(Int32)	Returns the SearchIndexInfo structure for the specified searchIndex.
Public method Static member	GetSearchIndexInfo(String)	Returns the SearchIndexInfo structure for the specified searchIndex.
Public method Static member	GetSearchIndexSites	Returns all sites for specified search index.
Public method Static member	GetSiteIndexes	Returns search indexes of specified site. Tries to load it from cache, if not found indexes are loaded from DB.
Public method Static member	IndexIsInCulture	If SearchIndex has specified culture assigned returns true, otherwise false. The result is cached for next time usage.
Public method Static member	IndexIsInSite	If SearchIndex has specified site assigned returns true, otherwise false. The result is cached for next time usage.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	InvalidateIndexIDs(String)	Invalidates index ids collection for specified object type.
Public method Static member	InvalidateIndexIDs(String, Boolean)	Invalidates index ids collection for specified object type.
Protected method	InvalidateIndexIDsInternal	Invalidates index ids collection for specified object type.
Public method Static member	IsObjectTypeIndexed	Determines whether the class has a general or system index.
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ProcessWebFarmTask(String, String, Byte[]).)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RebuildSiteIndexes	Rebuilds all indexes which belongs to the specified site.
Protected method	RebuildSiteIndexesInternal	Rebuilds all indexes which belongs to the specified site.
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	RemoveFromIndexCultureCache	Removes key from cached index-culture relation.
Protected method	RemoveFromIndexCultureCacheInternal	Removes key from cached index-culture relation.
Public method Static member	RemoveFromIndexSiteCache	Removes key from cached site indexes.
Protected method	RemoveFromIndexSiteCacheInternal	Removes key from cached site indexes.
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SearchTypeEnabled	Returns true if smart search is enabled and exists at least one index for specified object type.
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetIndexFilesLastUpdateTime	Sets last update time of search index files that belongs to current application process.
Protected method	SetIndexFilesLastUpdateTimeInternal	Sets last update time of search index files that belongs to current application process.
Public method Static member	SetIndexStatus	Sets status of indexInfo to status. The method sets IndexStatus or IndexStatusLocal based on the following criteria. For shared storage file system based indexes or Azure indexes, the first property is set. For local storage file system based indexes, the latter one is set.
Protected method	SetIndexStatusInternal	Sets status of indexInfo to status. The method sets IndexStatus or IndexStatusLocal based on the following criteria. For shared storage file system based indexes or Azure indexes, the first property is set. For local storage file system based indexes, the latter one is set.
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetSearchIndexInfo	Sets (updates or inserts) specified searchIndex.
Protected method	SetSearchIndexInfoInternal	Sets (updates or inserts) specified searchIndex.
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)