Revision history [back]

To utilize ft.aggregate method in node-redis, follow these steps:

1. Require the redis module in your Node.js application:

const redis = require('redis');

1. Create a Redis client instance:

const client = redis.createClient();

1. Use the ft.aggregate method on the Redis client instance to execute a full-text search aggregate command. The syntax for using the method is as follows:

client.ft_aggregate(index, query [, options], [callback]);

• The index parameter specifies the name of the Redis search index to aggregate on.
• The query parameter specifies the query for the aggregate command.
• The options parameter specifies additional options (if any) such as MAX, SORTBY, LIMIT, etc. The options are provided as an object.
• The callback parameter is an optional callback function that is executed after the aggregate command is executed.

For example, to aggregate a search query for documents containing the term "apple" in the "fruit" field:

client.ft_aggregate('myIndex', 'apple', { APPLY: ['@fruit'] }, function(err, results) {
  if (err) {
    throw err;
  }
  console.log(results);
});

Here, the APPLY option is used to specify the fields to include in the aggregate results.

1. Finally, close the Redis client connection once you're done:

client.quit();