How to: Index and search documents with the Dapr JavaScript SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use DaprClient.search to manage indexes and search JSON documents through a Dapr search component. This guide uses Meilisearch and covers index creation, document writes, full-text search, filtering, sorting, pagination, retrieval, and deletion. All examples work over HTTP or gRPC.

Prerequisites

Dapr CLI
An initialized Dapr environment with Dapr runtime 1.19 or later
Node.js 18 or later
Docker to run Meilisearch locally
The @dapr/dapr package, version 3.19.0 or later

In your application directory, initialize an npm project if you do not already have one, then install the SDK:

Search client usage

Mon, 01 Jan 0001 00:00:00 +0000

Search is available through DaprClient.search in JavaScript SDK 3.19.0 or later and requires Dapr runtime 1.19 or later. HTTP and gRPC use the alpha Search API and expose the same methods and JavaScript result shapes.

Client lifetime and configuration

Reuse a long-lived DaprClient. Await outstanding operations before calling await client.stop() during application shutdown.

HTTP is the default protocol. To explicitly configure gRPC:

import { CommunicationProtocolEnum, DaprClient } from "@dapr/dapr";

const client = new DaprClient({
 daprHost: "127.0.0.1",
 daprPort: "50001",
 communicationProtocol: CommunicationProtocolEnum.GRPC,
 daprApiToken: process.env.DAPR_API_TOKEN,
});

For HTTP, use CommunicationProtocolEnum.HTTP and the sidecar’s HTTP port (default "3500"). Port values are strings. When host and port are not explicitly supplied, the SDK can use DAPR_HTTP_ENDPOINT or DAPR_GRPC_ENDPOINT for the selected protocol, or fall back to the host and port defaults and DAPR_HTTP_PORT or DAPR_GRPC_PORT. The API token defaults to DAPR_API_TOKEN. See client configuration.

Dapr Search JavaScript SDK on Dapr Docs

How to: Index and search documents with the Dapr JavaScript SDK

Prerequisites

Search client usage

Client lifetime and configuration