Interface IAssetSearchEngine

Namespace: ImageVault.Core.Common.Search

Assembly: ImageVault.Core.dll

Syntax

public interface IAssetSearchEngine

Properties

ConnectionString

Sets the connection string

Declaration

string ConnectionString { set; }

Property Value

Type	Description
System.String

Description

Gets a description of the search engine

Declaration

string Description { get; }

Property Value

Type	Description
System.String

Enabled

True if a Search engine is configured

Declaration

bool Enabled { get; }

Property Value

Type	Description
System.Boolean

Methods

DeleteAssetAsync(SearchIndexInfo, Int32)

Deletes an asset from the search index

Declaration

Task DeleteAssetAsync(SearchIndexInfo indexInfo, int id)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
System.Int32	id

Returns

Type	Description
System.Threading.Tasks.Task

DeleteAssets(SearchIndexInfo, IList<Int32>)

Deletes the assets matching the supplied ids from the index

Declaration

void DeleteAssets(SearchIndexInfo indexInfo, IList<int> ids)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
System.Collections.Generic.IList<System.Int32>	ids

DeleteAssetsInVault(SearchIndexInfo, Int32)

Deletes all assets belonging to the supplied vaultId

Declaration

void DeleteAssetsInVault(SearchIndexInfo indexInfo, int vaultId)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
System.Int32	vaultId

DeleteIndex(SearchIndexInfo)

Deletes an index with the supplied id

Declaration

void DeleteIndex(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

DeleteIndexAsync(SearchIndexInfo)

Deletes the index (if it exists)

Declaration

Task DeleteIndexAsync(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

Returns

Type	Description
System.Threading.Tasks.Task

EnsureIndexExists(SearchIndexInfo)

Ensures that the index exists

Declaration

void EnsureIndexExists(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

EnsureIndexExistsAsync(SearchIndexInfo)

Ensures that the index exists

Declaration

Task EnsureIndexExistsAsync(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

Returns

Type	Description
System.Threading.Tasks.Task

GetSchemaVersion()

Returns the current schema version of the search engine

Declaration

int GetSchemaVersion()

Returns

Type	Description
System.Int32

GetStatisticsAsync(SearchIndexInfo)

Declaration

Task<IIndexStatistics> GetStatisticsAsync(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

Returns

Type	Description
System.Threading.Tasks.Task<IIndexStatistics>

IndexAssetAsync(SearchIndexInfo, IIndexableAsset)

Indexes the supplied asset

Declaration

Task IndexAssetAsync(SearchIndexInfo indexInfo, IIndexableAsset asset)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
IIndexableAsset	asset

Returns

Type	Description
System.Threading.Tasks.Task

IndexAssets(SearchIndexInfo, IList<IIndexableAsset>)

Indexes the supplied assets

Declaration

IndexOperationResponse IndexAssets(SearchIndexInfo indexInfo, IList<IIndexableAsset> indexableAssets)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
System.Collections.Generic.IList<IIndexableAsset>	indexableAssets

Returns

Type	Description
IndexOperationResponse

IndexAssetsAsync(SearchIndexInfo, IList<IIndexableAsset>)

Indexes the supplied assets

Declaration

Task<IndexOperationResponse> IndexAssetsAsync(SearchIndexInfo indexInfo, IList<IIndexableAsset> assets)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
System.Collections.Generic.IList<IIndexableAsset>	assets

Returns

Type	Description
System.Threading.Tasks.Task<IndexOperationResponse>

IndexExists(SearchIndexInfo)

Checks if the index is created

Declaration

bool IndexExists(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

Returns

Type	Description
System.Boolean

IndexExistsAsync(SearchIndexInfo)

Checks if the index is created

Declaration

Task<bool> IndexExistsAsync(SearchIndexInfo indexInfo)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

ListIndexes(Int32)

Declaration

IList<IAssetSearchEngineIndex> ListIndexes(int indexVersion)

Parameters

Type	Name	Description
System.Int32	indexVersion

Returns

Type	Description
System.Collections.Generic.IList<IAssetSearchEngineIndex>

Search(SearchIndexInfo, AssetsSearchRequest)

Performs a search

Declaration

ODataResponse<IIndexableAsset> Search(SearchIndexInfo indexInfo, AssetsSearchRequest request)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
AssetsSearchRequest	request

Returns

Type	Description
ODataResponse<IIndexableAsset>

SearchAsync(SearchIndexInfo, AssetsSearchRequest)

Performs a search

Declaration

Task<ODataResponse<IIndexableAsset>> SearchAsync(SearchIndexInfo indexInfo, AssetsSearchRequest request)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
AssetsSearchRequest	request

Returns

Type	Description
System.Threading.Tasks.Task<ODataResponse<IIndexableAsset>>

SuggestAsync(SearchIndexInfo, AssetsSearchRequest)

Performs a search

Declaration

Task<ODataResponse<ISuggestionItem>> SuggestAsync(SearchIndexInfo indexInfo, AssetsSearchRequest request)

Parameters

Type	Name	Description
SearchIndexInfo	indexInfo
AssetsSearchRequest	request

Returns

Type	Description
System.Threading.Tasks.Task<ODataResponse<ISuggestionItem>>

UpdateIndexInfoConfig(SearchIndexInfo)

Updates the supplied index info with configuration details that it's missing

Declaration

bool UpdateIndexInfoConfig(SearchIndexInfo info)

Parameters

Type	Name	Description
SearchIndexInfo	info

Returns

Type	Description
System.Boolean