graphmind-sdk 0.6.2 → 0.6.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +73 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Graphmind SDK for TypeScript/Node.js
|
|
2
|
+
|
|
3
|
+
TypeScript/Node.js client SDK for [Graphmind](https://github.com/fab679/graphmind) — a high-performance graph database with OpenCypher support.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install graphmind-sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Quick Start
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { GraphmindClient } from 'graphmind-sdk';
|
|
15
|
+
|
|
16
|
+
const client = new GraphmindClient({ url: 'http://localhost:8080' });
|
|
17
|
+
|
|
18
|
+
// Create data
|
|
19
|
+
await client.query('CREATE (a:Person {name: "Alice", age: 30})');
|
|
20
|
+
await client.query('CREATE (b:Person {name: "Bob", age: 25})');
|
|
21
|
+
|
|
22
|
+
// Query
|
|
23
|
+
const result = await client.query('MATCH (n:Person) RETURN n.name, n.age');
|
|
24
|
+
console.log(result);
|
|
25
|
+
|
|
26
|
+
// Schema
|
|
27
|
+
const schema = await client.schema();
|
|
28
|
+
console.log(schema);
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Authentication
|
|
32
|
+
|
|
33
|
+
```typescript
|
|
34
|
+
const client = new GraphmindClient({
|
|
35
|
+
url: 'http://localhost:8080',
|
|
36
|
+
token: 'my-secret-token',
|
|
37
|
+
});
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## API Reference
|
|
41
|
+
|
|
42
|
+
| Method | Description |
|
|
43
|
+
|--------|-------------|
|
|
44
|
+
| `query(cypher, graph?)` | Execute Cypher query (read or write) |
|
|
45
|
+
| `schema(graph?)` | Get schema introspection |
|
|
46
|
+
| `explain(cypher, graph?)` | Show execution plan |
|
|
47
|
+
| `profile(cypher, graph?)` | Execute with profiling |
|
|
48
|
+
| `executeScript(script, graph?)` | Multi-statement execution |
|
|
49
|
+
| `nlq(question, graph?)` | Natural language to Cypher |
|
|
50
|
+
| `status()` | Server health check |
|
|
51
|
+
| `ping()` | Connectivity test |
|
|
52
|
+
| `listGraphs()` | List all graph namespaces |
|
|
53
|
+
| `deleteGraph(name)` | Delete a graph namespace |
|
|
54
|
+
|
|
55
|
+
## Multi-Tenancy
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
// Queries target isolated graph namespaces
|
|
59
|
+
await client.query('CREATE (n:User {name: "Alice"})', 'production');
|
|
60
|
+
await client.query('CREATE (n:User {name: "Test"})', 'staging');
|
|
61
|
+
|
|
62
|
+
const graphs = await client.listGraphs();
|
|
63
|
+
// ['default', 'production', 'staging']
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Requirements
|
|
67
|
+
|
|
68
|
+
- Node.js 18+
|
|
69
|
+
- A running Graphmind server
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
Apache-2.0 — see [LICENSE](../../LICENSE)
|