Skip to content

Module represents a generic functionality and API for indexed search operations

License

Notifications You must be signed in to change notification settings

VirtoCommerce/vc-module-search

Repository files navigation

Virto Commerce Search Module

CI status Quality gate Reliability rating Security rating Sqale rating

The VirtoCommerce.Search module provides a comprehensive solution for indexed search functionality, offering full-text search capability, extensible document models, and multi-document support. It enables efficient indexing, querying, and management of search data for various e-commerce entities, empowering administrators to optimize search experiences for end-users.

Providers

The VirtoCommerce.Search module defines common abstractions for indexed search functionality across various search engines, providing flexibility and scalability for e-commerce search solutions. Choose from a range of well-know search engines:

or create a custom search provider to integrate with another search engine.

Features

  • Full-Text Search Capability
  • Extensible Document Model
  • Multi-Document Support (e.g., Product, Categories, Members, Orders, etc.)
  • Blue Green Indexation
  • Indexation Logs
  • Native Integration with Admin Back Office

Architecture

Explore the Indexed Search Overview for detailed insights into the architecture and functionality of the VirtoCommerce.Search module.

Configuration

Configure the search provider modules and activate them in the Search.Provider section, providing connection parameters as specified in the module documentation:

"Search": {
		"Provider": "ElasticAppSearch",
		"Scope": "default",
		"ElasticAppSearch": {
      "Endpoint": "https://localhost:3002",
			"PrivateApiKey": "private-key",
		  "KibanaBaseUrl": "https://localhost:5601"
		}
	}

Select Search Provider per Document Type

Tailor the search provider per document type to optimize search performance and functionality. Configure the provider for each document type as needed:

{
  "Search": {
    "Provider": "ElasticAppSearch",
    "DocumentScopes": [
      {
        "DocumentType": "Category",
        "Provider": "ElasticSearch8"
      }
    ]
  }
}

References

License

Copyright (c) Virto Solutions LTD. All rights reserved.

This software is licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://virtocommerce.com/opensourcelicense.

Unless required by the applicable law or agreed to in written form, the software distributed under the License is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.