arangojs 7.8.0 → 8.0.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/CHANGELOG.md +264 -3
- package/CONTRIBUTING.md +1 -1
- package/MIGRATING.md +126 -2
- package/README.md +7 -13
- package/analyzer.d.ts +531 -253
- package/analyzer.d.ts.map +1 -1
- package/analyzer.js +9 -8
- package/analyzer.js.map +1 -1
- package/aql.d.ts +122 -139
- package/aql.d.ts.map +1 -1
- package/aql.js +146 -148
- package/aql.js.map +1 -1
- package/collection.d.ts +311 -310
- package/collection.d.ts.map +1 -1
- package/collection.js +163 -96
- package/collection.js.map +1 -1
- package/connection.d.ts +65 -52
- package/connection.d.ts.map +1 -1
- package/connection.js +142 -140
- package/connection.js.map +1 -1
- package/cursor.d.ts +108 -26
- package/cursor.d.ts.map +1 -1
- package/cursor.js +24 -23
- package/cursor.js.map +1 -1
- package/database.d.ts +298 -330
- package/database.d.ts.map +1 -1
- package/database.js +178 -252
- package/database.js.map +1 -1
- package/documents.d.ts +3 -4
- package/documents.d.ts.map +1 -1
- package/documents.js +0 -1
- package/documents.js.map +1 -1
- package/error.d.ts +3 -6
- package/error.d.ts.map +1 -1
- package/error.js +5 -7
- package/error.js.map +1 -1
- package/foxx-manifest.d.ts +7 -8
- package/foxx-manifest.d.ts.map +1 -1
- package/foxx-manifest.js +1 -1
- package/foxx-manifest.js.map +1 -1
- package/graph.d.ts +38 -56
- package/graph.d.ts.map +1 -1
- package/graph.js +59 -63
- package/graph.js.map +1 -1
- package/index.d.ts +6 -8
- package/index.d.ts.map +1 -1
- package/index.js +1 -6
- package/index.js.map +1 -1
- package/indexes.d.ts +348 -127
- package/indexes.d.ts.map +1 -1
- package/indexes.js +1 -3
- package/indexes.js.map +1 -1
- package/lib/blob.d.ts +0 -2
- package/lib/blob.d.ts.map +1 -1
- package/lib/blob.js +0 -1
- package/lib/blob.js.map +1 -1
- package/lib/btoa.d.ts +1 -3
- package/lib/btoa.d.ts.map +1 -1
- package/lib/btoa.js +3 -5
- package/lib/btoa.js.map +1 -1
- package/lib/btoa.web.d.ts +1 -3
- package/lib/btoa.web.d.ts.map +1 -1
- package/lib/btoa.web.js +4 -6
- package/lib/btoa.web.js.map +1 -1
- package/lib/codes.d.ts +2 -2
- package/lib/codes.d.ts.map +1 -1
- package/lib/codes.js +3 -3
- package/lib/codes.js.map +1 -1
- package/lib/errback.d.ts +0 -2
- package/lib/errback.d.ts.map +1 -1
- package/lib/errback.js.map +1 -1
- package/lib/joinPath.d.ts +0 -2
- package/lib/joinPath.d.ts.map +1 -1
- package/lib/joinPath.js +0 -2
- package/lib/joinPath.js.map +1 -1
- package/lib/joinPath.web.d.ts +1 -3
- package/lib/joinPath.web.d.ts.map +1 -1
- package/lib/joinPath.web.js +7 -4
- package/lib/joinPath.web.js.map +1 -1
- package/lib/multipart.d.ts +0 -4
- package/lib/multipart.d.ts.map +1 -1
- package/lib/multipart.js +16 -37
- package/lib/multipart.js.map +1 -1
- package/lib/multipart.web.d.ts +0 -2
- package/lib/multipart.web.d.ts.map +1 -1
- package/lib/multipart.web.js +0 -2
- package/lib/multipart.web.js.map +1 -1
- package/lib/normalizeUrl.d.ts +0 -2
- package/lib/normalizeUrl.d.ts.map +1 -1
- package/lib/normalizeUrl.js +0 -2
- package/lib/normalizeUrl.js.map +1 -1
- package/lib/omit.d.ts +1 -3
- package/lib/omit.d.ts.map +1 -1
- package/lib/omit.js +1 -2
- package/lib/omit.js.map +1 -1
- package/lib/querystringify.d.ts +4 -0
- package/lib/querystringify.d.ts.map +1 -0
- package/lib/querystringify.js +20 -0
- package/lib/querystringify.js.map +1 -0
- package/lib/querystringify.web.d.ts +2 -0
- package/lib/querystringify.web.d.ts.map +1 -0
- package/lib/querystringify.web.js +30 -0
- package/lib/querystringify.web.js.map +1 -0
- package/lib/request.d.ts +0 -1
- package/lib/request.d.ts.map +1 -1
- package/lib/request.js +6 -3
- package/lib/request.js.map +1 -1
- package/lib/request.node.d.ts +2 -8
- package/lib/request.node.d.ts.map +1 -1
- package/lib/request.node.js +16 -7
- package/lib/request.node.js.map +1 -1
- package/lib/request.web.d.ts +2 -3
- package/lib/request.web.d.ts.map +1 -1
- package/lib/request.web.js +26 -29
- package/lib/request.web.js.map +1 -1
- package/lib/xhr.d.ts +1 -3
- package/lib/xhr.d.ts.map +1 -1
- package/lib/xhr.js +0 -2
- package/lib/xhr.js.map +1 -1
- package/package.json +5 -6
- package/route.d.ts +1 -2
- package/route.d.ts.map +1 -1
- package/route.js +1 -2
- package/route.js.map +1 -1
- package/transaction.d.ts +31 -6
- package/transaction.d.ts.map +1 -1
- package/transaction.js +13 -6
- package/transaction.js.map +1 -1
- package/view.d.ts +237 -181
- package/view.d.ts.map +1 -1
- package/view.js +17 -25
- package/view.js.map +1 -1
- package/web.js +1 -1
- package/web.js.map +1 -1
- package/lib/error.d.ts +0 -18
- package/lib/error.d.ts.map +0 -1
- package/lib/error.js +0 -18
- package/lib/error.js.map +0 -1
package/view.d.ts
CHANGED
|
@@ -7,14 +7,8 @@
|
|
|
7
7
|
*
|
|
8
8
|
* @packageDocumentation
|
|
9
9
|
*/
|
|
10
|
-
import {
|
|
10
|
+
import { ArangoApiResponse } from "./connection";
|
|
11
11
|
import { Database } from "./database";
|
|
12
|
-
/**
|
|
13
|
-
* String values indicating the View type.
|
|
14
|
-
*/
|
|
15
|
-
export declare enum ViewType {
|
|
16
|
-
ARANGOSEARCH_VIEW = "arangosearch"
|
|
17
|
-
}
|
|
18
12
|
/**
|
|
19
13
|
* Indicates whether the given value represents a {@link View}.
|
|
20
14
|
*
|
|
@@ -22,30 +16,89 @@ export declare enum ViewType {
|
|
|
22
16
|
*/
|
|
23
17
|
export declare function isArangoView(view: any): view is View;
|
|
24
18
|
/**
|
|
25
|
-
*
|
|
19
|
+
* Sorting direction. Descending or ascending.
|
|
20
|
+
*/
|
|
21
|
+
export declare type Direction = "desc" | "asc";
|
|
22
|
+
/**
|
|
23
|
+
* Policy to consolidate based on segment byte size and live document count as
|
|
24
|
+
* dictated by the customization attributes.
|
|
25
|
+
*
|
|
26
|
+
* @deprecated The `bytes_accum` consolidation policy was deprecated in
|
|
27
|
+
* ArangoDB 3.7 and should be replaced with the `tier` consolidation policy.
|
|
26
28
|
*/
|
|
27
|
-
export declare type
|
|
29
|
+
export declare type BytesAccumConsolidationPolicy = {
|
|
28
30
|
/**
|
|
29
|
-
*
|
|
31
|
+
* Type of consolidation policy.
|
|
30
32
|
*/
|
|
31
|
-
|
|
33
|
+
type: "bytes_accum";
|
|
32
34
|
/**
|
|
33
|
-
*
|
|
35
|
+
* Must be in the range of `0.0` to `1.0`.
|
|
34
36
|
*/
|
|
35
|
-
|
|
37
|
+
threshold?: number;
|
|
38
|
+
};
|
|
39
|
+
/**
|
|
40
|
+
* Policy to consolidate if the sum of all candidate segment byte size is less
|
|
41
|
+
* than the total segment byte size multiplied by a given threshold.
|
|
42
|
+
*/
|
|
43
|
+
export declare type TierConsolidationPolicy = {
|
|
36
44
|
/**
|
|
37
|
-
*
|
|
45
|
+
* Type of consolidation policy.
|
|
38
46
|
*/
|
|
39
|
-
|
|
47
|
+
type: "tier";
|
|
40
48
|
/**
|
|
41
|
-
*
|
|
49
|
+
* Size below which all segments are treated as equivalent.
|
|
50
|
+
*
|
|
51
|
+
* Default: `2097152` (2 MiB)
|
|
42
52
|
*/
|
|
43
|
-
|
|
53
|
+
segmentsBytesFloor?: number;
|
|
54
|
+
/**
|
|
55
|
+
* Maximum allowed size of all consolidation segments.
|
|
56
|
+
*
|
|
57
|
+
* Default: `5368709120` (5 GiB)
|
|
58
|
+
*/
|
|
59
|
+
segmentsBytesMax?: number;
|
|
60
|
+
/**
|
|
61
|
+
* Maximum number of segments that are evaluated as candidates for
|
|
62
|
+
* consolidation.
|
|
63
|
+
*
|
|
64
|
+
* Default: `10`
|
|
65
|
+
*/
|
|
66
|
+
segmentsMax?: number;
|
|
67
|
+
/**
|
|
68
|
+
* Minimum number of segments that are evaluated as candidates for
|
|
69
|
+
* consolidation.
|
|
70
|
+
*
|
|
71
|
+
* Default: `1`
|
|
72
|
+
*/
|
|
73
|
+
segmentsMin?: number;
|
|
74
|
+
/**
|
|
75
|
+
* Consolidation candidates with a score less than this value will be
|
|
76
|
+
* filtered out.
|
|
77
|
+
*
|
|
78
|
+
* Default: `0`
|
|
79
|
+
*/
|
|
80
|
+
minScore?: number;
|
|
44
81
|
};
|
|
82
|
+
/**
|
|
83
|
+
* Compression for storing data.
|
|
84
|
+
*/
|
|
85
|
+
export declare type Compression = "lz4" | "none";
|
|
86
|
+
/**
|
|
87
|
+
* Options for creating a View.
|
|
88
|
+
*/
|
|
89
|
+
export declare type CreateViewOptions = CreateArangoSearchViewOptions | CreateSearchAliasViewOptions;
|
|
90
|
+
/**
|
|
91
|
+
* Options for replacing a View's properties.
|
|
92
|
+
*/
|
|
93
|
+
export declare type ViewPropertiesOptions = ArangoSearchViewPropertiesOptions | SearchAliasViewPropertiesOptions;
|
|
94
|
+
/**
|
|
95
|
+
* Options for partially modifying a View's properties.
|
|
96
|
+
*/
|
|
97
|
+
export declare type ViewPatchPropertiesOptions = ArangoSearchViewPropertiesOptions | SearchAliasViewPatchPropertiesOptions;
|
|
45
98
|
/**
|
|
46
99
|
* A link definition for an ArangoSearch View.
|
|
47
100
|
*/
|
|
48
|
-
export declare type
|
|
101
|
+
export declare type ArangoSearchViewLinkOptions = {
|
|
49
102
|
/**
|
|
50
103
|
* A list of names of Analyzers to apply to values of processed document
|
|
51
104
|
* attributes.
|
|
@@ -55,9 +108,9 @@ export declare type ArangoSearchViewLink = {
|
|
|
55
108
|
analyzers?: string[];
|
|
56
109
|
/**
|
|
57
110
|
* An object mapping names of attributes to process for each document to
|
|
58
|
-
* {@link
|
|
111
|
+
* {@link ArangoSearchViewLinkOptions} definitions.
|
|
59
112
|
*/
|
|
60
|
-
fields?:
|
|
113
|
+
fields?: Record<string, ArangoSearchViewLinkOptions>;
|
|
61
114
|
/**
|
|
62
115
|
* If set to `true`, all document attributes will be processed, otherwise
|
|
63
116
|
* only the attributes in `fields` will be processed.
|
|
@@ -65,6 +118,12 @@ export declare type ArangoSearchViewLink = {
|
|
|
65
118
|
* Default: `false`
|
|
66
119
|
*/
|
|
67
120
|
includeAllFields?: boolean;
|
|
121
|
+
/**
|
|
122
|
+
* (Enterprise Edition only.) An object mapping attribute names to
|
|
123
|
+
* {@link ArangoSearchViewLinkOptions} definitions to index sub-objects
|
|
124
|
+
* stored in an array.
|
|
125
|
+
*/
|
|
126
|
+
nested?: Record<string, ArangoSearchViewLinkOptions>;
|
|
68
127
|
/**
|
|
69
128
|
* If set to `true`, the position of values in array values will be tracked,
|
|
70
129
|
* otherwise all values in an array will be treated as equal alternatives.
|
|
@@ -85,157 +144,53 @@ export declare type ArangoSearchViewLink = {
|
|
|
85
144
|
inBackground?: boolean;
|
|
86
145
|
};
|
|
87
146
|
/**
|
|
88
|
-
*
|
|
147
|
+
* Options for modifying the properties of an ArangoSearch View.
|
|
89
148
|
*/
|
|
90
|
-
export declare type
|
|
149
|
+
export declare type ArangoSearchViewPropertiesOptions = {
|
|
91
150
|
/**
|
|
92
151
|
* How many commits to wait between removing unused files.
|
|
152
|
+
*
|
|
153
|
+
* Default: `2`
|
|
93
154
|
*/
|
|
94
|
-
cleanupIntervalStep
|
|
155
|
+
cleanupIntervalStep?: number;
|
|
95
156
|
/**
|
|
96
157
|
* How long to wait between applying the `consolidationPolicy`.
|
|
158
|
+
*
|
|
159
|
+
* Default: `10000`
|
|
97
160
|
*/
|
|
98
|
-
consolidationIntervalMsec
|
|
99
|
-
/**
|
|
100
|
-
* Maximum number of writers cached in the pool.
|
|
101
|
-
*/
|
|
102
|
-
writebufferIdle: number;
|
|
103
|
-
/**
|
|
104
|
-
* Maximum number of concurrent active writers that perform a transaction.
|
|
105
|
-
*/
|
|
106
|
-
writebufferActive: number;
|
|
161
|
+
consolidationIntervalMsec?: number;
|
|
107
162
|
/**
|
|
108
|
-
*
|
|
163
|
+
* How long to wait between commiting View data store changes and making
|
|
164
|
+
* documents visible to queries.
|
|
165
|
+
*
|
|
166
|
+
* Default: `1000`
|
|
109
167
|
*/
|
|
110
|
-
|
|
168
|
+
commitIntervalMsec?: number;
|
|
111
169
|
/**
|
|
112
170
|
* Consolidation policy to apply for selecting which segments should be
|
|
113
171
|
* merged.
|
|
114
|
-
*/
|
|
115
|
-
consolidationPolicy: BytesAccumConsolidationPolicy | TierConsolidationPolicy;
|
|
116
|
-
/**
|
|
117
|
-
* Attribute path (`field`) for the value of each document that is
|
|
118
|
-
* used for sorting.
|
|
119
|
-
*/
|
|
120
|
-
primarySort: {
|
|
121
|
-
/**
|
|
122
|
-
* Attribute path for the value of each document used for
|
|
123
|
-
* sorting.
|
|
124
|
-
*/
|
|
125
|
-
field: string;
|
|
126
|
-
/**
|
|
127
|
-
* If set to `"asc"`, the primary sorting order is ascending.
|
|
128
|
-
* If set to `"desc"`, the primary sorting order is descending.
|
|
129
|
-
*/
|
|
130
|
-
direction: "desc" | "asc";
|
|
131
|
-
}[];
|
|
132
|
-
/**
|
|
133
|
-
* Compression to use for the primary sort data.
|
|
134
172
|
*
|
|
135
|
-
* Default: `"
|
|
136
|
-
*/
|
|
137
|
-
primarySortCompression: PrimarySortCompression;
|
|
138
|
-
/**
|
|
139
|
-
* Attribute paths for which values should be stored in the view index
|
|
140
|
-
* in addition to those used for sorting via `primarySort`.
|
|
173
|
+
* Default: `{ type: "tier" }`
|
|
141
174
|
*/
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* Attribute paths for which values should be stored in the view index
|
|
145
|
-
* in addition to those used for sorting via `primarySort`.
|
|
146
|
-
*/
|
|
147
|
-
fields: string[];
|
|
148
|
-
}[];
|
|
175
|
+
consolidationPolicy?: TierConsolidationPolicy;
|
|
149
176
|
/**
|
|
150
177
|
* An object mapping names of linked collections to
|
|
151
|
-
* {@link
|
|
152
|
-
*/
|
|
153
|
-
links: Dict<ArangoSearchViewLink | undefined>;
|
|
154
|
-
};
|
|
155
|
-
/**
|
|
156
|
-
* Policy to consolidate based on segment byte size and live document count as
|
|
157
|
-
* dictated by the customization attributes.
|
|
158
|
-
*/
|
|
159
|
-
export declare type BytesAccumConsolidationPolicy = {
|
|
160
|
-
/**
|
|
161
|
-
* Type of consolidation policy.
|
|
162
|
-
*/
|
|
163
|
-
type: "bytes_accum";
|
|
164
|
-
/**
|
|
165
|
-
* Must be in the range of `0.0` to `1.0`.
|
|
166
|
-
*/
|
|
167
|
-
threshold?: number;
|
|
168
|
-
};
|
|
169
|
-
/**
|
|
170
|
-
* Policy to consolidate if the sum of all candidate segment byte size is less
|
|
171
|
-
* than the total segment byte size multiplied by a given threshold.
|
|
172
|
-
*/
|
|
173
|
-
export declare type TierConsolidationPolicy = {
|
|
174
|
-
/**
|
|
175
|
-
* Type of consolidation policy.
|
|
178
|
+
* {@link ArangoSearchViewLinkOptions} definitions.
|
|
176
179
|
*/
|
|
177
|
-
|
|
178
|
-
/**
|
|
179
|
-
* Minimum number of segments that will be evaluated as candidates
|
|
180
|
-
* for consolidation.
|
|
181
|
-
*
|
|
182
|
-
* Default: `1`
|
|
183
|
-
*/
|
|
184
|
-
segmentsMin?: number;
|
|
185
|
-
/**
|
|
186
|
-
* Maximum number of segments that will be evaluated as candidates
|
|
187
|
-
* for consolidation.
|
|
188
|
-
*
|
|
189
|
-
* Default: `10`
|
|
190
|
-
*/
|
|
191
|
-
segmentsMax?: number;
|
|
192
|
-
/**
|
|
193
|
-
* Maximum allowed size of all consolidated segments.
|
|
194
|
-
*
|
|
195
|
-
* Default: `5368709120`, i.e. 5 GiB
|
|
196
|
-
*/
|
|
197
|
-
segmentsBytesMax?: number;
|
|
198
|
-
/**
|
|
199
|
-
* Defines the value to treat all smaller segments as equal for
|
|
200
|
-
* consolidation selection.
|
|
201
|
-
*
|
|
202
|
-
* Default: `2097152`, i.e. 2 MiB
|
|
203
|
-
*/
|
|
204
|
-
segmentsBytesFloor?: number;
|
|
205
|
-
/**
|
|
206
|
-
* Minimum score.
|
|
207
|
-
*/
|
|
208
|
-
minScore?: number;
|
|
180
|
+
links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
|
|
209
181
|
};
|
|
210
182
|
/**
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
* Default: `"lz4"`
|
|
183
|
+
* Options for partially modifying the properties of an ArangoSearch View.
|
|
214
184
|
*/
|
|
215
|
-
export declare type
|
|
185
|
+
export declare type ArangoSearchViewPatchPropertiesOptions = ArangoSearchViewPropertiesOptions;
|
|
216
186
|
/**
|
|
217
|
-
*
|
|
187
|
+
* Options for creating an ArangoSearch View.
|
|
218
188
|
*/
|
|
219
|
-
export declare type
|
|
189
|
+
export declare type CreateArangoSearchViewOptions = ArangoSearchViewPropertiesOptions & {
|
|
220
190
|
/**
|
|
221
|
-
*
|
|
222
|
-
*
|
|
223
|
-
* Default: `2`
|
|
224
|
-
*/
|
|
225
|
-
cleanupIntervalStep?: number;
|
|
226
|
-
/**
|
|
227
|
-
* How long to wait between applying the `consolidationPolicy`.
|
|
228
|
-
*
|
|
229
|
-
* Default: `10000`
|
|
230
|
-
*/
|
|
231
|
-
consolidationIntervalMsec?: number;
|
|
232
|
-
/**
|
|
233
|
-
* How long to wait between commiting View data store changes and making
|
|
234
|
-
* documents visible to queries.
|
|
235
|
-
*
|
|
236
|
-
* Default: `1000`
|
|
191
|
+
* Type of the View.
|
|
237
192
|
*/
|
|
238
|
-
|
|
193
|
+
type: "arangosearch";
|
|
239
194
|
/**
|
|
240
195
|
* Maximum number of writers cached in the pool.
|
|
241
196
|
*
|
|
@@ -251,14 +206,9 @@ export declare type ArangoSearchViewPropertiesOptions = {
|
|
|
251
206
|
/**
|
|
252
207
|
* Maximum memory byte size per writer before a writer flush is triggered.
|
|
253
208
|
*
|
|
254
|
-
* Default: `33554432
|
|
209
|
+
* Default: `33554432` (32 MiB)
|
|
255
210
|
*/
|
|
256
211
|
writebufferSizeMax?: number;
|
|
257
|
-
/**
|
|
258
|
-
* Consolidation policy to apply for selecting which segments should be
|
|
259
|
-
* merged.
|
|
260
|
-
*/
|
|
261
|
-
consolidationPolicy?: BytesAccumConsolidationPolicy | TierConsolidationPolicy;
|
|
262
212
|
/**
|
|
263
213
|
* Attribute path (`field`) for the value of each document that will be
|
|
264
214
|
* used for sorting.
|
|
@@ -279,7 +229,7 @@ export declare type ArangoSearchViewPropertiesOptions = {
|
|
|
279
229
|
* If set to `"asc"`, the primary sorting order will be ascending.
|
|
280
230
|
* If set to `"desc"`, the primary sorting order will be descending.
|
|
281
231
|
*/
|
|
282
|
-
direction:
|
|
232
|
+
direction: Direction;
|
|
283
233
|
} | {
|
|
284
234
|
/**
|
|
285
235
|
* Attribute path for the value of each document to use for
|
|
@@ -297,7 +247,7 @@ export declare type ArangoSearchViewPropertiesOptions = {
|
|
|
297
247
|
*
|
|
298
248
|
* Default: `"lz4"`
|
|
299
249
|
*/
|
|
300
|
-
primarySortCompression?:
|
|
250
|
+
primarySortCompression?: Compression;
|
|
301
251
|
/**
|
|
302
252
|
* Attribute paths for which values should be stored in the view index
|
|
303
253
|
* in addition to those used for sorting via `primarySort`.
|
|
@@ -308,25 +258,140 @@ export declare type ArangoSearchViewPropertiesOptions = {
|
|
|
308
258
|
* in addition to those used for sorting via `primarySort`.
|
|
309
259
|
*/
|
|
310
260
|
fields: string[];
|
|
261
|
+
/**
|
|
262
|
+
* How the attribute values should be compressed.
|
|
263
|
+
*
|
|
264
|
+
* Default: `"lz4"`
|
|
265
|
+
*/
|
|
266
|
+
compression?: Compression;
|
|
311
267
|
}[];
|
|
268
|
+
};
|
|
269
|
+
/**
|
|
270
|
+
* Options defining an index used in a SearchAlias View.
|
|
271
|
+
*/
|
|
272
|
+
export declare type SearchAliasViewIndexOptions = {
|
|
312
273
|
/**
|
|
313
|
-
*
|
|
314
|
-
|
|
274
|
+
* Name of a collection.
|
|
275
|
+
*/
|
|
276
|
+
collection: string;
|
|
277
|
+
/**
|
|
278
|
+
* Name of an inverted index in the collection.
|
|
315
279
|
*/
|
|
316
|
-
|
|
280
|
+
index: string;
|
|
317
281
|
};
|
|
318
282
|
/**
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
* See {@link ArangoSearchView} for the concrete type representing an
|
|
322
|
-
* ArangoSearch View.
|
|
283
|
+
* Options for modifying the properties of a SearchAlias View.
|
|
323
284
|
*/
|
|
324
|
-
export declare
|
|
285
|
+
export declare type SearchAliasViewPropertiesOptions = {
|
|
286
|
+
/**
|
|
287
|
+
* An array of inverted indexes to add to the View.
|
|
288
|
+
*/
|
|
289
|
+
indexes: SearchAliasViewIndexOptions[];
|
|
290
|
+
};
|
|
291
|
+
/**
|
|
292
|
+
* Options defining an index to be modified in a SearchAlias View.
|
|
293
|
+
*/
|
|
294
|
+
export declare type SearchAliasViewPatchIndexOptions = SearchAliasViewIndexOptions & {
|
|
295
|
+
/**
|
|
296
|
+
* Whether to add or remove the index.
|
|
297
|
+
*
|
|
298
|
+
* Default: `"add"`
|
|
299
|
+
*/
|
|
300
|
+
operation?: "add" | "del";
|
|
301
|
+
};
|
|
302
|
+
/**
|
|
303
|
+
* Options for partially modifying the properties of a SearchAlias View.
|
|
304
|
+
*/
|
|
305
|
+
export declare type SearchAliasViewPatchPropertiesOptions = {
|
|
306
|
+
/**
|
|
307
|
+
* An array of inverted indexes to add to the View.
|
|
308
|
+
*/
|
|
309
|
+
indexes: SearchAliasViewPatchIndexOptions[];
|
|
310
|
+
};
|
|
311
|
+
/**
|
|
312
|
+
* Options for creating a SearchAlias View.
|
|
313
|
+
*/
|
|
314
|
+
export declare type CreateSearchAliasViewOptions = SearchAliasViewPropertiesOptions & {
|
|
315
|
+
/**
|
|
316
|
+
* Type of the View.
|
|
317
|
+
*/
|
|
318
|
+
type: "search-alias";
|
|
319
|
+
};
|
|
320
|
+
/**
|
|
321
|
+
* Generic description of a View.
|
|
322
|
+
*/
|
|
323
|
+
export declare type GenericViewDescription = {
|
|
324
|
+
/**
|
|
325
|
+
* A globally unique identifier for this View.
|
|
326
|
+
*/
|
|
327
|
+
globallyUniqueId: string;
|
|
328
|
+
/**
|
|
329
|
+
* An identifier for this View.
|
|
330
|
+
*/
|
|
331
|
+
id: string;
|
|
332
|
+
/**
|
|
333
|
+
* Name of the View.
|
|
334
|
+
*/
|
|
335
|
+
name: string;
|
|
336
|
+
};
|
|
337
|
+
export declare type ViewDescription = ArangoSearchViewDescription | SearchAliasViewDescription;
|
|
338
|
+
export declare type ArangoSearchViewDescription = GenericViewDescription & {
|
|
339
|
+
type: "arangosearch";
|
|
340
|
+
};
|
|
341
|
+
export declare type SearchAliasViewDescription = GenericViewDescription & {
|
|
342
|
+
type: "search-alias";
|
|
343
|
+
};
|
|
344
|
+
export declare type ViewProperties = ArangoSearchViewProperties | SearchAliasViewProperties;
|
|
345
|
+
/**
|
|
346
|
+
* A link definition for an ArangoSearch View.
|
|
347
|
+
*/
|
|
348
|
+
export declare type ArangoSearchViewLink = {
|
|
349
|
+
analyzers: string[];
|
|
350
|
+
fields: Record<string, ArangoSearchViewLink>;
|
|
351
|
+
includeAllFields: boolean;
|
|
352
|
+
nested?: Record<string, ArangoSearchViewLink>;
|
|
353
|
+
trackListPositions: boolean;
|
|
354
|
+
storeValues: "none" | "id";
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* Properties of an ArangoSearch View.
|
|
358
|
+
*/
|
|
359
|
+
export declare type ArangoSearchViewProperties = ArangoSearchViewDescription & {
|
|
360
|
+
cleanupIntervalStep: number;
|
|
361
|
+
consolidationIntervalMsec: number;
|
|
362
|
+
commitIntervalMsec: number;
|
|
363
|
+
writebufferIdle: number;
|
|
364
|
+
writebufferActive: number;
|
|
365
|
+
writebufferSizeMax: number;
|
|
366
|
+
consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
|
|
367
|
+
primarySort: {
|
|
368
|
+
field: string;
|
|
369
|
+
direction: Direction;
|
|
370
|
+
}[];
|
|
371
|
+
primarySortCompression: Compression;
|
|
372
|
+
storedValues: {
|
|
373
|
+
fields: string[];
|
|
374
|
+
compression: Compression;
|
|
375
|
+
}[];
|
|
376
|
+
links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* Properties of a SearchAlias View.
|
|
380
|
+
*/
|
|
381
|
+
export declare type SearchAliasViewProperties = SearchAliasViewDescription & {
|
|
382
|
+
indexes: {
|
|
383
|
+
collection: string;
|
|
384
|
+
index: string;
|
|
385
|
+
}[];
|
|
386
|
+
};
|
|
387
|
+
/**
|
|
388
|
+
* Represents a View in a {@link database.Database}.
|
|
389
|
+
*/
|
|
390
|
+
export declare class View {
|
|
325
391
|
protected _name: string;
|
|
326
392
|
protected _db: Database;
|
|
327
393
|
/**
|
|
328
394
|
* @internal
|
|
329
|
-
* @hidden
|
|
330
395
|
*/
|
|
331
396
|
constructor(db: Database, name: string);
|
|
332
397
|
/**
|
|
@@ -350,7 +415,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
350
415
|
* // data contains general information about the View
|
|
351
416
|
* ```
|
|
352
417
|
*/
|
|
353
|
-
get(): Promise<ViewDescription
|
|
418
|
+
get(): Promise<ArangoApiResponse<ViewDescription>>;
|
|
354
419
|
/**
|
|
355
420
|
* Checks whether the View exists.
|
|
356
421
|
*
|
|
@@ -366,7 +431,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
366
431
|
/**
|
|
367
432
|
* Creates a View with the given `options` and the instance's name.
|
|
368
433
|
*
|
|
369
|
-
* See also {@link Database
|
|
434
|
+
* See also {@link database.Database#createView}.
|
|
370
435
|
*
|
|
371
436
|
* @example
|
|
372
437
|
* ```js
|
|
@@ -376,13 +441,11 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
376
441
|
* // the ArangoSearch View "potatoes" now exists
|
|
377
442
|
* ```
|
|
378
443
|
*/
|
|
379
|
-
create(options
|
|
380
|
-
type: ViewType;
|
|
381
|
-
}): Promise<ViewDescription & Properties>;
|
|
444
|
+
create<Options extends CreateViewOptions>(options: CreateViewOptions): Promise<typeof options extends CreateArangoSearchViewOptions ? ArangoSearchViewDescription : Options extends CreateSearchAliasViewOptions ? SearchAliasViewDescription : ViewDescription>;
|
|
382
445
|
/**
|
|
383
446
|
* Renames the View and updates the instance's `name` to `newName`.
|
|
384
447
|
*
|
|
385
|
-
* Additionally removes the instance from the {@link Database}'s internal
|
|
448
|
+
* Additionally removes the instance from the {@link database.Database}'s internal
|
|
386
449
|
* cache.
|
|
387
450
|
*
|
|
388
451
|
* **Note**: Renaming Views may not be supported when ArangoDB is
|
|
@@ -401,7 +464,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
401
464
|
* // view1 and view3 represent the same ArangoDB view!
|
|
402
465
|
* ```
|
|
403
466
|
*/
|
|
404
|
-
rename(newName: string): Promise<ViewDescription
|
|
467
|
+
rename(newName: string): Promise<ArangoApiResponse<ViewDescription>>;
|
|
405
468
|
/**
|
|
406
469
|
* Retrieves the View's properties.
|
|
407
470
|
*
|
|
@@ -413,7 +476,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
413
476
|
* // data contains the View's properties
|
|
414
477
|
* ```
|
|
415
478
|
*/
|
|
416
|
-
properties(): Promise<
|
|
479
|
+
properties(): Promise<ArangoApiResponse<ViewProperties>>;
|
|
417
480
|
/**
|
|
418
481
|
* Updates the properties of the View.
|
|
419
482
|
*
|
|
@@ -429,7 +492,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
429
492
|
* console.log(result.consolidationIntervalMsec); // 234
|
|
430
493
|
* ```
|
|
431
494
|
*/
|
|
432
|
-
updateProperties(properties?:
|
|
495
|
+
updateProperties<Properties extends ViewPatchPropertiesOptions | undefined>(properties?: Properties): Promise<Properties extends ArangoSearchViewPatchPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPatchPropertiesOptions ? SearchAliasViewProperties : ViewProperties>;
|
|
433
496
|
/**
|
|
434
497
|
* Replaces the properties of the View.
|
|
435
498
|
*
|
|
@@ -445,7 +508,7 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
445
508
|
* console.log(result.consolidationIntervalMsec); // 234
|
|
446
509
|
* ```
|
|
447
510
|
*/
|
|
448
|
-
replaceProperties(properties?:
|
|
511
|
+
replaceProperties<Properties extends ViewPropertiesOptions | undefined>(properties?: Properties): Promise<Properties extends ArangoSearchViewPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPropertiesOptions ? SearchAliasViewProperties : ViewProperties>;
|
|
449
512
|
/**
|
|
450
513
|
* Deletes the View from the database.
|
|
451
514
|
*
|
|
@@ -460,11 +523,4 @@ export declare class View<PropertiesOptions extends Record<string, any> = any, P
|
|
|
460
523
|
*/
|
|
461
524
|
drop(): Promise<boolean>;
|
|
462
525
|
}
|
|
463
|
-
/**
|
|
464
|
-
* Represents an ArangoSearch View in a {@link Database}.
|
|
465
|
-
*/
|
|
466
|
-
export interface ArangoSearchView extends View<ArangoSearchViewPropertiesOptions, ArangoSearchViewProperties & {
|
|
467
|
-
type: ViewType.ARANGOSEARCH_VIEW;
|
|
468
|
-
}> {
|
|
469
|
-
}
|
|
470
526
|
//# sourceMappingURL=view.d.ts.map
|
package/view.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"view.d.ts","sourceRoot":"","sources":["../src/view.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,IAAI,CAEpD;AAED;;GAEG;AACH,oBAAY,SAAS,GAAG,MAAM,GAAG,KAAK,CAAC;AAEvC;;;;;;GAMG;AACH,oBAAY,6BAA6B,GAAG;IAC1C;;OAEG;IACH,IAAI,EAAE,aAAa,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,oBAAY,uBAAuB,GAAG;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,oBAAY,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAEzC;;GAEG;AACH,oBAAY,iBAAiB,GACzB,6BAA6B,GAC7B,4BAA4B,CAAC;AAEjC;;GAEG;AACH,oBAAY,qBAAqB,GAC7B,iCAAiC,GACjC,gCAAgC,CAAC;AAErC;;GAEG;AACH,oBAAY,0BAA0B,GAClC,iCAAiC,GACjC,qCAAqC,CAAC;AAE1C;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IACrD;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IACrD;;;OAGG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,oBAAY,iCAAiC,GAAG;IAC9C;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,uBAAuB,CAAC;IAC9C;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,2BAA2B,EAAE,QAAQ,CAAC,CAAC,CAAC;CACrE,CAAC;AAEF;;GAEG;AACH,oBAAY,sCAAsC,GAChD,iCAAiC,CAAC;AAEpC;;GAEG;AACH,oBAAY,6BAA6B,GACvC,iCAAiC,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;IACrB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,CACV;QACE;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,SAAS,EAAE,SAAS,CAAC;KACtB,GACD;QACE;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;WAGG;QACH,GAAG,EAAE,OAAO,CAAC;KACd,CACJ,EAAE,CAAC;IACJ;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,WAAW,CAAC;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb;;;WAGG;QACH,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB;;;;WAIG;QACH,WAAW,CAAC,EAAE,WAAW,CAAC;KAC3B,EAAE,CAAC;CACL,CAAC;AAEJ;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,oBAAY,gCAAgC,GAAG;IAC7C;;OAEG;IACH,OAAO,EAAE,2BAA2B,EAAE,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,oBAAY,gCAAgC,GAAG,2BAA2B,GAAG;IAC3E;;;;OAIG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,oBAAY,qCAAqC,GAAG;IAClD;;OAEG;IACH,OAAO,EAAE,gCAAgC,EAAE,CAAC;CAC7C,CAAC;AAEF;;GAEG;AACH,oBAAY,4BAA4B,GAAG,gCAAgC,GAAG;IAC5E;;OAEG;IACH,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,oBAAY,sBAAsB,GAAG;IACnC;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,oBAAY,eAAe,GACvB,2BAA2B,GAC3B,0BAA0B,CAAC;AAE/B,oBAAY,2BAA2B,GAAG,sBAAsB,GAAG;IACjE,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;AAEF,oBAAY,0BAA0B,GAAG,sBAAsB,GAAG;IAChE,IAAI,EAAE,cAAc,CAAC;CACtB,CAAC;AAEF,oBAAY,cAAc,GACtB,0BAA0B,GAC1B,yBAAyB,CAAC;AAE9B;;GAEG;AACH,oBAAY,oBAAoB,GAAG;IACjC,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC7C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAC9C,kBAAkB,EAAE,OAAO,CAAC;IAC5B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG,2BAA2B,GAAG;IACrE,mBAAmB,EAAE,MAAM,CAAC;IAC5B,yBAAyB,EAAE,MAAM,CAAC;IAClC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,EAAE,uBAAuB,GAAG,6BAA6B,CAAC;IAC7E,WAAW,EAAE;QACX,KAAK,EAAE,MAAM,CAAC;QACd,SAAS,EAAE,SAAS,CAAC;KACtB,EAAE,CAAC;IACJ,sBAAsB,EAAE,WAAW,CAAC;IACpC,YAAY,EAAE;QACZ,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,WAAW,EAAE,WAAW,CAAC;KAC1B,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,CAAC,CAAC;CAC7D,CAAC;AAEF;;GAEG;AACH,oBAAY,yBAAyB,GAAG,0BAA0B,GAAG;IACnE,OAAO,EAAE;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAClD,CAAC;AAEF;;GAEG;AACH,qBAAa,IAAI;IACf,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC;IAExB;;OAEG;gBACS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;IAKtC;;;;OAIG;IACH,IAAI,YAAY,IAAI,IAAI,CAEvB;IAED;;OAEG;IACH,IAAI,IAAI,WAEP;IAED;;;;;;;;;;OAUG;IACH,GAAG,IAAI,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAMlD;;;;;;;;;;OAUG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC;IAYhC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,OAAO,SAAS,iBAAiB,EACtC,OAAO,EAAE,iBAAiB,GACzB,OAAO,CACR,OAAO,OAAO,SAAS,6BAA6B,GAChD,2BAA2B,GAC3B,OAAO,SAAS,4BAA4B,GAC5C,0BAA0B,GAC1B,eAAe,CACpB;IAWD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC;IAM1E;;;;;;;;;;OAUG;IACH,UAAU,IAAI,OAAO,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;IAMxD;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,UAAU,SAAS,0BAA0B,GAAG,SAAS,EACxE,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CACR,UAAU,SAAS,sCAAsC,GACrD,0BAA0B,GAC1B,UAAU,SAAS,qCAAqC,GACxD,yBAAyB,GACzB,cAAc,CACnB;IAQD;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,CAAC,UAAU,SAAS,qBAAqB,GAAG,SAAS,EACpE,UAAU,CAAC,EAAE,UAAU,GACtB,OAAO,CACR,UAAU,SAAS,iCAAiC,GAChD,0BAA0B,GAC1B,UAAU,SAAS,gCAAgC,GACnD,yBAAyB,GACzB,cAAc,CACnB;IAQD;;;;;;;;;;;OAWG;IACH,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;CASzB"}
|