Faceted Search Microservice
This is a faceted search microservice from Pip.Services library. It allows to search "facets" recorded by other microservices. For instance, statistics microservice can record groups and later use them in counters search.
The microservice currently supports the following deployment options:
- Deployment platforms: Standalone Process, Seneca
- External APIs: HTTP/REST, Seneca
- Persistence: Flat Files, MongoDB
This microservice has no dependencies on other microservices.
- Download Links
- Development Guide
- Configuration Guide
- Deployment Guide
- Client SDKs
- Communication Protocols
Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.
Right now the only way to get the microservice is to check it out directly from github repository
git clone firstname.lastname@example.org:pip-services-content/pip-services-facets-node.git
Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.
Add config.yml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yml file.
Example of microservice configuration
- descriptor: "pip-services-container:container-info:default:default:1.0"name: "pip-services-facets"description: "Facets microservice"- descriptor: "pip-services-commons:logger:console:default:1.0"level: "trace"- descriptor: "pip-services-facets:persistence:file:default:1.0"path: "./data/facets.json"- descriptor: "pip-services-facets:controller:default:default:1.0"options:max_facet_count: 100- descriptor: "pip-services-facets:service:http:default:1.0"connection:protocol: "http"host: "0.0.0.0"port: 8080
For more information on the microservice configuration see Configuration Guide.
Start the microservice using the command:
The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links
If you use Node.js then you should add dependency to the client SDK into package.json file of your project
Inside your code get the reference to the client SDK
var sdk = 'pip-clients-facets-node';
Define client configuration parameters that match configuration of the microservice external API
// Client configurationvar config =connection:protocol: 'http'host: 'localhost'port: 8080;
Instantiate the client and open connection to the microservice
// Create the client instancevar client = sdk;// Connect to the microserviceclient;
Now the client is ready to perform operations
// Record facets for a userclient;
// Get the list of user facetsclient;
This microservice was created and currently maintained by Sergey Seroukhov.