nick-s-2018 / csharp-client-draft

ManticoreSearch - the C# library for the Manticore Search Client

❗ WARNING: this is a development version of the client. The latest release's readme is https://github.com/manticoresoftware/manticoresearch-net/tree/3.3.0

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• SDK version: 3.3.0
• Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen For more information, please visit https://manticoresearch.com/contact-us/

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext

Dependencies

• Json.NET - 13.0.1 or later
• JsonSubTypes - 1.8.0 or later
• System.ComponentModel.Annotations - 5.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

Installation

Generate the DLL using your preferred tool (e.g. dotnet build)

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using ManticoreSearch.Api;
using ManticoreSearch.Client;
using ManticoreSearch.Model;

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Connections

Each ApiClass (properly the ApiClient inside it) will create an instance of HttpClient. It will use that for the entire lifecycle and dispose it when called the Dispose method.

To better manager the connections it's a common practice to reuse the HttpClient and HttpClientHandler (see here for details). To use your own HttpClient instance just pass it to the ApiClass constructor.

HttpClientHandler yourHandler = new HttpClientHandler();
HttpClient yourHttpClient = new HttpClient(yourHandler);
var api = new YourApiClass(yourHttpClient, yourHandler);

If you want to use an HttpClient and don't have access to the handler, for example in a DI context in Asp.net Core when using IHttpClientFactory.

HttpClient yourHttpClient = new HttpClient();
var api = new YourApiClass(yourHttpClient);

You'll loose some configuration settings, the features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings. You need to either manually handle those in your setup of the HttpClient or they won't be available.

Here an example of DI setup in a sample web project:

services.AddHttpClient<YourApiClass>(httpClient =>
   new PetApi(httpClient));

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using System.Net.Http;
using ManticoreSearch.Api;
using ManticoreSearch.Client;
using ManticoreSearch.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "http://127.0.0.1:9308";
            // create instances of HttpClient, HttpClientHandler to be reused later with different Api classes
            HttpClient httpClient = new HttpClient();
            HttpClientHandler httpClientHandler = new HttpClientHandler();
            var apiInstance = new IndexApi(httpClient, config, httpClientHandler);
            var body = ["'{\"insert\": {\"index\": \"test\", \"id\": 1, \"doc\": {\"title\": \"Title 1\"}}},\\n{\"insert\": {\"index\": \"test\", \"id\": 2, \"doc\": {\"title\": \"Title 2\"}}}'"];  // string | 

            try
            {
                // Bulk index operations
                BulkResponse result = apiInstance.Bulk(body);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling IndexApi.Bulk: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:9308

Class	Method	HTTP request	Description
IndexApi	Bulk	POST /json/bulk	Bulk index operations
IndexApi	Delete	POST /json/delete	Delete a document in an index
IndexApi	Insert	POST /json/insert	Create a new document in an index
IndexApi	Replace	POST /json/replace	Replace new document in an index
IndexApi	Update	POST /json/update	Update a document in an index
SearchApi	Percolate	POST /json/pq/{index}/search	Perform reverse search on a percolate index
SearchApi	Search	POST /json/search	Performs a search
UtilsApi	Sql	POST /sql	Perform SQL requests

Documentation for Models

• Model.Aggregation
• Model.BoolFilter
• Model.BulkResponse
• Model.DeleteDocumentRequest
• Model.DeleteResponse
• Model.EqualsFilter
• Model.ErrorResponse
• Model.Facet
• Model.FilterBoolean
• Model.FilterNumber
• Model.FilterString
• Model.GeoDistanceFilter
• Model.GeoDistanceFilterLocationAnchor
• Model.Highlight
• Model.HighlightField
• Model.InFilter
• Model.InsertDocumentRequest
• Model.MatchFilter
• Model.MatchOp
• Model.MatchOpFilter
• Model.MatchPhraseFilter
• Model.NotFilterBoolean
• Model.NotFilterNumber
• Model.NotFilterString
• Model.PercolateRequest
• Model.PercolateRequestQuery
• Model.QueryFilter
• Model.RangeFilter
• Model.SearchRequest
• Model.SearchResponse
• Model.SearchResponseHits
• Model.SortMVA
• Model.SortMultiple
• Model.SortOrder
• Model.SourceByRules
• Model.SuccessResponse
• Model.UpdateDocumentRequest
• Model.UpdateResponse

Documentation for Authorization

All endpoints do not require authorization.