Klororf.AzSearchLinq 0.7.0

AzSearchLinq: Simplify Your Queries to Azure Cognitive Search

AzSearchLinq is a .NET library that streamlines queries to Azure Cognitive Search. It allows developers to create more readable code when consume azure search

Table of Contents

• Introduction
• Fluent Mode
• Limits

Introduction

AzSearchLinq is a tool that makes querying Azure Cognitive Search easier. With its "Fluent" mode, you can construct OData queries in a more readable and efficient way.

Fluent Mode

In Fluent mode, you can create queries like this:

var test = _searchClient.Fluent<Product>()
    .Equal(x => x.Description, "A")
    .Greater(x => x.Price, 2);

var test2 = _searchClient.Fluent<Product>()
    .Equal(x => x.Size, "M")
    .LessOrEqual(x => x.Price, 100);

var test3 =  _searchClient.Fluent<Product>()
                            .Parentheses(fluent =>fluent
                                    .Equal(x => x.Description, "A")
                                    .Equal(x => x.Price, 2)
                                    .Parentheses(x => 
                                        x.Equal(x => x.Size, "M")
                                        )
                            );

You can also specify the logical operator (AND or OR) between conditions:

_searchClient.Fluent<Product>()
                .Equal(x => x.Size, "2")
                .LessOrEqual(x => x.Price, 2, LogicalOperator.Or);

Additionally, you can use the conditional parameter to ignore parts of the query based on values:

var x = 1 == 2;
_searchClient.Fluent<Product>()
            .Equal(x => x.Size, "2")
            .LessOrEqual(x => x.Price, 2, LogicalOperator.Or, x);

Limits

At this moment you can only use lambda operators, coditionals,search.ismatch(), search.in() in fluent mode for other things you can use the Linqeable way

Linqueable

Where

• Filter with conditional operators (==,!=...)
• Filter with string operatos (StartsWith,EndsWith,Contains)
• use search.in method
• filter with lambdas for complex types

Select

• Get the results and transform to other types

examples

SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.Where<Product>(x =>x.ProductName != "Mr").Select(x=>x.Product);

Also you can concatenate multiple where

SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.Where<Product>(x =>x.ProductName != "Mr")
                    .And(x=>x.Price == 20)
                    .Search();
/// produces ProductName ne 'Mr' and Price eq 20

SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.Where<Product>(x =>x.ProductName != "Mr")
                    .Or(x=>x.Price == 20)
                    .Search();
/// produces ProductName ne 'Mr' or Price eq 20

Use logical operators

SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.Where<Product>(x =>x.ProductName != "Mr" && x.Price >10)
                    .And(x=>x.Price == 20)
                    .Search();

Use string methods for search

/// is highly recomended set a custom analyzer for search
SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.Where<Product>(x =>x.Description.StartsWith("Blu"))
                    .Search();

/// Produces search.ismatch('Blu*','Description')

Filter by the properties values

SearchClient srchclient = new SearchClient(serviceEndpoint, indexName, credential);
var res = srchclient.SubWhere<Product,Color>(x =>x.Colors,x=>x.Hex="anything")
                    .Search();

/// Produces Colors/any(x: x/Hex eq 'anything')