Skip to content

Latest commit

 

History

History
217 lines (173 loc) · 8.83 KB

README.md

File metadata and controls

217 lines (173 loc) · 8.83 KB
Raw

Manticore .Net client

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

Frameworks supported

Dependencies

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

Manticore Search manticoresearch-net
dev dev
>= 6.3.6 >= 5.0.0
>= 6.2.0 >= 3.3.1
>= 2.5.1 >= 1.0.x 
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

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();
            
            // Perform insert and search operations
            var indexApi = new IndexApi(httpClient, config, httpClientHandler);
			var searchApi = new SearchApi(httpClient, config, httpClientHandler);
            try 
            {
            	string tableName = "products";
	
				Dictionary<string, Object> doc = new Dictionary<string, Object>(); 
				doc.Add("title", "Crossbody Bag with Tassel");
				doc.Add("price", 19.85);

                InsertDocumentRequest insertDocumentRequest = new InsertDocumentRequest(Index: "products", Doc: doc);
                indexApi.Insert(insertDocumentRequest);

	            SearchRequest searchRequest = new SearchRequest(Index: "products");
                                
                Highlight queryHighlight = new Highlight();
                List<string> highlightFields = new List<string>();
                highlightFields.Add("title");
                queryHighlight.Fields = highlightFields;

                SearchQuery query = new SearchQuery();
                query.QueryString = "@title Bag";
                
                searchRequest.Query = query;
                searchRequest.Highlight = queryHighlight;
                
                SearchResponse searchResponse = searchApi.Search(searchRequest);
						
				Console.WriteLine(searchResponse);
			}
            catch (ApiException  e)
            {
                Debug.Print("Exception when calling Api method: " + 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 /bulk Bulk index operations
IndexApi Delete POST /delete Delete a document in an index
IndexApi Insert POST /insert Create a new document in an index
IndexApi PartialReplace POST /{index}/_update/{id} Partially replaces a document in an index
IndexApi Replace POST /replace Replace new document in an index
IndexApi Update POST /update Update a document in an index
SearchApi Percolate POST /pq/{index}/search Perform reverse search on a percolate index
SearchApi Search POST /search Performs a search on an index
UtilsApi Sql POST /sql Perform SQL requests

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.