Interface ISearchService

Assembly: Alachisoft.NCache.Client.dll

Syntax

public interface ISearchService

Methods

ExecuteNonQuery(QueryCommand)

Declaration

int ExecuteNonQuery(QueryCommand queryCommand)

Parameters

Returns

Remarks

Examples

ICache _cache = CacheManager.GetCache("demoCache");

string query = "delete Test.Application.Employee where this.Name = ?";
QueryCommand queryCommand = new QueryCommand(query);
queryCommand.Parameters.Add("Name", "Paul Jones");
int result = _cache.SearchService.ExecuteNonQuery(queryCommand);

query = "delete Test.Application.Employee where this.Salary > ?";
queryCommand = new QueryCommand(query);
queryCommand.Parameters.Add("Salary", 2000);
result = _cache.SearchService.ExecuteNonQuery(queryCommand);

query = "delete Test.Application.Employee where Not(this.Name = 'Paul Jones' and this.Salary > 2000)";
queryCommand = new QueryCommand(query);
queryCommand.Parameters.Add("Name", "Paul Jones");
queryCommand.Parameters.Add("Salary", 2000);
result = _cache.SearchService.ExecuteNonQuery(queryCommand);

ExecuteReader(QueryCommand, Boolean, Int32)

Declaration

ICacheReader ExecuteReader(QueryCommand queryCommand, bool getData = true, int chunkSize = -1)

Parameters

Returns

Remarks

Examples

ICache cache = CacheManager.GetCache("demoCache");

Instead of Product, specify fully qualified name of your custom class.

string query = "SELECT Product where this.ProductName = ?";

QueryCommand queryCommand = new QueryCommand(query);
queryCommand.Parameters.Add("ProductName", "Chai");
queryCommand.Parameters.Add("UnitsInStock", 250);

try
{
    ICacheReader reader = cache.SearchService.ExecuteReader(queryCommand, true, 50);
    if (reader.FieldCount > 0)
    {
        while (reader.Read())
        {
            object category = reader.GetValue<object>(0);
            //perform operations
        }
    }
    else
    {
        //perform operations
    }
    reader.Close();
}

catch
{
    //handle exception
}

ExecuteScalar(QueryCommand)

Declaration

object ExecuteScalar(QueryCommand queryCommand)

Parameters

Returns

GetByTag<T>(Tag)

Declaration

IDictionary<string, T> GetByTag<T>(Tag tag)

Parameters

Returns

Type Parameters

Examples

The following example demonstrates how to get the objects with the specified tag.

ICache cache = CacheManager.GetCache("demoCache");
Tag tag = new Tag("Sports");
IDictionary<string,Product> result = cache.SearchService.GetByTag<Product>(tag);

GetByTag<T>(String)

Declaration

IDictionary<string, T> GetByTag<T>(string wildCardExpression)

Parameters

Returns

Type Parameters

Remarks

Examples

The following example demonstrates how to get the objects with the specified tag using wildcard.

ICache cache = CacheManager.GetCache("demoCache");

Following tags are created and items are added in the cache with these tags

Tag[] tags = new Tag[3];
tags[0] = new Tag("Important Customers");
tags[1] = new Tag("East Coast Customers");
tags[2] = new Tag("West Coast Customers");

IDictionary<string, Customer> result = cache.SearchService.GetByTag<Customer>("*Customers");

GetByTags<T>(IEnumerable<Tag>, TagSearchOptions)

Declaration

IDictionary<string, T> GetByTags<T>(IEnumerable<Tag> tags, TagSearchOptions type)

Parameters

Returns

Type Parameters

Examples

The following example demonstrates how to get the objects that have the specified tags with TagSearchOptions.

ICache cache = CacheManager.GetCache("demoCache");

Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");

IDictionary<string, Product> result = cache.SearchService.GetByTags<Product>(tags,TagSearchOptions.ByAllTags);

GetGroupData<T>(String)

Declaration

IDictionary<string, T> GetGroupData<T>(string group)

Parameters

Returns

Type Parameters

Examples

The following example demonstrates how to retrieve data against group.

ICache cache = CacheManager.GetCache("demoCache");
IDictionary<string,Product> keys = cache.SearchService.GetGroupData<Product>("group_name");

Exceptions

GetGroupKeys(String)

Declaration

ICollection<string> GetGroupKeys(string group)

Parameters

Returns

Examples

The following example demonstrates how to retrieve key list against group.

ICache cache = CacheManager.GetCache("demoCache");
ICollection<string> keys = cache.SearchService.GetGroupKeys("group_name");

Exceptions

GetKeysByTag(Tag)

Declaration

ICollection<string> GetKeysByTag(Tag tag)

Parameters

Returns

Examples

The following example demonstrates how to get the keys with the specified tag.

ICache cache = CacheManager.GetCache("demoCache");
Tag tag = new Tag("Sports");
ICollection<string> keys = cache.SearchService.GetKeysByTag(tag);

GetKeysByTag(String)

Declaration

ICollection<string> GetKeysByTag(string wildCardExpression)

Parameters

Returns

Remarks

Examples

The following example demonstrates how to get the keys with the specified tag using wildcard.

ICache cache = CacheManager.GetCache("demoCache");

Following tags are created and items are added in the cache with these tags

Tag[] tags = new Tag[3];
tags[0] = new Tag("Important Customers");
tags[1] = new Tag("East Coast Customers");
tags[2] = new Tag("West Coast Customers");

ICollection<string> keys = cache.SearchService.GetKeysByTag("*Customers");

GetKeysByTags(IEnumerable<Tag>, TagSearchOptions)

Declaration

ICollection<string> GetKeysByTags(IEnumerable<Tag> tags, TagSearchOptions type)

Parameters

Returns

Examples

The following example demonstrates how to get the keys that have the specified tags with TagSearchOptions.

ICache cache = CacheManager.GetCache("demoCache");

Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");

ICollection<string> result = cache.SearchService.GetKeysByTags(tags, TagSearchOptions.ByAllTags);

RemoveByTag(Tag)

Declaration

void RemoveByTag(Tag tag)

Parameters

Examples

The following example demonstrates how to remove the objects with the specified tag.

ICache cache = CacheManager.GetCache("demoCache");
Tag tag = new Tag("Alpha");
cache.SearchService.RemoveByTag(tag);

RemoveByTags(IEnumerable<Tag>, TagSearchOptions)

Declaration

void RemoveByTags(IEnumerable<Tag> tags, TagSearchOptions type)

Parameters

Examples

The following example demonstrates how to remove the objects with the specified tags with TagSearchOptions.

ICache cache = CacheManager.GetCache("demoCache");

Tag[] tags = new Tag[2];
tags[0] = new Tag("Alpha");
tags[1] = new Tag("Beta");

cache.SearchService.RemoveByTags(tags, TagSearchOptions.ByAllTags);

RemoveGroupData(String)

Declaration

void RemoveGroupData(string group)

Parameters

Examples

Example demonstrates how you can remove an item from cache using its group.

ICache cache = CacheManager.GetCache("demoCache");
cache.SearchService.RemoveGroupData("group_name");