Search & Filtering

Enterprise Commerce integrates both Meilisearch or Algolia as its core engine for robust search, filtering, and recommendations, ensuring that product data is accurately reflected and easily accessible. Both search engines provide lightning-fast, typo-tolerant search experiences that enhance the overall usability and efficiency of Enterprise Commerce.

To learn more about these search engines and their capabilities, visit:

The integration with both Meilisearch and Algolia is designed to operate exclusively on the server side. Attempts to utilize their respective clients or SDKs on the client side will result in an error.

Developers should access the search engine instances via the provided path clients/search.ts

Using the Filter Builder

The FilterBuilder class provides a convenient way to construct complex filter expressions for both Meilisearch and Algolia queries. It allows you to chain methods to define various filter criteria, including comparisons, logical operators, and special operators.

Here’s an example of how to use the FilterBuilder when using Meilisearch:

const filter = new FilterBuilder()
  .where("price", ComparisonOperators.GreaterThan, 100)
  .and()
  .group((sub) =>
    sub
      .where("category", "=", "Electronics")
      .or()
      .where("category", "=", "Computers")
  )
  .build();

// This will generate the following filter expression:
// price > 100 AND (category = "Electronics" OR category = "Computers")

Here’s an example of how to use the FilterBuilder when using Algolia:

const filter = new FilterBuilder()
  .where("price", 100, ComparisonOperators.GreaterThan)
  .and()
  .group((sub) =>
    sub.where("category", "Electronics").or().where("category", "Computers")
  )
  .build();

// This will generate the following filter expression:
// price > 100 AND (category:"Electronics" OR category:"Computers")

The FilterBuilder offers a variety of methods to construct complex search queries, allowing you to tailor your product searches to specific needs and provide a user-friendly experience.

While the FilterBuilder syntax is consistent for both Meilisearch and Algolia, there might be slight differences in how certain filters are applied or interpreted by each search engine. Always refer to the specific documentation of the search engine you’re using for any engine-specific behavior.

Reference

Enums

ComparisonOperators

Represents the comparison operators that can be used in filtering conditions.

Equal ( = )
NotEqual ( != )
GreaterThan ( > )
GreaterThanOrEqual ( >= )
LessThan (< )
LessThanOrEqual ( <= )
To ( TO )

LogicalOperators

Represents the logical operators that can be used to combine filtering conditions.

And (AND)
Or (OR)
Not (NOT)

SpecialOperators

Represents special operators that can be used in filtering conditions.

Exists (EXISTS)
IsEmpty (IS EMPTY)
IsNull (IS NULL)