@or-sdk/graph 1.8.1 → 1.9.0-beta.3803.0
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 +35 -3
- package/dist/cjs/Graphs.js +2 -1
- package/dist/cjs/Graphs.js.map +1 -1
- package/dist/esm/Graphs.js +2 -1
- package/dist/esm/Graphs.js.map +1 -1
- package/dist/types/Graphs.d.ts +3 -5
- package/dist/types/Graphs.d.ts.map +1 -1
- package/dist/types/types.d.ts +3 -3
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +2 -3
- package/src/Graphs.ts +13 -5
- package/src/types.ts +4 -1
package/README.md
CHANGED
|
@@ -55,11 +55,15 @@ Once you have an instance of the `Graphs` client, you can use its methods to int
|
|
|
55
55
|
Execute a query in a graph to retrieve, create, or manipulate data stored in the graph.
|
|
56
56
|
|
|
57
57
|
#### Params
|
|
58
|
-
- `query`: `ExecuteQueryArgs` - The query object containing the
|
|
58
|
+
- `query`: `ExecuteQueryArgs` - The query object containing the following properties:
|
|
59
|
+
- `graph`: `string` - The name of the graph to execute the query in
|
|
60
|
+
- `query`: `string` - The Cypher query string to execute
|
|
61
|
+
- `params`: `QueryParams` (optional) - Parameters to be used in the query as key-value pairs. Supports null, number, string, or boolean values
|
|
62
|
+
- `readonly`: `boolean` (optional) - Whether the query should be executed in read-only mode. When set to `true`, the query will be optimized for read operations and cannot modify the graph data
|
|
59
63
|
|
|
60
|
-
####
|
|
64
|
+
#### Examples
|
|
61
65
|
|
|
62
|
-
|
|
66
|
+
**Basic query with parameters:**
|
|
63
67
|
|
|
64
68
|
```typescript
|
|
65
69
|
const results = await graphs.query<{ p: Place }>({
|
|
@@ -85,6 +89,34 @@ const results = await graphs.query<{ p: Place }>({
|
|
|
85
89
|
]
|
|
86
90
|
```
|
|
87
91
|
|
|
92
|
+
**Read-only query:**
|
|
93
|
+
|
|
94
|
+
```typescript
|
|
95
|
+
const results = await graphs.query<{ p: Place }>({
|
|
96
|
+
graph: 'places',
|
|
97
|
+
query: 'MATCH (p: Place) WHERE p.lat > $minLat AND p.lng < $maxLng RETURN p',
|
|
98
|
+
params: {
|
|
99
|
+
minLat: 40.0,
|
|
100
|
+
maxLng: -74.0
|
|
101
|
+
},
|
|
102
|
+
readonly: true, // Optimizes query for read operations
|
|
103
|
+
});
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**Query with various parameter types:**
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
const results = await graphs.query<{ p: Place, r: Relationship }>({
|
|
110
|
+
graph: 'places',
|
|
111
|
+
query: 'MATCH (p: Place)-[r:CONNECTED_TO]->(other) WHERE p.active = $active AND p.rating >= $minRating RETURN p, r',
|
|
112
|
+
params: {
|
|
113
|
+
active: true, // boolean
|
|
114
|
+
minRating: 4.5, // number
|
|
115
|
+
excludeId: null // null value
|
|
116
|
+
},
|
|
117
|
+
});
|
|
118
|
+
```
|
|
119
|
+
|
|
88
120
|
### `transaction`
|
|
89
121
|
|
|
90
122
|
Execute a set of queries in a transaction in a specified graph. Transactions are used to perform multiple operations atomically, meaning that if any of the operations fail, all operations in the transaction are rolled back, ensuring data consistency.
|
package/dist/cjs/Graphs.js
CHANGED
|
@@ -79,12 +79,13 @@ var Graphs = (function (_super) {
|
|
|
79
79
|
}
|
|
80
80
|
Graphs.prototype.query = function (_a) {
|
|
81
81
|
return __awaiter(this, arguments, void 0, function (_b) {
|
|
82
|
-
var query = _b.query, params = _b.params, graph = _b.graph;
|
|
82
|
+
var query = _b.query, params = _b.params, graph = _b.graph, readonly = _b.readonly;
|
|
83
83
|
return __generator(this, function (_c) {
|
|
84
84
|
return [2, this.callApiV2({
|
|
85
85
|
data: {
|
|
86
86
|
query: query,
|
|
87
87
|
params: params,
|
|
88
|
+
readonly: readonly,
|
|
88
89
|
},
|
|
89
90
|
method: 'POST',
|
|
90
91
|
route: "graphs/".concat(graph, "/query"),
|
package/dist/cjs/Graphs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AAEpD,yCAA0C;
|
|
1
|
+
{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoD;AAEpD,yCAA0C;AAiB1C;IAA4B,0BAAI;IAC9B,gBAAY,MAAmB;QACrB,IAAA,KAAK,GAAwC,MAAM,MAA9C,EAAE,YAAY,GAA0B,MAAM,aAAhC,EAAE,SAAS,GAAe,MAAM,UAArB,EAAE,QAAQ,GAAK,MAAM,SAAX,CAAY;QAE5D,OAAA,MAAK,YAAC;YACJ,KAAK,OAAA;YACL,YAAY,cAAA;YACZ,UAAU,EAAE,uBAAW;YACvB,SAAS,WAAA;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC,SAAC;IACL,CAAC;IAmBY,sBAAK,GAAlB;4DAAsB,EAAoD;gBAAlD,KAAK,WAAA,EAAE,MAAM,YAAA,EAAE,KAAK,WAAA,EAAE,QAAQ,cAAA;;gBACpD,WAAO,IAAI,CAAC,SAAS,CAAW;wBAC9B,IAAI,EAAE;4BACJ,KAAK,OAAA;4BACL,MAAM,QAAA;4BACN,QAAQ,UAAA;yBACT;wBACD,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,iBAAU,KAAK,WAAQ;qBAC/B,CAAC,EAAC;;;KACJ;IAmBY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,OAAiC;;;gBACvE,WAAO,IAAI,CAAC,SAAS,CAAO;wBAC1B,IAAI,EAAE,OAAO;wBACb,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,iBAAU,KAAK,iBAAc;qBACrC,CAAC,EAAC;;;KACJ;IASY,2BAAU,GAAvB,UAAwB,IAAa;;;;;4BACtB,WAAM,IAAI,CAAC,SAAS,CAAqB;4BACpD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,QAAQ;4BACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,IAAI,GAAG,SAIX;wBAEF,WAAO,IAAA,eAAQ,EAAQ,IAAI,CAAC,EAAC;;;;KAC9B;IASY,6BAAY,GAAzB,UAA0B,IAAY;;;gBACpC,WAAO,IAAI,CAAC,SAAS,CAAY;wBAC/B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,IAAI,EAAE,KAAK;wBACX,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,QAAQ;qBAChB,CAAC,EAAC;;;KACJ;IAWY,4BAAW,GAAxB,UAAyB,KAAY;;;;gBAC3B,IAAI,GAAc,KAAK,KAAnB,EAAK,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAF,CAAW;gBAEhC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,KAAK,EAAE,iBAAU,IAAI,CAAE;wBACvB,MAAM,EAAE,KAAK;wBACb,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IASY,4BAAW,GAAxB,UAAyB,IAAY;;;gBACnC,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,IAAI,CAAE;qBACxB,CAAC,EAAC;;;KACJ;IAQY,0BAAS,GAAtB,UAAuB,KAAa,EAAE,EAAyB;;YAAvB,IAAA,IAAI,UAAA,EAAK,KAAK,cAAhB,QAAkB,CAAF;;gBACpD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;wBACxC,IAAI,EAAE,KAAK;qBACZ,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAa;;;;;4BACnC,WAAM,IAAI,CAAC,SAAS,CAAsB;4BACxD,MAAM,EAAE,KAAK;4BACb,KAAK,EAAE,iBAAU,KAAK,aAAU;4BAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,MAAA,EAAE,CAAC,CAAC,CAAC,EAAE;yBAC7B,CAAC,EAAA;;wBAJI,OAAO,GAAG,SAId;wBAEF,WAAO,IAAA,eAAQ,EAAQ,OAAO,CAAC,EAAC;;;;KACjC;IAUY,yBAAQ,GAArB,UAAsB,KAAa,EAAE,IAAY;;;gBAC/C,WAAO,IAAI,CAAC,SAAS,CAAQ;wBAC3B,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IAUY,4BAAW,GAAxB,UAAyB,KAAa,EAAE,IAAY;;;gBAClD,WAAO,IAAI,CAAC,SAAS,CAAgB;wBACnC,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,iBAAU,KAAK,sBAAY,IAAI,CAAE;qBACzC,CAAC,EAAC;;;KACJ;IAcY,6BAAY,GAAzB,UAA0B,KAAa,EAAE,IAAY;;;;;4BACjC,WAAM,IAAI,CAAC,SAAS,CAAqB;4BACzD,IAAI,EAAE,EAAE,IAAI,MAAA,EAAE;4BACd,MAAM,EAAE,MAAM;4BACd,KAAK,EAAE,iBAAU,KAAK,oBAAiB;yBACxC,CAAC,EAAA;;wBAJM,KAAK,GAAK,CAAA,SAIhB,CAAA,MAJW;wBAMb,WAAO,KAAK,EAAC;;;;KACd;IAkBY,2BAAU,GAAvB;4DAAwB,EAAoD;;gBAAlD,MAAM,YAAA,EAAE,UAAU,gBAAA,EAAE,YAAY,kBAAA;;;;wBAClD,KAAK,GAAG,oBAAa,MAAM,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,EAAxB,CAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,+BAA4B,CAAC;wBAEjG,WAAM,IAAI,CAAC,SAAS,CAAyB;gCACzD,IAAI,EAAE;oCACJ,KAAK,OAAA;oCACL,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;iCAC/B;gCACD,MAAM,EAAE,MAAM;gCACd,KAAK,EAAE,iBAAU,YAAY,WAAQ;6BACtC,CAAC,EAAA;;wBAPI,KAAK,GAAG,SAOZ;wBAEF,WAAO,KAAK,CAAC,CAAC,CAAC,EAAC;;;;KACjB;IACH,aAAC;AAAD,CAAC,AAtQD,CAA4B,WAAI,GAsQ/B;AAtQY,wBAAM"}
|
package/dist/esm/Graphs.js
CHANGED
|
@@ -32,11 +32,12 @@ export class Graphs extends Base {
|
|
|
32
32
|
});
|
|
33
33
|
}
|
|
34
34
|
query(_a) {
|
|
35
|
-
return __awaiter(this, arguments, void 0, function* ({ query, params, graph }) {
|
|
35
|
+
return __awaiter(this, arguments, void 0, function* ({ query, params, graph, readonly }) {
|
|
36
36
|
return this.callApiV2({
|
|
37
37
|
data: {
|
|
38
38
|
query,
|
|
39
39
|
params,
|
|
40
|
+
readonly,
|
|
40
41
|
},
|
|
41
42
|
method: 'POST',
|
|
42
43
|
route: `graphs/${graph}/query`,
|
package/dist/esm/Graphs.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAQ,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"Graphs.js","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAQ,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAiB1C,MAAM,OAAO,MAAO,SAAQ,IAAI;IAC9B,YAAY,MAAmB;QAC7B,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAE5D,KAAK,CAAC;YACJ,KAAK;YACL,YAAY;YACZ,UAAU,EAAE,WAAW;YACvB,SAAS;YACT,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;IACL,CAAC;IAmBY,KAAK;6DAAI,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAoB;YACxE,OAAO,IAAI,CAAC,SAAS,CAAW;gBAC9B,IAAI,EAAE;oBACJ,KAAK;oBACL,MAAM;oBACN,QAAQ;iBACT;gBACD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,QAAQ;aAC/B,CAAC,CAAC;QACL,CAAC;KAAA;IAmBY,WAAW,CAAC,KAAa,EAAE,OAAiC;;YACvE,OAAO,IAAI,CAAC,SAAS,CAAO;gBAC1B,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,cAAc;aACrC,CAAC,CAAC;QACL,CAAC;KAAA;IASY,UAAU,CAAC,IAAa;;YACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,CAAqB;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,IAAI,CAAC,CAAC;QAC/B,CAAC;KAAA;IASY,YAAY,CAAC,IAAY;;YACpC,OAAO,IAAI,CAAC,SAAS,CAAY;gBAC/B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,QAAQ;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAWY,WAAW,CAAC,KAAY;;YACnC,MAAM,EAAE,IAAI,KAAc,KAAK,EAAd,IAAI,UAAK,KAAK,EAAzB,QAAiB,CAAQ,CAAC;YAEhC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,KAAK,EAAE,UAAU,IAAI,EAAE;gBACvB,MAAM,EAAE,KAAK;gBACb,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IASY,WAAW,CAAC,IAAY;;YACnC,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,IAAI,EAAE;aACxB,CAAC,CAAC;QACL,CAAC;KAAA;IAQY,SAAS,CAAC,KAAa,EAAE,EAAyB;;gBAAzB,EAAE,IAAI,OAAmB,EAAd,KAAK,cAAhB,QAAkB,CAAF;YACpD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;gBACxC,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;QACL,CAAC;KAAA;IAUY,WAAW,CAAC,KAAa,EAAE,IAAa;;YACnD,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,SAAS,CAAsB;gBACxD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,UAAU;gBAChC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE;aAC7B,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAQ,OAAO,CAAC,CAAC;QAClC,CAAC;KAAA;IAUY,QAAQ,CAAC,KAAa,EAAE,IAAY;;YAC/C,OAAO,IAAI,CAAC,SAAS,CAAQ;gBAC3B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;IAUY,WAAW,CAAC,KAAa,EAAE,IAAY;;YAClD,OAAO,IAAI,CAAC,SAAS,CAAgB;gBACnC,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,UAAU,KAAK,YAAY,IAAI,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;KAAA;IAcY,YAAY,CAAC,KAAa,EAAE,IAAY;;YACnD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAqB;gBACzD,IAAI,EAAE,EAAE,IAAI,EAAE;gBACd,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,KAAK,iBAAiB;aACxC,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC;QACf,CAAC;KAAA;IAkBY,UAAU;6DAAC,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAkB;YAC1E,MAAM,KAAK,GAAG,aAAa,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,IAAI,EAAE,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,4BAA4B,CAAC;YAE/G,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAyB;gBACzD,IAAI,EAAE;oBACJ,KAAK;oBACL,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE;iBAC/B;gBACD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,UAAU,YAAY,QAAQ;aACtC,CAAC,CAAC;YAEH,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;KAAA;CACF"}
|
package/dist/types/Graphs.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Base, List } from '@or-sdk/base';
|
|
2
|
-
import { WriteResponse, Graph, ExecuteQueryArgs, GraphInfo, GraphConfig, Query, ExecuteTransactionArgs, CreateNodeArgs, Node } from './types';
|
|
2
|
+
import { WriteResponse, Graph, ExecuteQueryArgs, GraphInfo, GraphConfig, Query, ExecuteTransactionArgs, CreateNodeArgs, Node, NodeProperties } from './types';
|
|
3
3
|
export declare class Graphs extends Base {
|
|
4
4
|
constructor(params: GraphConfig);
|
|
5
|
-
query<T>({ query, params, graph }: ExecuteQueryArgs): Promise<T[]>;
|
|
5
|
+
query<T>({ query, params, graph, readonly }: ExecuteQueryArgs): Promise<T[]>;
|
|
6
6
|
transaction(graph: string, queries: ExecuteTransactionArgs[]): Promise<void>;
|
|
7
7
|
listGraphs(name?: string): Promise<List<Graph>>;
|
|
8
8
|
getGraphInfo(name: string): Promise<GraphInfo>;
|
|
@@ -14,8 +14,6 @@ export declare class Graphs extends Base {
|
|
|
14
14
|
getQuery(graph: string, name: string): Promise<Query>;
|
|
15
15
|
deleteQuery(graph: string, name: string): Promise<WriteResponse>;
|
|
16
16
|
textToCypher(graph: string, text: string): Promise<string>;
|
|
17
|
-
createNode({ labels, properties, databaseName }: CreateNodeArgs): Promise<Node<
|
|
18
|
-
[p: string]: any;
|
|
19
|
-
}>>;
|
|
17
|
+
createNode({ labels, properties, databaseName }: CreateNodeArgs): Promise<Node<NodeProperties>>;
|
|
20
18
|
}
|
|
21
19
|
//# sourceMappingURL=Graphs.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Graphs.d.ts","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAGpD,OAAO,EACL,aAAa,EACb,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,WAAW,EAEX,KAAK,EAEL,sBAAsB,
|
|
1
|
+
{"version":3,"file":"Graphs.d.ts","sourceRoot":"","sources":["../../src/Graphs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAY,MAAM,cAAc,CAAC;AAGpD,OAAO,EACL,aAAa,EACb,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,WAAW,EAEX,KAAK,EAEL,sBAAsB,EACtB,cAAc,EACd,IAAI,EACJ,cAAc,EACf,MAAM,SAAS,CAAC;AAGjB,qBAAa,MAAO,SAAQ,IAAI;gBAClB,MAAM,EAAE,WAAW;IA6BlB,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,gBAAgB;IA6B7D,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,sBAAsB,EAAE;IAe5D,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAiB/C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAgB9C,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,aAAa,CAAC;IAiBjD,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAajD,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,EAAE,KAAK;IAgBlD,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM;IAkBxC,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAepC,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAmBhE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA0B1D,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;CAc7G"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -10,12 +10,11 @@ export type ExecuteQueryArgs = {
|
|
|
10
10
|
query: string;
|
|
11
11
|
params?: QueryParams;
|
|
12
12
|
graph: string;
|
|
13
|
+
readonly?: boolean;
|
|
13
14
|
};
|
|
14
15
|
export type CreateNodeArgs = {
|
|
15
16
|
labels: string[];
|
|
16
|
-
properties:
|
|
17
|
-
[key: string]: string | number | boolean;
|
|
18
|
-
};
|
|
17
|
+
properties: NodeProperties;
|
|
19
18
|
databaseName: string;
|
|
20
19
|
};
|
|
21
20
|
export type ExecuteTransactionArgs = {
|
|
@@ -55,4 +54,5 @@ export type Query = {
|
|
|
55
54
|
params?: QueryParams;
|
|
56
55
|
};
|
|
57
56
|
export type ListQueriesResponse = Query[];
|
|
57
|
+
export type NodeProperties = Record<string, string | number | boolean>;
|
|
58
58
|
//# sourceMappingURL=types.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG;IAIxB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE3E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC,MAAM,MAAM,WAAW,GAAG;IAIxB,KAAK,EAAE,KAAK,CAAC;IAKb,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,SAAS,CAAC,EAAE,MAAM,CAAC;IAKnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE3E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,cAAc,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,KAAK,EAAE,CAAC;AAEzC,MAAM,MAAM,aAAa,GAAG;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG;IAC9B,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,IAAI,CAAC,CAAC,IAAI;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,CAAC,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;IACtB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,EAAE,CAAC,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,KAAK,GAAG;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG,KAAK,EAAE,CAAC;AAE1C,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@or-sdk/graph",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.9.0-beta.3803.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"main": "dist/cjs/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -26,6 +26,5 @@
|
|
|
26
26
|
},
|
|
27
27
|
"publishConfig": {
|
|
28
28
|
"access": "public"
|
|
29
|
-
}
|
|
30
|
-
"gitHead": "80d7f96b381692d6b26862d8141251f0a4458f9f"
|
|
29
|
+
}
|
|
31
30
|
}
|
package/src/Graphs.ts
CHANGED
|
@@ -10,7 +10,10 @@ import {
|
|
|
10
10
|
ListGraphsResponse,
|
|
11
11
|
Query,
|
|
12
12
|
ListQueriesResponse,
|
|
13
|
-
ExecuteTransactionArgs,
|
|
13
|
+
ExecuteTransactionArgs,
|
|
14
|
+
CreateNodeArgs,
|
|
15
|
+
Node,
|
|
16
|
+
NodeProperties,
|
|
14
17
|
} from './types';
|
|
15
18
|
|
|
16
19
|
|
|
@@ -44,11 +47,12 @@ export class Graphs extends Base {
|
|
|
44
47
|
* ```
|
|
45
48
|
* @returns Query results as array
|
|
46
49
|
*/
|
|
47
|
-
public async query<T>({ query, params, graph }: ExecuteQueryArgs) {
|
|
50
|
+
public async query<T>({ query, params, graph, readonly }: ExecuteQueryArgs) {
|
|
48
51
|
return this.callApiV2<Array<T>>({
|
|
49
52
|
data: {
|
|
50
53
|
query,
|
|
51
54
|
params,
|
|
55
|
+
readonly,
|
|
52
56
|
},
|
|
53
57
|
method: 'POST',
|
|
54
58
|
route: `graphs/${graph}/query`,
|
|
@@ -254,13 +258,17 @@ export class Graphs extends Base {
|
|
|
254
258
|
* @returns {Promise<Node>} Promise that returns created node
|
|
255
259
|
*
|
|
256
260
|
* ```typescript
|
|
257
|
-
* const node = await graph.createNode(
|
|
261
|
+
* const node = await graph.createNode({
|
|
262
|
+
* labels: ['Label1', 'Label2'],
|
|
263
|
+
* properties: { name: 'Node' },
|
|
264
|
+
* databaseName: 'my-graph'
|
|
265
|
+
* });
|
|
258
266
|
* ```
|
|
259
267
|
*/
|
|
260
|
-
public async createNode({ labels, properties, databaseName }: CreateNodeArgs): Promise<Node<
|
|
268
|
+
public async createNode({ labels, properties, databaseName }: CreateNodeArgs): Promise<Node<NodeProperties>> {
|
|
261
269
|
const query = `CREATE (n:${labels.map(label => '`' + label.trim() + '`').join(':')}) SET n = $params RETURN n`;
|
|
262
270
|
|
|
263
|
-
const nodes = await this.callApiV2<Node<
|
|
271
|
+
const nodes = await this.callApiV2<Node<NodeProperties>[]>({
|
|
264
272
|
data: {
|
|
265
273
|
query,
|
|
266
274
|
params: { params: properties },
|
package/src/types.ts
CHANGED
|
@@ -28,11 +28,12 @@ export type ExecuteQueryArgs = {
|
|
|
28
28
|
query: string;
|
|
29
29
|
params?: QueryParams;
|
|
30
30
|
graph: string;
|
|
31
|
+
readonly?: boolean;
|
|
31
32
|
};
|
|
32
33
|
|
|
33
34
|
export type CreateNodeArgs = {
|
|
34
35
|
labels: string[];
|
|
35
|
-
properties:
|
|
36
|
+
properties: NodeProperties;
|
|
36
37
|
databaseName: string;
|
|
37
38
|
};
|
|
38
39
|
|
|
@@ -82,3 +83,5 @@ export type Query = {
|
|
|
82
83
|
|
|
83
84
|
export type ListQueriesResponse = Query[];
|
|
84
85
|
|
|
86
|
+
export type NodeProperties = Record<string, string | number | boolean>;
|
|
87
|
+
|