Click or drag to resize
SearchIndexInfoProvider Class
Class providing SearchIndexInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderSearchIndexInfo, SearchIndexInfoProvider, ObjectQuerySearchIndexInfo
    CMS.DataEngineAbstractInfoProviderSearchIndexInfo, SearchIndexInfoProvider
      CMS.SearchSearchIndexInfoProvider

Namespace: CMS.Search
Assembly: CMS.Search (in CMS.Search.dll) Version: 13.0.131
Syntax
C#
public class SearchIndexInfoProvider : AbstractInfoProvider<SearchIndexInfo, SearchIndexInfoProvider>, 
	ISearchIndexInfoProvider, IInfoProvider<SearchIndexInfo>, IInfoByIdProvider<SearchIndexInfo>, 
	IInfoByNameProvider<SearchIndexInfo>

The SearchIndexInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodSearchIndexInfoProvider
Constructor.
Top
Fields
Properties
  NameDescription
Public propertyDataSource
Data source for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberGeneralIndexTypeList
Collection of index types which are handled using general indexer.
Public propertyHashtableSettings
Gets hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected propertyInfoObject
Info object instance the provider is working with.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyIsValid
Indicates if the provider instance is up-to-date and can be used to manage object instances.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public propertyStatic memberSearchEnabled
Gets or sets a property which indicates if Smart search is enabled.
Public propertyTypeInfo
Object type information.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clear hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryClearHashtables(Boolean).)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Overrides AbstractInfoProviderTInfo, TProviderDelete(TInfo).)
Protected methodDeleteInfo
Deletes the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberDeleteSearchIndexInfo(Int32)
Deletes specified searchIndex.
Public methodStatic memberDeleteSearchIndexInfo(SearchIndexInfo)
Deletes specified searchIndex.
Protected methodDeleteSearchIndexInfoInternal
Deletes specified searchIndex.
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetIndexIDs
Returns list of index ids for specified object type(s) and searchProvider.
Public methodStatic memberGetIndexStatus
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 methodGetIndexStatusInternal
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 methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetLocalizedSearchIndexInfo
Returns the SearchIndexInfo structure for the specified searchIndex. If localized SearchIndex found, then it is returned insted of regular one.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetRelevantIndexes
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 methodStatic memberGetSearchIndexes
Returns all search indexes
Public methodStatic memberGetSearchIndexInfo(Int32)
Returns the SearchIndexInfo structure for the specified searchIndex.
Public methodStatic memberGetSearchIndexInfo(String)
Returns the SearchIndexInfo structure for the specified searchIndex.
Public methodStatic memberGetSearchIndexSites
Returns all sites for specified search index.
Public methodStatic memberGetSiteIndexes
Returns search indexes of specified site. Tries to load it from cache, if not found indexes are loaded from DB.
Public methodStatic memberIndexIsInCulture
If SearchIndex has specified culture assigned returns true, otherwise false. The result is cached for next time usage.
Public methodStatic memberIndexIsInSite
If SearchIndex has specified site assigned returns true, otherwise false. The result is cached for next time usage.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberInvalidateIndexIDs(String)
Invalidates index ids collection for specified object type.
Public methodStatic memberInvalidateIndexIDs(String, Boolean)
Invalidates index ids collection for specified object type.
Protected methodInvalidateIndexIDsInternal
Invalidates index ids collection for specified object type.
Public methodStatic memberIsObjectTypeIndexed
Determines whether the class has a general or system index.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryProcessWebFarmTask(String, String, Byte).)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRebuildSiteIndexes
Rebuilds all indexes which belongs to the specified site.
Protected methodRebuildSiteIndexesInternal
Rebuilds all indexes which belongs to the specified site.
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberRemoveFromIndexCultureCache
Removes key from cached index-culture relation.
Protected methodRemoveFromIndexCultureCacheInternal
Removes key from cached index-culture relation.
Public methodStatic memberRemoveFromIndexSiteCache
Removes key from cached site indexes.
Protected methodRemoveFromIndexSiteCacheInternal
Removes key from cached site indexes.
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSearchTypeEnabled
Returns true if smart search is enabled and exists at least one index for specified object type.
Public methodSet
Inserts or updates the info object in the underlying data store.
(Overrides AbstractInfoProviderTInfo, TProviderSet(TInfo).)
Public methodSetAsDefaultProvider

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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetIndexFilesLastUpdateTime
Sets last update time of search index files that belongs to current application process.
Protected methodSetIndexFilesLastUpdateTimeInternal
Sets last update time of search index files that belongs to current application process.
Public methodStatic memberSetIndexStatus
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 methodSetIndexStatusInternal
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 methodSetInfo
Inserts or Updates the object to the database.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetSearchIndexInfo
Sets (updates or inserts) specified searchIndex.
Protected methodSetSearchIndexInfoInternal
Sets (updates or inserts) specified searchIndex.
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also