Enterspeed.Query.Sdk 1.1.0

Enterspeed Query .NET SDK ·

Installation

With .NET CLI

dotnet add package Enterspeed.Query.Sdk --version <version>

With Package Manager

Install-Package Enterspeed.Query.Sdk -Version <version>

How to use

Register services

Service has to be added to the service collection. This can be one by using the following extension method.

using IHost host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((_, services) =>
        services.AddEnterspeedQueryService())
    .Build();

Examples of usage

Example of a common implementation where the query service is being utilized.

using System.Text.Json.Serialization;
using Enterspeed.Query.Sdk.Api.Extensions;
using Enterspeed.Query.Sdk.Api.Models;
using Enterspeed.Query.Sdk.Api.Services;
using Enterspeed.Query.Sdk.Domain.Models;
using Enterspeed.Query.Sdk.Domain.Models.FilterOperators;
using Enterspeed.Query.Sdk.Domain.Models.LogicalOperators;

namespace Query;

public class MyQueryService
{
    private readonly IEnterspeedQueryService _enterspeedQueryService;

    public MyQueryService(IEnterspeedQueryService enterspeedQueryService)
    {
        _enterspeedQueryService = enterspeedQueryService;
    }

    // Query an Enterspeed index 
    public async Task<QueryApiResponse> Query()
    {
        var query = new QueryObject
        {
            Sort = new List<Sort>
            {
                new Sort()
                {
                    Field = "_updatedAt",
                    Order = SortOrder.Desc
                }
            },
            Facets = new List<Facet>
            {
                new Facet()
                {
                    Field = "tags",
                    Name = "Tags",
                    Size = 3
                }
            },
            Filters = new AndOperator
            {
                And = new List<IOperator>
                {
                    new EqualsOperator<bool>
                    {
                        Field = "isActive",
                        Value = true
                    },
                    new OrOperator
                    {
                        Or = new List<IOperator>
                        {
                            new EqualsOperator<bool>
                            {
                                Field = "isGlobal",
                                Value = true
                            },
                            new InOperator<string>
                            {
                                Field = "category",
                                Value = new List<string> { "selected category 1", "selected category 2" }
                            }
                        }
                    }
                }
            },
            Aliases = new List<string> { "blogPostTile" },
            Pagination = new Pagination
            {
                Page = 0,
                PageSize = 10
            }
        };

        var response = await _enterspeedQueryService.Query("environment-******-****-****-****-**********", "blogIndex", query);

        return response;
    }

    // Query an Enterspeed index and get strongly typed result
    public async Task<List<BlogPost>> QueryTyped()
    {
        var typedResult = await _enterspeedQueryService.QueryTyped("environment-******-****-****-****-**********", "blogIndex", new QueryObject());

        List<BlogPost> blogPosts = typedResult.Response.Results.GetContent<BlogPost>();

        return blogPosts;
    }

    // Multiple queries against an Enterspeed index 
    public async Task<MultiQueryApiResponse> MultiQuery()
    {
        var multiQuery = new List<MultiQueryObject>{
            new()
            {
                Index = "blogIndex",
                Name = "blogPosts",
                Filters = new AndOperator
                {
                    And = new List<IOperator>
                    {
                        new EqualsOperator<string>
                        {
                            Field = "title",
                            Value = "My Blog Post",
                            CaseInsensitive = true
                        }
                    }
                },
                Pagination = new Pagination
                {
                    Page = 0,
                    PageSize = 10
                }
            },
            new()
            {
                Index = "blogIndex",
                Name = "allCategoryFacets",
                Facets = new List<Facet>
                {
                    new()
                    {
                        Field = "category",
                        Name = "Category"
                    }
                },
                Pagination = new Pagination
                {
                    Page = 0,
                    PageSize = 0
                }
            }
        };

        var response = await _enterspeedQueryService.Query("environment-******-****-****-****-**********", multiQuery);

        var blogPostsQueryResponse = response.Response.Single(x => x.Name == "blogPosts");
        var allFacetsQueryResponse = response.Response.Single(x => x.Name == "allFacets");

        return response;
    }

    // Multiple queries against an Enterspeed index and get strongly typed results
    public async Task<MultiQueryApiResponse<IContent>> MultiQueryTyped()
    {
        var multiQuery = new List<MultiQueryObject>{
            new()
            {
                Index = "blogIndex",
                Name = "blogPosts",
                Sort = new List<Sort>
                {
                    new()
                    {
                        Field = "_updatedAt",
                        Order = SortOrder.Desc
                    }
                },
                Pagination = new Pagination
                {
                    Page = 0,
                    PageSize = 10
                }
            },
            new()
            {
                Index = "productIndex",
                Name = "products",
                Sort = new List<Sort>
                {
                    new()
                    {
                        Field = "_updatedAt",
                        Order = SortOrder.Desc
                    }
                },
                Pagination = new Pagination
                {
                    Page = 0,
                    PageSize = 10
                }
            }
        };

        var response = await _enterspeedQueryService.QueryTyped("environment-******-****-****-****-**********", multiQuery);

        List<BlogPost> blogPosts = response.Response.Single(x => x.Name == "blogPosts").Results.GetContent<BlogPost>();
        List<Product> products = response.Response.Single(x => x.Name == "allFacets").Results.GetContent<Product>();

        return response;
    }

    public class BlogPost
    {
        [JsonPropertyName("date")]
        public DateTime PublishedDate { get; set; }
        public string Title { get; set; }
        public string AuthorName { get; set; }
        public string[] Tags { get; set; }
    }

    public class Product
    {
        public string Url { get; set; }
        public string ProductName { get; set; }
        public double Price { get; set; }
        public string Sku { get; set; }
        public string Category { get; set; }
    }
}

Contributing

Pull requests are very welcome.
Please fork this repository and make a PR when you are ready.

Otherwise you are welcome to open an Issue in our issue tracker.

License

Enterspeed .NET SDK is MIT licensed