The `graphmind-sdk` is a TypeScript/Node.js client library designed to facilitate interaction with the Graphmind high-performance graph database, which natively supports OpenCypher. As of version 0.8.6, the SDK provides a comprehensive API for executing Cypher queries, managing graph schemas, performing health checks, and interacting with multi-tenant graph namespaces. It maintains a relatively active release cadence, frequently publishing patch versions. Key features include robust methods for standard query execution, schema introspection, query profiling, and an experimental natural language to Cypher (NLQ) translation capability. The SDK differentiates itself through its direct integration with Graphmind's performance optimizations and its support for distinct graph namespaces, enabling robust multi-tenancy scenarios.
npm install graphmind-sdkVerified import paths — ran on the pinned version, not inferred.
This quickstart initializes a Graphmind client, demonstrates creating and querying data using Cypher, fetches the database schema, and shows how to configure a client with an authentication token from environment variables.
Upgrade your Node.js environment to version 18 or higher.
Consult the official Graphmind SDK v0.8.0 changelog on GitHub for detailed breaking changes and migration steps.
Use `process.env.YOUR_TOKEN_VAR_NAME ?? ''` to retrieve authentication tokens, ensuring the environment variable is set in your deployment environment.
Ensure the Graphmind server is running and listening on `http://localhost:8080`, or update the `url` in `GraphmindClient` configuration to the correct server address.
Ensure you are using `import { GraphmindClient } from 'graphmind-sdk';` in an ESM-enabled Node.js environment or TypeScript project. If using CommonJS, configure your build system to handle ESM imports correctly or explicitly use dynamic imports if available.Double-check the method name (e.g., `query` vs `Query`). Ensure `new GraphmindClient(...)` was successfully called and that you `await` any asynchronous operations before trying to access methods on the returned client instance.
No dependency data recorded yet.