-
\ No newline at end of file
diff --git a/devel/classes/cursor.ArrayCursor.html b/devel/classes/cursor.ArrayCursor.html
index da5783b70..02f05efa4 100644
--- a/devel/classes/cursor.ArrayCursor.html
+++ b/devel/classes/cursor.ArrayCursor.html
@@ -1,156 +1,50 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Analyzer
Hierarchy
--
-
- Analyzer
Accessors
-name
--
-
- get name(): string -
-
--
Name of this Analyzer.
-See also Database.
-Returns string
Methods
-create
--
-
- create<Options>(options: Options): Promise<Options extends CreateIdentityAnalyzerOptions ? IdentityAnalyzerDescription : Options extends CreateDelimiterAnalyzerOptions ? DelimiterAnalyzerDescription : Options extends CreateStemAnalyzerOptions ? StemAnalyzerDescription : Options extends CreateNormAnalyzerOptions ? NormAnalyzerDescription : Options extends CreateNgramAnalyzerOptions ? NgramAnalyzerDescription : Options extends CreateTextAnalyzerOptions ? TextAnalyzerDescription : Options extends CreateSegmentationAnalyzerOptions ? SegmentationAnalyzerDescription : Options extends CreateAqlAnalyzerOptions ? AqlAnalyzerDescription : Options extends CreatePipelineAnalyzerOptions ? PipelineAnalyzerDescription : Options extends CreateStopwordsAnalyzerOptions ? StopwordsAnalyzerDescription : Options extends CreateCollationAnalyzerOptions ? CollationAnalyzerDescription : Options extends CreateMinHashAnalyzerOptions ? MinHashAnalyzerDescription : Options extends CreateClassificationAnalyzerOptions ? ClassificationAnalyzerDescription : Options extends CreateNearestNeighborsAnalyzerOptions ? NearestNeighborsAnalyzerDescription : Options extends CreateGeoJsonAnalyzerOptions ? GeoJsonAnalyzerDescription : Options extends CreateGeoPointAnalyzerOptions ? GeoPointAnalyzerDescription : Options extends CreateGeoS2AnalyzerOptions ? GeoS2AnalyzerDescription : AnalyzerDescription> -
-
--
Creates a new Analyzer with the given
-optionsand the instance's name.See also createAnalyzer.
- -Example
-const db = new Database();
const analyzer = db.analyzer("potatoes");
await analyzer.create({ type: "identity" });
// the identity Analyzer "potatoes" now exists -- -Type Parameters
--
-
-
-
Options extends CreateAnalyzerOptions
--Parameters
--
-
-
-
options: Options
-Options for creating the Analyzer.
-
Returns Promise<Options extends CreateIdentityAnalyzerOptions ? IdentityAnalyzerDescription : Options extends CreateDelimiterAnalyzerOptions ? DelimiterAnalyzerDescription : Options extends CreateStemAnalyzerOptions ? StemAnalyzerDescription : Options extends CreateNormAnalyzerOptions ? NormAnalyzerDescription : Options extends CreateNgramAnalyzerOptions ? NgramAnalyzerDescription : Options extends CreateTextAnalyzerOptions ? TextAnalyzerDescription : Options extends CreateSegmentationAnalyzerOptions ? SegmentationAnalyzerDescription : Options extends CreateAqlAnalyzerOptions ? AqlAnalyzerDescription : Options extends CreatePipelineAnalyzerOptions ? PipelineAnalyzerDescription : Options extends CreateStopwordsAnalyzerOptions ? StopwordsAnalyzerDescription : Options extends CreateCollationAnalyzerOptions ? CollationAnalyzerDescription : Options extends CreateMinHashAnalyzerOptions ? MinHashAnalyzerDescription : Options extends CreateClassificationAnalyzerOptions ? ClassificationAnalyzerDescription : Options extends CreateNearestNeighborsAnalyzerOptions ? NearestNeighborsAnalyzerDescription : Options extends CreateGeoJsonAnalyzerOptions ? GeoJsonAnalyzerDescription : Options extends CreateGeoPointAnalyzerOptions ? GeoPointAnalyzerDescription : Options extends CreateGeoS2AnalyzerOptions ? GeoS2AnalyzerDescription : AnalyzerDescription>
-
-
drop
--
-
- drop(force?: boolean): Promise<ArangoApiResponse<{
    name: string;
}>>
- -
--
Deletes the Analyzer from the database.
- -Example
-const db = new Database();
const analyzer = db.analyzer("some-analyzer");
await analyzer.drop();
// the Analyzer "some-analyzer" no longer exists --Parameters
--
-
-
-
force: boolean = false
-Whether the Analyzer should still be deleted even if it +
Analyzer | arangojs --Class Analyzer
Represents an Analyzer in a database.Database.
+Accessors
database
name
- get name(): string
Name of this Analyzer.
+See also database.Database.
+Returns string
Methods
create
- create<Options>(options): Promise<Options extends CreateIdentityAnalyzerOptions
    ? IdentityAnalyzerDescription
    : Options extends CreateDelimiterAnalyzerOptions
        ? DelimiterAnalyzerDescription
        : Options extends CreateStemAnalyzerOptions
            ? StemAnalyzerDescription
            : Options extends CreateNormAnalyzerOptions
                ? NormAnalyzerDescription
                : Options extends CreateNgramAnalyzerOptions
                    ? NgramAnalyzerDescription
                    : Options extends CreateTextAnalyzerOptions
                        ? TextAnalyzerDescription
                        : Options extends CreateSegmentationAnalyzerOptions
                            ? SegmentationAnalyzerDescription
                            : Options extends CreateAqlAnalyzerOptions
                                ? AqlAnalyzerDescription
                                : Options extends CreatePipelineAnalyzerOptions
                                    ? PipelineAnalyzerDescription
                                    : (...) extends (...)
                                        ? (...)
                                        : (...)> Creates a new Analyzer with the given
+optionsand the instance's name.See also database.Database#createAnalyzer.
+Type Parameters
- Options extends CreateAnalyzerOptions
Parameters
- options: Options
Options for creating the Analyzer.
+
Returns Promise<Options extends CreateIdentityAnalyzerOptions
    ? IdentityAnalyzerDescription
    : Options extends CreateDelimiterAnalyzerOptions
        ? DelimiterAnalyzerDescription
        : Options extends CreateStemAnalyzerOptions
            ? StemAnalyzerDescription
            : Options extends CreateNormAnalyzerOptions
                ? NormAnalyzerDescription
                : Options extends CreateNgramAnalyzerOptions
                    ? NgramAnalyzerDescription
                    : Options extends CreateTextAnalyzerOptions
                        ? TextAnalyzerDescription
                        : Options extends CreateSegmentationAnalyzerOptions
                            ? SegmentationAnalyzerDescription
                            : Options extends CreateAqlAnalyzerOptions
                                ? AqlAnalyzerDescription
                                : Options extends CreatePipelineAnalyzerOptions
                                    ? PipelineAnalyzerDescription
                                    : (...) extends (...)
                                        ? (...)
                                        : (...)>Example
+const db = new Database();
const analyzer = db.analyzer("potatoes");
await analyzer.create({ type: "identity" });
// the identity Analyzer "potatoes" now exists +
drop
- drop(force?): Promise<ArangoApiResponse<{
    name: string;
}>> Deletes the Analyzer from the database.
+-Parameters
- force: boolean = false
Whether the Analyzer should still be deleted even if it is currently in use.
-
Returns Promise<ArangoApiResponse<{
    name: string;
}>>- force: boolean = false
- -exists
-- get
--
-
- get(): Promise<ArangoApiResponse<AnalyzerDescription>> -
-
--
Retrieves the Analyzer definition for the Analyzer.
- -Example
-const db = new Database();
const analyzer = db.analyzer("some-analyzer");
const definition = await analyzer.get();
// definition contains the Analyzer definition -Returns Promise<ArangoApiResponse<AnalyzerDescription>>
-- \ No newline at end of file +Generated using TypeDoc
Returns Promise<ArangoApiResponse<{
    name: string;
}>>Example
+const db = new Database();
const analyzer = db.analyzer("some-analyzer");
await analyzer.drop();
// the Analyzer "some-analyzer" no longer exists + -
-
exists
get
- get(): Promise<ArangoApiResponse<AnalyzerDescription>>
Retrieves the Analyzer definition for the Analyzer.
+Returns Promise<ArangoApiResponse<AnalyzerDescription>>
Example
+const db = new Database();
const analyzer = db.analyzer("some-analyzer");
const definition = await analyzer.get();
// definition contains the Analyzer definition +
-
\ No newline at end of file
diff --git a/devel/classes/cursor.BatchedArrayCursor.html b/devel/classes/cursor.BatchedArrayCursor.html
index 20df01912..dd49f08fe 100644
--- a/devel/classes/cursor.BatchedArrayCursor.html
+++ b/devel/classes/cursor.BatchedArrayCursor.html
@@ -1,168 +1,53 @@
-
-
-ArrayCursor | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-has
- has
-
-[async
- [async
-
-flat
- flat
-for
- for
-
-
-
-
-
-
-
-
-Class ArrayCursor<T>
The ArrayCursor type represents a cursor returned from a
-query.
Class ArrayCursor<T>
The ArrayCursor type represents a cursor returned from a
+database.Database#query.
When using TypeScript, cursors can be cast to a specific item type in order to increase type safety.
-See also BatchedArrayCursor.
- -Example
const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const result = await db.query(query) as ArrayCursor<number>;
-Example
const db = new Database();
const query = aql`FOR x IN 1..10 RETURN x`;
const cursor = await db.query(query);
for await (const value of cursor) {
// Process each value asynchronously
await processValue(value);
}
-Type Parameters
--
-
-
-
T = any
-Type to use for each item. Defaults to
-any.
Hierarchy
--
-
- ArrayCursor
Accessors
-batches
--
-
- get batches(): BatchedArrayCursor<T> -
-
-
A BatchedArrayCursor providing batch-wise access to the cursor +
See also BatchedArrayCursor.
+Example
+const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const result = await db.query(query) as ArrayCursor<number>; +Example
+const db = new Database();
const query = aql`FOR x IN 1..10 RETURN x`;
const cursor = await db.query(query);
for await (const value of cursor) {
// Process each value asynchronously
await processValue(value);
} +
Type Parameters
Accessors
batches
- get batches(): BatchedArrayCursor<T>
- -
A BatchedArrayCursor providing batch-wise access to the cursor result set.
-See also items.
-Returns BatchedArrayCursor<T>
count
--
-
- get count(): undefined | number -
-
-
Total number of documents in the query result. Only available if the +
See also BatchedArrayCursor#items.
+Returns BatchedArrayCursor<T>
count
- get count(): undefined | number
- -
Total number of documents in the query result. Only available if the
-countoption was used.Returns undefined | number
extra
--
-
- get extra(): CursorExtras -
-
--
Additional information about the cursor.
-Returns CursorExtras
has
--
-
- get hasNext(): boolean -
-
-
Whether the cursor has more values. If set to
false, the cursor has +Returns undefined | number
database
extra
- get extra(): CursorExtras
Additional information about the cursor.
+Returns CursorExtras
has
- get hasNext(): boolean
- -
Whether the cursor has more values. If set to
-false, the cursor has already been depleted and contains no more items.Returns boolean
Methods
-[async
-id
- get id(): undefined | string
ID of this cursor.
+Returns undefined | string
Methods
[async
- [async
Iterator](): AsyncGenerator<T, undefined, undefined> - -
Enables use with
for awaitto deplete the cursor by asynchronously yielding every value in the cursor's remaining result set.Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.
- -Example
-const cursor = await db.query(aql`
FOR user IN users
FILTER user.isActive
RETURN user
`);
for await (const user of cursor) {
console.log(user.email, user.isAdmin);
} -Returns AsyncGenerator<T, undefined, undefined>
all
--
-
- all(): Promise<T[]> -
-
-
Depletes the cursor, then returns an array containing all values in the +
Returns AsyncGenerator<T, undefined, undefined>
Example
+const cursor = await db.query(aql`
FOR user IN users
FILTER user.isActive
RETURN user
`);
for await (const user of cursor) {
console.log(user.email, user.isAdmin);
} +
all
- all(): Promise<T[]>
- -
Depletes the cursor, then returns an array containing all values in the cursor's remaining result list.
- -Example
-const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.all(); // [1, 2, 3, 4, 5]
console.log(cursor.hasNext); // false -Returns Promise<T[]>
flat
--
-
- flat
Map<R>(callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R | R[])): Promise<R[]>
- -
-
Depletes the cursor by applying the
callbackfunction to each item in +Returns Promise<T[]>
Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.all(); // [1, 2, 3, 4, 5]
console.log(cursor.hasNext); // false +
flat
- flat
Map<R>(callback): Promise<R[]> - -
Depletes the cursor by applying the
callbackfunction to each item in the cursor's remaining result list. Returns an array containing the return values ofcallbackfor each item, flattened to a depth of 1.Note: If the result set spans multiple batches, any remaining batches @@ -159,51 +53,13 @@
flat
Map See also:
- -Array.prototype.flatMap.Example
- -const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const squares = await cursor.flatMap((currentValue) => {
return [currentValue, currentValue ** 2];
});
console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
console.log(cursor.hasNext); // false -Example
-const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odds = await cursor.flatMap((currentValue) => {
if (currentValue % 2 === 0) {
return []; // empty array flattens into nothing
}
return currentValue; // or [currentValue]
});
console.logs(odds); // [1, 3, 5] -- -Type Parameters
--
-
-
-
R
-Return type of the
-callbackfunction.
--Parameters
--
-
-
-
callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R | R[])
--Function to execute on each element.
--
-
-
-
-
-
- (currentValue: T, index: number, self: ArrayCursor<T>): R | R[] -
-
---
Parameters
--
-
-
-
currentValue: T
- -
-
index: number
- -
-
self: ArrayCursor<T>
Returns R | R[]
-
-
-
-
Returns Promise<R[]>
-
-
for
--
-
- for
Each(callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => false | void)): Promise<boolean>
- -
-
Advances the cursor by applying the
callbackfunction to each item in +Type Parameters
Parameters
Returns Promise<R[]>
Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const squares = await cursor.flatMap((currentValue) => {
return [currentValue, currentValue ** 2];
});
console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
console.log(cursor.hasNext); // false +Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odds = await cursor.flatMap((currentValue) => {
if (currentValue % 2 === 0) {
return []; // empty array flattens into nothing
}
return currentValue; // or [currentValue]
});
console.logs(odds); // [1, 3, 5] +
for
- for
Each(callback): Promise<boolean> - -
Advances the cursor by applying the
@@ -213,185 +69,56 @@callbackfunction to each item in the cursor's remaining result list until the cursor is depleted orcallbackreturns the exact valuefalse. Returns a promise that evalues totrueunless the function returnedfalse.for
Each See also:
- -Array.prototype.forEach.Example
- -const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.forEach((currentValue) => {
console.log(currentValue);
});
console.log(result) // true
console.log(cursor.hasNext); // false -Example
-const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.forEach((currentValue) => {
console.log(currentValue);
return false; // stop after the first item
});
console.log(result); // false
console.log(cursor.hasNext); // true ---Parameters
--
-
-
-
callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => false | void)
--Function to execute on each element.
--
-
-
-
-
-
- (currentValue: T, index: number, self: ArrayCursor<T>): false | void -
-
---
Parameters
--
-
-
-
currentValue: T
- -
-
index: number
- -
-
self: ArrayCursor<T>
Returns false | void
-
-
-
-
Returns Promise<boolean>
-
-
kill
--
-
- kill(): Promise<void> -
-
-
Kills the cursor and frees up associated database resources.
+Parameters
- callback: ((currentValue, index, self) => false | void)
Function to execute on each element.
+- (currentValue, index, self): false | void
Parameters
- currentValue: T
- index: number
- self: this
Returns false | void
Returns Promise<boolean>
Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.forEach((currentValue) => {
console.log(currentValue);
});
console.log(result) // true
console.log(cursor.hasNext); // false +Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.forEach((currentValue) => {
console.log(currentValue);
return false; // stop after the first item
});
console.log(result); // false
console.log(cursor.hasNext); // true + - callback: ((currentValue, index, self) => false | void)
kill
- kill(): Promise<void>
- -
Kills the cursor and frees up associated database resources.
This method has no effect if all batches have already been fetched.
- -Example
-const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
console.log(cursor1.hasMore); // false
await cursor1.kill(); // no effect
const cursor2 = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
console.log(cursor2.hasMore); // true
await cursor2.kill(); // cursor is depleted -Returns Promise<void>
map
--
-
- map<R>(callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R)): Promise<R[]> -
-
-
Depletes the cursor by applying the
callbackfunction to each item in +Returns Promise<void>
Example
+const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
console.log(cursor1.hasMore); // false
await cursor1.kill(); // no effect
const cursor2 = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
console.log(cursor2.hasMore); // true
await cursor2.kill(); // cursor is depleted +
map
- map<R>(callback): Promise<R[]>
- -
Depletes the cursor by applying the
callbackfunction to each item in the cursor's remaining result list. Returns an array containing the return values ofcallbackfor each item.Note: This creates an array of all return values, which may impact memory use when working with very large query result sets. Consider using -forEach, reduce or -flatMap instead.
+ArrayCursor#forEach, ArrayCursor#reduce or +ArrayCursor#flatMap instead.See also:
- -Array.prototype.map.Example
-const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const squares = await cursor.map((currentValue) => {
return currentValue ** 2;
});
console.log(squares); // [1, 4, 9, 16, 25]
console.log(cursor.hasNext); // false -- -Type Parameters
--
-
-
-
R
-Return type of the
-callbackfunction.
--Parameters
--
-
-
-
callback: ((currentValue: T, index: number, self: ArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (currentValue: T, index: number, self: ArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
currentValue: T
- -
-
index: number
- -
-
self: ArrayCursor<T>
Returns R
-
-
-
-
Returns Promise<R[]>
-
-
next
--
-
- next(): Promise<undefined | T> -
-
-
Advances the cursor and returns the next value in the cursor's remaining +
Type Parameters
Parameters
Returns Promise<R[]>
Example
+const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const squares = await cursor.map((currentValue) => {
return currentValue ** 2;
});
console.log(squares); // [1, 4, 9, 16, 25]
console.log(cursor.hasNext); // false +
next
- next(): Promise<undefined | T>
- -
Advances the cursor and returns the next value in the cursor's remaining result list, or
undefinedif the cursor has been depleted.Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.
- -Example
-const cursor = await db.query(aql`FOR x IN 1..3 RETURN x`);
const one = await cursor.next(); // 1
const two = await cursor.next(); // 2
const three = await cursor.next(); // 3
const empty = await cursor.next(); // undefined -Returns Promise<undefined | T>
reduce
--
-
- reduce<R>(reducer: ((accumulator: R, currentValue: T, index: number, self: ArrayCursor<T>) => R), initialValue: R): Promise<R> -
-
-
Depletes the cursor by applying the
reducerfunction to each item in +Returns Promise<undefined | T>
Example
+const cursor = await db.query(aql`FOR x IN 1..3 RETURN x`);
const one = await cursor.next(); // 1
const two = await cursor.next(); // 2
const three = await cursor.next(); // 3
const empty = await cursor.next(); // undefined +
reduce
- reduce<R>(reducer, initialValue): Promise<R>
- -
Depletes the cursor by applying the
reducerfunction to each item in the cursor's remaining result list. Returns the return value ofreducerfor the last item.Note: Most complex uses of the
+simpler code using ArrayCursor#forEach or thereducemethod can be replaced with -simpler code using forEach or thefor awaitsyntax.for awaitsyntax.Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.
See also:
- -Array.prototype.reduce.Example
- -function largestOfTwo(one, two) {
return Math.max(one, two);
}
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce(largestOfTwo, 0);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.reduce(largestOfTwo, 0);
console.log(emptyResult); // 0 -Example
-// BAD! NEEDLESSLY COMPLEX!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce((accumulator, currentValue) => {
if (currentValue % 2 === 0) {
accumulator.even.push(...currentValue);
} else {
accumulator.odd.push(...currentValue);
}
return accumulator;
}, { odd: [], even: [] });
console.log(result); // { odd: [1, 3, 5], even: [2, 4] }
// GOOD! MUCH SIMPLER!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odd = [];
const even = [];
for await (const currentValue of cursor) {
if (currentValue % 2 === 0) {
even.push(currentValue);
} else {
odd.push(currentValue);
}
}
console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } -- -Type Parameters
--
-
-
-
R
-Return type of the
-reducerfunction.
-Parameters
--
-
-
-
reducer: ((accumulator: R, currentValue: T, index: number, self: ArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (accumulator: R, currentValue: T, index: number, self: ArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
accumulator: R
- -
-
currentValue: T
- -
-
index: number
- -
-
self: ArrayCursor<T>
Returns R
-
-
- -
-
-
-
initialValue: R
-Initial value of the
accumulatorvalue passed to +Type Parameters
-Parameters
Returns Promise<R>
- - reduce<R>(reducer: ((accumulator: T | R, currentValue: T, index: number, self: ArrayCursor<T>) => R)): Promise<undefined | R> -
-
-
Depletes the cursor by applying the
reducerfunction to each item in +
Returns Promise<R>
Example
+function largestOfTwo(one, two) {
return Math.max(one, two);
}
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce(largestOfTwo, 0);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.reduce(largestOfTwo, 0);
console.log(emptyResult); // 0 +Example
+// BAD! NEEDLESSLY COMPLEX!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce((accumulator, currentValue) => {
if (currentValue % 2 === 0) {
accumulator.even.push(...currentValue);
} else {
accumulator.odd.push(...currentValue);
}
return accumulator;
}, { odd: [], even: [] });
console.log(result); // { odd: [1, 3, 5], even: [2, 4] }
// GOOD! MUCH SIMPLER!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odd = [];
const even = [];
for await (const currentValue of cursor) {
if (currentValue % 2 === 0) {
even.push(currentValue);
} else {
odd.push(currentValue);
}
}
console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } + -
-
- reduce<R>(reducer): Promise<undefined | R>
- -
Depletes the cursor by applying the
reducerfunction to each item in the cursor's remaining result list. Returns the return value ofreducerfor the last item.Note: If the result set spans multiple batches, any remaining batches @@ -400,90 +127,8 @@
Returns Promise
See also:
- -Array.prototype.reduce.Example
-function largestOfTwo(one, two) {
return Math.max(one, two);
}
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce(largestOfTwo);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.reduce(largestOfTwo);
console.log(emptyResult); // undefined -- -Type Parameters
--
-
-
-
R
-Return type of the
-reducerfunction.
--Parameters
--
-
-
-
reducer: ((accumulator: T | R, currentValue: T, index: number, self: ArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (accumulator: T | R, currentValue: T, index: number, self: ArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
accumulator: T | R
- -
-
currentValue: T
- -
-
index: number
- -
-
self: ArrayCursor<T>
Returns R
-
-
-
-
Returns Promise<undefined | R>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Parameters
Parameters
Returns Promise<undefined | R>
Example
function largestOfTwo(one, two) {
return Math.max(one, two);
}
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const result = await cursor.reduce(largestOfTwo);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.reduce(largestOfTwo);
console.log(emptyResult); // undefined
+
-
\ No newline at end of file
diff --git a/devel/classes/database.Database.html b/devel/classes/database.Database.html
index 653c1b11b..c4d4072fc 100644
--- a/devel/classes/database.Database.html
+++ b/devel/classes/database.Database.html
@@ -1,1095 +1,385 @@
-
-
-BatchedArrayCursor | arangojs
-
-
-
-
-
-
-
-
-
-
-
-has
- has
-has
- has
-
-
-[async
- [async
-
-flat
- flat
-for
- for
-
-load
- load
-
-
-
-
-
-
-
-Class BatchedArrayCursor<T>
The BatchedArrayCursor provides a batch-wise API to an ArrayCursor.
Class BatchedArrayCursor<T>
The BatchedArrayCursor provides a batch-wise API to an ArrayCursor.
When using TypeScript, cursors can be cast to a specific item type in order to increase type safety.
- -Example
const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const cursor = await db.query(query) as ArrayCursor<number>;
const batches = cursor.batches;
-Example
const db = new Database();
const query = aql`FOR x IN 1..10000 RETURN x`;
const cursor = await db.query(query, { batchSize: 10 });
for await (const batch of cursor.batches) {
// Process all values in a batch in parallel
await Promise.all(batch.map(
value => asyncProcessValue(value)
));
}
-Type Parameters
--
-
-
-
T = any
-Type to use for each item. Defaults to
-any.
Hierarchy
--
-
- BatchedArrayCursor
Accessors
-count
--
-
- get count(): undefined | number -
-
-
Total number of documents in the query result. Only available if the +
Example
+const db = new Database();
const query = aql`FOR x IN 1..5 RETURN x`;
const cursor = await db.query(query) as ArrayCursor<number>;
const batches = cursor.batches; +Example
+const db = new Database();
const query = aql`FOR x IN 1..10000 RETURN x`;
const cursor = await db.query(query, { batchSize: 10 });
for await (const batch of cursor.batches) {
// Process all values in a batch in parallel
await Promise.all(batch.map(
value => asyncProcessValue(value)
));
} +
Type Parameters
Accessors
count
- get count(): undefined | number
- -
Total number of documents in the query result. Only available if the
-countoption was used.Returns undefined | number
extra
--
-
- get extra(): Readonly<CursorExtras> -
-
--
Additional information about the cursor.
-Returns Readonly<CursorExtras>
has
--
-
- get hasMore(): boolean -
-
-
Whether the cursor has any remaining batches that haven't yet been +
Returns undefined | number
database
extra
- get extra(): Readonly<CursorExtras>
Additional information about the cursor.
+Returns Readonly<CursorExtras>
has
- get hasMore(): boolean
- -
Whether the cursor has any remaining batches that haven't yet been fetched. If set to
-false, all batches have been fetched and no additional requests to the server will be made when consuming any remaining batches from this cursor.Returns boolean
has
--
-
- get hasNext(): boolean -
-
-
Whether the cursor has more batches. If set to
false, the cursor has +Returns boolean
has
- get hasNext(): boolean
- -
Whether the cursor has more batches. If set to
-false, the cursor has already been depleted and contains no more batches.Returns boolean
items
--
-
- get items(): ArrayCursor<T> -
-
--
An ArrayCursor providing item-wise access to the cursor result set.
-See also batches.
-Returns ArrayCursor<T>
Methods
-[async
-id
- get id(): undefined | string
ID of this cursor.
+Returns undefined | string
items
- get items(): ArrayCursor<T>
An ArrayCursor providing item-wise access to the cursor result set.
+See also ArrayCursor#batches.
+Returns ArrayCursor<T>
Methods
[async
- [async
Iterator](): AsyncGenerator<T[], undefined, undefined> - -
Enables use with
for awaitto deplete the cursor by asynchronously yielding every batch in the cursor's remaining result set.Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the processing speed, this may result in the server discarding the cursor before it is fully depleted.
- -Example
-const cursor = await db.query(aql`
FOR user IN users
FILTER user.isActive
RETURN user
`);
for await (const users of cursor.batches) {
for (const user of users) {
console.log(user.email, user.isAdmin);
}
} -Returns AsyncGenerator<T[], undefined, undefined>
all
--
-
- all(): Promise<T[][]> -
-
-
Depletes the cursor, then returns an array containing all batches in the +
Returns AsyncGenerator<T[], undefined, undefined>
Example
+const cursor = await db.query(aql`
FOR user IN users
FILTER user.isActive
RETURN user
`);
for await (const users of cursor.batches) {
for (const user of users) {
console.log(user.email, user.isAdmin);
}
} +
all
- all(): Promise<T[][]>
- -
Depletes the cursor, then returns an array containing all batches in the cursor's remaining result list.
- -Example
-const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.all(); // [[1, 2], [3, 4], [5]]
console.log(cursor.hasNext); // false -Returns Promise<T[][]>
flat
--
-
- flat
Map<R>(callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R | R[])): Promise<R[]>
- -
-
Depletes the cursor by applying the
callbackfunction to each batch in +Returns Promise<T[][]>
Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.all(); // [[1, 2], [3, 4], [5]]
console.log(cursor.hasNext); // false +
flat
- flat
Map<R>(callback): Promise<R[]> - -
Depletes the cursor by applying the
callbackfunction to each batch in the cursor's remaining result list. Returns an array containing the return values ofcallbackfor each batch, flattened to a depth of 1.Note: If the result set spans multiple batches, any remaining batches @@ -171,51 +56,13 @@
flat
Map See also:
- -Array.prototype.flatMap.Example
- -const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const squares = await cursor.batches.flatMap((currentBatch) => {
return currentBatch.map((value) => value ** 2);
});
console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
console.log(cursor.hasNext); // false -Example
-const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
const odds = await cursor.batches.flatMap((currentBatch) => {
if (currentBatch[0] % 2 === 0) {
return []; // empty array flattens into nothing
}
return currentBatch;
});
console.logs(odds); // [1, 3, 5] -- -Type Parameters
--
-
-
-
R
-Return type of the
-callbackfunction.
--Parameters
--
-
-
-
callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R | R[])
--Function to execute on each element.
--
-
-
-
-
-
- (currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R | R[] -
-
---
Parameters
--
-
-
-
currentBatch: T[]
- -
-
index: number
- -
-
self: BatchedArrayCursor<T>
Returns R | R[]
-
-
-
-
Returns Promise<R[]>
-
-
for
--
-
- for
Each(callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => false | void)): Promise<boolean>
- -
-
Advances the cursor by applying the
callbackfunction to each item in +Type Parameters
Parameters
Returns Promise<R[]>
Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const squares = await cursor.batches.flatMap((currentBatch) => {
return currentBatch.map((value) => value ** 2);
});
console.log(squares); // [1, 1, 2, 4, 3, 9, 4, 16, 5, 25]
console.log(cursor.hasNext); // false +Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
const odds = await cursor.batches.flatMap((currentBatch) => {
if (currentBatch[0] % 2 === 0) {
return []; // empty array flattens into nothing
}
return currentBatch;
});
console.logs(odds); // [1, 3, 5] +
for
- for
Each(callback): Promise<boolean> - -
Advances the cursor by applying the
@@ -225,123 +72,34 @@callbackfunction to each item in the cursor's remaining result list until the cursor is depleted orcallbackreturns the exact valuefalse. Returns a promise that evalues totrueunless the function returnedfalse.for
Each See also:
- -Array.prototype.forEach.Example
- -const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.forEach((currentBatch) => {
for (const value of currentBatch) {
console.log(value);
}
});
console.log(result) // true
console.log(cursor.hasNext); // false -Example
-const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.forEach((currentBatch) => {
for (const value of currentBatch) {
console.log(value);
}
return false; // stop after the first batch
});
console.log(result); // false
console.log(cursor.hasNext); // true ---Parameters
--
-
-
-
callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => false | void)
--Function to execute on each element.
--
-
-
-
-
-
- (currentBatch: T[], index: number, self: BatchedArrayCursor<T>): false | void -
-
---
Parameters
--
-
-
-
currentBatch: T[]
- -
-
index: number
- -
-
self: BatchedArrayCursor<T>
Returns false | void
-
-
-
-
Returns Promise<boolean>
-
-
kill
--
-
- kill(): Promise<void> -
-
-
Drains the cursor and frees up associated database resources.
+Parameters
- callback: ((currentBatch, index, self) => false | void)
Function to execute on each element.
+- (currentBatch, index, self): false | void
Parameters
- currentBatch: T[]
- index: number
- self: this
Returns false | void
Returns Promise<boolean>
Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.forEach((currentBatch) => {
for (const value of currentBatch) {
console.log(value);
}
});
console.log(result) // true
console.log(cursor.hasNext); // false +Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const result = await cursor.batches.forEach((currentBatch) => {
for (const value of currentBatch) {
console.log(value);
}
return false; // stop after the first batch
});
console.log(result); // false
console.log(cursor.hasNext); // true + - callback: ((currentBatch, index, self) => false | void)
kill
- kill(): Promise<void>
- -
Drains the cursor and frees up associated database resources.
This method has no effect if all batches have already been consumed.
- -Example
-const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
console.log(cursor1.hasMore); // false
await cursor1.kill(); // no effect
const cursor2 = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
console.log(cursor2.hasMore); // true
await cursor2.kill(); // cursor is depleted -Returns Promise<void>
load
--
-
- load
All(): Promise<void>
- -
-
Loads all remaining batches from the server.
+Returns Promise<void>
Example
+const cursor1 = await db.query(aql`FOR x IN 1..5 RETURN x`);
console.log(cursor1.hasMore); // false
await cursor1.kill(); // no effect
const cursor2 = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
console.log(cursor2.hasMore); // true
await cursor2.kill(); // cursor is depleted +
load
- load
All(): Promise<void> - -
Loads all remaining batches from the server.
Warning: This may impact memory use when working with very large query result sets.
- -Example
-const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
console.log(cursor.hasMore); // true
await cursor.batches.loadAll();
console.log(cursor.hasMore); // false
console.log(cursor.hasNext); // true
for await (const item of cursor) {
console.log(item);
// No server roundtrips necessary any more
} -Returns Promise<void>
map
--
-
- map<R>(callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)): Promise<R[]> -
-
-
Depletes the cursor by applying the
callbackfunction to each batch in +Returns Promise<void>
Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
console.log(cursor.hasMore); // true
await cursor.batches.loadAll();
console.log(cursor.hasMore); // false
console.log(cursor.hasNext); // true
for await (const item of cursor) {
console.log(item);
// No server roundtrips necessary any more
} +
map
- map<R>(callback): Promise<R[]>
- -
Depletes the cursor by applying the
callbackfunction to each batch in the cursor's remaining result list. Returns an array containing the return values ofcallbackfor each batch.Note: This creates an array of all return values, which may impact memory use when working with very large query result sets. Consider using -forEach, reduce or -flatMap instead.
+BatchedArrayCursor#forEach, BatchedArrayCursor#reduce or +BatchedArrayCursor#flatMap instead.See also:
- -Array.prototype.map.Example
-const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const squares = await cursor.batches.map((currentBatch) => {
return currentBatch.map((value) => value ** 2);
});
console.log(squares); // [[1, 4], [9, 16], [25]]
console.log(cursor.hasNext); // false -- -Type Parameters
--
-
-
-
R
-Return type of the
-callbackfunction.
--Parameters
--
-
-
-
callback: ((currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
currentBatch: T[]
- -
-
index: number
- -
-
self: BatchedArrayCursor<T>
Returns R
-
-
-
-
Returns Promise<R[]>
-
-
next
--
-
- next(): Promise<undefined | T[]> -
-
-
Advances the cursor and returns all remaining values in the cursor's +
Type Parameters
Parameters
Returns Promise<R[]>
Example
+const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 2 }
);
const squares = await cursor.batches.map((currentBatch) => {
return currentBatch.map((value) => value ** 2);
});
console.log(squares); // [[1, 4], [9, 16], [25]]
console.log(cursor.hasNext); // false +
next
- next(): Promise<undefined | T[]>
- -
Advances the cursor and returns all remaining values in the cursor's current batch. If the current batch has already been exhausted, fetches the next batch from the server and returns it, or
@@ -349,23 +107,13 @@undefinedif the cursor has been depleted.nextconst cursor = await db.query(
aql`FOR i IN 1..10 RETURN i`,
{ batchSize: 5 }
);
const firstBatch = await cursor.batches.next(); // [1, 2, 3, 4, 5]
await cursor.next(); // 6
const lastBatch = await cursor.batches.next(); // [7, 8, 9, 10]
console.log(cursor.hasNext); // false - -Returns Promise<undefined | T[]>
reduce
--
-
- reduce<R>(reducer: ((accumulator: R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R), initialValue: R): Promise<R> -
-
-
Depletes the cursor by applying the
reducerfunction to each batch in +Returns Promise<undefined | T[]>
Example
+const cursor = await db.query(
aql`FOR i IN 1..10 RETURN i`,
{ batchSize: 5 }
);
const firstBatch = await cursor.batches.next(); // [1, 2, 3, 4, 5]
await cursor.next(); // 6
const lastBatch = await cursor.batches.next(); // [7, 8, 9, 10]
console.log(cursor.hasNext); // false +
reduce
- reduce<R>(reducer, initialValue): Promise<R>
- -
Depletes the cursor by applying the
reducerfunction to each batch in the cursor's remaining result list. Returns the return value ofreducerfor the last batch.Note: Most complex uses of the
reducemethod can be replaced with -simpler code using forEach or thefor await+simpler code using BatchedArrayCursor#forEach or thefor awaitsyntax.Note: If the result set spans multiple batches, any remaining batches will only be fetched on demand. Depending on the cursor's TTL and the @@ -373,55 +121,15 @@
reduce
Array.prototype.reduce. - -Example
- -function largestValue(baseline, values) {
return Math.max(baseline, ...values);
}
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 3 }
);
const result = await cursor.batches.reduce(largestValue, 0);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.batches.reduce(largestValue, 0);
console.log(emptyResult); // 0 -Example
-// BAD! NEEDLESSLY COMPLEX!
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
const result = await cursor.reduce((accumulator, currentBatch) => {
if (currentBatch[0] % 2 === 0) {
accumulator.even.push(...currentBatch);
} else {
accumulator.odd.push(...currentBatch);
}
return accumulator;
}, { odd: [], even: [] });
console.log(result); // { odd: [1, 3, 5], even: [2, 4] }
// GOOD! MUCH SIMPLER!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odd = [];
const even = [];
for await (const currentBatch of cursor) {
if (currentBatch[0] % 2 === 0) {
even.push(...currentBatch);
} else {
odd.push(...currentBatch);
}
}
console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } -- -Type Parameters
--
-
-
-
R
-Return type of the
-reducerfunction.
-Parameters
--
-
-
-
reducer: ((accumulator: R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (accumulator: R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
accumulator: R
- -
-
currentBatch: T[]
- -
-
index: number
- -
-
self: BatchedArrayCursor<T>
Returns R
-
-
- -
-
-
-
initialValue: R
-Initial value of the
accumulatorvalue passed to +Type Parameters
-Parameters
Returns Promise<R>
- - reduce<R>(reducer: ((accumulator: T[] | R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)): Promise<undefined | R> -
-
-
Depletes the cursor by applying the
reducerfunction to each batch in +
Returns Promise<R>
Example
+function largestValue(baseline, values) {
return Math.max(baseline, ...values);
}
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 3 }
);
const result = await cursor.batches.reduce(largestValue, 0);
console.log(result); // 5
console.log(cursor.hasNext); // false
const emptyResult = await cursor.batches.reduce(largestValue, 0);
console.log(emptyResult); // 0 +Example
+// BAD! NEEDLESSLY COMPLEX!
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 1 }
);
const result = await cursor.reduce((accumulator, currentBatch) => {
if (currentBatch[0] % 2 === 0) {
accumulator.even.push(...currentBatch);
} else {
accumulator.odd.push(...currentBatch);
}
return accumulator;
}, { odd: [], even: [] });
console.log(result); // { odd: [1, 3, 5], even: [2, 4] }
// GOOD! MUCH SIMPLER!
const cursor = await db.query(aql`FOR x IN 1..5 RETURN x`);
const odd = [];
const even = [];
for await (const currentBatch of cursor) {
if (currentBatch[0] % 2 === 0) {
even.push(...currentBatch);
} else {
odd.push(...currentBatch);
}
}
console.log({ odd, even }); // { odd: [1, 3, 5], even: [2, 4] } + -
-
- reduce<R>(reducer): Promise<undefined | R>
- -
Depletes the cursor by applying the
reducerfunction to each batch in the cursor's remaining result list. Returns the return value ofreducerfor the last batch.Note: If the result set spans multiple batches, any remaining batches @@ -430,92 +138,8 @@
Returns Promise
See also:
- -Array.prototype.reduce.Example
-function largestValue(values1, values2) {
return [Math.max(...values1, ...values2)];
}
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 3 }
);
const result = await cursor.batches.reduce(largestValue);
console.log(result); // [5]
console.log(cursor.hasNext); // false -- -Type Parameters
--
-
-
-
R
-Return type of the
-reducerfunction.
--Parameters
--
-
-
-
reducer: ((accumulator: T[] | R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>) => R)
--Function to execute on each element.
--
-
-
-
-
-
- (accumulator: T[] | R, currentBatch: T[], index: number, self: BatchedArrayCursor<T>): R -
-
---
Parameters
--
-
-
-
accumulator: T[] | R
- -
-
currentBatch: T[]
- -
-
index: number
- -
-
self: BatchedArrayCursor<T>
Returns R
-
-
-
-
Returns Promise<undefined | R>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Parameters
Parameters
Returns Promise<undefined | R>
Example
function largestValue(values1, values2) {
return [Math.max(...values1, ...values2)];
}
const cursor = await db.query(
aql`FOR x IN 1..5 RETURN x`,
{ batchSize: 3 }
);
const result = await cursor.batches.reduce(largestValue);
console.log(result); // [5]
console.log(cursor.hasNext); // false
+
-WriteOperation | arangojs
-
-WriteOperation | arangojs AgentOptions | arangojs
-
-ArangoApiResponse | arangojs
-
-ArangoApiResponse | arangojs ArangoResponseMetadata | arangojs
-
-ArangoResponseMetadata | arangojs BasicAuthCredentials | arangojs
-
-BasicAuthCredentials | arangojs BearerAuthCredentials | arangojs
-
-BearerAuthCredentials | arangojs Config | arangojs
-
-
-
-Database | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-queue
-
queue
-
-acquire
- acquire
-
-
-begin
- begin
clear
clear
-
-
-
-commit
- commit
compute
create
create
-create
- create
-create
- create
-create
- create
create
create
-create
- create
-create
-
-
-create
-
-
- create
create
-
-delete
-
-
-delete
- delete
delete
-delete
-
-
-download
- delete
download
-drop
-
-
-drop
- execute
execute
-
-
-get
-
-
-get
-
-
-get
-
-
-get
-
-
-get
-
-
-get
- get
get
get
get
get
get
get
get
-get
- get
-get
-
-
-get
- get
get
-get
- get
-
-
-install
-
-
-
-
-kill
-
-
-list
- install
kill
list
-list
- list
-list
-
-
-list
-
-
-list
-
-
-list
- list
list
list
list
-list
- list
list
list
list
-list
-
-
-list
-
-
-list
- list
list
list
-list
- list
-list
- list
-list
- list
-
-
-query
-
-
-query
-
-
-rebalance
- query
query
rebalance
-remove
-
-
-rename
- remove
rename
-rename
- rename
-renew
- renew
-replace
- replace
-replace
- replace
replace
replace
restore
- run
run
set
-set
- set
-set
-
-
-set
- set
set
-
-
-
-
-
-
-uninstall
-
-
-update
- uninstall
update
update
update
upgrade
-use
- use
-use
- use
-user
- user
-
-wait
- wait
-with
- with
\ No newline at end of file
diff --git a/devel/classes/error.ArangoError.html b/devel/classes/error.ArangoError.html
index de7065028..a0a3050f0 100644
--- a/devel/classes/error.ArangoError.html
+++ b/devel/classes/error.ArangoError.html
@@ -1,191 +1,23 @@
-ArangoError | arangojs
-
-FetchFailedError | arangojs
is
HttpError | arangojs
-
-HttpError | arangojs
is
NetworkError | arangojs
is
PropagationTimeoutError | arangojs
RequestAbortedError | arangojs
is
ResponseTimeoutError | arangojs
is
Graph | arangojs
-
-GraphEdgeCollection | arangojs
-
-GraphVertexCollection | arangojs
-
-Job | arangojs
-
-Route | arangojs
-
-Transaction | arangojs
-
-isAqlLiteral | arangojs
-
-isAqlLiteral | arangojs isAqlQuery | arangojs
-
-isAqlQuery | arangojs join | arangojs
-
-literal | arangojs
-
-
\ No newline at end of file
diff --git a/devel/functions/collection.collectionToString.html b/devel/functions/collection.collectionToString.html
index cce79e394..d7e6653b2 100644
--- a/devel/functions/collection.collectionToString.html
+++ b/devel/functions/collection.collectionToString.html
@@ -1,119 +1,4 @@
-collectionToString | arangojs
-
-isArangoCollection | arangojs
-
-isArangoCollection | arangojs isArangoDatabase | arangojs
-
-isArangoDatabase | arangojs isArangoError | arangojs
-
-isArangoError | arangojs isNetworkError | arangojs isSystemError | arangojs
-
-isArangoGraph | arangojs
-
-isArangoGraph | arangojs arangojs
-
-arangojs | arangojs isArangoTransaction | arangojs
-
-isArangoTransaction | arangojs isArangoView | arangojs
-
-isArangoView | arangojs arangojs arangojs
-
-AqlLiteral | arangojs
-
-AqlQuery | arangojs
-
-ArangoCollection | arangojs
-
-DocumentCollection | arangojs
-
-EdgeCollection | arangojs
-
-ProcessedResponse | arangojs
CursorExtras | arangojs
-
-CursorExtras | arangojs
CursorStats | arangojs
-
-SystemError | arangojs
-
-ArangoSearchViewStoredValueOptions | arangojs
-
-arangojs
-
-analyzer | arangojs
-
-aql | arangojs
-
-collection | arangojs
-
-connection | arangojs
-
-cursor | arangojs
-
-database | arangojs
-
-documents | arangojs
-
-error | arangojs
-
-foxx-manifest | arangojs
-
-graph | arangojs
-
-index | arangojs
-
-indexes | arangojs
-
-job | arangojs
-
-job | arangojs route | arangojs
-
-transaction | arangojs
-
-view | arangojs
-
-AnalyzerDescription | arangojs
-
-AnalyzerDescription | arangojs AnalyzerFeature | arangojs
-
-AnalyzerFeature | arangojs AqlAnalyzerDescription | arangojs
-
-AqlAnalyzerDescription | arangojs ClassificationAnalyzerDescription | arangojs
-
-ClassificationAnalyzerDescription | arangojs CollationAnalyzerDescription | arangojs
-
-CollationAnalyzerDescription | arangojs CreateAnalyzerOptions | arangojs
-
-CreateAnalyzerOptions | arangojs CreateAqlAnalyzerOptions | arangojs
-
-CreateClassificationAnalyzerOptions | arangojs
-
-CreateCollationAnalyzerOptions | arangojs
-
-CreateDelimiterAnalyzerOptions | arangojs
-
-CreateGeoJsonAnalyzerOptions | arangojs
-
-CreateGeoPointAnalyzerOptions | arangojs
-
-CreateGeoS2AnalyzerOptions | arangojs
-
-CreateIdentityAnalyzerOptions | arangojs
-
-CreateMinHashAnalyzerOptions | arangojs
-
-CreateMinHashAnalyzerOptions | arangojs CreateMultiDelimiterAnalyzerOptions | arangojs
-
-CreateNearestNeighborsAnalyzerOptions | arangojs
-
-CreateNgramAnalyzerOptions | arangojs
-
-CreateNgramAnalyzerOptions | arangojs CreateNormAnalyzerOptions | arangojs
-
-CreatePipelineAnalyzerOptions | arangojs
-
-CreatePipelineAnalyzerOptions | arangojs CreateSegmentationAnalyzerOptions | arangojs
-
-CreateStemAnalyzerOptions | arangojs
-
-CreateStopwordsAnalyzerOptions | arangojs
-
-CreateTextAnalyzerOptions | arangojs
-
-CreateWildcardAnalyzerOptions | arangojs
-
-CreateWildcardAnalyzerOptions | arangojs DelimiterAnalyzerDescription | arangojs
-
-DelimiterAnalyzerDescription | arangojs GenericAnalyzerDescription | arangojs
-
-GenericAnalyzerDescription | arangojs GeoJsonAnalyzerDescription | arangojs
-
-GeoJsonAnalyzerDescription | arangojs GeoPointAnalyzerDescription | arangojs
-
-GeoPointAnalyzerDescription | arangojs GeoS2AnalyzerDescription | arangojs
-
-GeoS2AnalyzerDescription | arangojs IdentityAnalyzerDescription | arangojs
-
-IdentityAnalyzerDescription | arangojs MinHashAnalyzerDescription | arangojs
-
-MinHashAnalyzerDescription | arangojs MultiDelimiterAnalyzerDescription | arangojs
-
-MultiDelimiterAnalyzerDescription | arangojs NearestNeighborsAnalyzerDescription | arangojs
-
-NearestNeighborsAnalyzerDescription | arangojs NgramAnalyzerDescription | arangojs
-
-NgramAnalyzerDescription | arangojs NormAnalyzerDescription | arangojs
-
-NormAnalyzerDescription | arangojs PipelineAnalyzerDescription | arangojs
-
-PipelineAnalyzerDescription | arangojs SegmentationAnalyzerDescription | arangojs
-
-SegmentationAnalyzerDescription | arangojs StemAnalyzerDescription | arangojs
-
-StemAnalyzerDescription | arangojs StopwordsAnalyzerDescription | arangojs
-
-StopwordsAnalyzerDescription | arangojs TextAnalyzerDescription | arangojs
-
-TextAnalyzerDescription | arangojs WildcardAnalyzerDescription | arangojs
-
-WildcardAnalyzerDescription | arangojs AqlValue | arangojs
-
-CollectionBatchReadOptions | arangojs
-
-CollectionChecksumOptions | arangojs
-
-CollectionDropOptions | arangojs
-
-CollectionEdgesOptions | arangojs
-
-CollectionEdgesResult | arangojs
-
-CollectionEdgesResult | arangojs CollectionImportOptions | arangojs
-
-CollectionImportResult | arangojs
-
-CollectionImportResult | arangojs CollectionInsertOptions | arangojs
-
-CollectionKeyOptions | arangojs
-
-CollectionKeyProperties | arangojs
-
-CollectionKeyProperties | arangojs CollectionMetadata | arangojs
-
-CollectionMetadata | arangojs CollectionProperties | arangojs
-
-CollectionPropertiesOptions | arangojs
-
-CollectionReadOptions | arangojs
-
-CollectionRemoveOptions | arangojs
-
-CollectionReplaceOptions | arangojs
-
-CollectionTruncateOptions | arangojs CollectionUpdateOptions | arangojs
-
-ComputedValueOptions | arangojs
-
-ComputedValueProperties | arangojs
-
-CreateCollectionOptions | arangojs
-
-DocumentExistsOptions | arangojs
-
-DocumentOperationFailure | arangojs
-
-DocumentOperationFailure | arangojs DocumentOperationMetadata | arangojs
-
-DocumentOperationMetadata | arangojs IndexListOptions | arangojs KeyGenerator | arangojs
-
-KeyGenerator | arangojs SchemaOptions | arangojs
-
-SchemaProperties | arangojs
-
-SchemaProperties | arangojs ShardingStrategy | arangojs
-
-ShardingStrategy | arangojs SimpleQueryAllOptions | arangojs
-
-SimpleQueryByExampleOptions | arangojs
-
-SimpleQueryFulltextOptions | arangojs
-
-SimpleQueryListType | arangojs
-
-SimpleQueryRemoveByExampleOptions | arangojs
-
-SimpleQueryRemoveByExampleResult | arangojs
-
-SimpleQueryRemoveByKeysOptions | arangojs
-
-SimpleQueryRemoveByKeysResult | arangojs
-
-SimpleQueryReplaceByExampleOptions | arangojs
-
-SimpleQueryReplaceByExampleResult | arangojs
-
-SimpleQueryUpdateByExampleOptions | arangojs
-
-SimpleQueryUpdateByExampleResult | arangojs
-
-TraversalOptions | arangojs
-
-ValidationLevel | arangojs
-
-
\ No newline at end of file
diff --git a/devel/types/collection.WriteOperation.html b/devel/types/collection.WriteOperation.html
index 4c7d572d9..7abedcb49 100644
--- a/devel/types/collection.WriteOperation.html
+++ b/devel/types/collection.WriteOperation.html
@@ -1,107 +1,2 @@
-
-
-
-Class Database
An object representing a single ArangoDB database. All arangojs collections, +
Class Database
An object representing a single ArangoDB database. All arangojs collections,
cursors, analyzers and so on are linked to a Database object.
Hierarchy
--
-
- Database
- Index
-
-
-
-
-
-
-
Constructors
-Accessors
-Methods
-acquire
Constructors
-constructor
--
-
- new
Database(config?: Config): Database
- -
--
Creates a new
-Databaseinstance with its own connection pool.See also database.
- -Example
-const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "my_database",
auth: { username: "admin", password: "hunter2" },
}); ---Parameters
--
-
-
-
-Optionalconfig: ConfigAn object with configuration options.
-
Returns Database
- -
-
- new
Database(url: string | string[], name?: string): Database
- -
--
Creates a new
-Databaseinstance with its own connection pool.See also database.
- -Example
-const db = new Database("http://127.0.0.1:8529", "my_database");
db.useBasicAuth("admin", "hunter2"); ---Parameters
--
-
-
-
url: string | string[]
-Base URL of the ArangoDB server or list of server URLs. -Equivalent to the
-urloption in Config.
- -
-
Optionalname: string
Returns Database
-
-
Accessors
-name
--
-
- get name(): string -
-
--
Name of the ArangoDB database this instance represents.
-Returns string
queue
--
-
- get queueTime(): QueueTimeMetrics -
-
-
Methods for accessing the server-reported queue times of the mostly +
Index
Constructors
Accessors
Methods
acquire
Constructors
constructor
- new
Database(config?): Database Creates a new
+Databaseinstance with its own connection pool.See also Database#database.
+Parameters
Optionalconfig: ConfigAn object with configuration options.
+
Returns Database
Example
+const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "my_database",
auth: { username: "admin", password: "hunter2" },
}); +- new
Database(url, name?): Database Creates a new
+Databaseinstance with its own connection pool.See also Database#database.
+Parameters
- url: string | string[]
Base URL of the ArangoDB server or list of server URLs. +Equivalent to the
+urloption in connection.Config. Optionalname: string
Returns Database
Example
+const db = new Database("http://127.0.0.1:8529", "my_database");
db.useBasicAuth("admin", "hunter2"); +- url: string | string[]
Accessors
name
- get name(): string
Name of the ArangoDB database this instance represents.
+Returns string
queue
- get queueTime(): QueueTimeMetrics
- -
Methods for accessing the server-reported queue times of the mostly recently received responses.
-Returns QueueTimeMetrics
Methods
-acquire
--
-
- acquire
Host List(overwrite?: boolean): Promise<void>
- -
-
Updates the URL list by requesting a list of all coordinators in the +
Returns QueueTimeMetrics
Methods
acquire
- acquire
Host List(overwrite?): Promise<void> - -
Updates the URL list by requesting a list of all coordinators in the cluster and adding any endpoints not initially specified in the -Config.
+connection.Config.For long-running processes communicating with an ArangoDB cluster it is recommended to run this method periodically (e.g. once per hour) to make sure new coordinators are picked up correctly and can be used for fail-over or load balancing.
- -Example
-const db = new Database();
const interval = setInterval(
() => db.acquireHostList(),
5 * 60 * 1000 // every 5 minutes
);
// later
clearInterval(interval);
system.close(); --Parameters
--
-
-
-
overwrite: boolean = false
-If set to
true, the existing host list will be +-Parameters
- overwrite: boolean = false
If set to
-true, the existing host list will be replaced instead of extended.
Returns Promise<void>
- overwrite: boolean = false
- analyzer
-Returns Promise<void>
Example
+const db = new Database();
const interval = setInterval(
() => db.acquireHostList(),
5 * 60 * 1000 // every 5 minutes
);
// later
clearInterval(interval);
system.close(); + -
-
analyzer
- analyzer(analyzerName): Analyzer
- -
Returns an analyzer.Analyzer instance representing the Analyzer with the given
- -analyzerName.Example
-const db = new Database();
const analyzer = db.analyzer("some-analyzer");
const info = await analyzer.get(); ---Parameters
--
-
-
-
analyzerName: string
Returns Analyzer
-
-
analyzers
--
-
- analyzers(): Promise<Analyzer[]> -
-
--
Fetches all Analyzers visible in the database and returns an array of -Analyzer instances for those Analyzers.
-See also listAnalyzers.
- -Example
-const db = new Database();
const analyzers = await db.analyzers();
// analyzers is an array of Analyzer instances -Returns Promise<Analyzer[]>
begin
--
-
- begin
Transaction(collections: TransactionCollections, options?: TransactionOptions): Promise<Transaction>
- -
-
Begins a new streaming transaction for the given collections, then returns -a Transaction instance for the transaction.
+Parameters
- analyzerName: string
Returns Analyzer
Example
+const db = new Database();
const analyzer = db.analyzer("some-analyzer");
const info = await analyzer.get(); +
analyzers
- analyzers(): Promise<Analyzer[]>
Fetches all Analyzers visible in the database and returns an array of +analyzer.Analyzer instances for those Analyzers.
+See also Database#listAnalyzers.
+Returns Promise<Analyzer[]>
Example
+const db = new Database();
const analyzers = await db.analyzers();
// analyzers is an array of Analyzer instances +
begin
- begin
Transaction(collections, options?): Promise<Transaction> - -
Begins a new streaming transaction for the given collections, then returns +a transaction.Transaction instance for the transaction.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as -well as (in TypeScript) DocumentCollection and -EdgeCollection.Example
-const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({
read: ["vertices"],
write: [edges] // collection instances can be passed directly
});
const start = await trx.step(() => vertices.document("a"));
const end = await trx.step(() => vertices.document("b"));
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); ---Parameters
--
-
-
-
collections: TransactionCollections
-Collections involved in the transaction.
-
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<Transaction>
- -
-
- begin
Transaction(collections: (string | ArangoCollection)[], options?: TransactionOptions): Promise<Transaction>
- -
-
Begins a new streaming transaction for the given collections, then returns -a Transaction instance for the transaction.
+implementing the collection.ArangoCollection interface:Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as +well as (in TypeScript) collection.DocumentCollection and +collection.EdgeCollection. +Parameters
- collections: TransactionCollections
Collections involved in the transaction.
+ Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<Transaction>
Example
+const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({
read: ["vertices"],
write: [edges] // collection instances can be passed directly
});
const start = await trx.step(() => vertices.document("a"));
const end = await trx.step(() => vertices.document("b"));
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); + - collections: TransactionCollections
- begin
Transaction(collections, options?): Promise<Transaction> - -
Begins a new streaming transaction for the given collections, then returns +a transaction.Transaction instance for the transaction.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Example
-const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction([
"vertices",
edges // collection instances can be passed directly
]);
const start = await trx.step(() => vertices.document("a"));
const end = await trx.step(() => vertices.document("b"));
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); --Parameters
--
-
-
-
collections: (string | ArangoCollection)[]
-Collections that can be read from and written to +implementing the collection.ArangoCollection interface:
+Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.-Parameters
- collections: (string | ArangoCollection)[]
Collections that can be read from and written to during the transaction.
-
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<Transaction>
- - collections: (string | ArangoCollection)[]
- begin
Transaction(collection: string | ArangoCollection, options?: TransactionOptions): Promise<Transaction>
- -
-
Begins a new streaming transaction for the given collections, then returns -a Transaction instance for the transaction.
+ Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<Transaction>
Example
+const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction([
"vertices",
edges // collection instances can be passed directly
]);
const start = await trx.step(() => vertices.document("a"));
const end = await trx.step(() => vertices.document("b"));
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); + -
-
- begin
Transaction(collection, options?): Promise<Transaction> - -
Begins a new streaming transaction for the given collections, then returns +a transaction.Transaction instance for the transaction.
The Collection can be specified as a collection name (string) or an object -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Example
-const vertices = db.collection("vertices");
const start = vertices.document("a");
const end = vertices.document("b");
const edges = db.collection("edges");
const trx = await db.beginTransaction(
edges // collection instances can be passed directly
);
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); --Parameters
--
-
-
-
collection: string | ArangoCollection
-A collection that can be read from and written to +implementing the collection.ArangoCollection interface:
+Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.-Parameters
- collection: string | ArangoCollection
A collection that can be read from and written to during the transaction.
-
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<Transaction>
- collection: string | ArangoCollection
- -clear
-Slow Queries -
-
- clear
Slow Queries(): Promise<void>
- -
--
Clears the list of recent slow queries.
-See also listSlowQueries.
- -Example
-const db = new Database();
await db.clearSlowQueries();
// Slow query list is now cleared -Returns Promise<void>
- clear
-User Access Level -
-
- clear
User Access Level(username: string, __namedParameters: UserAccessLevelOptions): Promise<ArangoApiResponse<Record<string, AccessLevel>>>
- -
-
Clears the given ArangoDB user's access level for the database, or the +
Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<Transaction>
Example
+const vertices = db.collection("vertices");
const start = vertices.document("a");
const end = vertices.document("b");
const edges = db.collection("edges");
const trx = await db.beginTransaction(
edges // collection instances can be passed directly
);
await trx.step(() => edges.save({ _from: start._id, _to: end._id }));
await trx.commit(); + -
-
clear
- clear
Slow Queries(): Promise<void> Clears the list of recent slow queries.
+See also Database#listSlowQueries.
+Returns Promise<void>
Example
+const db = new Database();
await db.clearSlowQueries();
// Slow query list is now cleared +
clear
- clear
User Access Level(username, __namedParameters): Promise<ArangoApiResponse<Record<string, AccessLevel>>> - -
Clears the given ArangoDB user's access level for the database, or the given collection in the given database.
- -Example
- -const db = new Database();
await db.clearUserAccessLevel("steve");
// The access level of the user "steve" has been cleared for the current
// database. -Example
- -const db = new Database();
await db.clearUserAccessLevel("steve", { database: "staging" });
// The access level of the user "steve" has been cleared for the "staging"
// database. -Example
- -const db = new Database();
await db.clearUserAccessLevel("steve", { collection: "pokemons" });
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in the current database. -Example
- -const db = new Database();
await db.clearUserAccessLevel("steve", {
database: "staging",
collection: "pokemons"
});
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in the "staging" database. -Example
- -const db = new Database();
const staging = db.database("staging");
await db.clearUserAccessLevel("steve", { database: staging });
// The access level of the user "steve" has been cleared for the "staging"
// database. -Example
-const db = new Database();
const staging = db.database("staging");
await db.clearUserAccessLevel("steve", {
collection: staging.collection("pokemons")
});
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in database "staging". ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to clear the access level for.
-
- -
-
__namedParameters: UserAccessLevelOptions
Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>
-
-
close
--
-
- close(): void -
-
-
Closes all active connections of this database instance.
+Parameters
- username: string
Name of the ArangoDB user to clear the access level for.
+ - __namedParameters: UserAccessLevelOptions
Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>
Example
+const db = new Database();
await db.clearUserAccessLevel("steve");
// The access level of the user "steve" has been cleared for the current
// database. +Example
+const db = new Database();
await db.clearUserAccessLevel("steve", { database: "staging" });
// The access level of the user "steve" has been cleared for the "staging"
// database. +Example
+const db = new Database();
await db.clearUserAccessLevel("steve", { collection: "pokemons" });
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in the current database. +Example
+const db = new Database();
await db.clearUserAccessLevel("steve", {
database: "staging",
collection: "pokemons"
});
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in the "staging" database. +Example
+const db = new Database();
const staging = db.database("staging");
await db.clearUserAccessLevel("steve", { database: staging });
// The access level of the user "steve" has been cleared for the "staging"
// database. +Example
+const db = new Database();
const staging = db.database("staging");
await db.clearUserAccessLevel("steve", {
collection: staging.collection("pokemons")
});
// The access level of the user "steve" has been cleared for the
// "pokemons" collection in database "staging". + - username: string
close
- close(): void
- -
Closes all active connections of this database instance.
Can be used to clean up idling connections during longer periods of inactivity.
Note: This method currently has no effect in the browser version of arangojs.
- -Example
-const db = new Database();
const sessions = db.collection("sessions");
// Clean up expired sessions once per hour
setInterval(async () => {
await db.query(aql`
FOR session IN ${sessions}
FILTER session.expires < DATE_NOW()
REMOVE session IN ${sessions}
`);
// Making sure to close the connections because they're no longer used
system.close();
}, 1000 * 60 * 60); -Returns void
collection
--
-
- collection<T>(collectionName: string): DocumentCollection<T> & EdgeCollection<T> -
-
-
Returns a
+Collectioninstance for the given collection name.Returns void
Example
+const db = new Database();
const sessions = db.collection("sessions");
// Clean up expired sessions once per hour
setInterval(async () => {
await db.query(aql`
FOR session IN ${sessions}
FILTER session.expires < DATE_NOW()
REMOVE session IN ${sessions}
`);
// Making sure to close the connections because they're no longer used
system.close();
}, 1000 * 60 * 60); +
collection
- collection<T>(collectionName): DocumentCollection<T, T> & EdgeCollection<T, T>
- -
Returns a
Collectioninstance for the given collection name.In TypeScript the collection implements both the -DocumentCollection and EdgeCollection +collection.DocumentCollection and collection.EdgeCollection interfaces and can be cast to either type to enforce a stricter API.
- -Example
- -const db = new Database();
const collection = db.collection("potatoes"); -Example
- -interface Person {
name: string;
}
const db = new Database();
const persons = db.collection<Person>("persons"); -Example
-interface Person {
name: string;
}
interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>;
const edges = db.collection("friends") as EdgeCollection<Friend>; -- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
--Parameters
--
-
-
-
collectionName: string
-Name of the edge collection.
-
Returns DocumentCollection<T> & EdgeCollection<T>
-
-
collections
--
-
- collections(excludeSystem?: boolean): Promise<(DocumentCollection<any> & EdgeCollection<any>)[]> -
-
-
Fetches all collections from the database and returns an array of +
Type Parameters
Parameters
- collectionName: string
Name of the edge collection.
+
Returns DocumentCollection<T, T> & EdgeCollection<T, T>
Example
+const db = new Database();
const collection = db.collection("potatoes"); +Example
+interface Person {
name: string;
}
const db = new Database();
const persons = db.collection<Person>("persons"); +Example
+interface Person {
name: string;
}
interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>;
const edges = db.collection("friends") as EdgeCollection<Friend>; + - collectionName: string
collections
- collections(excludeSystem?): Promise<(DocumentCollection<any, any> & EdgeCollection<any, any>)[]>
- -
Fetches all collections from the database and returns an array of
Collectioninstances.In TypeScript these instances implement both the -DocumentCollection and EdgeCollection +collection.DocumentCollection and collection.EdgeCollection interfaces and can be cast to either type to enforce a stricter API.
-See also listCollections.
- -Example
- -const db = new Database();
const collections = await db.collections();
// collections is an array of DocumentCollection and EdgeCollection
// instances not including system collections -Example
-const db = new Database();
const collections = await db.collections(false);
// collections is an array of DocumentCollection and EdgeCollection
// instances including system collections ---Parameters
--
-
-
-
excludeSystem: boolean = true
-Whether system collections should be excluded.
-
Returns Promise<(DocumentCollection<any> & EdgeCollection<any>)[]>
-
-
commit
--
-
- commit
Local Service State(replace?: boolean): Promise<void>
- -
-
Writes all locally available services to the database and updates any +
See also Database#listCollections.
+Parameters
- excludeSystem: boolean = true
Whether system collections should be excluded.
+
Returns Promise<(DocumentCollection<any, any> & EdgeCollection<any, any>)[]>
Example
+const db = new Database();
const collections = await db.collections();
// collections is an array of DocumentCollection and EdgeCollection
// instances not including system collections +Example
+const db = new Database();
const collections = await db.collections(false);
// collections is an array of DocumentCollection and EdgeCollection
// instances including system collections + - excludeSystem: boolean = true
commit
- commit
Local Service State(replace?): Promise<void> - -
Writes all locally available services to the database and updates any service bundles missing in the database.
- -Example
- -await db.commitLocalServiceState();
// all services available on the coordinator have been written to the db -Example
-await db.commitLocalServiceState(true);
// all service conflicts have been resolved in favor of this coordinator --Parameters
--
-
-
-
replace: boolean = false
-If set to
true, outdated services will also be +-Parameters
- replace: boolean = false
If set to
-true, outdated services will also be committed. This can be used to solve some consistency problems when service bundles are missing in the database or were deleted manually.
Returns Promise<void>
- replace: boolean = false
- -compute
-Cluster Rebalance -
-
- compute
Cluster Rebalance(opts: ClusterRebalanceOptions): Promise<ClusterRebalanceResult>
- -
--
Computes a set of move shard operations to rebalance the cluster.
- -Example
-const db = new Database();
const result = await db.computerClusterRebalance({
moveLeaders: true,
moveFollowers: true
});
if (result.moves.length) {
await db.executeClusterRebalance(result.moves);
} ---Parameters
--
-
-
-
opts: ClusterRebalanceOptions
Returns Promise<ClusterRebalanceResult>
-
-
- -create
-Analyzer -
-
- create
Analyzer(analyzerName: string, options: CreateAnalyzerOptions): Promise<Analyzer>
- -
--
Creates a new Analyzer with the given
- -analyzerNameandoptions, then -returns an Analyzer instance for the new Analyzer.Example
-const db = new Database();
const analyzer = await db.createAnalyzer("potatoes", { type: "identity" });
// the identity Analyzer "potatoes" now exists ---Parameters
--
-
-
-
analyzerName: string
-Name of the Analyzer.
-
- -
-
options: CreateAnalyzerOptions
-An object defining the properties of the Analyzer.
-
Returns Promise<Analyzer>
-
-
- create
-Collection -
-
- create
Collection<T>(collectionName: string, options?: CreateCollectionOptions & {
    type?: DOCUMENT_COLLECTION;
}): Promise<DocumentCollection<T>>
- -
--
Creates a new collection with the given
- -collectionNameandoptions, -then returns a DocumentCollection instance for the new collection.Example
- -const db = new Database();
const documents = db.createCollection("persons"); -Example
-interface Person {
name: string;
}
const db = new Database();
const documents = db.createCollection<Person>("persons"); -- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
--Parameters
--
-
-
-
collectionName: string
-Name of the new collection.
-
- -
-
-Optionaloptions: CreateCollectionOptions & {
    type?: DOCUMENT_COLLECTION;
}Options for creating the collection.
-
Returns Promise<DocumentCollection<T>>
- -
-
- create
Collection<T>(collectionName: string, options: CreateCollectionOptions & {
    type: EDGE_COLLECTION;
}): Promise<EdgeCollection<T>>
- -
-
Creates a new edge collection with the given
collectionNameand -options, then returns an EdgeCollection instance for the new +
Returns Promise<void>
Example
+await db.commitLocalServiceState();
// all services available on the coordinator have been written to the db +Example
+await db.commitLocalServiceState(true);
// all service conflicts have been resolved in favor of this coordinator + -
-
compute
- compute
Cluster Rebalance(opts): Promise<ClusterRebalanceResult> Computes a set of move shard operations to rebalance the cluster.
+Parameters
- opts: ClusterRebalanceOptions
Returns Promise<ClusterRebalanceResult>
Example
+const db = new Database();
const result = await db.computerClusterRebalance({
moveLeaders: true,
moveFollowers: true
});
if (result.moves.length) {
await db.executeClusterRebalance(result.moves);
} +
create
- create
Analyzer(analyzerName, options): Promise<Analyzer> Creates a new Analyzer with the given
+analyzerNameandoptions, then +returns an analyzer.Analyzer instance for the new Analyzer.Parameters
- analyzerName: string
Name of the Analyzer.
+ - options: CreateAnalyzerOptions
An object defining the properties of the Analyzer.
+
Returns Promise<Analyzer>
Example
+const db = new Database();
const analyzer = await db.createAnalyzer("potatoes", { type: "identity" });
// the identity Analyzer "potatoes" now exists +- analyzerName: string
create
- create
Collection<T>(collectionName, options?): Promise<DocumentCollection<T, T>> Creates a new collection with the given
+collectionNameandoptions, +then returns a collection.DocumentCollection instance for the new collection.Type Parameters
Parameters
- collectionName: string
Name of the new collection.
+ Optionaloptions: CreateCollectionOptions & {
    type?: DOCUMENT_COLLECTION;
}Options for creating the collection.
+
Returns Promise<DocumentCollection<T, T>>
Example
+const db = new Database();
const documents = db.createCollection("persons"); +Example
+interface Person {
name: string;
}
const db = new Database();
const documents = db.createCollection<Person>("persons"); +- collectionName: string
- create
Collection<T>(collectionName, options): Promise<EdgeCollection<T, T>> - -
Creates a new edge collection with the given
- -collectionNameand +options, then returns an collection.EdgeCollection instance for the new edge collection.Example
- -const db = new Database();
const edges = db.createCollection("friends", {
type: CollectionType.EDGE_COLLECTION
}); -Example
-interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.createCollection<Friend>("friends", {
type: CollectionType.EDGE_COLLECTION
}); -- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for edge document data. Defaults to
-any.
--Parameters
--
-
-
-
collectionName: string
-Name of the new collection.
-
- -
-
options: CreateCollectionOptions & {
-
    type: EDGE_COLLECTION;
}Options for creating the collection.
-
Returns Promise<EdgeCollection<T>>
-
-
create
--
-
- create
Database(databaseName: string, options?: CreateDatabaseOptions): Promise<Database>
- -
-
Creates a new database with the given
databaseNamewith the given +Type Parameters
Parameters
- collectionName: string
Name of the new collection.
+ - options: CreateCollectionOptions & {
    type: EDGE_COLLECTION;
}Options for creating the collection.
+
Returns Promise<EdgeCollection<T, T>>
Example
+const db = new Database();
const edges = db.createCollection("friends", {
type: CollectionType.EDGE_COLLECTION
}); +Example
+interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.createCollection<Friend>("friends", {
type: CollectionType.EDGE_COLLECTION
}); + - collectionName: string
create
- create
Database(databaseName, options?): Promise<Database> - -
Creates a new database with the given
- -databaseNamewith the givenoptionsand returns aDatabaseinstance for that database.Example
-const db = new Database();
const info = await db.createDatabase("mydb", {
users: [{ username: "root" }]
});
// the database has been created ---Parameters
--
-
-
-
databaseName: string
-Name of the database to create.
-
- -
-
-Optionaloptions: CreateDatabaseOptionsOptions for creating the database.
-
Returns Promise<Database>
- -
-
- create
Database(databaseName: string, users: CreateDatabaseUser[]): Promise<Database>
- -
-
Creates a new database with the given
databaseNamewith the given +Parameters
- databaseName: string
Name of the database to create.
+ Optionaloptions: CreateDatabaseOptionsOptions for creating the database.
+
Returns Promise<Database>
Example
+const db = new Database();
const info = await db.createDatabase("mydb", {
users: [{ username: "root" }]
});
// the database has been created + - databaseName: string
- create
Database(databaseName, users): Promise<Database> - -
Creates a new database with the given
- -databaseNamewith the givenusersand returns aDatabaseinstance for that database.Example
-const db = new Database();
const info = await db.createDatabase("mydb", [{ username: "root" }]);
// the database has been created ---Parameters
--
-
-
-
databaseName: string
-Name of the database to create.
-
- -
-
users: CreateDatabaseUser[]
-Database users to create with the database.
-
Returns Promise<Database>
-
-
create
--
-
- create
Edge Collection<T>(collectionName: string, options?: CreateCollectionOptions): Promise<EdgeCollection<T>>
- -
-
Creates a new edge collection with the given
collectionNameand -options, then returns an EdgeCollection instance for the new +Parameters
- databaseName: string
Name of the database to create.
+ - users: CreateDatabaseUser[]
Database users to create with the database.
+
Returns Promise<Database>
Example
+const db = new Database();
const info = await db.createDatabase("mydb", [{ username: "root" }]);
// the database has been created + - databaseName: string
create
- create
Edge Collection<T>(collectionName, options?): Promise<EdgeCollection<T, T>> - -
Creates a new edge collection with the given
-collectionNameand +options, then returns an collection.EdgeCollection instance for the new edge collection.This is a convenience method for calling createCollection +
This is a convenience method for calling Database#createCollection with
- -options.typeset toEDGE_COLLECTION.Example
- -const db = new Database();
const edges = db.createEdgeCollection("friends"); -Example
-interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.createEdgeCollection<Friend>("friends"); -- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for edge document data. Defaults to
-any.
--Parameters
--
-
-
-
collectionName: string
-Name of the new collection.
-
- -
-
-Optionaloptions: CreateCollectionOptionsOptions for creating the collection.
-
Returns Promise<EdgeCollection<T>>
-
-
create
--
-
- create
Function(name: string, code: string, isDeterministic?: boolean): Promise<ArangoApiResponse<{
    isNewlyCreated: boolean;
}>>
- -
-
Creates an AQL user function with the given name and code if it does +
Type Parameters
Parameters
- collectionName: string
Name of the new collection.
+ Optionaloptions: CreateCollectionOptionsOptions for creating the collection.
+
Returns Promise<EdgeCollection<T, T>>
Example
+const db = new Database();
const edges = db.createEdgeCollection("friends"); +Example
+interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.createEdgeCollection<Friend>("friends"); + - collectionName: string
create
- create
Function(name, code, isDeterministic?): Promise<ArangoApiResponse<{
    isNewlyCreated: boolean;
}>> - -
Creates an AQL user function with the given name and code if it does not already exist or replaces it if a function with the same name already existed.
- -Example
-const db = new Database();
await db.createFunction(
"ACME::ACCOUNTING::CALCULATE_VAT",
"(price) => price * 0.19"
);
// Use the new function in an AQL query with template handler:
const cursor = await db.query(aql`
FOR product IN products
RETURN MERGE(
{ vat: ACME::ACCOUNTING::CALCULATE_VAT(product.price) },
product
)
`);
// cursor is a cursor for the query result --Parameters
--
-
-
-
name: string
-A valid AQL function name. The function name must consist +
-Parameters
- name: string
A valid AQL function name. The function name must consist of at least two alphanumeric identifiers separated with double colons.
-
- -
-
code: string
-A string evaluating to a JavaScript function (not a +
- code: string
A string evaluating to a JavaScript function (not a JavaScript function object).
-
- -
-
isDeterministic: boolean = false
-If set to
true, the function is expected to + - isDeterministic: boolean = false
If set to
-true, the function is expected to always return the same result for equivalent inputs. This option currently has no effect but may allow for optimizations in the future.
Returns Promise<ArangoApiResponse<{
    isNewlyCreated: boolean;
}>> - name: string
- -create
-Graph -
-
- create
Graph(graphName: string, edgeDefinitions: EdgeDefinitionOptions[], options?: CreateGraphOptions): Promise<Graph>
- -
--
Creates a graph with the given
-graphNameandedgeDefinitions, then -returns a Graph instance for the new graph.--Parameters
--
-
-
-
graphName: string
-Name of the graph to be created.
-
- -
-
edgeDefinitions: EdgeDefinitionOptions[]
-An array of edge definitions.
-
- -
-
-Optionaloptions: CreateGraphOptionsAn object defining the properties of the graph.
-
Returns Promise<Graph>
-
-
- create
-Hot Backup -
-
- create
Hot Backup(options?: HotBackupOptions): Promise<HotBackupResult>
- -
-
(Enterprise Edition only.) Creates a hot backup of the entire ArangoDB +
Returns Promise<ArangoApiResponse<{
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
await db.createFunction(
"ACME::ACCOUNTING::CALCULATE_VAT",
"(price) => price * 0.19"
);
// Use the new function in an AQL query with template handler:
const cursor = await db.query(aql`
FOR product IN products
RETURN MERGE(
{ vat: ACME::ACCOUNTING::CALCULATE_VAT(product.price) },
product
)
`);
// cursor is a cursor for the query result + -
-
create
- create
Graph(graphName, edgeDefinitions, options?): Promise<Graph> Creates a graph with the given
+graphNameandedgeDefinitions, then +returns a graph.Graph instance for the new graph.Parameters
- graphName: string
Name of the graph to be created.
+ - edgeDefinitions: EdgeDefinitionOptions[]
An array of edge definitions.
+ Optionaloptions: CreateGraphOptionsAn object defining the properties of the graph.
+
Returns Promise<Graph>
- graphName: string
create
- create
Hot Backup(options?): Promise<HotBackupResult> - -
(Enterprise Edition only.) Creates a hot backup of the entire ArangoDB deployment including all databases, collections, etc.
Returns an object describing the backup result.
- -Example
-const info = await db.createHotBackup();
// a hot backup has been created ---Parameters
--
-
-
-
options: HotBackupOptions = {}
-Options for creating the backup.
-
Returns Promise<HotBackupResult>
-
-
create
--
-
- create
Job<T>(callback: (() => Promise<T>)): Promise<Job<T>>
- -
-
Creates an async job by executing the given callback function. The first +
Parameters
- options: HotBackupOptions = {}
Options for creating the backup.
+
Returns Promise<HotBackupResult>
Example
+const info = await db.createHotBackup();
// a hot backup has been created + - options: HotBackupOptions = {}
create
- create
Job<T>(callback): Promise<Job<T>> - -
Creates an async job by executing the given callback function. The first database request performed by the callback will be marked for asynchronous execution and its result will be made available as an async job.
-Returns a Job instance that can be used to retrieve the result +
Returns a Job instance that can be used to retrieve the result of the callback function once the request has been executed.
- -Example
-const db = new Database();
const job = await db.createJob(() => db.collections());
while (!job.isLoaded) {
await timeout(1000);
await job.load();
}
// job.result is a list of Collection instances -- -Type Parameters
--
-
-
-
T
--Parameters
--
-
-
-
callback: (() => Promise<T>)
--Callback function to execute as an async job.
--
-
-
-
-
-
- (): Promise<T> -
-
-
Returns Promise<T>
-
-
Returns Promise<Job<T>>
-
-
create
--
-
- create
User(username: string, passwd: string): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Creates a new ArangoDB user with the given password.
- -Example
-const db = new Database();
const user = await db.createUser("steve", "hunter2");
// The user "steve" has been created ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to create.
-
- -
-
passwd: string
-Password of the new ArangoDB user.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
- -
-
- create
User(username: string, options: UserOptions): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Creates a new ArangoDB user with the given options.
- -Example
-const db = new Database();
const user = await db.createUser("steve", { passwd: "hunter2" });
// The user "steve" has been created ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to create.
-
- -
-
options: UserOptions
-Additional options for creating the ArangoDB user.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
-
-
create
--
-
- create
View(viewName: string, options: CreateViewOptions): Promise<View>
- -
--
Creates a new View with the given
- -viewNameandoptions, then returns a -View instance for the new View.Example
-const db = new Database();
const view = await db.createView("potatoes", { type: "arangosearch" });
// the ArangoSearch View "potatoes" now exists ---Parameters
--
-
-
-
viewName: string
-Name of the View.
-
- -
-
options: CreateViewOptions
-An object defining the properties of the View.
-
Returns Promise<View>
-
-
database
--
-
- database(databaseName: string): Database -
-
-
Creates a new
Databaseinstance for the givendatabaseNamethat +Type Parameters
Parameters
Returns Promise<Job<T>>
Example
+const db = new Database();
const job = await db.createJob(() => db.collections());
while (!job.isLoaded) {
await timeout(1000);
await job.load();
}
// job.result is a list of Collection instances +
create
- create
User(username, passwd): Promise<ArangoApiResponse<ArangoUser>> Creates a new ArangoDB user with the given password.
+Parameters
- username: string
Name of the ArangoDB user to create.
+ - passwd: string
Password of the new ArangoDB user.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.createUser("steve", "hunter2");
// The user "steve" has been created +- username: string
- create
User(username, options): Promise<ArangoApiResponse<ArangoUser>> Creates a new ArangoDB user with the given options.
+Parameters
- username: string
Name of the ArangoDB user to create.
+ - options: UserOptions
Additional options for creating the ArangoDB user.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.createUser("steve", { passwd: "hunter2" });
// The user "steve" has been created +- username: string
create
- create
View(viewName, options): Promise<View> Creates a new View with the given
+viewNameandoptions, then returns a +view.View instance for the new View.Parameters
- viewName: string
Name of the View.
+ - options: CreateViewOptions
An object defining the properties of the View.
+
Returns Promise<View>
Example
+const db = new Database();
const view = await db.createView("potatoes", { type: "arangosearch" });
// the ArangoSearch View "potatoes" now exists +- viewName: string
database
- database(databaseName): Database
- -
Creates a new
-Databaseinstance for the givendatabaseNamethat shares this database's connection pool.See also new Database.
- -Example
-const systemDb = new Database();
const myDb = system.database("my_database"); ---Parameters
--
-
-
-
databaseName: string
-Name of the database.
-
Returns Database
-
-
databases
--
-
- databases(): Promise<Database[]> -
-
-
Fetches all databases from the server and returns an array of
Database+See also :constructor.
+Parameters
- databaseName: string
Name of the database.
+
Returns Database
Example
+const systemDb = new Database();
const myDb = systemDb.database("my_database"); + - databaseName: string
databases
- databases(): Promise<Database[]>
- -
Fetches all databases from the server and returns an array of
-Databaseinstances for those databases.See also listDatabases and -userDatabases.
- -Example
-const db = new Database();
const names = await db.databases();
// databases is an array of databases -Returns Promise<Database[]>
delete
-delete
--
-
- delete
Expired Job Results(threshold: number): Promise<void>
- -
-
Deletes the results of all completed async jobs created before the given +
See also Database#listDatabases and +Database#userDatabases.
+Returns Promise<Database[]>
Example
+const db = new Database();
const names = await db.databases();
// databases is an array of databases +
delete
delete
- delete
Expired Job Results(threshold): Promise<void> - -
Deletes the results of all completed async jobs created before the given threshold.
- -Example
-const db = new Database();
const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
await db.deleteExpiredJobResults(Date.now() - ONE_WEEK);
// all job results older than a week have been deleted ---Parameters
--
-
-
-
threshold: number
-The expiration timestamp in milliseconds.
-
Returns Promise<void>
-
-
delete
-download
--
-
- download
Service(mount: string): Promise<Blob | Buffer>
- -
-
Retrieves a zip bundle containing the service files.
+Parameters
- threshold: number
The expiration timestamp in milliseconds.
+
Returns Promise<void>
Example
+const db = new Database();
const ONE_WEEK = 7 * 24 * 60 * 60 * 1000;
await db.deleteExpiredJobResults(Date.now() - ONE_WEEK);
// all job results older than a week have been deleted + - threshold: number
delete
download
- download
Service(mount): Promise<Buffer | Blob> - -
Retrieves a zip bundle containing the service files.
Returns a
- -Bufferin node.js orBlobin the browser.Example
-const db = new Database();
const serviceBundle = await db.downloadService("/my-foxx"); ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
Returns Promise<Blob | Buffer>
-
-
drop
--
-
- drop
Database(databaseName: string): Promise<boolean>
- -
--
Deletes the database with the given
- -databaseNamefrom the server.Example
-const db = new Database();
await db.dropDatabase("mydb");
// database "mydb" no longer exists ---Parameters
--
-
-
-
databaseName: string
-Name of the database to delete.
-
Returns Promise<boolean>
-
-
drop
--
-
- drop
Function(name: string, group?: boolean): Promise<ArangoApiResponse<{
    deletedCount: number;
}>>
- -
--
Deletes the AQL user function with the given name from the database.
- -Example
-const db = new Database();
await db.dropFunction("ACME::ACCOUNTING::CALCULATE_VAT");
// the function no longer exists --Parameters
--
-
-
-
name: string
-The name of the user function to drop.
-
- -
-
group: boolean = false
-If set to
true, all functions with a name starting with +Parameters
- mount: string
The service's mount point, relative to the database.
+
Returns Promise<Buffer | Blob>
Example
+const db = new Database();
const serviceBundle = await db.downloadService("/my-foxx"); + - mount: string
drop
Database - drop
Database(databaseName): Promise<boolean> Deletes the database with the given
+databaseNamefrom the server.Parameters
- databaseName: string
Name of the database to delete.
+
Returns Promise<boolean>
Example
+const db = new Database();
await db.dropDatabase("mydb");
// database "mydb" no longer exists +- databaseName: string
drop
Function - drop
Function(name, group?): Promise<ArangoApiResponse<{
    deletedCount: number;
}>> Deletes the AQL user function with the given name from the database.
+-Parameters
- name: string
The name of the user function to drop.
+ - group: boolean = false
If set to
-true, all functions with a name starting withnamewill be deleted, otherwise only the function with the exact name will be deleted.
Returns Promise<ArangoApiResponse<{
    deletedCount: number;
}>>- name: string
- -execute
-Cluster Rebalance -
-
- execute
Cluster Rebalance(moves: ClusterRebalanceMove[]): Promise<unknown>
- -
--
Executes the given cluster move shard operations.
- -Example
-const db = new Database();
const result = await db.computerClusterRebalance({
moveLeaders: true,
moveFollowers: true
});
if (result.moves.length) {
await db.executeClusterRebalance(result.moves);
} ---Parameters
--
-
-
-
moves: ClusterRebalanceMove[]
Returns Promise<unknown>
-
-
- execute
-Transaction -
-
- execute
Transaction(collections: TransactionCollections & {
    allowImplicit?: boolean;
}, action: string, options?: TransactionOptions & {
    params?: any;
}): Promise<any>
- -
-
Performs a server-side JavaScript transaction and returns its return +
Returns Promise<ArangoApiResponse<{
    deletedCount: number;
}>>Example
+const db = new Database();
await db.dropFunction("ACME::ACCOUNTING::CALCULATE_VAT");
// the function no longer exists + -
-
execute
- execute
Cluster Rebalance(moves): Promise<unknown> Executes the given cluster move shard operations.
+Parameters
- moves: ClusterRebalanceMove[]
Returns Promise<unknown>
Example
+const db = new Database();
const result = await db.computerClusterRebalance({
moveLeaders: true,
moveFollowers: true
});
if (result.moves.length) {
await db.executeClusterRebalance(result.moves);
} +
execute
- execute
Transaction(collections, action, options?): Promise<any> - -
Performs a server-side JavaScript transaction and returns its return value.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
+implementing the collection.ArangoCollection interface:Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.Note: The
@@ -1097,38 +387,19 @@actionfunction will be evaluated and executed on the server inside ArangoDB's embedded JavaScript environment and can not access any values other than those passed via theparamsoption.execute
Transactionthe JavaScript @arangodbmodule for information about accessing the database from within ArangoDB's server-side JavaScript environment. - -Example
-const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction({
read: ["_users"]
}, action, {
params: { age: 12 }
});
// result contains the return value of the action --Parameters
--
-
-
-
collections: TransactionCollections & {
-
    allowImplicit?: boolean;
}Collections involved in the transaction.
-
- -
-
action: string
-A string evaluating to a JavaScript function to be +
-Parameters
- collections: TransactionCollections & {
    allowImplicit?: boolean;
}Collections involved in the transaction.
+ - action: string
A string evaluating to a JavaScript function to be executed on the server.
-
- -
-
-Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction. If
options.allowImplicit+ Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction. If
-options.allowImplicitis specified, it will be used ifcollections.allowImplicitwas not specified.
Returns Promise<any>
- - collections: TransactionCollections & {
- execute
Transaction(collections: (string | ArangoCollection)[], action: string, options?: TransactionOptions & {
    params?: any;
}): Promise<any>
- -
-
Performs a server-side transaction and returns its return value.
+
Returns Promise<any>
Example
+const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction({
read: ["_users"]
}, action, {
params: { age: 12 }
});
// result contains the return value of the action + -
-
- execute
Transaction(collections, action, options?): Promise<any> - -
Performs a server-side transaction and returns its return value.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
+implementing the collection.ArangoCollection interface:Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.Note: The
actionfunction will be evaluated and executed on the server inside ArangoDB's embedded JavaScript environment and can not access any values other than those passed via theparamsoption. @@ -1136,37 +407,18 @@Returns Promisethe JavaScript
@arangodbmodule for information about accessing the database from within ArangoDB's server-side JavaScript environment. - -Example
-const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction(["_users"], action, {
params: { age: 12 }
});
// result contains the return value of the action --Parameters
--
-
-
-
collections: (string | ArangoCollection)[]
-Collections that can be read from and written to +
-Parameters
- collections: (string | ArangoCollection)[]
Collections that can be read from and written to during the transaction.
-
- -
-
action: string
-A string evaluating to a JavaScript function to be +
- action: string
A string evaluating to a JavaScript function to be executed on the server.
-
- -
-
-Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction.
-
Returns Promise<any>
- - collections: (string | ArangoCollection)[]
- execute
Transaction(collection: string | ArangoCollection, action: string, options?: TransactionOptions & {
    params?: any;
}): Promise<any>
- -
-
Performs a server-side transaction and returns its return value.
+ Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction.
+
Returns Promise<any>
Example
+const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction(["_users"], action, {
params: { age: 12 }
});
// result contains the return value of the action + -
-
- execute
Transaction(collection, action, options?): Promise<any> - -
Performs a server-side transaction and returns its return value.
The Collection can be specified as a collection name (string) or an object -implementing the ArangoCollection interface:
+implementing the collection.ArangoCollection interface:Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.Note: The
actionfunction will be evaluated and executed on the server inside ArangoDB's embedded JavaScript environment and can not access any values other than those passed via theparamsoption. @@ -1174,2336 +426,681 @@Returns Promisethe JavaScript
@arangodbmodule for information about accessing the database from within ArangoDB's server-side JavaScript environment. - -Example
-const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction("_users", action, {
params: { age: 12 }
});
// result contains the return value of the action --Parameters
--
-
-
-
collection: string | ArangoCollection
-A collection that can be read from and written to +
-Parameters
- collection: string | ArangoCollection
A collection that can be read from and written to during the transaction.
-
- -
-
action: string
-A string evaluating to a JavaScript function to be +
- action: string
A string evaluating to a JavaScript function to be executed on the server.
-
- -
-
-Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction.
-
Returns Promise<any>
- collection: string | ArangoCollection
- -exists
-- explain
--
-
- explain(query: AqlQuery<any>, options?: ExplainOptions & {
    allPlans?: false;
}): Promise<ArangoApiResponse<SingleExplainResult>>
- -
-
Explains a database query using the given
-query.See the aql template string handler for information about how +
Optionaloptions: TransactionOptions & {
    params?: any;
}Options for the transaction.
+
Returns Promise<any>
Example
+const db = new Database();
const action = `
function(params) {
// This code will be executed inside ArangoDB!
const { query } = require("@arangodb");
return query\`
FOR user IN _users
FILTER user.age > ${params.age}
RETURN u.user
\`.toArray();
}
`);
const result = await db.executeTransaction("_users", action, {
params: { age: 12 }
});
// result contains the return value of the action + -
-
exists
explain
- explain(query, options?): Promise<ArangoApiResponse<SingleExplainResult>>
- -
Explains a database query using the given
+query.See the aql!aql template string handler for information about how to create a query string without manually defining bind parameters nor having to worry about escaping variables.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`); ---Parameters
--
-
-
-
query: AqlQuery<any>
-An object containing an AQL query string and bind -parameters, e.g. the object returned from an aql template string.
-
- -
-
-Optionaloptions: ExplainOptions & {
    allPlans?: false;
}Options for explaining the query.
-
Returns Promise<ArangoApiResponse<SingleExplainResult>>
- -
-
- explain(query: AqlQuery<any>, options?: ExplainOptions & {
    allPlans: true;
}): Promise<ArangoApiResponse<MultiExplainResult>>
- -
-
Explains a database query using the given
-query.See the aql template string handler for information about how +
Parameters
- query: AqlQuery<any>
An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.
+ Optionaloptions: ExplainOptions & {
    allPlans?: false;
}Options for explaining the query.
+
Returns Promise<ArangoApiResponse<SingleExplainResult>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`); + - query: AqlQuery<any>
- explain(query, options?): Promise<ArangoApiResponse<MultiExplainResult>>
- -
Explains a database query using the given
+query.See the aql!aql template string handler for information about how to create a query string without manually defining bind parameters nor having to worry about escaping variables.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ allPlans: true }
); ---Parameters
--
-
-
-
query: AqlQuery<any>
-An object containing an AQL query string and bind -parameters, e.g. the object returned from an aql template string.
-
- -
-
-Optionaloptions: ExplainOptions & {
    allPlans: true;
}Options for explaining the query.
-
Returns Promise<ArangoApiResponse<MultiExplainResult>>
- -
-
- explain(query: string | AqlLiteral, bindVars?: Record<string, any>, options?: ExplainOptions & {
    allPlans?: false;
}): Promise<ArangoApiResponse<SingleExplainResult>>
- -
-
Explains a database query using the given
-queryandbindVars.See the aql template string handler for a safer and easier +
Parameters
- query: AqlQuery<any>
An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.
+ Optionaloptions: ExplainOptions & {
    allPlans: true;
}Options for explaining the query.
+
Returns Promise<ArangoApiResponse<MultiExplainResult>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ allPlans: true }
); + - query: AqlQuery<any>
- explain(query, bindVars?, options?): Promise<ArangoApiResponse<SingleExplainResult>>
- -
Explains a database query using the given
+queryandbindVars.See the aql!aql template string handler for a safer and easier alternative to passing strings directly.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
`
FOR doc IN @@collection
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ "@collection": collection.name }
); ---Parameters
--
-
-
-
query: string | AqlLiteral
-An AQL query string.
-
- -
-
-OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
-
- -
-
-Optionaloptions: ExplainOptions & {
    allPlans?: false;
}Options for explaining the query.
-
Returns Promise<ArangoApiResponse<SingleExplainResult>>
- -
-
- explain(query: string | AqlLiteral, bindVars?: Record<string, any>, options?: ExplainOptions & {
    allPlans: true;
}): Promise<ArangoApiResponse<MultiExplainResult>>
- -
-
Explains a database query using the given
-queryandbindVars.See the aql template string handler for a safer and easier +
Parameters
- query: string | AqlLiteral
An AQL query string.
+ OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
+Optionaloptions: ExplainOptions & {
    allPlans?: false;
}Options for explaining the query.
+
Returns Promise<ArangoApiResponse<SingleExplainResult>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
`
FOR doc IN @@collection
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ "@collection": collection.name }
); + - query: string | AqlLiteral
- explain(query, bindVars?, options?): Promise<ArangoApiResponse<MultiExplainResult>>
- -
Explains a database query using the given
+queryandbindVars.See the aql!aql template string handler for a safer and easier alternative to passing strings directly.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
`
FOR doc IN @@collection
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ "@collection": collection.name },
{ allPlans: true }
); ---Parameters
--
-
-
-
query: string | AqlLiteral
-An AQL query string.
-
- -
-
-OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
-
- -
-
-Optionaloptions: ExplainOptions & {
    allPlans: true;
}Options for explaining the query.
-
Returns Promise<ArangoApiResponse<MultiExplainResult>>
-
-
get
--
-
- get(): Promise<DatabaseInfo> -
-
--
Fetches the database description for the active database from the server.
- -Example
-const db = new Database();
const info = await db.get();
// the database exists -Returns Promise<DatabaseInfo>
get
--
-
- get
Cluster Imbalance(): Promise<ClusterRebalanceState>
- -
--
Computes the current cluster imbalance.
- -Example
-const db = new Database();
const imbalance = await db.getClusterImbalance(); -Returns Promise<ClusterRebalanceState>
get
--
-
- get
Log Entries(options?: LogEntriesOptions): Promise<LogEntries>
- -
--
Retrieves the log messages from the server's global log.
- -Example
-const log = await db.getLogEntries();
for (let i = 0; i < log.totalAmount; i++) {
console.log(`${
new Date(log.timestamp[i] * 1000).toISOString()
} - [${LogLevel[log.level[i]]}] ${log.text[i]} (#${log.lid[i]})`);
} ---Parameters
--
-
-
-
-Optionaloptions: LogEntriesOptionsOptions for retrieving the log entries.
-
Returns Promise<LogEntries>
-
-
get
--
-
- get
Log Level(): Promise<Record<string, LogLevelSetting>>
- -
--
Retrieves the server's current log level for each topic.
- -Example
-const levels = await db.getLogLevel();
console.log(levels.request); // log level for incoming requests -Returns Promise<Record<string, LogLevelSetting>>
get
--
-
- get
Log Messages(options?: LogEntriesOptions): Promise<LogMessage[]>
- -
--
Retrieves the log messages from the server's global log.
- -Deprecated
This endpoint has been deprecated in ArangoDB 3.8. -Use getLogEntries instead.
- -Example
-const messages = await db.getLogMessages();
for (const m of messages) {
console.log(`${m.date} - [${m.level}] ${m.message} (#${m.id})`);
} ---Parameters
--
-
-
-
-Optionaloptions: LogEntriesOptionsOptions for retrieving the log entries.
-
Returns Promise<LogMessage[]>
-
-
get
--
-
- get
Service(mount: string): Promise<ServiceInfo>
- -
--
Retrieves information about a mounted service.
- -Example
-const db = new Database();
const info = await db.getService("/my-service");
// info contains detailed information about the service ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
Returns Promise<ServiceInfo>
-
-
get
--
-
- get
Service Configuration(mount: string, minimal?: false): Promise<Record<string, ServiceConfiguration>>
- -
-
Retrieves information about the service's configuration options and their +
Parameters
- query: string | AqlLiteral
An AQL query string.
+ OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
+Optionaloptions: ExplainOptions & {
    allPlans: true;
}Options for explaining the query.
+
Returns Promise<ArangoApiResponse<MultiExplainResult>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const explanation = await db.explain(
`
FOR doc IN @@collection
FILTER doc.flavor == "strawberry"
RETURN doc._key
`,
{ "@collection": collection.name },
{ allPlans: true }
); + - query: string | AqlLiteral
get
- get(): Promise<DatabaseInfo>
Fetches the database description for the active database from the server.
+Returns Promise<DatabaseInfo>
Example
+const db = new Database();
const info = await db.get();
// the database exists +
get
- get
Cluster Imbalance(): Promise<ClusterRebalanceState> Computes the current cluster imbalance.
+Returns Promise<ClusterRebalanceState>
Example
+const db = new Database();
const imbalance = await db.getClusterImbalance(); +
get
- get
Log Entries(options?): Promise<LogEntries> Retrieves the log messages from the server's global log.
+Parameters
Optionaloptions: LogEntriesOptionsOptions for retrieving the log entries.
+
Returns Promise<LogEntries>
Example
+const log = await db.getLogEntries();
for (let i = 0; i < log.totalAmount; i++) {
console.log(`${
new Date(log.timestamp[i] * 1000).toISOString()
} - [${LogLevel[log.level[i]]}] ${log.text[i]} (#${log.lid[i]})`);
} +
get
- get
Log Level(): Promise<Record<string, LogLevelSetting>> Retrieves the server's current log level for each topic.
+Returns Promise<Record<string, LogLevelSetting>>
Example
+const levels = await db.getLogLevel();
console.log(levels.request); // log level for incoming requests +
get
- get
Log Messages(options?): Promise<LogMessage[]> Retrieves the log messages from the server's global log.
+Parameters
Optionaloptions: LogEntriesOptionsOptions for retrieving the log entries.
+
Returns Promise<LogMessage[]>
Deprecated
This endpoint has been deprecated in ArangoDB 3.8. +Use Database#getLogEntries instead.
+Example
+const messages = await db.getLogMessages();
for (const m of messages) {
console.log(`${m.date} - [${m.level}] ${m.message} (#${m.id})`);
} +
get
- get
Service(mount): Promise<ServiceInfo> Retrieves information about a mounted service.
+Parameters
- mount: string
The service's mount point, relative to the database.
+
Returns Promise<ServiceInfo>
Example
+const db = new Database();
const info = await db.getService("/my-service");
// info contains detailed information about the service +- mount: string
get
- get
Service Configuration(mount, minimal?): Promise<Record<string, ServiceConfiguration>> - -
Retrieves information about the service's configuration options and their current values.
-See also replaceServiceConfiguration and -updateServiceConfiguration.
- -Example
-const db = new Database();
const config = await db.getServiceConfiguration("/my-service");
for (const [key, option] of Object.entries(config)) {
console.log(`${option.title} (${key}): ${option.current}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#replaceServiceConfiguration and +Database#updateServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ Optionalminimal: falseIf set to
-true, the result will only include each configuration option's current value. Otherwise it will include the full definition for each option.
Returns Promise<Record<string, ServiceConfiguration>>
- - mount: string
- get
Service Configuration(mount: string, minimal: true): Promise<Record<string, any>>
- -
-
Retrieves information about the service's configuration options and their +
Returns Promise<Record<string, ServiceConfiguration>>
Example
+const db = new Database();
const config = await db.getServiceConfiguration("/my-service");
for (const [key, option] of Object.entries(config)) {
console.log(`${option.title} (${key}): ${option.current}`);
} + -
-
- get
Service Configuration(mount, minimal): Promise<Record<string, any>> - -
Retrieves information about the service's configuration options and their current values.
-See also replaceServiceConfiguration and -updateServiceConfiguration.
- -Example
-const db = new Database();
const config = await db.getServiceConfiguration("/my-service", true);
for (const [key, value] of Object.entries(config)) {
console.log(`${key}: ${value}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#replaceServiceConfiguration and +Database#updateServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - minimal: true
If set to
-true, the result will only include each configuration option's current value. Otherwise it will include the full definition for each option.
Returns Promise<Record<string, any>>
- mount: string
- get
-Service Dependencies -
-
- get
Service Dependencies(mount: string, minimal?: false): Promise<Record<string, SingleServiceDependency | MultiServiceDependency>>
- -
-
Retrieves information about the service's dependencies and their current +
Returns Promise<Record<string, any>>
Example
+const db = new Database();
const config = await db.getServiceConfiguration("/my-service", true);
for (const [key, value] of Object.entries(config)) {
console.log(`${key}: ${value}`);
} + -
-
get
- get
Service Dependencies(mount, minimal?): Promise<Record<string, SingleServiceDependency | MultiServiceDependency>> - -
Retrieves information about the service's dependencies and their current mount points.
-See also replaceServiceDependencies and -updateServiceDependencies.
- -Example
-const db = new Database();
const deps = await db.getServiceDependencies("/my-service");
for (const [key, dep] of Object.entries(deps)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#replaceServiceDependencies and +Database#updateServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ Optionalminimal: falseIf set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<Record<string, SingleServiceDependency | MultiServiceDependency>>
- - mount: string
- get
Service Dependencies(mount: string, minimal: true): Promise<Record<string, string | string[]>>
- -
-
Retrieves information about the service's dependencies and their current +
Returns Promise<Record<string, SingleServiceDependency | MultiServiceDependency>>
Example
+const db = new Database();
const deps = await db.getServiceDependencies("/my-service");
for (const [key, dep] of Object.entries(deps)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
} + -
-
- get
Service Dependencies(mount, minimal): Promise<Record<string, string | string[]>> - -
Retrieves information about the service's dependencies and their current mount points.
-See also replaceServiceDependencies and -updateServiceDependencies.
- -Example
-const db = new Database();
const deps = await db.getServiceDependencies("/my-service", true);
for (const [key, value] of Object.entries(deps)) {
console.log(`${key}: ${value}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#replaceServiceDependencies and +Database#updateServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - minimal: true
If set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<Record<string, string | string[]>>
- mount: string
- get
-Service Documentation -
-
- get
Service Documentation(mount: string): Promise<SwaggerJson>
- -
-
Retrieves an Open API compatible Swagger API description object for the +
Returns Promise<Record<string, string | string[]>>
Example
+const db = new Database();
const deps = await db.getServiceDependencies("/my-service", true);
for (const [key, value] of Object.entries(deps)) {
console.log(`${key}: ${value}`);
} + -
-
get
- get
Service Documentation(mount): Promise<SwaggerJson> - -
Retrieves an Open API compatible Swagger API description object for the service installed at the given mount point.
- -Example
-const db = new Database();
const spec = await db.getServiceDocumentation("/my-service");
// spec is a Swagger API description of the service ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
Returns Promise<SwaggerJson>
-
-
get
--
-
- get
Service Readme(mount: string): Promise<undefined | string>
- -
-
Retrieves the text content of the service's
+READMEorREADME.mdfile.Parameters
- mount: string
The service's mount point, relative to the database.
+
Returns Promise<SwaggerJson>
Example
+const db = new Database();
const spec = await db.getServiceDocumentation("/my-service");
// spec is a Swagger API description of the service + - mount: string
get
- get
Service Readme(mount): Promise<undefined | string> - -
Retrieves the text content of the service's
READMEorREADME.mdfile.Returns
- -undefinedif no such file could be found.Example
-const db = new Database();
const readme = await db.getServiceReadme("/my-service");
if (readme !== undefined) console.log(readme);
else console.warn(`No README found.`) ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
Returns Promise<undefined | string>
-
-
get
--
-
- get
User(username: string): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Fetches the user data of a single ArangoDB user.
- -Example
-const db = new Database();
const user = await db.getUser("steve");
// user is the user object for the user named "steve" ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to fetch.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
-
-
get
--
-
- get
User Access Level(username: string, __namedParameters: UserAccessLevelOptions): Promise<AccessLevel>
- -
-
Fetches the given ArangoDB user's access level for the database, or the +
Parameters
- mount: string
The service's mount point, relative to the database.
+
Returns Promise<undefined | string>
Example
+const db = new Database();
const readme = await db.getServiceReadme("/my-service");
if (readme !== undefined) console.log(readme);
else console.warn(`No README found.`) + - mount: string
get
- get
User(username): Promise<ArangoApiResponse<ArangoUser>> Fetches the user data of a single ArangoDB user.
+Parameters
- username: string
Name of the ArangoDB user to fetch.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.getUser("steve");
// user is the user object for the user named "steve" +- username: string
get
- get
User Access Level(username, __namedParameters): Promise<AccessLevel> - -
Fetches the given ArangoDB user's access level for the database, or the given collection in the given database.
- -Example
- -const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve");
// The access level of the user "steve" has been fetched for the current
// database. -Example
- -const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
database: "staging"
});
// The access level of the user "steve" has been fetched for the "staging"
// database. -Example
- -const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
collection: "pokemons"
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in the current database. -Example
- -const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
database: "staging",
collection: "pokemons"
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in the "staging" database. -Example
- -const db = new Database();
const staging = db.database("staging");
const accessLevel = await db.getUserAccessLevel("steve", {
database: staging
});
// The access level of the user "steve" has been fetched for the "staging"
// database. -Example
-const db = new Database();
const staging = db.database("staging");
const accessLevel = await db.getUserAccessLevel("steve", {
collection: staging.collection("pokemons")
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in database "staging". ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to fetch the access level for.
-
- -
-
__namedParameters: UserAccessLevelOptions
Returns Promise<AccessLevel>
-
-
get
--
-
- get
User Databases(username: string, full?: false): Promise<Record<string, AccessLevel>>
- -
-
Fetches an object mapping names of databases to the access level of the +
Parameters
- username: string
Name of the ArangoDB user to fetch the access level for.
+ - __namedParameters: UserAccessLevelOptions
Returns Promise<AccessLevel>
Example
+const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve");
// The access level of the user "steve" has been fetched for the current
// database. +Example
+const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
database: "staging"
});
// The access level of the user "steve" has been fetched for the "staging"
// database. +Example
+const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
collection: "pokemons"
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in the current database. +Example
+const db = new Database();
const accessLevel = await db.getUserAccessLevel("steve", {
database: "staging",
collection: "pokemons"
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in the "staging" database. +Example
+const db = new Database();
const staging = db.database("staging");
const accessLevel = await db.getUserAccessLevel("steve", {
database: staging
});
// The access level of the user "steve" has been fetched for the "staging"
// database. +Example
+const db = new Database();
const staging = db.database("staging");
const accessLevel = await db.getUserAccessLevel("steve", {
collection: staging.collection("pokemons")
});
// The access level of the user "steve" has been fetched for the
// "pokemons" collection in database "staging". + - username: string
get
- get
User Databases(username, full?): Promise<Record<string, AccessLevel>> - -
Fetches an object mapping names of databases to the access level of the given ArangoDB user for those databases.
- -Example
-const db = new Database();
const accessLevels = await db.getUserDatabases("steve");
for (const [databaseName, accessLevel] of Object.entries(accessLevels)) {
console.log(`${databaseName}: ${accessLevel}`);
} ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to fetch the access levels for.
-
- -
-
-Optionalfull: falseWhether access levels for collections should be included.
-
Returns Promise<Record<string, AccessLevel>>
- -
-
- get
User Databases(username: string, full: true): Promise<Record<string, {
    collections: Record<string, "undefined" | AccessLevel>;
    permission: AccessLevel;
}>>
- -
-
Fetches an object mapping names of databases to the access level of the +
Parameters
- username: string
Name of the ArangoDB user to fetch the access levels for.
+ Optionalfull: falseWhether access levels for collections should be included.
+
Returns Promise<Record<string, AccessLevel>>
Example
+const db = new Database();
const accessLevels = await db.getUserDatabases("steve");
for (const [databaseName, accessLevel] of Object.entries(accessLevels)) {
console.log(`${databaseName}: ${accessLevel}`);
} + - username: string
- get
User Databases(username, full): Promise<Record<string, {
    collections: Record<string, "undefined" | AccessLevel>;
    permission: AccessLevel;
}>> - -
Fetches an object mapping names of databases to the access level of the given ArangoDB user for those databases and the collections within each database.
- -Example
-const db = new Database();
const accessLevels = await db.getUserDatabases("steve", true);
for (const [databaseName, obj] of Object.entries(accessLevels)) {
console.log(`${databaseName}: ${obj.permission}`);
for (const [collectionName, accessLevel] of Object.entries(obj.collections)) {
console.log(`${databaseName}/${collectionName}: ${accessLevel}`);
}
} ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to fetch the access levels for.
-
- -
-
full: true
-Whether access levels for collections should be included.
-
Returns Promise<Record<string, {
    collections: Record<string, "undefined" | AccessLevel>;
    permission: AccessLevel;
}>> -
-
graph
--
-
- graph(graphName: string): Graph -
-
-
Returns a Graph instance representing the graph with the given +
Parameters
- username: string
Name of the ArangoDB user to fetch the access levels for.
+ - full: true
Whether access levels for collections should be included.
+
Returns Promise<Record<string, {
    collections: Record<string, "undefined" | AccessLevel>;
    permission: AccessLevel;
}>>Example
+const db = new Database();
const accessLevels = await db.getUserDatabases("steve", true);
for (const [databaseName, obj] of Object.entries(accessLevels)) {
console.log(`${databaseName}: ${obj.permission}`);
for (const [collectionName, accessLevel] of Object.entries(obj.collections)) {
console.log(`${databaseName}/${collectionName}: ${accessLevel}`);
}
} + - username: string
graph
- graph(graphName): Graph
- -
Returns a graph.Graph instance representing the graph with the given
- -graphName.Example
-const db = new Database();
const graph = db.graph("some-graph"); ---Parameters
--
-
-
-
graphName: string
-Name of the graph.
-
Returns Graph
-
-
graphs
-graphs
- graphs(): Promise<Graph[]>
- -
Fetches all graphs from the database and returns an array of graph.Graph instances for those graphs.
-See also listGraphs.
- -Example
-const db = new Database();
const graphs = await db.graphs();
// graphs is an array of Graph instances -Returns Promise<Graph[]>
install
--
-
- install
Service(mount: string, source: string | Readable | Blob | Buffer, options?: InstallServiceOptions): Promise<ServiceInfo>
- -
--
Installs a new service.
- -Example
- -const db = new Database();
// Using a node.js file stream as source
const source = fs.createReadStream("./my-foxx-service.zip");
const info = await db.installService("/hello", source); -Example
- -const db = new Database();
// Using a node.js Buffer as source
const source = fs.readFileSync("./my-foxx-service.zip");
const info = await db.installService("/hello", source); -Example
-const db = new Database();
// Using a File (Blob) from a browser file input
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.installService("/hello", source); ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
source: string | Readable | Blob | Buffer
-The service bundle to install.
-
- -
-
options: InstallServiceOptions = {}
-Options for installing the service.
-
Returns Promise<ServiceInfo>
-
-
job
-kill
--
-
- kill
Query(queryId: string): Promise<void>
- -
--
Kills a running query with the given
-queryId.See also listRunningQueries.
- -Example
-const db = new Database();
const queries = await db.listRunningQueries();
await Promise.all(queries.map(
async (query) => {
if (query.state === "executing") {
await db.killQuery(query.id);
}
}
)); ---Parameters
--
-
-
-
queryId: string
-The ID of a currently running query.
-
Returns Promise<void>
-
-
list
--
-
- list
Analyzers(): Promise<AnalyzerDescription[]>
- -
-
Fetches all Analyzers visible in the database and returns an array of +
See also Database#listGraphs.
+Returns Promise<Graph[]>
Example
+const db = new Database();
const graphs = await db.graphs();
// graphs is an array of Graph instances +
install
- install
Service(mount, source, options?): Promise<ServiceInfo> Installs a new service.
+Parameters
- mount: string
The service's mount point, relative to the database.
+ - source: string | Blob | File
The service bundle to install.
+ - options: InstallServiceOptions = {}
Options for installing the service.
+
Returns Promise<ServiceInfo>
Example
+const db = new Database();
// Using a Buffer in Node.js as source
const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
const info = await db.installService("/hello", source); +Example
+const db = new Database();
// Using a Blob in Node.js as source
const source = await fs.openAsBlob("./my-foxx-service.zip");
const info = await db.installService("/hello", source); +Example
+const db = new Database();
// Using a File from a browser file input as source
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.installService("/hello", source); +- mount: string
job
kill
- kill
Query(queryId): Promise<void> Kills a running query with the given
+queryId.See also Database#listRunningQueries.
+Parameters
- queryId: string
The ID of a currently running query.
+
Returns Promise<void>
Example
+const db = new Database();
const queries = await db.listRunningQueries();
await Promise.all(queries.map(
async (query) => {
if (query.state === "executing") {
await db.killQuery(query.id);
}
}
)); +- queryId: string
list
- list
Analyzers(): Promise<AnalyzerDescription[]> - -
Fetches all Analyzers visible in the database and returns an array of Analyzer descriptions.
-See also analyzers.
- -Example
-const db = new Database();
const analyzers = await db.listAnalyzers();
// analyzers is an array of Analyzer descriptions -Returns Promise<AnalyzerDescription[]>
list
--
-
- list
Collections(excludeSystem?: boolean): Promise<CollectionMetadata[]>
- -
-
Fetches all collections from the database and returns an array of +
See also Database#analyzers.
+Returns Promise<AnalyzerDescription[]>
Example
+const db = new Database();
const analyzers = await db.listAnalyzers();
// analyzers is an array of Analyzer descriptions +
list
- list
Collections(excludeSystem?): Promise<CollectionMetadata[]> - -
Fetches all collections from the database and returns an array of collection descriptions.
-See also collections.
- -Example
- -const db = new Database();
const collections = await db.listCollections();
// collections is an array of collection descriptions
// not including system collections -Example
-const db = new Database();
const collections = await db.listCollections(false);
// collections is an array of collection descriptions
// including system collections ---Parameters
--
-
-
-
excludeSystem: boolean = true
-Whether system collections should be excluded.
-
Returns Promise<CollectionMetadata[]>
-
-
list
-list
--
-
- list
Databases(): Promise<string[]>
- -
--
Fetches all databases from the server and returns an array of their names.
-See also databases and -listUserDatabases.
- -Example
-const db = new Database();
const names = await db.listDatabases();
// databases is an array of database names -Returns Promise<string[]>
list
--
-
- list
Functions(): Promise<AqlUserFunction[]>
- -
--
Fetches a list of all AQL user functions registered with the database.
- -Example
-const db = new Database();
const functions = await db.listFunctions();
const names = functions.map(fn => fn.name); -Returns Promise<AqlUserFunction[]>
list
--
-
- list
Graphs(): Promise<GraphInfo[]>
- -
-
Fetches all graphs from the database and returns an array of graph +
See also Database#collections.
+Parameters
- excludeSystem: boolean = true
Whether system collections should be excluded.
+
Returns Promise<CollectionMetadata[]>
Example
+const db = new Database();
const collections = await db.listCollections();
// collections is an array of collection descriptions
// not including system collections +Example
+const db = new Database();
const collections = await db.listCollections(false);
// collections is an array of collection descriptions
// including system collections + - excludeSystem: boolean = true
list
list
- list
Databases(): Promise<string[]> Fetches all databases from the server and returns an array of their names.
+See also Database#databases and +Database#listUserDatabases.
+Returns Promise<string[]>
Example
+const db = new Database();
const names = await db.listDatabases();
// databases is an array of database names +
list
- list
Functions(): Promise<AqlUserFunction[]> Fetches a list of all AQL user functions registered with the database.
+Returns Promise<AqlUserFunction[]>
Example
+const db = new Database();
const functions = await db.listFunctions();
const names = functions.map(fn => fn.name); +
list
list
--
-
- list
Hot Backups(id?: string | string[]): Promise<HotBackupList>
- -
-
(Enterprise Edition only.) Retrieves a list of all locally found hot +
See also Database#graphs.
+Returns Promise<GraphInfo[]>
Example
+const db = new Database();
const graphs = await db.listGraphs();
// graphs is an array of graph descriptions +
list
- list
Hot Backups(id?): Promise<HotBackupList> - -
(Enterprise Edition only.) Retrieves a list of all locally found hot backups.
- -Example
-const backups = await db.listHotBackups();
for (const backup of backups) {
console.log(backup.id);
} --Parameters
--
-
-
-
-Optionalid: string | string[]If specified, only the backup with the given ID will be +
-Parameters
Optionalid: string | string[]If specified, only the backup with the given ID will be returned.
-
Returns Promise<HotBackupList>
- -list
-Pending Jobs - -list
-Running Queries -
-
- list
Running Queries(): Promise<QueryInfo[]>
- -
--
Fetches a list of information for all currently running queries.
-See also listSlowQueries and killQuery.
- -Example
-const db = new Database();
const queries = await db.listRunningQueries(); -Returns Promise<QueryInfo[]>
- list
-Service Scripts Returns Promise<HotBackupList>
Example
+const backups = await db.listHotBackups();
for (const backup of backups) {
console.log(backup.id);
} + -
-
list
list
- list
Running Queries(): Promise<QueryInfo[]> Fetches a list of information for all currently running queries.
+See also Database#listSlowQueries and Database#killQuery.
+Returns Promise<QueryInfo[]>
Example
+const db = new Database();
const queries = await db.listRunningQueries(); +
list
- list
Service Scripts(mount): Promise<Record<string, string>> - -
Retrieves a list of scripts defined in the service manifest's "scripts" section mapped to their human readable representations.
- -Example
-const db = new Database();
const scripts = await db.listServiceScripts("/my-service");
for (const [name, title] of Object.entries(scripts)) {
console.log(`${name}: ${title}`);
} ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
Returns Promise<Record<string, string>>
-
-
list
--
-
- list
Services(excludeSystem?: boolean): Promise<ServiceSummary[]>
- -
--
Fetches a list of all installed service.
- -Example
- -const db = new Database();
const services = await db.listServices(); -Example
-const db = new Database();
const services = await db.listServices(false); // all services ---Parameters
--
-
-
-
excludeSystem: boolean = true
-Whether system services should be excluded.
-
Returns Promise<ServiceSummary[]>
-
-
list
--
-
- list
Slow Queries(): Promise<QueryInfo[]>
- -
--
Fetches a list of information for all recent slow queries.
-See also listRunningQueries and -clearSlowQueries.
- -Example
-const db = new Database();
const queries = await db.listSlowQueries();
// Only works if slow query tracking is enabled -Returns Promise<QueryInfo[]>
list
--
-
- list
Transactions(): Promise<TransactionDetails[]>
- -
-
Fetches all active transactions from the database and returns an array of +
Parameters
- mount: string
The service's mount point, relative to the database.
+
Returns Promise<Record<string, string>>
Example
+const db = new Database();
const scripts = await db.listServiceScripts("/my-service");
for (const [name, title] of Object.entries(scripts)) {
console.log(`${name}: ${title}`);
} + - mount: string
list
- list
Services(excludeSystem?): Promise<ServiceSummary[]> Fetches a list of all installed service.
+Parameters
- excludeSystem: boolean = true
Whether system services should be excluded.
+
Returns Promise<ServiceSummary[]>
Example
+const db = new Database();
const services = await db.listServices(); +Example
+const db = new Database();
const services = await db.listServices(false); // all services +- excludeSystem: boolean = true
list
- list
Slow Queries(): Promise<QueryInfo[]> Fetches a list of information for all recent slow queries.
+See also Database#listRunningQueries and +Database#clearSlowQueries.
+Returns Promise<QueryInfo[]>
Example
+const db = new Database();
const queries = await db.listSlowQueries();
// Only works if slow query tracking is enabled +
list
- list
Transactions(): Promise<TransactionDetails[]> - -
Fetches all active transactions from the database and returns an array of transaction descriptions.
-See also transactions.
- -Example
-const db = new Database();
const transactions = await db.listTransactions();
// transactions is an array of transaction descriptions -Returns Promise<TransactionDetails[]>
list
--
-
- list
User Databases(): Promise<string[]>
- -
-
Fetches all databases accessible to the active user from the server and +
See also Database#transactions.
+Returns Promise<TransactionDetails[]>
Example
+const db = new Database();
const transactions = await db.listTransactions();
// transactions is an array of transaction descriptions +
list
- list
User Databases(): Promise<string[]> - -
Fetches all databases accessible to the active user from the server and returns an array of their names.
-See also userDatabases and -listDatabases.
- -Example
-const db = new Database();
const names = await db.listUserDatabases();
// databases is an array of database names -Returns Promise<string[]>
list
--
-
- list
Users(): Promise<ArangoUser[]>
- -
-
Fetches all ArangoDB users visible to the authenticated user and returns +
See also Database#userDatabases and +Database#listDatabases.
+Returns Promise<string[]>
Example
+const db = new Database();
const names = await db.listUserDatabases();
// databases is an array of database names +
list
- list
Users(): Promise<ArangoUser[]> - -
Fetches all ArangoDB users visible to the authenticated user and returns an array of user objects.
- -Example
-const db = new Database();
const users = await db.listUsers();
// users is an array of user objects -Returns Promise<ArangoUser[]>
list
--
-
- list
Views(): Promise<ViewDescription[]>
- -
-
Fetches all Views from the database and returns an array of View +
Returns Promise<ArangoUser[]>
Example
+const db = new Database();
const users = await db.listUsers();
// users is an array of user objects +
list
- list
Views(): Promise<ViewDescription[]> - -
Fetches all Views from the database and returns an array of View descriptions.
-See also views.
- -Example
-const db = new Database();
const views = await db.listViews();
// views is an array of View descriptions -Returns Promise<ViewDescription[]>
login
--
-
- login(username?: string, password?: string): Promise<string> -
-
-
Validates the given database credentials and exchanges them for an +
See also Database#views.
+Returns Promise<ViewDescription[]>
Example
+const db = new Database();
const views = await db.listViews();
// views is an array of View descriptions +
login
- login(username?, password?): Promise<string>
- -
Validates the given database credentials and exchanges them for an authentication token, then uses the authentication token for future requests and returns it.
- -Example
-const db = new Database();
await db.login("admin", "hunter2");
// with an authentication token for the "admin" user. ---Parameters
--
-
-
-
username: string = "root"
-The username to authenticate with.
-
- -
-
password: string = ""
-The password to authenticate with.
-
Returns Promise<string>
-
-
parse
--
-
- parse(query: string | AqlLiteral | AqlQuery<any>): Promise<ParseResult> -
-
-
Parses the given query and returns the result.
-See the aql template string handler for information about how +
Parameters
- username: string = "root"
The username to authenticate with.
+ - password: string = ""
The password to authenticate with.
+
Returns Promise<string>
Example
+const db = new Database();
await db.login("admin", "hunter2");
// with an authentication token for the "admin" user. + - username: string = "root"
parse
- parse(query): Promise<ParseResult>
- -
Parses the given query and returns the result.
+See the aql!aql template string handler for information about how to create a query string without manually defining bind parameters nor having to worry about escaping variables.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const ast = await db.parse(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`); --Parameters
--
-
-
-
query: string | AqlLiteral | AqlQuery<any>
-An AQL query string or an object containing an AQL query -string and bind parameters, e.g. the object returned from an aql +
-Parameters
- query: string | AqlLiteral | AqlQuery<any>
An AQL query string or an object containing an AQL query +string and bind parameters, e.g. the object returned from an aql!aql template string.
-
Returns Promise<ParseResult>
- query: string | AqlLiteral | AqlQuery<any>
- query
--
-
- query<T>(query: AqlQuery<T>, options?: QueryOptions): Promise<ArrayCursor<T>> -
-
-
Performs a database query using the given
-query, then returns a new -ArrayCursor instance for the result set.See the aql template string handler for information about how +
Returns Promise<ParseResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const ast = await db.parse(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc._key
`); + -
-
query
- query<T>(query, options?): Promise<ArrayCursor<T>>
- -
Performs a database query using the given
+query, then returns a new +cursor.ArrayCursor instance for the result set.See the aql!aql template string handler for information about how to create a query string without manually defining bind parameters nor having to worry about escaping variables.
Note: When executing a query in a streaming transaction using the
- -stepmethod, the resulting cursor will be bound to that transaction and you do not need to use thestepmethod to consume it.Example
- -const db = new Database();
const active = true;
const Users = db.collection("_users");
// Using an aql template string:
// Bind parameters are automatically extracted and arangojs collections
// are automatically passed as collection bind parameters.
const cursor = await db.query(aql`
FOR u IN ${Users}
FILTER u.authData.active == ${active}
RETURN u.user
`);
// cursor is a cursor for the query result -Example
-const db = new Database();
const active = true;
const Users = db.collection("_users");
// Using an object with a regular multi-line string
const cursor = await db.query({
query: `
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`,
bindVars: { active: active, "@users": Users.name }
}); -- -Type Parameters
--
-
-
-
T = any
--Parameters
--
-
-
-
query: AqlQuery<T>
-An object containing an AQL query string and bind -parameters, e.g. the object returned from an aql template string.
-
- -
-
-Optionaloptions: QueryOptionsOptions for the query execution.
-
Returns Promise<ArrayCursor<T>>
- -
-
- query<T>(query: string | AqlLiteral, bindVars?: Record<string, any>, options?: QueryOptions): Promise<ArrayCursor<T>> -
-
-
Performs a database query using the given
-queryandbindVars, then -returns a new ArrayCursor instance for the result set.See the aql template string handler for a safer and easier +
Type Parameters
Parameters
- query: AqlQuery<T>
An object containing an AQL query string and bind +parameters, e.g. the object returned from an aql!aql template string.
+ Optionaloptions: QueryOptionsOptions for the query execution.
+
Returns Promise<ArrayCursor<T>>
Example
+const db = new Database();
const active = true;
const Users = db.collection("_users");
// Using an aql template string:
// Bind parameters are automatically extracted and arangojs collections
// are automatically passed as collection bind parameters.
const cursor = await db.query(aql`
FOR u IN ${Users}
FILTER u.authData.active == ${active}
RETURN u.user
`);
// cursor is a cursor for the query result +Example
+const db = new Database();
const active = true;
const Users = db.collection("_users");
// Using an object with a regular multi-line string
const cursor = await db.query({
query: `
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`,
bindVars: { active: active, "@users": Users.name }
}); + - query: AqlQuery<T>
- query<T>(query, bindVars?, options?): Promise<ArrayCursor<T>>
- -
Performs a database query using the given
+queryandbindVars, then +returns a new cursor.ArrayCursor instance for the result set.See the aql!aql template string handler for a safer and easier alternative to passing strings directly.
Note: When executing a query in a streaming transaction using the
- -stepmethod, the resulting cursor will be bound to that transaction and you do not need to use thestepmethod to consume it.Example
- -const db = new Database();
const active = true;
const Users = db.collection("_users");
const cursor = await db.query(
// A normal multi-line string
`
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`,
{ active: active, "@users": Users.name }
); -Example
-const db = new Database();
const active = true;
const Users = db.collection("_users");
const cursor = await db.query(
// An AQL literal created from a normal multi-line string
aql.literal(`
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`),
{ active: active, "@users": Users.name }
); -- -Type Parameters
--
-
-
-
T = any
--Parameters
--
-
-
-
query: string | AqlLiteral
-An AQL query string.
-
- -
-
-OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
-
- -
-
-Optionaloptions: QueryOptionsOptions for the query execution.
-
Returns Promise<ArrayCursor<T>>
-
-
query
--
-
- query
Rules(): Promise<QueryOptimizerRule[]>
- -
--
Fetches the available optimizer rules.
- -Example
-const db = new Database();
const rules = await db.queryRules();
for (const rule of rules) {
console.log(rule.name);
} -Returns Promise<QueryOptimizerRule[]>
query
--
-
- query
Tracking(): Promise<QueryTracking>
- -
--
Fetches the query tracking properties.
- -Example
-const db = new Database();
const tracking = await db.queryTracking();
console.log(tracking.enabled); -Returns Promise<QueryTracking>
- - query
Tracking(options: QueryTrackingOptions): Promise<QueryTracking>
- -
--
Modifies the query tracking properties.
- -Example
-const db = new Database();
// track up to 5 slow queries exceeding 5 seconds execution time
await db.setQueryTracking({
enabled: true,
trackSlowQueries: true,
maxSlowQueries: 5,
slowQueryThreshold: 5
}); ---Parameters
--
-
-
-
options: QueryTrackingOptions
-Options for query tracking.
-
Returns Promise<QueryTracking>
-
-
rebalance
--
-
- rebalance
Cluster(opts: ClusterRebalanceOptions): Promise<ClusterRebalanceResult>
- -
-
Computes a set of move shard operations to rebalance the cluster and +
Type Parameters
Parameters
- query: string | AqlLiteral
An AQL query string.
+ OptionalbindVars: Record<string, any>An object defining bind parameters for the query.
+Optionaloptions: QueryOptionsOptions for the query execution.
+
Returns Promise<ArrayCursor<T>>
Example
+const db = new Database();
const active = true;
const Users = db.collection("_users");
const cursor = await db.query(
// A normal multi-line string
`
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`,
{ active: active, "@users": Users.name }
); +Example
+const db = new Database();
const active = true;
const Users = db.collection("_users");
const cursor = await db.query(
// An AQL literal created from a normal multi-line string
aql.literal(`
FOR u IN @@users
FILTER u.authData.active == @active
RETURN u.user
`),
{ active: active, "@users": Users.name }
); + - query: string | AqlLiteral
query
- query
Rules(): Promise<QueryOptimizerRule[]> Fetches the available optimizer rules.
+Returns Promise<QueryOptimizerRule[]>
Example
+const db = new Database();
const rules = await db.queryRules();
for (const rule of rules) {
console.log(rule.name);
} +
query
- query
Tracking(): Promise<QueryTracking> Fetches the query tracking properties.
+Returns Promise<QueryTracking>
Example
+const db = new Database();
const tracking = await db.queryTracking();
console.log(tracking.enabled); +- query
Tracking(options): Promise<QueryTracking> Modifies the query tracking properties.
+Parameters
- options: QueryTrackingOptions
Options for query tracking.
+
Returns Promise<QueryTracking>
Example
+const db = new Database();
// track up to 5 slow queries exceeding 5 seconds execution time
await db.setQueryTracking({
enabled: true,
trackSlowQueries: true,
maxSlowQueries: 5,
slowQueryThreshold: 5
}); +- options: QueryTrackingOptions
rebalance
- rebalance
Cluster(opts): Promise<ClusterRebalanceResult> - -
Computes a set of move shard operations to rebalance the cluster and executes them.
- -Example
-const db = new Database();
const result = await db.rebalanceCluster({
moveLeaders: true,
moveFollowers: true
});
// The cluster is now rebalanced. ---Parameters
--
-
-
-
opts: ClusterRebalanceOptions
Returns Promise<ClusterRebalanceResult>
-
-
remove
--
-
- remove
User(username: string): Promise<ArangoApiResponse<Record<string, never>>>
- -
--
Removes the ArangoDB user with the given username from the server.
- -Example
-const db = new Database();
await db.removeUser("steve");
// The user "steve" has been removed ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to remove.
-
Returns Promise<ArangoApiResponse<Record<string, never>>>
-
-
rename
--
-
- rename
Collection(collectionName: string, newName: string): Promise<ArangoApiResponse<CollectionMetadata>>
- -
-
Renames the collection
+collectionNametonewName.Parameters
- opts: ClusterRebalanceOptions
Returns Promise<ClusterRebalanceResult>
Example
+const db = new Database();
const result = await db.rebalanceCluster({
moveLeaders: true,
moveFollowers: true
});
// The cluster is now rebalanced. +
remove
- remove
User(username): Promise<ArangoApiResponse<Record<string, never>>> Removes the ArangoDB user with the given username from the server.
+Parameters
- username: string
Name of the ArangoDB user to remove.
+
Returns Promise<ArangoApiResponse<Record<string, never>>>
Example
+const db = new Database();
await db.removeUser("steve");
// The user "steve" has been removed +- username: string
rename
- rename
Collection(collectionName, newName): Promise<ArangoApiResponse<CollectionMetadata>> - -
Renames the collection
collectionNametonewName.Additionally removes any stored
Collectioninstance forcollectionNamefrom theDatabaseinstance's internal cache.Note: Renaming collections may not be supported when ArangoDB is running in a cluster configuration.
---Parameters
--
-
-
-
collectionName: string
-Current name of the collection.
-
- -
-
newName: string
-The new name of the collection.
-
Returns Promise<ArangoApiResponse<CollectionMetadata>>
-
-
rename
--
-
- rename
View(viewName: string, newName: string): Promise<ArangoApiResponse<ViewDescription>>
- -
-
Renames the view
-viewNametonewName.Additionally removes any stored View instance for
viewNamefrom +Parameters
- collectionName: string
Current name of the collection.
+ - newName: string
The new name of the collection.
+
Returns Promise<ArangoApiResponse<CollectionMetadata>>
- collectionName: string
rename
- rename
View(viewName, newName): Promise<ArangoApiResponse<ViewDescription>> - -
Renames the view
+viewNametonewName.Additionally removes any stored view.View instance for
viewNamefrom theDatabaseinstance's internal cache.Note: Renaming views may not be supported when ArangoDB is running in a cluster configuration.
---Parameters
--
-
-
-
viewName: string
-Current name of the view.
-
- -
-
newName: string
-The new name of the view.
-
Returns Promise<ArangoApiResponse<ViewDescription>>
-
-
renew
--
-
- renew
Auth Token(): Promise<null | string>
- -
-
Attempts to renew the authentication token passed to useBearerAuth -or returned and used by login. If a new authentication +
Parameters
- viewName: string
Current name of the view.
+ - newName: string
The new name of the view.
+
Returns Promise<ArangoApiResponse<ViewDescription>>
- viewName: string
renew
- renew
Auth Token(): Promise<null | string> - -
Attempts to renew the authentication token passed to Database#useBearerAuth +or returned and used by Database#login. If a new authentication token is issued, it will be used for future requests and returned.
- -Example
-const db = new Database();
await db.login("admin", "hunter2");
// ... later ...
const newToken = await db.renewAuthToken();
if (!newToken) // no new token issued -Returns Promise<null | string>
replace
--
-
- replace
Service(mount: string, source: string | Readable | Blob | Buffer, options?: ReplaceServiceOptions): Promise<ServiceInfo>
- -
-
Replaces an existing service with a new service by completely removing the +
Returns Promise<null | string>
Example
+const db = new Database();
await db.login("admin", "hunter2");
// ... later ...
const newToken = await db.renewAuthToken();
if (!newToken) // no new token issued +
replace
- replace
Service(mount, source, options?): Promise<ServiceInfo> - -
Replaces an existing service with a new service by completely removing the old service and installing a new service at the same mount point.
- -Example
- -const db = new Database();
// Using a node.js file stream as source
const source = fs.createReadStream("./my-foxx-service.zip");
const info = await db.replaceService("/hello", source); -Example
- -const db = new Database();
// Using a node.js Buffer as source
const source = fs.readFileSync("./my-foxx-service.zip");
const info = await db.replaceService("/hello", source); -Example
-const db = new Database();
// Using a File (Blob) from a browser file input
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.replaceService("/hello", source); ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
source: string | Readable | Blob | Buffer
-The service bundle to install.
-
- -
-
options: ReplaceServiceOptions = {}
-Options for replacing the service.
-
Returns Promise<ServiceInfo>
-
-
replace
--
-
- replace
Service Configuration(mount: string, cfg: Record<string, any>, minimal?: false): Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>
- -
-
Replaces the configuration of the given service, discarding any existing +
Parameters
- mount: string
The service's mount point, relative to the database.
+ - source: string | Blob | File
The service bundle to install.
+ - options: ReplaceServiceOptions = {}
Options for replacing the service.
+
Returns Promise<ServiceInfo>
Example
+const db = new Database();
// Using a Buffer in Node.js as source
const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
const info = await db.replaceService("/hello", source); +Example
+const db = new Database();
// Using a Blob in Node.js as source
const source = await fs.openAsBlob("./my-foxx-service.zip");
const info = await db.replaceService("/hello", source); +Example
+const db = new Database();
// Using a File from a browser file input as source
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.replaceService("/hello", source); + - mount: string
replace
- replace
Service Configuration(mount, cfg, minimal?): Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>> - -
Replaces the configuration of the given service, discarding any existing values for options not specified.
-See also updateServiceConfiguration and -getServiceConfiguration.
- -Example
-const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.replaceServiceConfiguration("/my-service", config);
for (const [key, option] of Object.entries(info)) {
console.log(`${option.title} (${key}): ${option.value}`);
if (option.warning) console.warn(`Warning: ${option.warning}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
cfg: Record<string, any>
-An object mapping configuration option names to values.
-
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#updateServiceConfiguration and +Database#getServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - cfg: Record<string, any>
An object mapping configuration option names to values.
+ Optionalminimal: falseIf set to
-true, the result will only include each configuration option's current value and warning (if any). Otherwise it will include the full definition for each option.
Returns Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>
- - mount: string
- replace
Service Configuration(mount: string, cfg: Record<string, any>, minimal: true): Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}>
- -
-
Replaces the configuration of the given service, discarding any existing +
Returns Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>Example
+const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.replaceServiceConfiguration("/my-service", config);
for (const [key, option] of Object.entries(info)) {
console.log(`${option.title} (${key}): ${option.value}`);
if (option.warning) console.warn(`Warning: ${option.warning}`);
} + -
-
- replace
Service Configuration(mount, cfg, minimal): Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}> - -
Replaces the configuration of the given service, discarding any existing values for options not specified.
-See also updateServiceConfiguration and -getServiceConfiguration.
- -Example
-const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.replaceServiceConfiguration("/my-service", config);
for (const [key, value] of Object.entries(info.values)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
cfg: Record<string, any>
-An object mapping configuration option names to values.
-
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#updateServiceConfiguration and +Database#getServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - cfg: Record<string, any>
An object mapping configuration option names to values.
+ - minimal: true
If set to
-true, the result will only include each configuration option's current value and warning (if any). Otherwise it will include the full definition for each option.
Returns Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}> - mount: string
- replace
-Service Dependencies Returns Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}>Example
+const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.replaceServiceConfiguration("/my-service", config);
for (const [key, value] of Object.entries(info.values)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} + -
-
replace
- replace
Service Dependencies(mount, deps, minimal?): Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
    warning?: string;
}>> - -
Replaces the dependencies of the given service, discarding any existing mount points for dependencies not specified.
-See also updateServiceDependencies and -getServiceDependencies.
- -Example
-const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.replaceServiceDependencies("/my-service", deps);
for (const [key, dep] of Object.entries(info)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
if (dep.warning) console.warn(`Warning: ${dep.warning}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
deps: Record<string, string>
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#updateServiceDependencies and +Database#getServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - deps: Record<string, string>
Optionalminimal: falseIf set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<Record<string, Object>>
- - mount: string
- replace
Service Dependencies(mount: string, deps: Record<string, string>, minimal: true): Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}>
- -
-
Replaces the dependencies of the given service, discarding any existing +
Returns Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
    warning?: string;
}>>Example
+const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.replaceServiceDependencies("/my-service", deps);
for (const [key, dep] of Object.entries(info)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
if (dep.warning) console.warn(`Warning: ${dep.warning}`);
} + -
-
- replace
Service Dependencies(mount, deps, minimal): Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}> - -
Replaces the dependencies of the given service, discarding any existing mount points for dependencies not specified.
-See also updateServiceDependencies and -getServiceDependencies.
- -Example
-const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.replaceServiceDependencies(
"/my-service",
deps,
true
);
for (const [key, value] of Object.entries(info)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
deps: Record<string, string>
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#updateServiceDependencies and +Database#getServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - deps: Record<string, string>
- minimal: true
If set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}> - mount: string
- -replace
-User -
-
- replace
User(username: string, options: UserOptions): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Replaces the ArangoDB user's option with the new options.
- -Example
-const db = new Database();
const user = await db.replaceUser("steve", { passwd: "", active: false });
// The user "steve" has been set to inactive with an empty password ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to modify.
-
- -
-
options: UserOptions
-New options to replace the user's existing options.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
-
-
- restore
-Hot Backup Returns Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}>Example
+const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.replaceServiceDependencies(
"/my-service",
deps,
true
);
for (const [key, value] of Object.entries(info)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} + -
-
replace
- replace
User(username, options): Promise<ArangoApiResponse<ArangoUser>> Replaces the ArangoDB user's option with the new options.
+Parameters
- username: string
Name of the ArangoDB user to modify.
+ - options: UserOptions
New options to replace the user's existing options.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.replaceUser("steve", { passwd: "", active: false });
// The user "steve" has been set to inactive with an empty password +- username: string
restore
- restore
Hot Backup(id): Promise<string> - -
(Enteprise Edition only.) Restores a consistent local hot backup.
Returns the directory path of the restored backup.
- -Example
-await db.restoreHotBackup("2023-09-19T15.38.21Z_example");
// the backup has been restored ---Parameters
--
-
-
-
id: string
-The ID of the backup to restore.
-
Returns Promise<string>
-
-
route
-route
- route(path?, headers?): Route
- -
Returns a new route.Route instance for the given path (relative to the database) that can be used to perform arbitrary HTTP requests.
- -Example
-const db = new Database();
const myFoxxService = db.route("my-foxx-service");
const response = await myFoxxService.post("users", {
username: "admin",
password: "hunter2"
});
// response.body is the result of
// POST /_db/_system/my-foxx-service/users
// with JSON request body '{"username": "admin", "password": "hunter2"}' --Parameters
--
-
-
-
-Optionalpath: stringThe database-relative URL of the route. Defaults to the +
-Parameters
Optionalpath: stringThe database-relative URL of the route. Defaults to the database API root.
-
--
-
-Optionalheaders: HeadersDefault headers that should be sent with each request to +
Optionalheaders: Record<string, string> | HeadersDefault headers that should be sent with each request to the route.
-
Returns Route
- run
-Service Script Returns Route
Example
+const db = new Database();
const myFoxxService = db.route("my-foxx-service");
const response = await myFoxxService.post("users", {
username: "admin",
password: "hunter2"
});
// response.body is the result of
// POST /_db/_system/my-foxx-service/users
// with JSON request body '{"username": "admin", "password": "hunter2"}' + -
-
run
- run
Service Script(mount, name, params?): Promise<any> - -
Executes a service script and retrieves its result exposed as
- -module.exports(if any).Example
-const db = new Database();
const result = await db.runServiceScript(
"/my-service",
"create-user",
{
username: "service_admin",
password: "hunter2"
}
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
name: string
-Name of the service script to execute as defined in the +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - name: string
Name of the service script to execute as defined in the service manifest.
-
- -
-
-Optionalparams: anyArbitrary value that will be exposed to the script as +
Optionalparams: anyArbitrary value that will be exposed to the script as
-argv[0]in the service context (e.g.module.context.argv[0]). Must be serializable to JSON.
Returns Promise<any>
- mount: string
- run
-Service Tests -
-
- run
Service Tests(mount: string, options?: {
    filter?: string;
    idiomatic?: false;
    reporter?: "default";
}): Promise<ServiceTestDefaultReport>
- -
-
Runs the tests of a given service and returns the results using the +
Returns Promise<any>
Example
+const db = new Database();
const result = await db.runServiceScript(
"/my-service",
"create-user",
{
username: "service_admin",
password: "hunter2"
}
); + -
-
run
- run
Service Tests(mount, options?): Promise<ServiceTestDefaultReport> - -
Runs the tests of a given service and returns the results using the "default" reporter.
- -Example
-const db = new Database();
const testReport = await db.runServiceTests("/my-foxx"); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
-Optionaloptions: {
    filter?: string;
    idiomatic?: false;
    reporter?: "default";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ Optionaloptions: {
    filter?: string;
    idiomatic?: false;
    reporter?: "default";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
-Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. Has no effect when +
Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. Has no effect when using the "default" or "suite" reporters.
-
--
-
Optionalreporter?: "default"
Returns Promise<ServiceTestDefaultReport>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic?: false;
    reporter: "suite";
}): Promise<ServiceTestSuiteReport>
- -
-
Runs the tests of a given service and returns the results using the +
Optionalreporter?: "default"
-
-
Returns Promise<ServiceTestDefaultReport>
Example
+const db = new Database();
const testReport = await db.runServiceTests("/my-foxx"); + -
-
- run
Service Tests(mount, options): Promise<ServiceTestSuiteReport> - -
Runs the tests of a given service and returns the results using the "suite" reporter, which groups the test result by test suite.
- -Example
-const db = new Database();
const suiteReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "suite" }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic?: false;
    reporter: "suite";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic?: false;
    reporter: "suite";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
-Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. Has no effect when +
Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. Has no effect when using the "default" or "suite" reporters.
-
--
-
reporter: "suite"
Returns Promise<ServiceTestSuiteReport>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic?: false;
    reporter: "stream";
}): Promise<ServiceTestStreamReport>
- -
-
Runs the tests of a given service and returns the results using the +
reporter: "suite"
-
-
Returns Promise<ServiceTestSuiteReport>
Example
+const db = new Database();
const suiteReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "suite" }
); + -
-
- run
Service Tests(mount, options): Promise<ServiceTestStreamReport> - -
Runs the tests of a given service and returns the results using the "stream" reporter, which represents the results as a sequence of tuples representing events.
- -Example
-const db = new Database();
const streamEvents = await db.runServiceTests(
"/my-foxx",
{ reporter: "stream" }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic?: false;
    reporter: "stream";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic?: false;
    reporter: "stream";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
-Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
true, + Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
-true, the results will be returned as a formatted string.
--
-
reporter: "stream"
Returns Promise<ServiceTestStreamReport>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic?: false;
    reporter: "tap";
}): Promise<ServiceTestTapReport>
- -
-
Runs the tests of a given service and returns the results using the +
reporter: "stream"
-
-
Returns Promise<ServiceTestStreamReport>
Example
+const db = new Database();
const streamEvents = await db.runServiceTests(
"/my-foxx",
{ reporter: "stream" }
); + -
-
- run
Service Tests(mount, options): Promise<ServiceTestTapReport> - -
Runs the tests of a given service and returns the results using the "tap" reporter, which represents the results as an array of strings using the "tap" format.
- -Example
-const db = new Database();
const tapLines = await db.runServiceTests(
"/my-foxx",
{ reporter: "tap" }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic?: false;
    reporter: "tap";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic?: false;
    reporter: "tap";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
-Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
true, + Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
-true, the results will be returned as a formatted string.
--
-
reporter: "tap"
Returns Promise<ServiceTestTapReport>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic?: false;
    reporter: "xunit";
}): Promise<ServiceTestXunitReport>
- -
-
Runs the tests of a given service and returns the results using the +
reporter: "tap"
-
-
Returns Promise<ServiceTestTapReport>
Example
+const db = new Database();
const tapLines = await db.runServiceTests(
"/my-foxx",
{ reporter: "tap" }
); + -
-
- run
Service Tests(mount, options): Promise<ServiceTestXunitReport> - -
Runs the tests of a given service and returns the results using the "xunit" reporter, which represents the results as an XML document using the JSONML exchange format.
- -Example
-const db = new Database();
const jsonML = await db.runServiceTests(
"/my-foxx",
{ reporter: "xunit" }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic?: false;
    reporter: "xunit";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic?: false;
    reporter: "xunit";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
-Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
true, + Optionalidiomatic?: falseWhether the reporter should use "idiomatic" mode. If set to
-true, the results will be returned as a formatted string.
--
-
reporter: "xunit"
Returns Promise<ServiceTestXunitReport>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic: true;
    reporter: "stream";
}): Promise<string>
- -
-
Runs the tests of a given service and returns the results as a string +
reporter: "xunit"
-
-
Returns Promise<ServiceTestXunitReport>
Example
+const db = new Database();
const jsonML = await db.runServiceTests(
"/my-foxx",
{ reporter: "xunit" }
); + -
-
- run
Service Tests(mount, options): Promise<string> - -
Runs the tests of a given service and returns the results as a string using the "stream" reporter in "idiomatic" mode, which represents the results as a line-delimited JSON stream of tuples representing events.
- -Example
-const db = new Database();
const streamReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "stream", idiomatic: true }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic: true;
    reporter: "stream";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic: true;
    reporter: "stream";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
idiomatic: true
-Whether the reporter should use "idiomatic" mode. If set to
false, + idiomatic: true
Whether the reporter should use "idiomatic" mode. If set to
-false, the results will be returned as an array of tuples instead of a string.
--
-
reporter: "stream"
Returns Promise<string>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic: true;
    reporter: "tap";
}): Promise<string>
- -
-
Runs the tests of a given service and returns the results as a string +
reporter: "stream"
-
-
Returns Promise<string>
Example
+const db = new Database();
const streamReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "stream", idiomatic: true }
); + -
-
- run
Service Tests(mount, options): Promise<string> - -
Runs the tests of a given service and returns the results as a string using the "tap" reporter in "idiomatic" mode, which represents the results using the "tap" format.
- -Example
-const db = new Database();
const tapReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "tap", idiomatic: true }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic: true;
    reporter: "tap";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic: true;
    reporter: "tap";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
idiomatic: true
-Whether the reporter should use "idiomatic" mode. If set to
false, + idiomatic: true
Whether the reporter should use "idiomatic" mode. If set to
-false, the results will be returned as an array of strings instead of a single string.
--
-
reporter: "tap"
Returns Promise<string>
- - mount: string
- run
Service Tests(mount: string, options: {
    filter?: string;
    idiomatic: true;
    reporter: "xunit";
}): Promise<string>
- -
-
Runs the tests of a given service and returns the results as a string +
reporter: "tap"
-
-
Returns Promise<string>
Example
+const db = new Database();
const tapReport = await db.runServiceTests(
"/my-foxx",
{ reporter: "tap", idiomatic: true }
); + -
-
- run
Service Tests(mount, options): Promise<string> - -
Runs the tests of a given service and returns the results as a string using the "xunit" reporter in "idiomatic" mode, which represents the results as an XML document.
- -Example
-const db = new Database();
const xml = await db.runServiceTests(
"/my-foxx",
{ reporter: "xunit", idiomatic: true }
); --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
options: {
-
    filter?: string;
    idiomatic: true;
    reporter: "xunit";
}-Options for running the tests.
--
-
-
-
-Optionalfilter?: stringIf set, only tests with full names including this exact string will be +
-Parameters
- mount: string
The service's mount point, relative to the database.
+ - options: {
    filter?: string;
    idiomatic: true;
    reporter: "xunit";
}Options for running the tests.
+Optionalfilter?: stringIf set, only tests with full names including this exact string will be executed.
-
--
-
idiomatic: true
-Whether the reporter should use "idiomatic" mode. If set to
false, + idiomatic: true
Whether the reporter should use "idiomatic" mode. If set to
-false, the results will be returned using the JSONML exchange format instead of a string.
--
-
reporter: "xunit"
Returns Promise<string>
- mount: string
- set
-Log Level -
-
- set
Log Level(levels: Record<string, LogLevelSetting>): Promise<Record<string, LogLevelSetting>>
- -
-
Sets the server's log level for each of the given topics to the given level.
+ reporter: "xunit"
-
-
Returns Promise<string>
Example
+const db = new Database();
const xml = await db.runServiceTests(
"/my-foxx",
{ reporter: "xunit", idiomatic: true }
); + -
-
set
- set
Log Level(levels): Promise<Record<string, LogLevelSetting>> - -
Sets the server's log level for each of the given topics to the given level.
Any omitted topics will be left unchanged.
- -Example
-await db.setLogLevel({ request: "debug" });
// Debug information will now be logged for each request ---Parameters
--
-
-
-
levels: Record<string, LogLevelSetting>
-An object mapping topic names to log levels.
-
Returns Promise<Record<string, LogLevelSetting>>
-
-
set
--
-
- set
Response Queue Time Samples(responseQueueTimeSamples: number): void
- -
-
Sets the limit for the number of values of the most recently received +
Parameters
- levels: Record<string, LogLevelSetting>
An object mapping topic names to log levels.
+
Returns Promise<Record<string, LogLevelSetting>>
Example
+await db.setLogLevel({ request: "debug" });
// Debug information will now be logged for each request + - levels: Record<string, LogLevelSetting>
set
- set
Response Queue Time Samples(responseQueueTimeSamples): void - -
Sets the limit for the number of values of the most recently received server-reported queue times that can be accessed using -queueTime.
---Parameters
--
-
-
-
responseQueueTimeSamples: number
-Number of values to maintain.
-
Returns void
-
-
set
--
-
- set
Service Development Mode(mount: string, enabled?: boolean): Promise<ServiceInfo>
- -
--
Enables or disables development mode for the given service.
- -Example
-const db = new Database();
await db.setServiceDevelopmentMode("/my-service", true);
// the service is now in development mode
await db.setServiceDevelopmentMode("/my-service", false);
// the service is now in production mode ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
enabled: boolean = true
-Whether development mode should be enabled or disabled.
-
Returns Promise<ServiceInfo>
-
-
set
--
-
- set
User Access Level(username: string, __namedParameters: UserAccessLevelOptions & {
    grant: AccessLevel;
}): Promise<ArangoApiResponse<Record<string, AccessLevel>>>
- -
-
Sets the given ArangoDB user's access level for the database, or the +Database#queueTime.
+Parameters
- responseQueueTimeSamples: number
Number of values to maintain.
+
Returns void
- responseQueueTimeSamples: number
set
- set
Service Development Mode(mount, enabled?): Promise<ServiceInfo> Enables or disables development mode for the given service.
+Parameters
- mount: string
The service's mount point, relative to the database.
+ - enabled: boolean = true
Whether development mode should be enabled or disabled.
+
Returns Promise<ServiceInfo>
Example
+const db = new Database();
await db.setServiceDevelopmentMode("/my-service", true);
// the service is now in development mode
await db.setServiceDevelopmentMode("/my-service", false);
// the service is now in production mode +- mount: string
set
- set
User Access Level(username, __namedParameters): Promise<ArangoApiResponse<Record<string, AccessLevel>>> - -
Sets the given ArangoDB user's access level for the database, or the given collection in the given database.
- -Example
- -const db = new Database();
await db.setUserAccessLevel("steve", { grant: "rw" });
// The user "steve" now has read-write access to the current database. -Example
- -const db = new Database();
await db.setUserAccessLevel("steve", {
database: "staging",
grant: "rw"
});
// The user "steve" now has read-write access to the "staging" database. -Example
- -const db = new Database();
await db.setUserAccessLevel("steve", {
collection: "pokemons",
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in the current database. -Example
- -const db = new Database();
await db.setUserAccessLevel("steve", {
database: "staging",
collection: "pokemons",
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in the "staging" database. -Example
- -const db = new Database();
const staging = db.database("staging");
await db.setUserAccessLevel("steve", {
database: staging,
grant: "rw"
});
// The user "steve" now has read-write access to the "staging" database. -Example
-const db = new Database();
const staging = db.database("staging");
await db.setUserAccessLevel("steve", {
collection: staging.collection("pokemons"),
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in database "staging". ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to set the access level for.
-
- -
-
__namedParameters: UserAccessLevelOptions & {
    grant: AccessLevel;
}
Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>
-
-
shutdown
-time
--
-
- time(): Promise<number> -
-
-
Retrives the server's current system time in milliseconds with microsecond +
Parameters
- username: string
Name of the ArangoDB user to set the access level for.
+ - __namedParameters: UserAccessLevelOptions & {
    grant: AccessLevel;
}
Returns Promise<ArangoApiResponse<Record<string, AccessLevel>>>
Example
+const db = new Database();
await db.setUserAccessLevel("steve", { grant: "rw" });
// The user "steve" now has read-write access to the current database. +Example
+const db = new Database();
await db.setUserAccessLevel("steve", {
database: "staging",
grant: "rw"
});
// The user "steve" now has read-write access to the "staging" database. +Example
+const db = new Database();
await db.setUserAccessLevel("steve", {
collection: "pokemons",
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in the current database. +Example
+const db = new Database();
await db.setUserAccessLevel("steve", {
database: "staging",
collection: "pokemons",
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in the "staging" database. +Example
+const db = new Database();
const staging = db.database("staging");
await db.setUserAccessLevel("steve", {
database: staging,
grant: "rw"
});
// The user "steve" now has read-write access to the "staging" database. +Example
+const db = new Database();
const staging = db.database("staging");
await db.setUserAccessLevel("steve", {
collection: staging.collection("pokemons"),
grant: "rw"
});
// The user "steve" now has read-write access to the "pokemons" collection
// in database "staging". + - username: string
shutdown
time
transaction
--
-
- transaction(transactionId: string): Transaction -
-
-
Returns a Transaction instance for an existing streaming +
Returns Promise<number>
transaction
- transaction(transactionId): Transaction
- -
Returns a transaction.Transaction instance for an existing streaming transaction with the given
-id.See also beginTransaction.
- -Example
-const trx1 = await db.beginTransaction(collections);
const id = trx1.id;
// later
const trx2 = db.transaction(id);
await trx2.commit(); ---Parameters
--
-
-
-
transactionId: string
Returns Transaction
-
-
transactions
--
-
- transactions(): Promise<Transaction[]> -
-
--
Fetches all active transactions from the database and returns an array of -Transaction instances for those transactions.
-See also listTransactions.
- -Example
-const db = new Database();
const transactions = await db.transactions();
// transactions is an array of transactions -Returns Promise<Transaction[]>
uninstall
--
-
- uninstall
Service(mount: string, options?: UninstallServiceOptions): Promise<void>
- -
--
Completely removes a service from the database.
- -Example
-const db = new Database();
await db.uninstallService("/my-foxx"); ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
-Optionaloptions: UninstallServiceOptionsOptions for uninstalling the service.
-
Returns Promise<void>
-
-
update
--
-
- update
Service Configuration(mount: string, cfg: Record<string, any>, minimal?: false): Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>
- -
-
Updates the configuration of the given service while maintaining any +
See also Database#beginTransaction.
+Parameters
- transactionId: string
Returns Transaction
Example
+const trx1 = await db.beginTransaction(collections);
const id = trx1.id;
// later
const trx2 = db.transaction(id);
await trx2.commit(); +
transactions
- transactions(): Promise<Transaction[]>
Fetches all active transactions from the database and returns an array of +transaction.Transaction instances for those transactions.
+See also Database#listTransactions.
+Returns Promise<Transaction[]>
Example
+const db = new Database();
const transactions = await db.transactions();
// transactions is an array of transactions +
uninstall
- uninstall
Service(mount, options?): Promise<void> Completely removes a service from the database.
+Parameters
- mount: string
The service's mount point, relative to the database.
+ Optionaloptions: UninstallServiceOptionsOptions for uninstalling the service.
+
Returns Promise<void>
Example
+const db = new Database();
await db.uninstallService("/my-foxx"); +- mount: string
update
- update
Service Configuration(mount, cfg, minimal?): Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>> - -
Updates the configuration of the given service while maintaining any existing values for options not specified.
-See also replaceServiceConfiguration and -getServiceConfiguration.
- -Example
-const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.updateServiceConfiguration("/my-service", config);
for (const [key, option] of Object.entries(info)) {
console.log(`${option.title} (${key}): ${option.value}`);
if (option.warning) console.warn(`Warning: ${option.warning}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
cfg: Record<string, any>
-An object mapping configuration option names to values.
-
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#replaceServiceConfiguration and +Database#getServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - cfg: Record<string, any>
An object mapping configuration option names to values.
+ Optionalminimal: falseIf set to
-true, the result will only include each configuration option's current value and warning (if any). Otherwise it will include the full definition for each option.
Returns Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>
- - mount: string
- update
Service Configuration(mount: string, cfg: Record<string, any>, minimal: true): Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}>
- -
-
Updates the configuration of the given service while maintaining any +
Returns Promise<Record<string, ServiceConfiguration & {
    warning?: string;
}>>Example
+const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.updateServiceConfiguration("/my-service", config);
for (const [key, option] of Object.entries(info)) {
console.log(`${option.title} (${key}): ${option.value}`);
if (option.warning) console.warn(`Warning: ${option.warning}`);
} + -
-
- update
Service Configuration(mount, cfg, minimal): Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}> - -
Updates the configuration of the given service while maintaining any existing values for options not specified.
-See also replaceServiceConfiguration and -getServiceConfiguration.
- -Example
-const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.updateServiceConfiguration("/my-service", config);
for (const [key, value] of Object.entries(info.values)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
cfg: Record<string, any>
-An object mapping configuration option names to values.
-
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#replaceServiceConfiguration and +Database#getServiceConfiguration.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - cfg: Record<string, any>
An object mapping configuration option names to values.
+ - minimal: true
If set to
-true, the result will only include each configuration option's current value and warning (if any). Otherwise it will include the full definition for each option.
Returns Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}> - mount: string
- update
-Service Dependencies Returns Promise<{
    values: Record<string, any>;
    warnings: Record<string, string>;
}>Example
+const db = new Database();
const config = { currency: "USD", locale: "en-US" };
const info = await db.updateServiceConfiguration("/my-service", config);
for (const [key, value] of Object.entries(info.values)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} + -
-
update
- update
Service Dependencies(mount, deps, minimal?): Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
    warning?: string;
}>> - -
Updates the dependencies of the given service while maintaining any existing mount points for dependencies not specified.
-See also replaceServiceDependencies and -getServiceDependencies.
- -Example
-const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.updateServiceDependencies("/my-service", deps);
for (const [key, dep] of Object.entries(info)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
if (dep.warning) console.warn(`Warning: ${dep.warning}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
deps: Record<string, string>
- -
-
-Optionalminimal: falseIf set to
true, the result will only include each +See also Database#replaceServiceDependencies and +Database#getServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - deps: Record<string, string>
Optionalminimal: falseIf set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<Record<string, Object>>
- - mount: string
- update
Service Dependencies(mount: string, deps: Record<string, string>, minimal: true): Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}>
- -
-
Updates the dependencies of the given service while maintaining any +
Returns Promise<Record<string, (SingleServiceDependency | MultiServiceDependency) & {
    warning?: string;
}>>Example
+const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.updateServiceDependencies("/my-service", deps);
for (const [key, dep] of Object.entries(info)) {
console.log(`${dep.title} (${key}): ${dep.current}`);
if (dep.warning) console.warn(`Warning: ${dep.warning}`);
} + -
-
- update
Service Dependencies(mount, deps, minimal): Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}> - -
Updates the dependencies of the given service while maintaining any existing mount points for dependencies not specified.
-See also replaceServiceDependencies and -getServiceDependencies.
- -Example
-const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.updateServiceDependencies(
"/my-service",
deps,
true
);
for (const [key, value] of Object.entries(info)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} --Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
deps: Record<string, string>
- -
-
minimal: true
-If set to
true, the result will only include each +See also Database#replaceServiceDependencies and +Database#getServiceDependencies.
+-Parameters
- mount: string
The service's mount point, relative to the database.
+ - deps: Record<string, string>
- minimal: true
If set to
-true, the result will only include each dependency's current mount point. Otherwise it will include the full definition for each dependency.
Returns Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}> - mount: string
- -update
-User -
-
- update
User(username: string, passwd: string): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Sets the password of a given ArangoDB user to the new value.
- -Example
-const db = new Database();
const user = await db.updateUser("steve", "hunter2");
// The user "steve" has received a new password ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to change the password for.
-
- -
-
passwd: string
-New password for the ArangoDB user.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
- -
-
- update
User(username: string, options: Partial<UserOptions>): Promise<ArangoApiResponse<ArangoUser>>
- -
--
Updates the ArangoDB user with the new options.
- -Example
-const db = new Database();
const user = await db.updateUser("steve", { active: false });
// The user "steve" has been set to inactive ---Parameters
--
-
-
-
username: string
-Name of the ArangoDB user to modify.
-
- -
-
options: Partial<UserOptions>
-Options of the ArangoDB user to modify.
-
Returns Promise<ArangoApiResponse<ArangoUser>>
-
-
- upgrade
-Service -
-
- upgrade
Service(mount: string, source: string | Readable | Blob | Buffer, options?: UpgradeServiceOptions): Promise<ServiceInfo>
- -
-
Replaces an existing service with a new service while retaining the old +
Returns Promise<{
    values: Record<string, string>;
    warnings: Record<string, string>;
}>Example
+const db = new Database();
const deps = { mailer: "/mailer-api", auth: "/remote-auth" };
const info = await db.updateServiceDependencies(
"/my-service",
deps,
true
);
for (const [key, value] of Object.entries(info)) {
console.log(`${key}: ${value}`);
if (info.warnings[key]) console.warn(`Warning: ${info.warnings[key]}`);
} + -
-
update
- update
User(username, passwd): Promise<ArangoApiResponse<ArangoUser>> Sets the password of a given ArangoDB user to the new value.
+Parameters
- username: string
Name of the ArangoDB user to change the password for.
+ - passwd: string
New password for the ArangoDB user.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.updateUser("steve", "hunter2");
// The user "steve" has received a new password +- username: string
- update
User(username, options): Promise<ArangoApiResponse<ArangoUser>> Updates the ArangoDB user with the new options.
+Parameters
- username: string
Name of the ArangoDB user to modify.
+ - options: Partial<UserOptions>
Options of the ArangoDB user to modify.
+
Returns Promise<ArangoApiResponse<ArangoUser>>
Example
+const db = new Database();
const user = await db.updateUser("steve", { active: false });
// The user "steve" has been set to inactive +- username: string
upgrade
- upgrade
Service(mount, source, options?): Promise<ServiceInfo> - -
Replaces an existing service with a new service while retaining the old service's configuration and dependencies.
- -Example
- -const db = new Database();
// Using a node.js file stream as source
const source = fs.createReadStream("./my-foxx-service.zip");
const info = await db.upgradeService("/hello", source); -Example
- -const db = new Database();
// Using a node.js Buffer as source
const source = fs.readFileSync("./my-foxx-service.zip");
const info = await db.upgradeService("/hello", source); -Example
-const db = new Database();
// Using a File (Blob) from a browser file input
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.upgradeService("/hello", source); ---Parameters
--
-
-
-
mount: string
-The service's mount point, relative to the database.
-
- -
-
source: string | Readable | Blob | Buffer
-The service bundle to install.
-
- -
-
options: UpgradeServiceOptions = {}
-Options for upgrading the service.
-
Returns Promise<ServiceInfo>
-
-
use
--
-
- use
Basic Auth(username?: string, password?: string): Database
- -
-
Updates the underlying connection's
authorizationheader to use Basic +Parameters
- mount: string
The service's mount point, relative to the database.
+ - source: string | Blob | File
The service bundle to install.
+ - options: UpgradeServiceOptions = {}
Options for upgrading the service.
+
Returns Promise<ServiceInfo>
Example
+const db = new Database();
// Using a Buffer in Node.js as source
const source = new Blob([await fs.readFileSync("./my-foxx-service.zip")]);
const info = await db.upgradeService("/hello", source); +Example
+const db = new Database();
// Using a Blob in Node.js as source
const source = await fs.openAsBlob("./my-foxx-service.zip");
const info = await db.upgradeService("/hello", source); +Example
+const db = new Database();
// Using a File from a browser file input as source
const element = document.getElementById("my-file-input");
const source = element.files[0];
const info = await db.upgradeService("/hello", source); + - mount: string
use
- use
Basic Auth(username?, password?): this - -
Updates the underlying connection's
- -authorizationheader to use Basic authentication with the givenusernameandpassword, then returns itself.Example
-const db = new Database();
db.useBasicAuth("admin", "hunter2");
// with the username "admin" and password "hunter2". ---Parameters
--
-
-
-
username: string = "root"
-The username to authenticate with.
-
- -
-
password: string = ""
-The password to authenticate with.
-
Returns Database
-
-
use
--
-
- use
Bearer Auth(token: string): Database
- -
-
Updates the underlying connection's
authorizationheader to use Bearer +Parameters
- username: string = "root"
The username to authenticate with.
+ - password: string = ""
The password to authenticate with.
+
Returns this
Example
+const db = new Database();
db.useBasicAuth("admin", "hunter2");
// with the username "admin" and password "hunter2". + - username: string = "root"
use
- use
Bearer Auth(token): this - -
Updates the underlying connection's
- -authorizationheader to use Bearer authentication with the given authenticationtoken, then returns itself.Example
-const db = new Database();
db.useBearerAuth("keyboardcat");
// The database instance now uses Bearer authentication. ---Parameters
--
-
-
-
token: string
-The token to authenticate with.
-
Returns Database
-
-
user
--
-
- user
Databases(): Promise<Database[]>
- -
-
Fetches all databases accessible to the active user from the server and +
Parameters
- token: string
The token to authenticate with.
+
Returns this
Example
+const db = new Database();
db.useBearerAuth("keyboardcat");
// The database instance now uses Bearer authentication. + - token: string
user
- user
Databases(): Promise<Database[]> - -
Fetches all databases accessible to the active user from the server and returns an array of
-Databaseinstances for those databases.See also listUserDatabases and -databases.
- -Example
-const db = new Database();
const names = await db.userDatabases();
// databases is an array of databases -Returns Promise<Database[]>
version
--
-
- version(details?: boolean): Promise<VersionInfo> -
-
--
Fetches version information from the ArangoDB server.
- -Example
-const db = new Database();
const version = await db.version();
// the version object contains the ArangoDB version information.
// license: "community" or "enterprise"
// version: ArangoDB version number
// server: description of the server --Parameters
--
-
-
-
-Optionaldetails: booleanIf set to
true, additional information about the +See also Database#listUserDatabases and +Database#databases.
+Returns Promise<Database[]>
Example
+const db = new Database();
const names = await db.userDatabases();
// databases is an array of databases +
version
- version(details?): Promise<VersionInfo>
Fetches version information from the ArangoDB server.
+-Parameters
Optionaldetails: booleanIf set to
-true, additional information about the ArangoDB server will be available as thedetailsproperty.
Returns Promise<VersionInfo>
- -view
-- views
-Returns Promise<VersionInfo>
Example
+const db = new Database();
const version = await db.version();
// the version object contains the ArangoDB version information.
// license: "community" or "enterprise"
// version: ArangoDB version number
// server: description of the server + -
-
view
views
wait
--
-
- wait
For Propagation(request: RequestOptions, timeout?: number): Promise<void>
- -
-
Performs a request against every known coordinator and returns when the +
See also Database#listViews.
+Returns Promise<View[]>
Example
+const db = new Database();
const views = await db.views();
// views is an array of ArangoSearch View instances +
wait
- wait
For Propagation(request, timeout?): Promise<void> - -
Performs a request against every known coordinator and returns when the request has succeeded against every coordinator or the timeout is reached.
Note: This method is primarily intended to make database setup easier in cluster scenarios and requires all coordinators to be known to arangojs before the method is invoked. The method is not useful in single-server or leader-follower replication scenarios.
- -Example
-const db = new Database({ loadBalancingStrategy: "ROUND_ROBIN" });
await system.acquireHostList();
const analyzer = db.analyzer("my-analyzer");
await analyzer.create();
await db.waitForPropagation(
{ path: `/_api/analyzer/${encodeURIComponent(analyzer.name)}` },
30000
);
// Analyzer has been propagated to all coordinators and can safely be used ---Parameters
--
-
-
-
request: RequestOptions
-Request to perform against each known coordinator.
-
- -
-
-Optionaltimeout: numberMaximum number of milliseconds to wait for propagation.
-
Returns Promise<void>
-
-
with
--
-
- with
Transaction<T>(collections: TransactionCollections, callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>), options?: TransactionOptions): Promise<T>
- -
-
Begins and commits a transaction using the given callback. Individual +
Parameters
- request: RequestOptions
Request to perform against each known coordinator.
+ Optionaltimeout: numberMaximum number of milliseconds to wait for propagation.
+
Returns Promise<void>
Example
+const db = new Database({ loadBalancingStrategy: "ROUND_ROBIN" });
await system.acquireHostList();
const analyzer = db.analyzer("my-analyzer");
await analyzer.create();
await db.waitForPropagation(
{ path: `/_api/analyzer/${encodeURIComponent(analyzer.name)}` },
30000
);
// Analyzer has been propagated to all coordinators and can safely be used + - request: RequestOptions
with
- with
Transaction<T>(collections, callback, options?): Promise<T> - -
Begins and commits a transaction using the given callback. Individual requests that are part of the transaction need to be wrapped in the step function passed into the callback. If the promise returned by the callback is rejected, the transaction will be aborted.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as -well as (in TypeScript) DocumentCollection and -EdgeCollection.Example
-const vertices = db.collection("vertices");
const edges = db.collection("edges");
await db.withTransaction(
{
read: ["vertices"],
write: [edges] // collection instances can be passed directly
},
async (step) => {
const start = await step(() => vertices.document("a"));
const end = await step(() => vertices.document("b"));
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); -- -Type Parameters
--
-
-
-
T
-Parameters
--
-
-
-
collections: TransactionCollections
-Collections involved in the transaction.
-
- -
-
callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
--Callback function executing the transaction steps.
--
-
-
-
-
-
- (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T> -
-
--
Parameters
--
-
-
-
step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
--
-
-
-
-
-
- <T>(callback: (() => Promise<T>)): Promise<T> -
-
--
Executes the given function locally as a single step of the transaction.
- -Example
- -const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); -Example
- -// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); -Example
- -// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); -Example
- -// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed -Example
- -// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); -Example
- -// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); -Example
- -// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); -Example
-// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); -- -Type Parameters
--
-
-
-
T
-Type of the callback's returned promise.
-
-Parameters
--
-
-
-
callback: (() => Promise<T>)
-Callback function returning a promise.
+implementing the collection.ArangoCollection interface:Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as +well as (in TypeScript) collection.DocumentCollection and +collection.EdgeCollection. +Type Parameters
Parameters
- collections: TransactionCollections
Collections involved in the transaction.
+ - callback: ((step) => Promise<T>)
Callback function executing the transaction steps.
+- (step): Promise<T>
- -
Parameters
- step: (<T>(callback) => Promise<T>)
- <T>(callback): Promise<T>
Executes the given function locally as a single step of the transaction.
+Type Parameters
-Parameters
- callback: (() => Promise<T>)-
Callback function returning a promise.
Warning: The callback function should wrap a single call of an async arangojs method (e.g. a method on a
Collectionobject of a collection that is involved in the transaction or thedb.querymethod). @@ -3520,107 +1117,39 @@callback: ( -
- -
-
-
- (): Promise<T> -
-
-
Returns Promise<T>
Returns Promise<T>
- -
Returns Promise<T>
- callback: (() => Promise<T>)
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<T>
- - step: (<T>(callback) => Promise<T>)
- with
Transaction<T>(collections: (string | ArangoCollection)[], callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>), options?: TransactionOptions): Promise<T>
- -
-
Begins and commits a transaction using the given callback. Individual +
Returns Promise<T>
Example
+const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); +Example
+// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); +Example
+// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); +Example
+// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed +Example
+// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); +Example
+// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); +Example
+// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); +Example
+// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); + - collections: TransactionCollections
Returns Promise<T>
-
-
-
-
Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<T>
Example
+const vertices = db.collection("vertices");
const edges = db.collection("edges");
await db.withTransaction(
{
read: ["vertices"],
write: [edges] // collection instances can be passed directly
},
async (step) => {
const start = await step(() => vertices.document("a"));
const end = await step(() => vertices.document("b"));
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); + -
-
- with
Transaction<T>(collections, callback, options?): Promise<T> - -
Begins and commits a transaction using the given callback. Individual requests that are part of the transaction need to be wrapped in the step function passed into the callback. If the promise returned by the callback is rejected, the transaction will be aborted.
Collections can be specified as collection names (strings) or objects -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Example
-const vertices = db.collection("vertices");
const edges = db.collection("edges");
await db.withTransaction(
[
"vertices",
edges, // collection instances can be passed directly
],
async (step) => {
const start = await step(() => vertices.document("a"));
const end = await step(() => vertices.document("b"));
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); -- -Type Parameters
--
-
-
-
T
-Parameters
--
-
-
-
collections: (string | ArangoCollection)[]
-Collections that can be read from and written to +implementing the collection.ArangoCollection interface:
+Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.Type Parameters
Parameters
- collections: (string | ArangoCollection)[]
Collections that can be read from and written to during the transaction.
-
- -
-
callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
--Callback function executing the transaction steps.
--
-
-
-
-
-
- (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T> -
-
--
Parameters
--
-
-
-
step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
--
-
-
-
-
-
- <T>(callback: (() => Promise<T>)): Promise<T> -
-
--
Executes the given function locally as a single step of the transaction.
- -Example
- -const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); -Example
- -// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); -Example
- -// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); -Example
- -// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed -Example
- -// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); -Example
- -// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); -Example
- -// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); -Example
-// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); -- -Type Parameters
--
-
-
-
T
-Type of the callback's returned promise.
-
-Parameters
--
-
-
-
callback: (() => Promise<T>)
-Callback function returning a promise.
+ - callback: ((step) => Promise<T>)
Callback function executing the transaction steps.
+- (step): Promise<T>
- -
Parameters
- step: (<T>(callback) => Promise<T>)
- <T>(callback): Promise<T>
Executes the given function locally as a single step of the transaction.
+Type Parameters
-Parameters
- callback: (() => Promise<T>)-
Callback function returning a promise.
Warning: The callback function should wrap a single call of an async arangojs method (e.g. a method on a
Collectionobject of a collection that is involved in the transaction or thedb.querymethod). @@ -3637,107 +1166,39 @@callback: ( -
- -
-
-
- (): Promise<T> -
-
-
Returns Promise<T>
Returns Promise<T>
- -
Returns Promise<T>
- callback: (() => Promise<T>)
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<T>
- - step: (<T>(callback) => Promise<T>)
- with
Transaction<T>(collection: string | ArangoCollection, callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>), options?: TransactionOptions): Promise<T>
- -
-
Begins and commits a transaction using the given callback. Individual +
Returns Promise<T>
Example
+const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); +Example
+// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); +Example
+// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); +Example
+// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed +Example
+// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); +Example
+// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); +Example
+// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); +Example
+// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); + -
-
-
-
Returns Promise<T>
-
-
-
-
Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<T>
Example
+const vertices = db.collection("vertices");
const edges = db.collection("edges");
await db.withTransaction(
[
"vertices",
edges, // collection instances can be passed directly
],
async (step) => {
const start = await step(() => vertices.document("a"));
const end = await step(() => vertices.document("b"));
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); + - collections: (string | ArangoCollection)[]
- with
Transaction<T>(collection, callback, options?): Promise<T> - -
Begins and commits a transaction using the given callback. Individual requests that are part of the transaction need to be wrapped in the step function passed into the callback. If the promise returned by the callback is rejected, the transaction will be aborted.
The Collection can be specified as a collection name (string) or an object -implementing the ArangoCollection interface:
- -Collection, -GraphVertexCollection, GraphEdgeCollection as well as -(in TypeScript) DocumentCollection and EdgeCollection.Example
-const vertices = db.collection("vertices");
const start = vertices.document("a");
const end = vertices.document("b");
const edges = db.collection("edges");
await db.withTransaction(
edges, // collection instances can be passed directly
async (step) => {
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); -- -Type Parameters
--
-
-
-
T
-Parameters
--
-
-
-
collection: string | ArangoCollection
-A collection that can be read from and written to +implementing the collection.ArangoCollection interface:
+Collection, +graph.GraphVertexCollection, graph.GraphEdgeCollection as well as +(in TypeScript) collection.DocumentCollection and collection.EdgeCollection.Type Parameters
Parameters
- collection: string | ArangoCollection
A collection that can be read from and written to during the transaction.
-
- -
-
callback: ((step: (<T>(callback: (() => Promise<T>)) => Promise<T>)) => Promise<T>)
--Callback function executing the transaction steps.
--
-
-
-
-
-
- (step: (<T>(callback: (() => Promise<T>)) => Promise<T>)): Promise<T> -
-
---
Parameters
--
-
-
-
step: (<T>(callback: (() => Promise<T>)) => Promise<T>)
--
-
-
-
-
-
- <T>(callback: (() => Promise<T>)): Promise<T> -
-
--
Executes the given function locally as a single step of the transaction.
- -Example
- -const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); -Example
- -// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); -Example
- -// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); -Example
- -// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed -Example
- -// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); -Example
- -// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); -Example
- -// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); -Example
-// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); -- -Type Parameters
--
-
-
-
T
-Type of the callback's returned promise.
-
--Parameters
--
-
-
-
callback: (() => Promise<T>)
-Callback function returning a promise.
+ - callback: ((step) => Promise<T>)
Callback function executing the transaction steps.
+- (step): Promise<T>
- -
Parameters
- step: (<T>(callback) => Promise<T>)
- <T>(callback): Promise<T>
Executes the given function locally as a single step of the transaction.
+Type Parameters
-Parameters
- callback: (() => Promise<T>)-
Callback function returning a promise.
Warning: The callback function should wrap a single call of an async arangojs method (e.g. a method on a
Collectionobject of a collection that is involved in the transaction or thedb.querymethod). @@ -3754,165 +1215,23 @@callback: ( -
- -
-
-
- (): Promise<T> -
-
-
Returns Promise<T>
Returns Promise<T>
- -
Returns Promise<T>
- callback: (() => Promise<T>)
- -
-
-Optionaloptions: TransactionOptionsOptions for the transaction.
-
Returns Promise<T>
- step: (<T>(callback) => Promise<T>)
-
-
-
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
- collection: string | ArangoCollection
Returns Promise<T>
Example
+const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); +Example
+// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); +Example
+// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); +Example
+// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed +Example
+// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); +Example
+// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); +Example
+// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); +Example
+// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); + -
-
Returns Promise<T>
-
-
-
-
Optionaloptions: TransactionOptionsOptions for the transaction.
+
Returns Promise<T>
Example
+const vertices = db.collection("vertices");
const start = vertices.document("a");
const end = vertices.document("b");
const edges = db.collection("edges");
await db.withTransaction(
edges, // collection instances can be passed directly
async (step) => {
await step(() => edges.save({ _from: start._id, _to: end._id }));
}
); + -
-
-
\ No newline at end of file
diff --git a/devel/classes/error.FetchFailedError.html b/devel/classes/error.FetchFailedError.html
new file mode 100644
index 000000000..8722de6c4
--- /dev/null
+++ b/devel/classes/error.FetchFailedError.html
@@ -0,0 +1,16 @@
+
-
-
-
-
-
-
-
-
-
-
-
-
-
-error
-ArangoError | arangojs
error
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
error
-
-
-Class ArangoError
Represents an error returned by ArangoDB.
-Hierarchy
--
-
- Error
-
-
-
- ArangoError
- Index
-
-
-
-
-
Properties
-Methods
-Properties
-code
-code: number
-HTTP status code included in the server error response object.
-error
-error
-ArangoDB error code.
+Class ArangoError
Represents an error returned by ArangoDB.
+Hierarchy
- Error
- ArangoError
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Arango Error(data, options): ArangoError Creates a new
+ArangoErrorfrom an ArangoDB error response.Parameters
- data: ArangoErrorResponse
- options: {
    cause?: Error;
    isSafeToRetry?: null | boolean;
}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns ArangoError
Properties
code
code: number
HTTP status code included in the server error response object.
+error
error
ArangoDB error code.
-name
-name: string = "ArangoError"
response
-response: any
-Server response object.
-Static Optional prepare
-prepare
-
-
Type declaration
--
-
-
-
-
-
- (err: Error, stackTraces: CallSite[]): any -
-
--
Optional override for formatting stack traces
- -See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
---Parameters
--
-
-
-
err: Error
- -
-
stackTraces: CallSite[]
Returns any
-
-
Static stack
-stack
Methods
-toJSON
--
-
- toJSON(): {
    code: number;
    error: boolean;
    errorMessage: string;
    errorNum: number;
}
- -
-
Returns {
-
    code: number;
    error: boolean;
    errorMessage: string;
    errorNum: number;
}-
-
-
-
code: number
- -
-
error: boolean
- -
-
error
Message: string
- -
-
error
Num: number
-
-
Static capture
-
-
-
\ No newline at end of file
+Generated using TypeDoc
name
name: string = "ArangoError"
Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Accessors
error
- get errorMessage(): string
Error message accompanying the error code.
+Returns string
request
- get request(): undefined | Request
Fetch request object.
+Returns undefined | Request
response
- get response(): undefined | ProcessedResponse<ArangoErrorResponse>
Server response object.
+Returns undefined | ProcessedResponse<ArangoErrorResponse>
Methods
toJSON
Static capture
Class FetchFailedError
Represents an error from a failed fetch request.
+The root cause is often extremely difficult to determine.
+Hierarchy (view full)
- NetworkError
- FetchFailedError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Fetch Failed Error(message, options): FetchFailedError Parameters
- message: undefined | string
- options: {
    cause: TypeError;
    isSafeToRetry?: null | boolean;
    request: Request;
}cause: TypeError
OptionalisSafe To Retry?: null | boolean request: Request
Returns FetchFailedError
Properties
is
is
Indicates whether the request that caused this error can be safely retried.
+name
name: string = "FetchFailedError"
request
request: Request
Fetch request object.
+Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
toJSON
Static capture
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class HttpError
Represents a plain HTTP error response.
-Hierarchy
--
-
- Error
-
-
-
- HttpError
- Index
-
-
-
-
-
Properties
-Methods
-Properties
-code
-code: number
-HTTP status code of the server response.
-name
-name: string = "HttpError"
response
-response: any
-Server response object.
-Static Optional prepare
-prepare
-
-
Type declaration
--
-
-
-
-
-
- (err: Error, stackTraces: CallSite[]): any -
-
--
Optional override for formatting stack traces
- -See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
---Parameters
--
-
-
-
err: Error
- -
-
stackTraces: CallSite[]
Returns any
-
-
Static stack
-stack
Methods
-toJSON
-Static capture
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Class HttpError
Represents a plain HTTP error response.
+Hierarchy (view full)
- NetworkError
- HttpError
Index
Properties
Methods
Properties
code
code: number
HTTP status code of the server response.
+is
is
Indicates whether the request that caused this error can be safely retried.
+name
name: string = "HttpError"
request
request: Request
Fetch request object.
+response
Server response object.
+Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
toJSON
Static capture
Class NetworkError
Represents a network error or an error encountered while performing a network request.
+Hierarchy (view full)
- Error
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Network Error(message, options): NetworkError Parameters
- message: string
- options: {
    cause?: Error;
    isSafeToRetry?: null | boolean;
    request: Request;
}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean request: Request
Returns NetworkError
Properties
is
is
Indicates whether the request that caused this error can be safely retried.
+name
name: string = "NetworkError"
request
request: Request
Fetch request object.
+Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
toJSON
Static capture
Class PropagationTimeoutError
Represents an error from a deliberate timeout encountered while waiting +for propagation.
+Hierarchy
- Error
- PropagationTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Propagation Timeout Error(message, options): PropagationTimeoutError Parameters
- message: undefined | string
- options: {
    cause: Error;
}cause: Error
Returns PropagationTimeoutError
Properties
name
name: string = "PropagationTimeoutError"
Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Class RequestAbortedError
Represents an error from a request that was aborted.
+Hierarchy (view full)
- NetworkError
- RequestAbortedError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Request Aborted Error(message, options): RequestAbortedError Parameters
- message: undefined | string
- options: {
    cause?: Error;
    isSafeToRetry?: null | boolean;
    request: Request;
}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean request: Request
Returns RequestAbortedError
Properties
is
is
Indicates whether the request that caused this error can be safely retried.
+name
name: string = "RequestAbortedError"
request
request: Request
Fetch request object.
+Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
toJSON
Static capture
Class ResponseTimeoutError
Represents an error from a deliberate timeout encountered while waiting +for a server response.
+Hierarchy (view full)
- NetworkError
- ResponseTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Response Timeout Error(message, options): ResponseTimeoutError Parameters
- message: undefined | string
- options: {
    cause?: Error;
    isSafeToRetry?: null | boolean;
    request: Request;
}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean request: Request
Returns ResponseTimeoutError
Properties
is
is
Indicates whether the request that caused this error can be safely retried.
+name
name: string = "ResponseTimeoutError"
request
request: Request
Fetch request object.
+Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
toJSON
Static capture
-
\ No newline at end of file
diff --git a/devel/classes/graph.GraphEdgeCollection.html b/devel/classes/graph.GraphEdgeCollection.html
index 881ce6502..e524e3231 100644
--- a/devel/classes/graph.GraphEdgeCollection.html
+++ b/devel/classes/graph.GraphEdgeCollection.html
@@ -1,330 +1,75 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-add
-
-
-add
-
-
- vertex
-
-
-Class Graph
Represents a graph in a Database.
-Hierarchy
--
-
- Graph
- Index
-
-
-
-
-
Accessors
-name
-
Methods
-Accessors
-name
--
-
- get name(): string -
-
--
Name of the graph.
-Returns string
Methods
-add
--
-
- add
Edge Definition(edgeDefinition: EdgeDefinitionOptions, options?: AddEdgeDefinitionOptions): Promise<GraphInfo>
- -
--
Adds an edge definition to this graph.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
await graph.addEdgeDefinition({
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
});
// The edge definition has been added to the graph ---Parameters
--
-
-
-
edgeDefinition: EdgeDefinitionOptions
-Definition of a relation in this graph.
-
- -
-
options: AddEdgeDefinitionOptions = {}
Returns Promise<GraphInfo>
-
-
add
--
-
- add
Vertex Collection(collection: string | ArangoCollection, options?: AddVertexCollectionOptions): Promise<GraphInfo>
- -
--
Adds the given collection to this graph as a vertex collection.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
await graph.addVertexCollection("more-vertices");
// The collection "more-vertices" has been added to the graph
const extra = db.collection("extra-vertices");
await graph.addVertexCollection(extra);
// The collection "extra-vertices" has been added to the graph ---Parameters
--
-
-
-
collection: string | ArangoCollection
-Collection to add to the graph.
-
- -
-
options: AddVertexCollectionOptions = {}
Returns Promise<GraphInfo>
-
-
create
--
-
- create(edgeDefinitions: EdgeDefinitionOptions[], options?: CreateGraphOptions): Promise<GraphInfo> -
-
-
Creates a graph with the given
edgeDefinitionsandoptionsfor this +Graph | arangojs --Class Graph
Represents a graph in a database.Database.
+Accessors
database
name
- get name(): string
Name of the graph.
+Returns string
Methods
add
Edge Definition - add
Edge Definition(edgeDefinition, options?): Promise<GraphInfo> Adds an edge definition to this graph.
+Parameters
- edgeDefinition: EdgeDefinitionOptions
Definition of a relation in this graph.
+ - options: AddEdgeDefinitionOptions = {}
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
await graph.addEdgeDefinition({
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
});
// The edge definition has been added to the graph +- edgeDefinition: EdgeDefinitionOptions
add
Vertex Collection - add
Vertex Collection(collection, options?): Promise<GraphInfo> Adds the given collection to this graph as a vertex collection.
+Parameters
- collection: string | ArangoCollection
Collection to add to the graph.
+ - options: AddVertexCollectionOptions = {}
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
await graph.addVertexCollection("more-vertices");
// The collection "more-vertices" has been added to the graph
const extra = db.collection("extra-vertices");
await graph.addVertexCollection(extra);
// The collection "extra-vertices" has been added to the graph +- collection: string | ArangoCollection
create
- create(edgeDefinitions, options?): Promise<GraphInfo>
- -
Creates a graph with the given
- -edgeDefinitionsandoptionsfor this graph's name.Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
// graph now exists ---Parameters
--
-
-
-
edgeDefinitions: EdgeDefinitionOptions[]
-Definitions for the relations of the graph.
-
- -
-
options: CreateGraphOptions = {}
-Options for creating the graph.
-
Returns Promise<GraphInfo>
-
-
- drop
--
-
- drop(dropCollections?: boolean): Promise<boolean> -
-
--
Deletes the graph from the database.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
await graph.drop();
// the graph "some-graph" no longer exists --Parameters
--
-
-
-
dropCollections: boolean = false
-If set to
true, the collections associated with +Parameters
- edgeDefinitions: EdgeDefinitionOptions[]
Definitions for the relations of the graph.
+ - options: CreateGraphOptions = {}
Options for creating the graph.
+
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
// graph now exists + - edgeDefinitions: EdgeDefinitionOptions[]
drop
- edge
-Collection -
-
- edge
Collection<T>(collection: string | ArangoCollection): GraphEdgeCollection<T>
- -
-
Returns a GraphEdgeCollection instance for the given collection +
Returns Promise<boolean>
Example
+const db = new Database();
const graph = db.graph("some-graph");
await graph.drop();
// the graph "some-graph" no longer exists + -
-
edge
Collection - edge
Collection<T>(collection): GraphEdgeCollection<T> - -
Returns a graph.GraphEdgeCollection instance for the given collection name representing the collection in this graph.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const graphEdgeCollection = graph.edgeCollection("edges");
// Access the underlying EdgeCollection API:
const edgeCollection = graphEdgeCollection.collection; -- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
--Parameters
--
-
-
-
collection: string | ArangoCollection
-Name of the edge collection.
-
Returns GraphEdgeCollection<T>
-
-
- -edge
-Collections -
-
- edge
Collections(): Promise<GraphEdgeCollection<any>[]>
- -
--
Fetches all edge collections of this graph from the database and returns -an array of GraphEdgeCollection instances.
-See also listEdgeCollections.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const graphEdgeCollections = await graph.edgeCollections();
for (const collection of graphEdgeCollection) {
console.log(collection.name);
// "edges"
} -Returns Promise<GraphEdgeCollection<any>[]>
- -exists
-- -get
-- list
-Edge Collections -
-
- list
Edge Collections(): Promise<string[]>
- -
-
Fetches all edge collections of this graph from the database and returns +
Type Parameters
Parameters
- collection: string | ArangoCollection
Name of the edge collection.
+
Returns GraphEdgeCollection<T>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const graphEdgeCollection = graph.edgeCollection("edges");
// Access the underlying EdgeCollection API:
const edgeCollection = graphEdgeCollection.collection; + - collection: string | ArangoCollection
edge
Collections - edge
Collections(): Promise<GraphEdgeCollection<any>[]> Fetches all edge collections of this graph from the database and returns +an array of graph.GraphEdgeCollection instances.
+See also graph.Graph#listEdgeCollections.
+Returns Promise<GraphEdgeCollection<any>[]>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const graphEdgeCollections = await graph.edgeCollections();
for (const collection of graphEdgeCollection) {
console.log(collection.name);
// "edges"
} +
exists
get
list
Edge Collections - list
Edge Collections(): Promise<string[]> - -
Fetches all edge collections of this graph from the database and returns an array of their names.
-See also edgeCollections.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const edgeCollectionNames = await graph.listEdgeCollections();
// ["edges"] -Returns Promise<string[]>
- list
-Vertex Collections -
-
- list
Vertex Collections(): Promise<string[]>
- -
-
Fetches all vertex collections of this graph from the database and returns +
See also graph.Graph#edgeCollections.
+Returns Promise<string[]>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const edgeCollectionNames = await graph.listEdgeCollections();
// ["edges"] +
list
Vertex Collections - list
Vertex Collections(): Promise<string[]> - -
Fetches all vertex collections of this graph from the database and returns an array of their names.
-See also vertexCollections.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const vertexCollectionNames = await graph.listVertexCollections();
// ["start-vertices", "end-vertices"] -Returns Promise<string[]>
- remove
-Edge Definition -
-
- remove
Edge Definition(collection: string | ArangoCollection, dropCollection?: boolean): Promise<GraphInfo>
- -
--
Removes the edge definition for the given edge collection from this graph.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.removeEdgeDefinition("edges");
// The edge definition for "edges" has been replaced --Parameters
--
-
-
-
collection: string | ArangoCollection
-Edge collection for which to remove the definition.
-
- -
-
dropCollection: boolean = false
-If set to
true, the collection will also be +See also graph.Graph#vertexCollections.
+Returns Promise<string[]>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const vertexCollectionNames = await graph.listVertexCollections();
// ["start-vertices", "end-vertices"] +
remove
Edge Definition - remove
Edge Definition(collection, dropCollection?): Promise<GraphInfo> Removes the edge definition for the given edge collection from this graph.
+-Parameters
- collection: string | ArangoCollection
Edge collection for which to remove the definition.
+ - dropCollection: boolean = false
If set to
-true, the collection will also be deleted from the database.
Returns Promise<GraphInfo>
- collection: string | ArangoCollection
- remove
-Vertex Collection -
-
- remove
Vertex Collection(collection: string | ArangoCollection, dropCollection?: boolean): Promise<GraphInfo>
- -
--
Removes the given collection from this graph as a vertex collection.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.removeVertexCollection("start-vertices");
// The collection "start-vertices" is no longer part of the graph. --Parameters
--
-
-
-
collection: string | ArangoCollection
-Collection to remove from the graph.
-
- -
-
dropCollection: boolean = false
-If set to
true, the collection will also be +
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.removeEdgeDefinition("edges");
// The edge definition for "edges" has been replaced + -
-
remove
Vertex Collection - remove
Vertex Collection(collection, dropCollection?): Promise<GraphInfo> Removes the given collection from this graph as a vertex collection.
+-Parameters
- collection: string | ArangoCollection
Collection to remove from the graph.
+ - dropCollection: boolean = false
If set to
-true, the collection will also be deleted from the database.
Returns Promise<GraphInfo>
- collection: string | ArangoCollection
- replace
-Edge Definition -
-
- replace
Edge Definition(edgeDefinition: EdgeDefinitionOptions, options?: ReplaceEdgeDefinitionOptions): Promise<GraphInfo>
- -
-
Replaces an edge definition in this graph. The existing edge definition +
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.removeVertexCollection("start-vertices");
// The collection "start-vertices" is no longer part of the graph. + -
-
replace
Edge Definition - replace
Edge Definition(edgeDefinition, options?): Promise<GraphInfo> - -
Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.replaceEdgeDefinition({
collection: "edges",
from: ["start-vertices"],
to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced ---Parameters
--
-
-
-
edgeDefinition: EdgeDefinitionOptions
-Definition of a relation in this graph.
-
- -
-
Optionaloptions: ReplaceEdgeDefinitionOptions
Returns Promise<GraphInfo>
- -
-
- replace
Edge Definition(collection: string | ArangoCollection, edgeDefinition: EdgeDefinitionOptions, options?: ReplaceEdgeDefinitionOptions): Promise<GraphInfo>
- -
-
Replaces an edge definition in this graph. The existing edge definition +
Parameters
- edgeDefinition: EdgeDefinitionOptions
Definition of a relation in this graph.
+ Optionaloptions: ReplaceEdgeDefinitionOptions
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.replaceEdgeDefinition({
collection: "edges",
from: ["start-vertices"],
to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced + - edgeDefinition: EdgeDefinitionOptions
- replace
Edge Definition(collection, edgeDefinition, options?): Promise<GraphInfo> - -
Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.replaceEdgeDefinition("edges", {
collection: "edges",
from: ["start-vertices"],
to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced ---Parameters
--
-
-
-
collection: string | ArangoCollection
-Edge collection for which to replace the definition.
-
- -
-
edgeDefinition: EdgeDefinitionOptions
-Definition of a relation in this graph.
-
- -
-
Optionaloptions: ReplaceEdgeDefinitionOptions
Returns Promise<GraphInfo>
-
-
- -traversal
--
-
- traversal(startVertex: string, options?: TraversalOptions): Promise<any> -
-
--
Performs a traversal starting from the given
-startVertexand following -edges contained in this graph.See also traversal.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and are -no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.
- -Example
-const db = new Database();
const graph = db.graph("my-graph");
const collection = graph.edgeCollection("edges").collection;
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/b", "vertices/c"],
["z", "vertices/c", "vertices/d"],
]);
const startVertex = "vertices/a";
const cursor = await db.query(aql`
FOR vertex IN OUTBOUND ${startVertex} GRAPH ${graph}
RETURN vertex._key
`);
const result = await cursor.all();
console.log(result); // ["a", "b", "c", "d"] ---Parameters
--
-
-
-
startVertex: string
-Document
-_idof a vertex in this graph.
- -
-
-Optionaloptions: TraversalOptionsOptions for performing the traversal.
-
Returns Promise<any>
-
-
- vertex
-Collection -
-
- vertex
Collection<T>(collection: string | ArangoCollection): GraphVertexCollection<T>
- -
-
Returns a GraphVertexCollection instance for the given collection +
Parameters
- collection: string | ArangoCollection
Edge collection for which to replace the definition.
+ - edgeDefinition: EdgeDefinitionOptions
Definition of a relation in this graph.
+ Optionaloptions: ReplaceEdgeDefinitionOptions
Returns Promise<GraphInfo>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
await graph.replaceEdgeDefinition("edges", {
collection: "edges",
from: ["start-vertices"],
to: ["other-vertices"],
});
// The edge definition for "edges" has been replaced + - collection: string | ArangoCollection
vertex
Collection - vertex
Collection<T>(collection): GraphVertexCollection<T> - -
Returns a graph.GraphVertexCollection instance for the given collection name representing the collection in this graph.
-- -Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
--Parameters
--
-
-
-
collection: string | ArangoCollection
-Name of the vertex collection.
-
Returns GraphVertexCollection<T>
-
-
- vertex
-Collections -
-
- vertex
Collections(): Promise<GraphVertexCollection<any>[]>
- -
--
Fetches all vertex collections of this graph from the database and returns -an array of GraphVertexCollection instances.
-See also listVertexCollections.
- -Example
-const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const vertexCollections = await graph.vertexCollections();
for (const vertexCollection of vertexCollections) {
console.log(vertexCollection.name);
// "start-vertices"
// "end-vertices"
} -Returns Promise<GraphVertexCollection<any>[]>
-- \ No newline at end of file +Generated using TypeDoc
Type Parameters
Parameters
- collection: string | ArangoCollection
Name of the vertex collection.
+
Returns GraphVertexCollection<T>
vertex
- vertex
Collections(): Promise<GraphVertexCollection<any>[]> Fetches all vertex collections of this graph from the database and returns +an array of graph.GraphVertexCollection instances.
+See also graph.Graph#listVertexCollections.
+Returns Promise<GraphVertexCollection<any>[]>
Example
+const db = new Database();
const graph = db.graph("some-graph");
const info = await graph.create([
{
collection: "edges",
from: ["start-vertices"],
to: ["end-vertices"],
},
]);
const vertexCollections = await graph.vertexCollections();
for (const vertexCollection of vertexCollections) {
console.log(vertexCollection.name);
// "start-vertices"
// "end-vertices"
} +
-
\ No newline at end of file
diff --git a/devel/classes/graph.GraphVertexCollection.html b/devel/classes/graph.GraphVertexCollection.html
index 86a1ec4d2..1a4ef3e3c 100644
--- a/devel/classes/graph.GraphVertexCollection.html
+++ b/devel/classes/graph.GraphVertexCollection.html
@@ -1,333 +1,77 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class GraphEdgeCollection<T>
Represents a EdgeCollection of edges in a Graph.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
Hierarchy
--
-
- GraphEdgeCollection
Implements
-
- Index
-
-
-
-
-
Accessors
-Methods
-Accessors
-collection
--
-
- get collection(): EdgeCollection<T> -
-
--
A EdgeCollection instance for this edge collection.
-Returns EdgeCollection<T>
graph
-name
--
-
- get name(): string -
-
--
Name of the collection.
-Returns string
Methods
-edge
--
-
- edge(selector: DocumentSelector, options?: GraphCollectionReadOptions): Promise<Edge<T>> -
-
-
Retrieves the edge matching the given key or id.
+GraphEdgeCollection | arangojs -Class GraphEdgeCollection<T>
Represents a collection.EdgeCollection of edges in a graph.Graph.
+Type Parameters
Implements
Index
Accessors
Methods
Accessors
collection
- get collection(): EdgeCollection<T, T>
A collection.EdgeCollection instance for this edge collection.
+Returns EdgeCollection<T, T>
database
graph
- get graph(): Graph
The graph.Graph instance this edge collection is bound to.
+Returns Graph
name
- get name(): string
Name of the collection.
+Returns string
Methods
edge
- edge(selector, options?): Promise<Edge<T>>
- -
Retrieves the edge matching the given key or id.
Throws an exception when passed a edge or
- -_idfrom a different collection, or if the edge does not exist.Example
- -const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
const edge = await collection.edge("abc123");
console.log(edge);
} catch (e: any) {
console.error("Could not find edge");
} -Example
-const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", { graceful: true });
if (edge) {
console.log(edge);
} else {
console.error("Edge does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
- -
-
-Optionaloptions: GraphCollectionReadOptionsOptions for retrieving the edge.
-
Returns Promise<Edge<T>>
- - selector: DocumentSelector
- edge(selector: DocumentSelector, graceful: boolean): Promise<Edge<T>> -
-
-
Retrieves the edge matching the given key or id.
+ Optionaloptions: GraphCollectionReadOptionsOptions for retrieving the edge.
+
Returns Promise<Edge<T>>
Example
+const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
const edge = await collection.edge("abc123");
console.log(edge);
} catch (e: any) {
console.error("Could not find edge");
} +Example
+const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", { graceful: true });
if (edge) {
console.log(edge);
} else {
console.error("Edge does not exist");
} + -
-
- edge(selector, graceful): Promise<Edge<T>>
- -
Retrieves the edge matching the given key or id.
Throws an exception when passed a edge or
- -_idfrom a different collection, or if the edge does not exist.Example
- -const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
const edge = await collection.edge("abc123", false);
console.log(edge);
} catch (e: any) {
console.error("Could not find edge");
} -Example
-const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", true);
if (edge) {
console.log(edge);
} else {
console.error("Edge does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
- -
-
graceful: boolean
-If set to
true,nullis returned instead of an + - graceful: boolean
If set to
-true,nullis returned instead of an exception being thrown if the edge does not exist.
Returns Promise<Edge<T>>
- selector: DocumentSelector
- edge
-Exists -
-
- edge
Exists(selector: DocumentSelector): Promise<boolean>
- -
-
Checks whether a edge matching the given key or id exists in this +
Returns Promise<Edge<T>>
Example
+const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
try {
const edge = await collection.edge("abc123", false);
console.log(edge);
} catch (e: any) {
console.error("Could not find edge");
} +Example
+const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const edge = await collection.edge("abc123", true);
if (edge) {
console.log(edge);
} else {
console.error("Edge does not exist");
} + -
-
edge
Exists - edge
Exists(selector): Promise<boolean> - -
Checks whether a edge matching the given key or id exists in this collection.
Throws an exception when passed a edge or
- -_idfrom a different collection.Example
-const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const exists = await collection.edgeExists("abc123");
if (!exists) {
console.log("Edge does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
Returns Promise<boolean>
- selector: DocumentSelector
- remove
--
-
- remove(selector: DocumentSelector, options?: GraphCollectionRemoveOptions): Promise<DocumentMetadata & {
    old?: Edge<T>;
}>
- -
-
Removes an existing edge from the collection.
+
Returns Promise<boolean>
Example
+const graph = db.graph("some-graph");
const collection = graph.edgeCollection("friends")
const exists = await collection.edgeExists("abc123");
if (!exists) {
console.log("Edge does not exist");
} + -
-
remove
- remove(selector, options?): Promise<DocumentMetadata & {
    old?: Edge<T>;
}> - -
Removes an existing edge from the collection.
Throws an exception when passed a edge or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
const doc = await collection.edge("musadir");
await collection.remove(doc);
// edge with key "musadir" deleted --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
- -
-
-Optionaloptions: GraphCollectionRemoveOptionsOptions for removing the edge.
-
Returns Promise<DocumentMetadata & {
    old?: Edge<T>;
}> - selector: DocumentSelector
- replace
--
-
- replace(selector: DocumentSelector, newValue: EdgeData<T>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}>
- -
-
Replaces an existing edge in the collection.
+ Optionaloptions: GraphCollectionRemoveOptionsOptions for removing the edge.
+
Returns Promise<DocumentMetadata & {
    old?: Edge<T>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
const doc = await collection.edge("musadir");
await collection.remove(doc);
// edge with key "musadir" deleted + -
-
replace
- replace(selector, newValue, options?): Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}> - -
Replaces an existing edge in the collection.
Throws an exception when passed a edge or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.replace(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false undefined --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
- -
-
newValue: EdgeData<T>
- -
-
-Optionaloptions: GraphCollectionReplaceOptionsOptions for replacing the edge.
-
Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}> - selector: DocumentSelector
- -save
--
-
- save(data: EdgeData<T>, options?: GraphCollectionInsertOptions): Promise<DocumentMetadata & {
    new?: Edge<T>;
}>
- -
--
Inserts a new edge with the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("friends");
const result = await collection.save(
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ returnNew: true }
); ---Parameters
--
-
-
-
data: EdgeData<T>
-The contents of the new edge.
-
- -
-
-Optionaloptions: GraphCollectionInsertOptionsOptions for inserting the edge.
-
Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
}> -
-
- update
--
-
- update(selector: DocumentSelector, newValue: Patch<EdgeData<T>>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}>
- -
-
Updates an existing edge in the collection.
+ - newValue: EdgeData<T>
Optionaloptions: GraphCollectionReplaceOptionsOptions for replacing the edge.
+
Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.replace(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false undefined + -
-
save
- save(data, options?): Promise<DocumentMetadata & {
    new?: Edge<T>;
}> Inserts a new edge with the given
+datainto the collection.Parameters
- data: EdgeData<T>
The contents of the new edge.
+ Optionaloptions: GraphCollectionInsertOptionsOptions for inserting the edge.
+
Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
const result = await collection.save(
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ returnNew: true }
); +- data: EdgeData<T>
update
- update(selector, newValue, options?): Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}> - -
Updates an existing edge in the collection.
Throws an exception when passed a edge or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.update(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false true ---Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a edge from this collection).
- -
-
newValue: Patch<EdgeData<T>>
- -
-
-Optionaloptions: GraphCollectionReplaceOptionsOptions for updating the edge.
-
Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}> - selector: DocumentSelector
-
-
-- \ No newline at end of file +Generated using TypeDoc
- newValue: Patch<EdgeData<T>>
Optionaloptions: GraphCollectionReplaceOptionsOptions for updating the edge.
+Returns Promise<DocumentMetadata & {
    new?: Edge<T>;
    old?: Edge<T>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.update(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false true +
-
\ No newline at end of file
diff --git a/devel/classes/job.Job.html b/devel/classes/job.Job.html
index d064742d9..224681f6e 100644
--- a/devel/classes/job.Job.html
+++ b/devel/classes/job.Job.html
@@ -1,165 +1,25 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class GraphVertexCollection<T>
Represents a DocumentCollection of vertices in a Graph.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
Hierarchy
--
-
- GraphVertexCollection
Implements
-
- Index
-
-
-
-
-
Accessors
-Methods
-Accessors
-collection
--
-
- get collection(): DocumentCollection<T> -
-
--
A DocumentCollection instance for this vertex collection.
-Returns DocumentCollection<T>
graph
-name
--
-
- get name(): string -
-
--
Name of the collection.
-Returns string
Methods
-remove
--
-
- remove(selector: DocumentSelector, options?: GraphCollectionRemoveOptions): Promise<DocumentMetadata & {
    old?: Document<T>;
}>
- -
-
Removes an existing vertex from the collection.
+GraphVertexCollection | arangojs -Class GraphVertexCollection<T>
Represents a collection.DocumentCollection of vertices in a graph.Graph.
+Type Parameters
Implements
Index
Accessors
Methods
Accessors
collection
- get collection(): DocumentCollection<T, T>
A collection.DocumentCollection instance for this vertex collection.
+Returns DocumentCollection<T, T>
database
graph
- get graph(): Graph
The graph.Graph instance this vertex collection is bound to.
+Returns Graph
name
- get name(): string
Name of the collection.
+Returns string
Methods
remove
- remove(selector, options?): Promise<DocumentMetadata & {
    old?: Document<T>;
}> - -
Removes an existing vertex from the collection.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
- -const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
await collection.remove("abc123");
// document with key "abc123" deleted -Example
-const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const doc = await collection.vertex("abc123");
await collection.remove(doc);
// document with key "abc123" deleted --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
- -
-
-Optionaloptions: GraphCollectionRemoveOptionsOptions for removing the vertex.
-
Returns Promise<DocumentMetadata & {
    old?: Document<T>;
}> - selector: DocumentSelector
- replace
--
-
- replace(selector: DocumentSelector, newValue: DocumentData<T>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}>
- -
-
Replaces an existing vertex in the collection.
+ Optionaloptions: GraphCollectionRemoveOptionsOptions for removing the vertex.
+
Returns Promise<DocumentMetadata & {
    old?: Document<T>;
}>Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
await collection.remove("abc123");
// document with key "abc123" deleted +Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const doc = await collection.vertex("abc123");
await collection.remove(doc);
// document with key "abc123" deleted + -
-
replace
- replace(selector, newValue, options?): Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}> - -
Replaces an existing vertex in the collection.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
-const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.replace(
"a",
{ color: "red" },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "red" undefined --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
- -
-
newValue: DocumentData<T>
- -
-
-Optionaloptions: GraphCollectionReplaceOptionsOptions for replacing the vertex.
-
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}> - selector: DocumentSelector
- -save
--
-
- save(data: DocumentData<T>, options?: GraphCollectionInsertOptions): Promise<DocumentMetadata & {
    new?: Document<T>;
}>
- -
--
Inserts a new vertex with the given
- -datainto the collection.Example
-const graph = db.graph("some-graph");
const collection = graph.vertexCollection("friends");
const result = await collection.save(
{ _key: "a", color: "blue", count: 1 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 1 ---Parameters
--
-
-
-
data: DocumentData<T>
-The contents of the new vertex.
-
- -
-
-Optionaloptions: GraphCollectionInsertOptionsOptions for inserting the vertex.
-
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
}> -
-
- update
--
-
- update(selector: DocumentSelector, newValue: Patch<DocumentData<T>>, options?: GraphCollectionReplaceOptions): Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}>
- -
-
Updates an existing vertex in the collection.
+ - newValue: DocumentData<T>
Optionaloptions: GraphCollectionReplaceOptionsOptions for replacing the vertex.
+
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}>Example
+const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.replace(
"a",
{ color: "red" },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "red" undefined + -
-
save
- save(data, options?): Promise<DocumentMetadata & {
    new?: Document<T>;
}> Inserts a new vertex with the given
+datainto the collection.Parameters
- data: DocumentData<T>
The contents of the new vertex.
+ Optionaloptions: GraphCollectionInsertOptionsOptions for inserting the vertex.
+
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
}>Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("friends");
const result = await collection.save(
{ _key: "a", color: "blue", count: 1 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 1 +- data: DocumentData<T>
update
- update(selector, newValue, options?): Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}> - -
Updates an existing vertex in the collection.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
-const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.update(
"a",
{ count: 2 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 2 --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
- -
-
newValue: Patch<DocumentData<T>>
- -
-
-Optionaloptions: GraphCollectionReplaceOptionsOptions for updating the vertex.
-
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}> - selector: DocumentSelector
- vertex
--
-
- vertex(selector: DocumentSelector, options?: GraphCollectionReadOptions): Promise<Document<T>> -
-
-
Retrieves the vertex matching the given key or id.
+ - newValue: Patch<DocumentData<T>>
Optionaloptions: GraphCollectionReplaceOptionsOptions for updating the vertex.
+
Returns Promise<DocumentMetadata & {
    new?: Document<T>;
    old?: Document<T>;
}>Example
+const graph = db.graph("some-graph");
const collection = graph.collection("vertices");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.update(
"a",
{ count: 2 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 2 + -
-
vertex
- vertex(selector, options?): Promise<Document<T>>
- -
Retrieves the vertex matching the given key or id.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
- -const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
try {
const vertex = await collection.vertex("abc123");
console.log(vertex);
} catch (e: any) {
console.error("Could not find vertex");
} -Example
-const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", { graceful: true });
if (vertex) {
console.log(vertex);
} else {
console.error("Could not find vertex");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
- -
-
-Optionaloptions: GraphCollectionReadOptionsOptions for retrieving the vertex.
-
Returns Promise<Document<T>>
- - selector: DocumentSelector
- vertex(selector: DocumentSelector, graceful: boolean): Promise<Document<T>> -
-
-
Retrieves the vertex matching the given key or id.
+ Optionaloptions: GraphCollectionReadOptionsOptions for retrieving the vertex.
+
Returns Promise<Document<T>>
Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
try {
const vertex = await collection.vertex("abc123");
console.log(vertex);
} catch (e: any) {
console.error("Could not find vertex");
} +Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", { graceful: true });
if (vertex) {
console.log(vertex);
} else {
console.error("Could not find vertex");
} + -
-
- vertex(selector, graceful): Promise<Document<T>>
- -
Retrieves the vertex matching the given key or id.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
- -const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
try {
const vertex = await collection.vertex("abc123", false);
console.log(vertex);
} catch (e: any) {
console.error("Could not find vertex");
} -Example
-const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", true);
if (vertex) {
console.log(vertex);
} else {
console.error("Could not find vertex");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
- -
-
graceful: boolean
-If set to
true,nullis returned instead of an + - graceful: boolean
If set to
-true,nullis returned instead of an exception being thrown if the vertex does not exist.
Returns Promise<Document<T>>
- selector: DocumentSelector
- vertex
-Exists -
-
- vertex
Exists(selector: DocumentSelector): Promise<boolean>
- -
-
Checks whether a vertex matching the given key or id exists in this +
Returns Promise<Document<T>>
Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
try {
const vertex = await collection.vertex("abc123", false);
console.log(vertex);
} catch (e: any) {
console.error("Could not find vertex");
} +Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const vertex = await collection.vertex("abc123", true);
if (vertex) {
console.log(vertex);
} else {
console.error("Could not find vertex");
} + -
-
vertex
Exists - vertex
Exists(selector): Promise<boolean> - -
Checks whether a vertex matching the given key or id exists in this collection.
Throws an exception when passed a vertex or
- -_idfrom a different collection.Example
-const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const exists = await collection.vertexExists("abc123");
if (!exists) {
console.log("Vertex does not exist");
} ---Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a vertex from this collection).
Returns Promise<boolean>
- selector: DocumentSelector
-
-
-- \ No newline at end of file +Generated using TypeDoc
Returns Promise<boolean>
Example
+const graph = db.graph("some-graph");
const collection = graph.vertexCollection("vertices");
const exists = await collection.vertexExists("abc123");
if (!exists) {
console.log("Vertex does not exist");
} +
-
\ No newline at end of file
diff --git a/devel/classes/route.Route.html b/devel/classes/route.Route.html
index 1fa3ff001..6b2754225 100644
--- a/devel/classes/route.Route.html
+++ b/devel/classes/route.Route.html
@@ -1,469 +1,114 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-is
-
-
-
-
-
-
-
-
-Class Job<T>
Represents an async job in a Database.
-Type Parameters
--
-
-
-
T = any
Hierarchy
--
-
- Job
- Index
-
-
-
-
-
Accessors
-Methods
-Accessors
-is
--
-
- get isLoaded(): boolean -
-
--
Whether the job's results have been loaded. If set to
-true, the job's -result can be accessed from result.Returns boolean
result
--
-
- get result(): undefined | T -
-
--
The job's result if it has been loaded or
-undefinedotherwise.Returns undefined | T
Methods
-cancel
--
-
- cancel(): Promise<void> -
-
-
Cancels the job if it is still running. Note that it may take some time to +
Job | arangojs --Class Job<T>
Represents an async job in a database.Database.
+Type Parameters
Index
Accessors
Methods
Accessors
database
id
- get id(): string
The job's ID.
+Returns string
is
Loaded - get isLoaded(): boolean
Whether the job's results have been loaded. If set to
+true, the job's +result can be accessed from Job.result.Returns boolean
result
Methods
cancel
- -delete
-Result - get
-Completed delete
Result get
Completed - get
Completed(): Promise<boolean> - -
Fetches the job's completion state.
Returns
- -trueif the job has completed,falseotherwise.Example
-// poll for the job to complete
while (!(await job.getCompleted())) {
await timeout(1000);
}
// job result is now available and can be loaded
await job.load();
console.log(job.result); -Returns Promise<boolean>
- load
--
-
- load(): Promise<undefined | T> -
-
--
Loads the job's result from the database if it is not already loaded.
- -Example
-// poll for the job to complete
while (!job.isLoaded) {
await timeout(1000);
const result = await job.load();
console.log(result);
}
// job result is now loaded and can also be accessed from job.result
console.log(job.result); -Returns Promise<undefined | T>
-- \ No newline at end of file +Generated using TypeDoc
Returns Promise<boolean>
Example
+// poll for the job to complete
while (!(await job.getCompleted())) {
await timeout(1000);
}
// job result is now available and can be loaded
await job.load();
console.log(job.result); +
load
- load(): Promise<undefined | T>
Loads the job's result from the database if it is not already loaded.
+Returns Promise<undefined | T>
Example
+// poll for the job to complete
while (!job.isLoaded) {
await timeout(1000);
const result = await job.load();
console.log(result);
}
// job result is now loaded and can also be accessed from job.result
console.log(job.result); +
-
\ No newline at end of file
diff --git a/devel/classes/transaction.Transaction.html b/devel/classes/transaction.Transaction.html
index 6eb0ab02b..a5e9d2de3 100644
--- a/devel/classes/transaction.Transaction.html
+++ b/devel/classes/transaction.Transaction.html
@@ -1,172 +1,31 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-Class Route
Represents an arbitrary route relative to an ArangoDB database.
-Hierarchy
--
-
- Route
Methods
-delete
--
-
- delete(path: string, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a DELETE request against the given path relative to this route +
Route | arangojs --Class Route
Represents an arbitrary route relative to an ArangoDB database.
+Accessors
database
headers
- get headers(): Headers
Headers of this route.
+Returns Headers
path
- get path(): string
Path of this route.
+Returns string
Methods
delete
- delete(path, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a DELETE request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.delete("/users/admin"); ---Parameters
-Returns Promise<ArangojsResponse>
- - delete(qs?: Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a DELETE request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.delete("/users/admin"); + - path: string
- delete(search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a DELETE request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.roue("/users/admin");
const res = await user.delete(); ---Parameters
-Returns Promise<ArangojsResponse>
- get
--
-
- get(path: string, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a GET request against the given path relative to this route +
Parameters
Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.roue("/users/admin");
const res = await user.delete(); +
get
- get(path, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a GET request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.get("/users", { offset: 10, limit: 5 }); ---Parameters
-Returns Promise<ArangojsResponse>
- - get(qs?: Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a GET request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.get("/users", { offset: 10, limit: 5 }); + - path: string
- get(search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a GET request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.get({ offset: 10, limit: 5 }); ---Parameters
-Returns Promise<ArangojsResponse>
- head
--
-
- head(path: string, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a HEAD request against the given path relative to this route +
Parameters
Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.get({ offset: 10, limit: 5 }); +
head
- head(path, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a HEAD request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.head("/users", { offset: 10, limit: 5 }); ---Parameters
-Returns Promise<ArangojsResponse>
- - head(qs?: Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a HEAD request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.head("/users", { offset: 10, limit: 5 }); + - path: string
- head(search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a HEAD request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.head({ offset: 10, limit: 5 }); ---Parameters
-Returns Promise<ArangojsResponse>
- patch
--
-
- patch(path: string, body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a PATCH request against the given path relative to this route +
Parameters
Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.head({ offset: 10, limit: 5 }); +
patch
- patch(path, body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a PATCH request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.patch("/users/admin", { password: "admin" }); ---Parameters
-Returns Promise<ArangojsResponse>
- - patch(body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a PATCH request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalbody: anyBody of the request object.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.patch("/users/admin", { password: "admin" }); + - path: string
- patch(body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a PATCH request against the given path relative to this route and returns the server response.
Note:
- -bodymust not be astring.Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.route("/users/admin")
const res = await user.patch({ password: "admin" }); ---Parameters
-Returns Promise<ArangojsResponse>
- post
--
-
- post(path: string, body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a POST request against the given path relative to this route +
Parameters
Optionalbody: anyBody of the request object. Must not be a string.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.route("/users/admin")
const res = await user.patch({ password: "admin" }); +
post
- post(path, body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a POST request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.post("/users", {
username: "admin",
password: "hunter2"
}); ---Parameters
-Returns Promise<ArangojsResponse>
- - post(body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a POST request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalbody: anyBody of the request object.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.post("/users", {
username: "admin",
password: "hunter2"
}); + - path: string
- post(body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a POST request against the given path relative to this route and returns the server response.
Note:
- -bodymust not be astring.Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.post({
username: "admin",
password: "hunter2"
}); ---Parameters
-Returns Promise<ArangojsResponse>
- put
--
-
- put(path: string, body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a PUT request against the given path relative to this route +
Parameters
Optionalbody: anyBody of the request object. Must not be a string.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.post({
username: "admin",
password: "hunter2"
}); +
put
- put(path, body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a PUT request against the given path relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.put("/users/admin/password", { password: "admin" }); ---Parameters
-Returns Promise<ArangojsResponse>
- - put(body?: any, qs?: string | Params, headers?: Headers): Promise<ArangojsResponse> -
-
-
Performs a PUT request against the given path relative to this route +
Parameters
- path: string
Path relative to this route.
+ Optionalbody: anyBody of the request object.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.put("/users/admin/password", { password: "admin" }); + - path: string
- put(body?, search?, headers?): Promise<ProcessedResponse<any>>
- -
Performs a PUT request against the given path relative to this route and returns the server response.
Note:
- -bodymust not be astring.Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const password = foxx.route("/users/admin/password");
const res = await password.put({ password: "admin" }); ---Parameters
-Returns Promise<ArangojsResponse>
- request
--
-
- request(options?: RequestOptions): Promise<ArangojsResponse> -
-
-
Performs an arbitrary HTTP request relative to this route and returns the +
Parameters
Optionalbody: anyBody of the request object. Must not be a string.
+Optionalsearch: Record<string, any> | URLSearchParamsQuery string parameters for this request.
+Optionalheaders: Record<string, string> | HeadersAdditional headers to send with this request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const password = foxx.route("/users/admin/password");
const res = await password.put({ password: "admin" }); +
request
- request(options?): Promise<ProcessedResponse<any>>
- -
Performs an arbitrary HTTP request relative to this route and returns the server response.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.request({
method: "POST",
path: "/users",
body: {
username: "admin",
password: "hunter2"
}
}); ---Parameters
--
-
-
-
-Optionaloptions: RequestOptionsOptions for performing the request.
-
Returns Promise<ArangojsResponse>
-
-
- route
--
-
- route(path: string, headers?: Headers): Route -
-
-
Creates a new route relative to this route that inherits any of its default +
Parameters
Optionaloptions: RequestOptionsOptions for performing the request.
+
Returns Promise<ProcessedResponse<any>>
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.request({
method: "POST",
path: "/users",
body: {
username: "admin",
password: "hunter2"
}
}); +
route
- route(path, headers?): Route
- -
Creates a new route relative to this route that inherits any of its default HTTP headers.
- -Example
-const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users"); ---Parameters
--
-
-
-
path: string
-Path relative to this route.
-
- -
-
-Optionalheaders: HeadersAdditional headers that will be sent with each request.
-
Returns Route
-
-
-- \ No newline at end of file +Generated using TypeDoc
Parameters
- path: string
Path relative to this route.
+ Optionalheaders: Record<string, string> | HeadersAdditional headers that will be sent with each request.
+
Returns Route
Example
+const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users"); +
-View | arangojs
-
-CollectionStatus | arangojs
-
-CollectionStatus | arangojs CollectionType | arangojs
-
-CollectionType | arangojs LogLevel | arangojs
-
-LogLevel | arangojs isArangoAnalyzer | arangojs
-
-isArangoAnalyzer | arangojs aql | arangojs
-
-
\ No newline at end of file
diff --git a/devel/functions/aql.isAqlLiteral.html b/devel/functions/aql.isAqlLiteral.html
index 48bab6906..2daafff84 100644
--- a/devel/functions/aql.isAqlLiteral.html
+++ b/devel/functions/aql.isAqlLiteral.html
@@ -1,77 +1,3 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/devel/classes/view.View.html b/devel/classes/view.View.html
index f4aee7acc..0c180d55c 100644
--- a/devel/classes/view.View.html
+++ b/devel/classes/view.View.html
@@ -1,257 +1,46 @@
-
-
-
-Class Transaction
Represents a streaming transaction in a Database.
-Hierarchy
--
-
- Transaction
Accessors
-id
--
-
- get id(): string -
-
--
Unique identifier of this transaction.
-See transaction.
-Returns string
Methods
-abort
--
-
- abort(options?: TransactionAbortOptions): Promise<TransactionStatus> -
-
--
Attempts to abort the transaction to the databases.
- -Example
-const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const result = await trx.abort();
// result indicates the updated transaction status ---Parameters
--
-
-
-
options: TransactionAbortOptions = {}
-Options for aborting the transaction.
-
Returns Promise<TransactionStatus>
-
-
commit
--
-
- commit(options?: TransactionCommitOptions): Promise<TransactionStatus> -
-
--
Attempts to commit the transaction to the databases.
- -Example
-const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const result = await trx.commit();
// result indicates the updated transaction status ---Parameters
--
-
-
-
options: TransactionCommitOptions = {}
-Options for comitting the transaction.
-
Returns Promise<TransactionStatus>
-
-
exists
-get
--
-
- get(): Promise<TransactionStatus> -
-
--
Retrieves general information about the transaction.
- -Example
-const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const info = await trx.get();
// the transaction exists -Returns Promise<TransactionStatus>
step
--
-
- step<T>(callback: (() => Promise<T>)): Promise<T> -
-
--
Executes the given function locally as a single step of the transaction.
- -Example
- -const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); -Example
- -// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); -Example
- -// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); -Example
- -// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed -Example
- -// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); -Example
- -// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); -Example
- -// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); -Example
-// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); -- -Type Parameters
--
-
-
-
T
-Type of the callback's returned promise.
-
-Parameters
--
-
-
-
callback: (() => Promise<T>)
-Callback function returning a promise.
+Transaction | arangojs -Class Transaction
Represents a streaming transaction in a database.Database.
+Accessors
database
id
- get id(): string
Unique identifier of this transaction.
+ +Returns string
Methods
abort
- abort(options?): Promise<TransactionStatus>
Attempts to abort the transaction to the databases.
+Parameters
- options: TransactionAbortOptions = {}
Options for aborting the transaction.
+
Returns Promise<TransactionStatus>
Example
+const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const result = await trx.abort();
// result indicates the updated transaction status +- options: TransactionAbortOptions = {}
commit
- commit(options?): Promise<TransactionStatus>
Attempts to commit the transaction to the databases.
+Parameters
- options: TransactionCommitOptions = {}
Options for comitting the transaction.
+
Returns Promise<TransactionStatus>
Example
+const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const result = await trx.commit();
// result indicates the updated transaction status +- options: TransactionCommitOptions = {}
exists
get
- get(): Promise<TransactionStatus>
Retrieves general information about the transaction.
+Returns Promise<TransactionStatus>
Example
+const db = new Database();
const col = db.collection("some-collection");
const trx = db.beginTransaction(col);
await trx.step(() => col.save({ hello: "world" }));
const info = await trx.get();
// the transaction exists +
step
- step<T>(callback): Promise<T>
Executes the given function locally as a single step of the transaction.
+Type Parameters
-Parameters
- callback: (() => Promise<T>)-
Callback function returning a promise.
Warning: The callback function should wrap a single call of an async arangojs method (e.g. a method on a
Collectionobject of a collection that is involved in the transaction or thedb.querymethod). @@ -183,56 +42,20 @@callback: ( -
- -
-
-
- (): Promise<T> -
-
-
Returns Promise<T>
Returns Promise<T>
- -
- callback: (() => Promise<T>)
-- \ No newline at end of file +Generated using TypeDoc
Returns Promise<T>
Example
+const db = new Database();
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const trx = await db.beginTransaction({ write: [vertices, edges] });
// The following code will be part of the transaction
const left = await trx.step(() => vertices.save({ label: "left" }));
const right = await trx.step(() => vertices.save({ label: "right" }));
// Results from preceding actions can be used normally
await trx.step(() => edges.save({
_from: left._id,
_to: right._id,
data: "potato"
}));
// Transaction must be committed for changes to take effected
// Always call either trx.commit or trx.abort to end a transaction
await trx.commit(); +Example
+// BAD! If the callback is an async function it must only use await once!
await trx.step(async () => {
await collection.save(data);
await collection.save(moreData); // WRONG
});
// BAD! Callback function must use only one arangojs call!
await trx.step(() => {
return collection.save(data)
.then(() => collection.save(moreData)); // WRONG
});
// BETTER: Wrap every arangojs method call that should be part of the
// transaction in a separate `trx.step` call
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData)); +Example
+// BAD! If the callback is an async function it must not await before
// calling an arangojs method!
await trx.step(async () => {
await doSomethingElse();
return collection.save(data); // WRONG
});
// BAD! Any arangojs inside the callback must not happen inside a promise
// method!
await trx.step(() => {
return doSomethingElse()
.then(() => collection.save(data)); // WRONG
});
// BETTER: Perform any async logic needed outside the `trx.step` call
await doSomethingElse();
await trx.step(() => collection.save(data));
// OKAY: You can perform async logic in the callback after the arangojs
// method call as long as it does not involve additional arangojs method
// calls, but this makes it easy to make mistakes later
await trx.step(async () => {
await collection.save(data);
await doSomethingDifferent(); // no arangojs method calls allowed
}); +Example
+// BAD! The callback should not use any functions that themselves use any
// arangojs methods!
async function saveSomeData() {
await collection.save(data);
await collection.save(moreData);
}
await trx.step(() => saveSomeData()); // WRONG
// BETTER: Pass the transaction to functions that need to call arangojs
// methods inside a transaction
async function saveSomeData(trx) {
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
}
await saveSomeData(); // no `trx.step` call needed +Example
+// BAD! You must wait for the promise to resolve (or await on the
// `trx.step` call) before calling `trx.step` again!
trx.step(() => collection.save(data)); // WRONG
await trx.step(() => collection.save(moreData));
// BAD! The trx.step callback can not make multiple calls to async arangojs
// methods, not even using Promise.all!
await trx.step(() => Promise.all([ // WRONG
collection.save(data),
collection.save(moreData),
]));
// BAD! Multiple `trx.step` calls can not run in parallel!
await Promise.all([ // WRONG
trx.step(() => collection.save(data)),
trx.step(() => collection.save(moreData)),
]));
// BETTER: Always call `trx.step` sequentially, one after the other
await trx.step(() => collection.save(data));
await trx.step(() => collection.save(moreData));
// OKAY: The then callback can be used if async/await is not available
trx.step(() => collection.save(data))
.then(() => trx.step(() => collection.save(moreData))); +Example
+// BAD! The callback will return an empty promise that resolves before
// the inner arangojs method call has even talked to ArangoDB!
await trx.step(async () => {
collection.save(data); // WRONG
});
// BETTER: Use an arrow function so you don't forget to return
await trx.step(() => collection.save(data));
// OKAY: Remember to always return when using a function body
await trx.step(() => {
return collection.save(data); // easy to forget!
});
// OKAY: You do not have to use arrow functions but it helps
await trx.step(function () {
return collection.save(data);
}); +Example
+// BAD! You can not pass promises instead of a callback!
await trx.step(collection.save(data)); // WRONG
// BETTER: Wrap the code in a function and pass the function instead
await trx.step(() => collection.save(data)); +Example
+// WORSE: Calls to non-async arangojs methods don't need to be performed
// as part of a transaction
const collection = await trx.step(() => db.collection("my-documents"));
// BETTER: If an arangojs method is not async and doesn't return promises,
// call it without `trx.step`
const collection = db.collection("my-documents"); +
-
-
-
\ No newline at end of file
diff --git a/devel/enums/collection.CollectionStatus.html b/devel/enums/collection.CollectionStatus.html
index 6f2c55f9f..9723bb276 100644
--- a/devel/enums/collection.CollectionStatus.html
+++ b/devel/enums/collection.CollectionStatus.html
@@ -1,112 +1,8 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- replace
update
-
-
-Class View
Represents a View in a Database.
-Hierarchy
--
-
- View
- Index
-
-
-
-
-
Accessors
-name
-
Methods
-Accessors
-name
--
-
- get name(): string -
-
--
Name of the View.
-Returns string
Methods
-create
--
-
- create<Options>(options: CreateViewOptions): Promise<Options extends CreateSearchAliasViewOptions ? SearchAliasViewDescription : ViewDescription> -
-
--
Creates a View with the given
-optionsand the instance's name.See also createView.
- -Example
-const db = new Database();
const view = db.view("potatoes");
await view.create();
// the ArangoSearch View "potatoes" now exists -- -Type Parameters
--
-
-
-
Options extends CreateViewOptions
--Parameters
--
-
-
-
options: CreateViewOptions
Returns Promise<Options extends CreateSearchAliasViewOptions ? SearchAliasViewDescription : ViewDescription>
-
-
drop
-exists
-get
--
-
- get(): Promise<ArangoApiResponse<ViewDescription>> -
-
--
Retrieves general information about the View.
- -Example
-const db = new Database();
const view = db.view("some-view");
const data = await view.get();
// data contains general information about the View -Returns Promise<ArangoApiResponse<ViewDescription>>
properties
--
-
- properties(): Promise<ArangoApiResponse<ViewProperties>> -
-
--
Retrieves the View's properties.
- -Example
-const db = new Database();
const view = db.view("some-view");
const data = await view.properties();
// data contains the View's properties -Returns Promise<ArangoApiResponse<ViewProperties>>
rename
--
-
- rename(newName: string): Promise<ArangoApiResponse<ViewDescription>> -
-
-
Renames the View and updates the instance's
-nametonewName.Additionally removes the instance from the Database's internal +
View | arangojs --Class View
Represents a View in a database.Database.
+Index
Accessors
Methods
Accessors
database
name
- get name(): string
Name of the View.
+Returns string
Methods
create
- create<Options>(options): Promise<Options extends CreateSearchAliasViewOptions
    ? SearchAliasViewDescription
    : ViewDescription> Creates a View with the given
+optionsand the instance's name.See also database.Database#createView.
+Type Parameters
- Options extends CreateViewOptions
Parameters
- options: CreateViewOptions
Returns Promise<Options extends CreateSearchAliasViewOptions
    ? SearchAliasViewDescription
    : ViewDescription>Example
+const db = new Database();
const view = db.view("potatoes");
await view.create();
// the ArangoSearch View "potatoes" now exists +
drop
exists
get
- get(): Promise<ArangoApiResponse<ViewDescription>>
Retrieves general information about the View.
+Returns Promise<ArangoApiResponse<ViewDescription>>
Example
+const db = new Database();
const view = db.view("some-view");
const data = await view.get();
// data contains general information about the View +
properties
- properties(): Promise<ArangoApiResponse<ViewProperties>>
Retrieves the View's properties.
+Returns Promise<ArangoApiResponse<ViewProperties>>
Example
+const db = new Database();
const view = db.view("some-view");
const data = await view.properties();
// data contains the View's properties +
rename
- rename(newName): Promise<ArangoApiResponse<ViewDescription>>
- -
Renames the View and updates the instance's
+nametonewName.Additionally removes the instance from the database.Database's internal cache.
Note: Renaming Views may not be supported when ArangoDB is running in a cluster configuration.
- -Example
-const db = new Database();
const view1 = db.view("some-view");
await view1.rename("other-view");
const view2 = db.view("some-view");
const view3 = db.view("other-view");
// Note all three View instances are different objects but
// view1 and view3 represent the same ArangoDB view! ---Parameters
--
-
-
-
newName: string
-The new name of the View.
-
Returns Promise<ArangoApiResponse<ViewDescription>>
-
-
- -replace
-Properties -
-
- replace
Properties<Properties>(properties?: Properties): Promise<Properties extends ArangoSearchViewPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPropertiesOptions ? SearchAliasViewProperties : ViewProperties>
- -
--
Replaces the properties of the View.
- -Example
-const db = new Database();
const view = db.view("some-view");
const result = await view.replaceProperties({
consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234 -- -Type Parameters
--
-
-
-
Properties extends undefined | ViewPropertiesOptions
--Parameters
--
-
-
-
-Optionalproperties: PropertiesNew properties of the View.
-
Returns Promise<Properties extends ArangoSearchViewPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPropertiesOptions ? SearchAliasViewProperties : ViewProperties>
-
-
- update
-Properties -
-
- update
Properties<Properties>(properties?: Properties): Promise<Properties extends ArangoSearchViewPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPatchPropertiesOptions ? SearchAliasViewProperties : ViewProperties>
- -
--
Updates the properties of the View.
- -Example
-const db = new Database();
const view = db.view("some-view");
const result = await view.updateProperties({
consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234 -- -Type Parameters
--
-
-
-
Properties extends undefined | ViewPatchPropertiesOptions
--Parameters
--
-
-
-
-Optionalproperties: PropertiesProperties of the View to update.
-
Returns Promise<Properties extends ArangoSearchViewPropertiesOptions ? ArangoSearchViewProperties : Properties extends SearchAliasViewPatchPropertiesOptions ? SearchAliasViewProperties : ViewProperties>
-
-
-- \ No newline at end of file +Generated using TypeDoc
Parameters
- newName: string
The new name of the View.
+
Returns Promise<ArangoApiResponse<ViewDescription>>
Example
+const db = new Database();
const view1 = db.view("some-view");
await view1.rename("other-view");
const view2 = db.view("some-view");
const view3 = db.view("other-view");
// Note all three View instances are different objects but
// view1 and view3 represent the same ArangoDB view! +
replace
- replace
Properties<Properties>(properties?): Promise<Properties extends ArangoSearchViewPropertiesOptions
    ? ArangoSearchViewProperties
    : Properties extends SearchAliasViewPropertiesOptions
        ? SearchAliasViewProperties
        : ViewProperties> Replaces the properties of the View.
+Type Parameters
- Properties extends undefined | ViewPropertiesOptions
Parameters
Optionalproperties: PropertiesNew properties of the View.
+
Returns Promise<Properties extends ArangoSearchViewPropertiesOptions
    ? ArangoSearchViewProperties
    : Properties extends SearchAliasViewPropertiesOptions
        ? SearchAliasViewProperties
        : ViewProperties>Example
+const db = new Database();
const view = db.view("some-view");
const result = await view.replaceProperties({
consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234 +
update
- update
Properties<Properties>(properties?): Promise<Properties extends ArangoSearchViewPropertiesOptions
    ? ArangoSearchViewProperties
    : Properties extends SearchAliasViewPatchPropertiesOptions
        ? SearchAliasViewProperties
        : ViewProperties> Updates the properties of the View.
+Type Parameters
- Properties extends undefined | ViewPatchPropertiesOptions
Parameters
Optionalproperties: PropertiesProperties of the View to update.
+
Returns Promise<Properties extends ArangoSearchViewPropertiesOptions
    ? ArangoSearchViewProperties
    : Properties extends SearchAliasViewPatchPropertiesOptions
        ? SearchAliasViewProperties
        : ViewProperties>Example
+const db = new Database();
const view = db.view("some-view");
const result = await view.updateProperties({
consolidationIntervalMsec: 234
});
console.log(result.consolidationIntervalMsec); // 234 +
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/enums/collection.CollectionType.html b/devel/enums/collection.CollectionType.html
index 5d9c403de..750bd1947 100644
--- a/devel/enums/collection.CollectionType.html
+++ b/devel/enums/collection.CollectionType.html
@@ -1,84 +1,4 @@
-
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/enums/database.LogLevel.html b/devel/enums/database.LogLevel.html
index 8f137399a..fb38bd707 100644
--- a/devel/enums/database.LogLevel.html
+++ b/devel/enums/database.LogLevel.html
@@ -1,105 +1,7 @@
-
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/functions/analyzer.isArangoAnalyzer.html b/devel/functions/analyzer.isArangoAnalyzer.html
index 21230a0f7..26d9ad880 100644
--- a/devel/functions/analyzer.isArangoAnalyzer.html
+++ b/devel/functions/analyzer.isArangoAnalyzer.html
@@ -1,113 +1,3 @@
-
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/functions/aql.aql.html b/devel/functions/aql.aql.html
index 9334c7fe9..c4259bd6e 100644
--- a/devel/functions/aql.aql.html
+++ b/devel/functions/aql.aql.html
@@ -1,32 +1,10 @@
-
-
-
-
-
-
-Function aql
-
-
- aql<T>(templateStrings: TemplateStringsArray, ...args: AqlValue[]): GeneratedAqlQuery<T> -
-
--
Template string handler (template tag) for AQL queries.
+aql | arangojs --Function aql
- aql<T>(templateStrings, ...args): AqlQuery<T>
- to the interpolated values and produce an AQL query object containing both the query and the values. This prevents most injection attacks when using untrusted values in dynamic queries. - -
Template string handler (template tag) for AQL queries.
The
-aqltag can be used to write complex AQL queries as multi-line strings without having to worry aboutbindVarsand the distinction between collections and regular parameters.Tagged template strings will return an AqlQuery object with +
Tagged template strings will return an AqlQuery object with
-queryandbindVarsattributes reflecting any interpolated values.Any ArangoCollection instance used in a query string will +
Any collection.ArangoCollection instance used in a query string will be recognized as a collection reference and generate an AQL collection bind parameter instead of a regular AQL value bind parameter.
Note: you should always use the
aqltemplate tag when writing @@ -36,71 +14,10 @@Function aql
Example
- -// Some user-supplied string that may be malicious
const untrustedValue = req.body.email;
// Without aql tag: BAD! DO NOT DO THIS!
const badQuery = `
FOR user IN users
FILTER user.email == "${untrustedValue}"
RETURN user
`;
// e.g. if untrustedValue is '" || user.admin == true || "':
// Query:
// FOR user IN users
// FILTER user.email == "" || user.admin == true || ""
// RETURN user
// With the aql tag: GOOD! MUCH SAFER!
const betterQuery = aql`
FOR user IN users
FILTER user.email == ${untrustedValue}
RETURN user
`;
// Query:
// FOR user IN users
// FILTER user.email == @value0
// RETURN user
// Bind parameters:
// value0 -> untrustedValue -Example
- -const collection = db.collection("some-collection");
const minValue = 23;
const result = await db.query(aql`
FOR d IN ${collection}
FILTER d.num > ${minValue}
RETURN d
`);
// Equivalent raw query object
const result2 = await db.query({
query: `
FOR d IN @@collection
FILTER d.num > @minValue
RETURN d
`,
bindVars: {
"@collection": collection.name,
minValue: minValue
}
}); -Example
-const collection = db.collection("some-collection");
const color = "green";
const filter = aql`FILTER d.color == ${color}'`;
const result = await db.query(aql`
FOR d IN ${collection}
${filter}
RETURN d
`); -
- -Type Parameters
--
-
-
-
T = any
--Parameters
--
-
-
-
templateStrings: TemplateStringsArray
- -
-
Rest...args: AqlValue[]
Returns GeneratedAqlQuery<T>
-- \ No newline at end of file +Generated using TypeDoc
Type Parameters
Parameters
- templateStrings: TemplateStringsArray
Rest...args: AqlValue[]
Returns AqlQuery<T>
Example
// Some user-supplied string that may be malicious
const untrustedValue = req.body.email;
// Without aql tag: BAD! DO NOT DO THIS!
const badQuery = `
FOR user IN users
FILTER user.email == "${untrustedValue}"
RETURN user
`;
// e.g. if untrustedValue is '" || user.admin == true || "':
// Query:
// FOR user IN users
// FILTER user.email == "" || user.admin == true || ""
// RETURN user
// With the aql tag: GOOD! MUCH SAFER!
const betterQuery = aql`
FOR user IN users
FILTER user.email == ${untrustedValue}
RETURN user
`;
// Query:
// FOR user IN users
// FILTER user.email == @value0
// RETURN user
// Bind parameters:
// value0 -> untrustedValue
+Example
const collection = db.collection("some-collection");
const minValue = 23;
const result = await db.query(aql`
FOR d IN ${collection}
FILTER d.num > ${minValue}
RETURN d
`);
// Equivalent raw query object
const result2 = await db.query({
query: `
FOR d IN @@collection
FILTER d.num > @minValue
RETURN d
`,
bindVars: {
"@collection": collection.name,
minValue: minValue
}
});
+Example
const collection = db.collection("some-collection");
const color = "green";
const filter = aql`FILTER d.color == ${color}'`;
const result = await db.query(aql`
FOR d IN ${collection}
${filter}
RETURN d
`);
+
-
-
-
-
-
-
-
-Function isAqlLiteral
-
-
- is
Aql Literal(literal: any): literal is AqlLiteral
- -
--
Indicates whether the given value is an AqlLiteral.
---Parameters
--
-
-
-
literal: any
-A value that might be an
-AqlLiteral.
Returns literal is AqlLiteral
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function isAqlLiteral
- is
Aql Literal(literal): literal is AqlLiteral Indicates whether the given value is an AqlLiteral.
+Parameters
- literal: any
A value that might be an
+AqlLiteral.
Returns literal is AqlLiteral
- literal: any
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/functions/aql.join.html b/devel/functions/aql.join.html
index 02706bb87..0adb2ed84 100644
--- a/devel/functions/aql.join.html
+++ b/devel/functions/aql.join.html
@@ -1,94 +1,15 @@
-
-
\ No newline at end of file
diff --git a/devel/functions/aql.literal.html b/devel/functions/aql.literal.html
index 7ef38e53d..abc13dd82 100644
--- a/devel/functions/aql.literal.html
+++ b/devel/functions/aql.literal.html
@@ -1,26 +1,4 @@
-
-
-
-
-
-Function join
-
-
- join(values: AqlValue[], sep?: string): GeneratedAqlQuery -
-
-
Constructs AqlQuery objects from an array of arbitrary values.
+join | arangojs -Function join
- join(values, sep?): AqlQuery
- -
Constructs AqlQuery objects from an array of arbitrary values.
Note: Nesting
- -aqltemplate strings is a much safer alternative for most use cases. This low-level helper function only exists to complement theaqltag when constructing complex queries from dynamic arrays of query fragments.Example
- -const users = db.collection("users");
const filters = [];
if (adminsOnly) filters.push(aql`FILTER user.admin`);
if (activeOnly) filters.push(aql`FILTER user.active`);
const result = await db.query(aql`
FOR user IN ${users}
${join(filters)}
RETURN user
`); -Example
-const users = db.collection("users");
const keys = ["jreyes", "ghermann"];
// BAD! NEEDLESSLY COMPLEX!
const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));
const result = await db.query(aql`
FOR user IN [
${join(docs, ", ")}
]
RETURN user
`);
// Query:
// FOR user IN [
// DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)
// ]
// RETURN user
// Bind parameters:
// @value0 -> "users"
// value1 -> "jreyes"
// value2 -> "ghermann"
// GOOD! MUCH SIMPLER!
const result = await db.query(aql`
FOR key IN ${keys}
LET user = DOCUMENT(${users}, key)
RETURN user
`);
// Query:
// FOR user IN @value0
// LET user = DOCUMENT(@@value1, key)
// RETURN user
// Bind parameters:
// value0 -> ["jreyes", "ghermann"]
// @value1 -> "users" ---Parameters
--
-
-
-
values: AqlValue[]
-Array of values to join. These values will behave exactly +
-Parameters
- values: AqlValue[]
Array of values to join. These values will behave exactly like values interpolated in an
-aqltemplate string.
- -
-
sep: string = " "
-Seperator to insert between values. This value will behave -exactly like a value passed to literal, i.e. it will be +
- sep: string = " "
Seperator to insert between values. This value will behave +exactly like a value passed to literal, i.e. it will be inlined as-is, rather than being converted into a bind parameter.
-
Returns GeneratedAqlQuery
- values: AqlValue[]
-
-
-- \ No newline at end of file +Generated using TypeDoc
Returns AqlQuery
Example
+const users = db.collection("users");
const filters = [];
if (adminsOnly) filters.push(aql`FILTER user.admin`);
if (activeOnly) filters.push(aql`FILTER user.active`);
const result = await db.query(aql`
FOR user IN ${users}
${join(filters)}
RETURN user
`); +Example
+const users = db.collection("users");
const keys = ["jreyes", "ghermann"];
// BAD! NEEDLESSLY COMPLEX!
const docs = keys.map(key => aql`DOCUMENT(${users}, ${key}`));
const result = await db.query(aql`
FOR user IN [
${join(docs, ", ")}
]
RETURN user
`);
// Query:
// FOR user IN [
// DOCUMENT(@@value0, @value1), DOCUMENT(@@value0, @value2)
// ]
// RETURN user
// Bind parameters:
// @value0 -> "users"
// value1 -> "jreyes"
// value2 -> "ghermann"
// GOOD! MUCH SIMPLER!
const result = await db.query(aql`
FOR key IN ${keys}
LET user = DOCUMENT(${users}, key)
RETURN user
`);
// Query:
// FOR user IN @value0
// LET user = DOCUMENT(@@value1, key)
// RETURN user
// Bind parameters:
// value0 -> ["jreyes", "ghermann"]
// @value1 -> "users" +
-
-
-
-
-
-Function literal
-
-
- literal(value: undefined | null | string | number | boolean | AqlLiteral): AqlLiteral -
-
--
Marks an arbitrary scalar value (i.e. a string, number or boolean) as +
literal | arangojs --Function literal
- literal(value): AqlLiteral
- rare edge cases where a trusted AQL query fragment must be read from a string (e.g. when reading query fragments from JSON) and should only be used as a last resort. - -
Marks an arbitrary scalar value (i.e. a string, number or boolean) as safe for being inlined directly into AQL queries when used in an
aqltemplate string, rather than being converted into a bind parameter.Note: Nesting
aqltemplate strings is a much safer alternative for @@ -28,64 +6,10 @@Function literal
Example
- -// BAD! DO NOT DO THIS!
const sortDirection = literal('ASC');
// GOOD! DO THIS INSTEAD!
const sortDirection = aql`ASC`; -Example
- -// BAD! DO NOT DO THIS!
const filterColor = literal('FILTER d.color == "green"');
const result = await db.query(aql`
FOR d IN some-collection
${filterColor}
RETURN d
`);
// GOOD! DO THIS INSTEAD!
const color = "green";
const filterColor = aql`FILTER d.color === ${color}`;
const result = await db.query(aql`
FOR d IN some-collection
${filterColor}
RETURN d
`); -Example
-// WARNING: We explicitly trust the environment variable to be safe!
const filter = literal(process.env.FILTER_STATEMENT);
const users = await db.query(aql`
FOR user IN users
${filter}
RETURN user
`); -
--Parameters
--
-
-
-
value: undefined | null | string | number | boolean | AqlLiteral
Returns AqlLiteral
-- \ No newline at end of file +Generated using TypeDoc
Parameters
- value: undefined | null | string | number | boolean | AqlLiteral
Returns AqlLiteral
Example
// BAD! DO NOT DO THIS!
const sortDirection = literal('ASC');
// GOOD! DO THIS INSTEAD!
const sortDirection = aql`ASC`;
+Example
// BAD! DO NOT DO THIS!
const filterColor = literal('FILTER d.color == "green"');
const result = await db.query(aql`
FOR d IN some-collection
${filterColor}
RETURN d
`);
// GOOD! DO THIS INSTEAD!
const color = "green";
const filterColor = aql`FILTER d.color === ${color}`;
const result = await db.query(aql`
FOR d IN some-collection
${filterColor}
RETURN d
`);
+Example
// WARNING: We explicitly trust the environment variable to be safe!
const filter = literal(process.env.FILTER_STATEMENT);
const users = await db.query(aql`
FOR user IN users
${filter}
RETURN user
`);
+
-
\ No newline at end of file
diff --git a/devel/functions/collection.isArangoCollection.html b/devel/functions/collection.isArangoCollection.html
index 2f9fbaaa9..6ff1217cf 100644
--- a/devel/functions/collection.isArangoCollection.html
+++ b/devel/functions/collection.isArangoCollection.html
@@ -1,118 +1,3 @@
-
-
-
-
-
-Function collectionToString
-
-
- collection
To String(collection: string | ArangoCollection): string
- -
-
Coerces the given collection name or ArangoCollection object to +
collectionToString | arangojs --Function collectionToString
- collection
To String(collection): string - -
Coerces the given collection name or ArangoCollection object to a string representing the collection name.
---Parameters
--
-
-
-
collection: string | ArangoCollection
-Collection name or ArangoCollection object.
-
Returns string
-
-
-- \ No newline at end of file +Generated using TypeDoc
Parameters
- collection: string | ArangoCollection
Collection name or ArangoCollection object.
+
Returns string
- collection
-
-
-
-
-
-
-
-Function isArangoCollection
-
-
- is
Arango Collection(collection: any): collection is ArangoCollection
- -
--
Indicates whether the given value represents an ArangoCollection.
---Parameters
--
-
-
-
collection: any
-A value that might be a collection.
-
Returns collection is ArangoCollection
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function isArangoCollection
- is
Arango Collection(collection): collection is ArangoCollection Indicates whether the given value represents an ArangoCollection.
+Parameters
- collection: any
A value that might be a collection.
+
Returns collection is ArangoCollection
- collection: any
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/functions/error.isArangoError.html b/devel/functions/error.isArangoError.html
index f1872b5a6..617529507 100644
--- a/devel/functions/error.isArangoError.html
+++ b/devel/functions/error.isArangoError.html
@@ -1,74 +1,3 @@
-
-
-
-
-
-
-
-
-Function isArangoError
-
-
- is
Arango Error(error: any): error is ArangoError
- -
--
Indicates whether the given value represents an ArangoError.
---Parameters
--
-
-
-
error: any
-A value that might be an
-ArangoError.
Returns error is ArangoError
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function isArangoError
- is
Arango Error(error): error is ArangoError Indicates whether the given value represents an ArangoError.
+Parameters
- error: any
A value that might be an
+ArangoError.
Returns error is ArangoError
- error: any
Function isNetworkError
- is
Network Error(error): error is NetworkError Indicates whether the given value represents a NetworkError.
+Parameters
- error: any
A value that might be a
+NetworkError.
Returns error is NetworkError
- error: any
-
-
-
-
-
-
-
-Function isSystemError
-
-
- is
System Error(err: any): err is SystemError
- -
--
Indicates whether the given value represents a Node.js
-SystemError.--Parameters
--
-
-
-
err: any
Returns err is SystemError
-
-
-
-
\ No newline at end of file
diff --git a/devel/functions/graph.isArangoGraph.html b/devel/functions/graph.isArangoGraph.html
index 0f5efc804..745e15d42 100644
--- a/devel/functions/graph.isArangoGraph.html
+++ b/devel/functions/graph.isArangoGraph.html
@@ -1,84 +1,3 @@
-Generated using TypeDoc
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function isArangoGraph
- is
Arango Graph(graph): graph is Graph Indicates whether the given value represents a graph.Graph.
+Parameters
- graph: any
A value that might be a Graph.
+
Returns graph is Graph
- graph: any
-
-
-
-
-
-
-
-Function arangojs
-
-
- arangojs(config?: Config): Database -
-
--
Creates a new
-Databaseinstance with its own connection pool.This is a wrapper function for the new Database.
- -Example
-const db = arangojs({
url: "http://127.0.0.1:8529",
databaseName: "myDatabase",
auth: { username: "admin", password: "hunter2" },
}); ---Parameters
--
-
-
-
-Optionalconfig: ConfigAn object with configuration options.
-
Returns Database
- -
-
- arangojs(url: string | string[], name?: string): Database -
-
--
Creates a new
-Databaseinstance with its own connection pool.This is a wrapper function for the new Database.
- -Example
-const db = arangojs("http://127.0.0.1:8529", "myDatabase");
db.useBasicAuth("admin", "hunter2"); ---Parameters
--
-
-
-
url: string | string[]
-Base URL of the ArangoDB server or list of server URLs. -Equivalent to the
-urloption in Config.
- -
-
Optionalname: string
Returns Database
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function arangojs
- arangojs(config?): Database
Creates a new
+Databaseinstance with its own connection pool.This is a wrapper function for the database.Database:constructor.
+Parameters
Optionalconfig: ConfigAn object with configuration options.
+
Returns Database
Example
+const db = arangojs({
url: "http://127.0.0.1:8529",
databaseName: "myDatabase",
auth: { username: "admin", password: "hunter2" },
}); +- arangojs(url, name?): Database
Creates a new
+Databaseinstance with its own connection pool.This is a wrapper function for the database.Database:constructor.
+Parameters
- url: string | string[]
Base URL of the ArangoDB server or list of server URLs. +Equivalent to the
+urloption in connection.Config. Optionalname: string
Returns Database
Example
+const db = arangojs("http://127.0.0.1:8529", "myDatabase");
db.useBasicAuth("admin", "hunter2"); +- url: string | string[]
-
-
-
-
-
-
-
-Function isArangoTransaction
-
-
- is
Arango Transaction(transaction: any): transaction is Transaction
- -
--
Indicates whether the given value represents a Transaction.
---Parameters
--
-
-
-
transaction: any
-A value that might be a transaction.
-
Returns transaction is Transaction
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Function isArangoTransaction
- is
Arango Transaction(transaction): transaction is Transaction Indicates whether the given value represents a Transaction.
+Parameters
- transaction: any
A value that might be a transaction.
+
Returns transaction is Transaction
- transaction: any
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/hierarchy.html b/devel/hierarchy.html
new file mode 100644
index 000000000..816db9d90
--- /dev/null
+++ b/devel/hierarchy.html
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/devel/index.html b/devel/index.html
index 2c3ab58ce..2dd4fb433 100644
--- a/devel/index.html
+++ b/devel/index.html
@@ -1,85 +1,36 @@
-
-
\ No newline at end of file
diff --git a/devel/interfaces/aql.AqlLiteral.html b/devel/interfaces/aql.AqlLiteral.html
index f38a7f77d..11f25f101 100644
--- a/devel/interfaces/aql.AqlLiteral.html
+++ b/devel/interfaces/aql.AqlLiteral.html
@@ -1,73 +1,5 @@
-
-
-
-arangojs
-
- arangojs
ArangoDB JavaScript Driver
- -The official ArangoDB JavaScript client for Node.js and the browser.
+arangojs
ArangoDB JavaScript Driver
The official ArangoDB JavaScript client for Node.js and the browser.
Links
- --
-
-
+
Links
- - -Install
- - - -With npm or yarn
- -
- - -npm install --save arangojs
## - or -
yarn add arangojs -For browsers
- -When using modern JavaScript tooling with a bundler and compiler (e.g. Babel), +
Install
With npm or yarn
+npm install --save arangojs
## - or -
yarn add arangojs +For browsers
When using modern JavaScript tooling with a bundler and compiler (e.g. Babel), arangojs can be installed using
-npmoryarnlike any other dependency.For use without a compiler, the npm release comes with a precompiled browser -build for evergreen browsers:
-
-var arangojs = require("arangojs/web"); -You can also use unpkg during development:
-
-< !-- note the path includes the version number (e.g. 8.0.0) -- >
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script>
<script>
var db = new arangojs.Database();
// ...
</script> -When loading the browser build with a script tag make sure to load the polyfill first:
-
- - -<script src="https://cdnjs.cloudflare.com/ajax/libs/babel-polyfill/6.26.0/polyfill.js"></script>
<script src="https://unpkg.com/arangojs@8.0.0/web.js"></script> -Basic usage example
- -Modern JavaScript/TypeScript with async/await:
-
+// TS: import { Database, aql } from "arangojs";
const { Database, aql } = require("arangojs");
const db = new Database();
const Pokemons = db.collection("my-pokemons");
async function main() {
try {
const pokemons = await db.query(aql`
FOR pokemon IN ${Pokemons}
FILTER pokemon.type == "fire"
RETURN pokemon
`);
console.log("My pokemons, let me show you them:");
for await (const pokemon of pokemons) {
console.log(pokemon.name);
}
} catch (err) {
console.error(err.message);
}
}
main(); -You can also use jsDelivr CDN during development:
+
+<script type="importmap">
{
"imports": {
"arangojs": "https://cdn.jsdelivr.net/npm/arangojs@9.0.0-preview.1/esm/index.js?+esm"
}
}
</script>
<script type="module">
import { Database } from "arangojs";
const db = new Database();
// ...
</script> +Basic usage example
Modern JavaScript/TypeScript with async/await and ES Modules:
+import { Database, aql } from "arangojs";
const db = new Database();
const Pokemons = db.collection("my-pokemons");
async function main() {
try {
const pokemons = await db.query(aql`
FOR pokemon IN ${Pokemons}
FILTER pokemon.type == "fire"
RETURN pokemon
`);
console.log("My pokemans, let me show you them:");
for await (const pokemon of pokemons) {
console.log(pokemon.name);
}
} catch (err) {
console.error(err.message);
}
}
main(); +Using a different database:
-
-const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "pancakes",
auth: { username: "root", password: "hunter2" },
});
// The credentials can be swapped at any time
db.useBasicAuth("admin", "maplesyrup"); -Old-school JavaScript with promises:
-
+var arangojs = require("arangojs");
var Database = arangojs.Database;
var db = new Database();
var pokemons = db.collection("pokemons");
db.query({
query: "FOR p IN @@c FILTER p.type == 'fire' RETURN p",
bindVars: { "@c": "pokemons" },
})
.then(function (cursor) {
console.log("My pokemons, let me show you them:");
return cursor.forEach(function (pokemon) {
console.log(pokemon.name);
});
})
.catch(function (err) {
console.error(err.message);
}); -
+const db = new Database({
url: "http://127.0.0.1:8529",
databaseName: "pancakes",
auth: { username: "root", password: "hunter2" },
});
// The credentials can be swapped at any time
db.useBasicAuth("admin", "maplesyrup"); +Old-school JavaScript with promises and CommonJS:
+var arangojs = require("arangojs");
var Database = arangojs.Database;
var db = new Database();
var pokemons = db.collection("pokemons");
db.query({
query: "FOR p IN @@c FILTER p.type == 'fire' RETURN p",
bindVars: { "@c": "pokemons" },
})
.then(function (cursor) {
console.log("My pokemons, let me show you them:");
return cursor.forEach(function (pokemon) {
console.log(pokemon.name);
});
})
.catch(function (err) {
console.error(err.message);
}); +Note: The examples throughout this documentation use
- - -async/awaitand other modern language features like multi-line strings and template tags. When developing for an environment without support for these language features, substitute promises forawaitsyntax as in the above example.Compatibility
- -The arangojs driver is compatible with the latest stable version of ArangoDB +
Compatibility
The arangojs driver is compatible with the latest stable version of ArangoDB available at the time of the driver release and remains compatible with the two most recent Node.js LTS versions in accordance with the official Node.js long-term support schedule. Versions @@ -93,11 +44,7 @@
Compatibility
from within thearangoshinteractive shell, please refer to the documentation of the@arangodbmodule and thedbobject instead. - - -Error responses
- -If arangojs encounters an API error, it will throw an
ArangoErrorwith +Error responses
If arangojs encounters an API error, it will throw an
ArangoErrorwith anerrorNumproperty indicating the ArangoDB error code and thecodeproperty indicating the HTTP status code from the response body.For any other non-ArangoDB error responses (4xx/5xx status code), it will throw @@ -108,22 +55,14 @@
Error responses
responseproperty on the error object.If the request failed at a network level or the connection was closed without receiving a response, the underlying system error will be thrown instead.
- - -Common issues
- - - -Missing functions or unexpected server errors
- -Please make sure you are using the latest version of this driver and that the +
Common issues
Missing functions or unexpected server errors
Please make sure you are using the latest version of this driver and that the version of the arangojs documentation you are reading matches that version.
Changes in the major version number of arangojs (e.g. 7.x.y -> 8.0.0) indicate backwards-incompatible changes in the arangojs API that may require changes in your code when upgrading your version of arangojs.
Additionally please ensure that your version of Node.js (or browser) and ArangoDB are supported by the version of arangojs you are trying to use. See -the compatibility section for additional information.
+the compatibility section for additional information.Note: As of June 2018 ArangoDB 2.8 has reached its End of Life and is no longer supported in arangojs 7 and later. If your code needs to work with ArangoDB 2.8 you can continue using arangojs 6 and enable ArangoDB 2.8 @@ -131,134 +70,79 @@
Missing functions or unexpected server errors
enable the ArangoDB 2.8 compatibility mode in arangojs 6.You can install an older version of arangojs using
npmoryarn:
- - -# for version 6.x.x
yarn add arangojs@6
# - or -
npm install --save arangojs@6 -No code intelligence when using require instead of import
- -If you are using
requireto import thearangojsmodule in JavaScript, the + +No code intelligence when using require instead of import
If you are using
requireto import thearangojsmodule in JavaScript, the default export might not be recognized as a function by the code intelligence of common editors like Visual Studio Code, breaking auto-complete and other useful features.As a workaround, use the
-arangojsfunction exported by that module instead of calling the module itself:
+const arangojs = require("arangojs");
- const db = arangojs({
+ const db = arangojs.arangojs({
url: ARANGODB_SERVER,
}); -const arangojs = require("arangojs");
- const db = arangojs({
+ const db = arangojs.arangojs({
url: ARANGODB_SERVER,
}); +Alternatively you can use the
-Databaseclass directly:
+const arangojs = require("arangojs");
+ const Database = arangojs.Database;
- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); -const arangojs = require("arangojs");
+ const Database = arangojs.Database;
- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +Or using object destructuring:
-
- - -- const arangojs = require("arangojs");
+ const { Database } = require("arangojs");
- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); -Error stack traces contain no useful information
- -Due to the async, queue-based behavior of arangojs, the stack traces generated +
+- const arangojs = require("arangojs");
+ const { Database } = require("arangojs");
- const db = arangojs({
+ const db = new Database({
url: ARANGODB_SERVER,
}); +Error stack traces contain no useful information
Due to the async, queue-based behavior of arangojs, the stack traces generated when an error occur rarely provide enough information to determine the location in your own code where the request was initiated.
Using the
-precaptureStackTracesconfiguration option, arangojs will attempt to always generate stack traces proactively when a request is performed, allowing arangojs to provide more meaningful stack traces at the cost of an impact to performance even when no error occurs.
+const { Database } = require("arangojs");
const db = new Database({
url: ARANGODB_SERVER,
+ precaptureStackTraces: true,
}); -const { Database } = require("arangojs");
const db = new Database({
url: ARANGODB_SERVER,
+ precaptureStackTraces: true,
}); +Note that arangojs will attempt to use
- - -Error.captureStackTraceif available and fall back to generating a stack trace by throwing an error. In environments that do not support thestackproperty on error objects, this option will still impact performance but not result in any additional information becoming available.Node.js
- -ReferenceError: window is not definedIf you compile your Node project using a build tool like Webpack, you may need +
Node.js
ReferenceError: window is not definedIf you compile your Node project using a build tool like Webpack, you may need to tell it to target the correct environment:
-
+// webpack.config.js
+ "target": "node", -// webpack.config.js
+ "target": "node", +To support use in both browser and Node environments arangojs uses the
- - -package.jsonbrowserfield, to substitute browser-specific implementations for certain modules. Build tools like Webpack will respect this field when targetting a browser environment and may need to be explicitly told you are targetting Node instead.Node.js with self-signed HTTPS certificates
- -If you need to support self-signed HTTPS certificates, you may have to add -your certificates to the
-agentOptions, e.g.:
+const { Database } = require("arangojs");
const db = new Database({
url: ARANGODB_SERVER,
+ agentOptions: {
+ ca: [
+ fs.readFileSync(".ssl/sub.class1.server.ca.pem"),
+ fs.readFileSync(".ssl/ca.pem")
+ ]
+ },
}); -Node.js with self-signed HTTPS certificates
If you need to support self-signed HTTPS certificates in Node.js, you may have +to override the global fetch agent. At the time of this writing, there is no +official way to do this for the native
+fetchimplementation in Node.js.However as Node.js uses the
+undicimodule for itsfetchimplementation +internally, you can override the global agent by addingundicias a +dependency to your project and using itssetGlobalDispatcheras follows:import { Agent, setGlobalDispatcher } from "undici";
setGlobalDispatcher(
new Agent({
ca: [
fs.readFileSync(".ssl/sub.class1.server.ca.pem"),
fs.readFileSync(".ssl/ca.pem"),
],
})
); +Although this is strongly discouraged, it's also possible to disable HTTPS certificate validation entirely, but note this has extremely dangerous security implications:
-
+const { Database } = require("arangojs");
const db = new Database({
url: ARANGODB_SERVER,
+ agentOptions: {
+ rejectUnauthorized: false
+ },
}); -import { Agent, setGlobalDispatcher } from "undici";
setGlobalDispatcher(
new Agent({
rejectUnauthorized: false,
})
); +When using arangojs in the browser, self-signed HTTPS certificates need to be trusted by the browser or use a trusted root certificate.
- - -Streaming transactions leak
- -When using the
transaction.stepmethod it is important to be aware of the +Streaming transactions leak
When using the
-transaction.stepmethod it is important to be aware of the limitations of what a callback passed to this method is allowed to do.
+const collection = db.collection(collectionName);
const trx = db.transaction(transactionId);
// WARNING: This code will not work as intended!
await trx.step(async () => {
await collection.save(doc1);
await collection.save(doc2); // Not part of the transaction!
});
// INSTEAD: Always perform a single operation per step:
await trx.step(() => collection.save(doc1));
await trx.step(() => collection.save(doc2)); -const collection = db.collection(collectionName);
const trx = db.transaction(transactionId);
// WARNING: This code will not work as intended!
await trx.step(async () => {
await collection.save(doc1);
await collection.save(doc2); // Not part of the transaction!
});
// INSTEAD: Always perform a single operation per step:
await trx.step(() => collection.save(doc1));
await trx.step(() => collection.save(doc2)); +Please refer to the documentation of this method for additional examples.
- - -Streaming transactions timeout in cluster
- -Example messages:
+transaction not found,transaction already expired.Streaming transactions timeout in cluster
Example messages:
transaction not found,transaction already expired.Transactions have different guarantees in a cluster.
When using arangojs in a cluster with load balancing, you may need to adjust -the value of
-agentOptions.maxSocketsto accommodate the number of transactions +the value ofconfig.poolSizeto accommodate the number of transactions you need to be able to run in parallel. The default value is likely to be too low for most cluster scenarios involving frequent streaming transactions.Note: When using a high value for
agentOptions.maxSocketsyou may have +Note: When using a high value for
- - -config.poolSizeyou may have to adjust the maximum number of threads in the ArangoDB configuration using theserver.maximal-threadsoption to support larger numbers of concurrent transactions on the server side.License
- -The Apache License, Version 2.0. For more information, see the accompanying +
License
The Apache License, Version 2.0. For more information, see the accompanying LICENSE file.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Includes code from x3-linkedlist +used under the MIT license.
+
-
\ No newline at end of file
diff --git a/devel/interfaces/aql.AqlQuery.html b/devel/interfaces/aql.AqlQuery.html
index 5fc6f15ee..31704484d 100644
--- a/devel/interfaces/aql.AqlQuery.html
+++ b/devel/interfaces/aql.AqlQuery.html
@@ -1,107 +1,10 @@
-
-
-AqlLiteral | arangojs
-
-
-
-
-
-Interface AqlLiteral
An object representing a trusted AQL literal that will be inlined directly +
Interface AqlLiteral
An object representing a trusted AQL literal that will be inlined directly when used in an AQL template or passed to AQL helper functions.
Arbitrary values can be converted to trusted AQL literals by passing them -to the literal helper function.
-Hierarchy
--
-
- AqlLiteral
-
-
\ No newline at end of file
+to the literal helper function.
+Generated using TypeDoc
interface AqlLiteral {}
-
\ No newline at end of file
diff --git a/devel/interfaces/collection.ArangoCollection.html b/devel/interfaces/collection.ArangoCollection.html
index f9860d02c..400b8a11c 100644
--- a/devel/interfaces/collection.ArangoCollection.html
+++ b/devel/interfaces/collection.ArangoCollection.html
@@ -1,92 +1,6 @@
-
-
-AqlQuery | arangojs
-
-
-
-
-
-
-
-
-
-
-
-bind
-
bind
-
-
-
-
-
-Interface AqlQuery<T>
Generic AQL query object consisting of an AQL query string and its bind +
Interface AqlQuery<T>
Generic AQL query object consisting of an AQL query string and its bind parameters.
-Type Parameters
--
-
-
-
T = any
Hierarchy
--
-
- AqlQuery
Properties
-Optional [type]
-[type]?: any
bind
-bind
-An object mapping AQL bind parameter names to their respective values.
+interface AqlQuery<T> {
    [type]?: any;
    bindVars: Record<string, any>;
    query: string;
}
    [type]?: any;
    bindVars: Record<string, any>;
    query: string;
}
Type Parameters
Properties
Optional [type]
[type]?: any
bind
bind
An object mapping AQL bind parameter names to their respective values.
Names of parameters representing collections are prefixed with an at-symbol.
-query
-query: string
-An AQL query string.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
query
query: string
An AQL query string.
+
-
\ No newline at end of file
diff --git a/devel/interfaces/collection.DocumentCollection.html b/devel/interfaces/collection.DocumentCollection.html
index 38cb312ca..fea9ac30e 100644
--- a/devel/interfaces/collection.DocumentCollection.html
+++ b/devel/interfaces/collection.DocumentCollection.html
@@ -1,720 +1,181 @@
-
-
-ArangoCollection | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface ArangoCollection
A marker interface identifying objects that can be used in AQL template +
Interface ArangoCollection
A marker interface identifying objects that can be used in AQL template strings to create references to ArangoDB collections.
-See aql.
-Hierarchy
--
-
- ArangoCollection -
Implemented by
-
- Index
-
-
-
Properties
-name
-
Properties
-Readonly name
-name: string
-Name of the collection.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
See aql!aql.
+Hierarchy (view full)
- ArangoCollection
Implemented by
Index
Properties
name
+
Properties
Readonly name
name: string
Name of the collection.
+
-
\ No newline at end of file
diff --git a/devel/interfaces/collection.EdgeCollection.html b/devel/interfaces/collection.EdgeCollection.html
index b669d8b80..c6d89d7c5 100644
--- a/devel/interfaces/collection.EdgeCollection.html
+++ b/devel/interfaces/collection.EdgeCollection.html
@@ -1,780 +1,195 @@
-
-
-DocumentCollection | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-by
-
-
-
-
-
-
-
-
-
- document
document
drop
ensure
-
-
- load
recalculate
remove
- replace
-replace
-
-
-
-
-
-
-save
-
-
-
-
- save
update
-update
-
-
-Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
-
-
-Interface DocumentCollection<T>
Represents an document collection in a Database.
-See EdgeCollection for a variant of this interface more suited for +
Interface DocumentCollection<EntryResultType, EntryInputType>
Represents an document collection in a database.Database.
+See EdgeCollection for a variant of this interface more suited for edge collections.
When using TypeScript, collections can be cast to a specific document data type to increase type safety.
- -Example
interface Person {
name: string;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>;
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for document data. Defaults to
-any.
Hierarchy
--
-
- ArangoCollection
-
-
-
- DocumentCollection -
- Index
-
-
-
-
-
Properties
-name
-
Methods
-all
-any
-by
Properties
-Readonly name
-name: string
-Name of the collection.
-Methods
-all
--
-
- all(options?: SimpleQueryAllOptions): Promise<ArrayCursor<Document<T>>> -
-
--
Retrieves all documents in the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.all();
const cursor = await db.query(aql`
FOR doc IN ${collection}
RETURN doc
`); ---Parameters
--
-
-
-
-Optionaloptions: SimpleQueryAllOptionsOptions for retrieving the documents.
-
Returns Promise<ArrayCursor<Document<T>>>
-
-
any
--
-
- any(): Promise<Document<T>> -
-
--
Retrieves a random document from the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const doc = await collection.any();
const cursor = await db.query(aql`
FOR doc IN ${collection}
SORT RAND()
LIMIT 1
RETURN doc
`);
const doc = await cursor.next(); -Returns Promise<Document<T>>
by
--
-
- by
Example(example: Partial<DocumentData<T>>, options?: SimpleQueryByExampleOptions): Promise<ArrayCursor<Document<T>>>
- -
--
Retrieves all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.byExample({ flavor: "strawberry" });
const cursor = await db.query(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc
`); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for documents.
-
- -
-
-Optionaloptions: SimpleQueryByExampleOptionsOptions for retrieving the documents.
-
Returns Promise<ArrayCursor<Document<T>>>
-
-
checksum
--
-
- checksum(options?: CollectionChecksumOptions): Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>>
- -
--
Retrieves the collection checksum.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.checksum();
// data contains the collection's checksum ---Parameters
--
-
-
-
-Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
-
Returns Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>> -
-
compact
--
-
- compact(): Promise<ArangoApiResponse<Record<string, never>>> -
-
--
Triggers compaction for a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.compact();
// Background compaction is triggered on the collection -Returns Promise<ArangoApiResponse<Record<string, never>>>
count
--
-
- count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>
- -
--
Retrieves information about the number of documents in a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.count();
// data contains the collection's count -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>
create
--
-
- create(options?: CreateCollectionOptions & {
    type?: CollectionType;
}): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- -
-
Creates a collection with the given
-optionsand the instance's name.See also createCollection and -createEdgeCollection.
-Note: When called on an EdgeCollection instance in TypeScript, -the
typeoption must still be set to the correct CollectionType. +Param: T
Type to use for document data. Defaults to
+any.Example
+interface Person {
name: string;
}
const db = new Database();
const documents = db.collection("persons") as DocumentCollection<Person>; +
interface DocumentCollection<EntryResultType, EntryInputType> {
    database: Database;
    name: string;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Document<EntryResultType>>;
    document(selector, graceful): Promise<Document<EntryResultType>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Document<EntryResultType>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<Index & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    index(selector): Promise<Index>;
    indexes<IndexType>(options?): Promise<IndexType[]>;
    loadIndexes(): Promise<boolean>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Document<EntryResultType>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Document<EntryResultType>;
    })[]>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
    truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
}
    database: Database;
    name: string;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Document<EntryResultType>>;
    document(selector, graceful): Promise<Document<EntryResultType>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Document<EntryResultType>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<Index & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    index(selector): Promise<Index>;
    indexes<IndexType>(options?): Promise<IndexType[]>;
    loadIndexes(): Promise<boolean>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Document<EntryResultType>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Document<EntryResultType>;
    })[]>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
    truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Document<EntryResultType>;
        old?: Document<EntryResultType>;
    })[]>;
}
Type Parameters
- EntryResultType extends Record<string, any> = any
- EntryInputType extends Record<string, any> = EntryResultType
Hierarchy (view full)
- ArangoCollection
- DocumentCollection
Index
Properties
Methods
checksum
+compact
+count
+create
+document
+document
Properties
Readonly database
Database this collection belongs to.
+Readonly name
name: string
Name of the collection.
+Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>> Retrieves the collection checksum.
+Parameters
Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
+
Returns Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.checksum();
// data contains the collection's checksum +
compact
- compact(): Promise<ArangoApiResponse<Record<string, never>>>
Triggers compaction for a collection.
+Returns Promise<ArangoApiResponse<Record<string, never>>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.compact();
// Background compaction is triggered on the collection +
count
- count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>> Retrieves information about the number of documents in a collection.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.count();
// data contains the collection's count +
create
- create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- -
Creates a collection with the given
+optionsand the instance's name.See also database.Database#createCollection and +database.Database#createEdgeCollection.
+Note: When called on an EdgeCollection instance in TypeScript, +the
- -typeoption must still be set to the correct CollectionType. Otherwise this will result in the collection being created with the default type (i.e. as a document collection).Example
- -const db = new Database();
const collection = db.collection("potatoes");
await collection.create();
// the document collection "potatoes" now exists -Example
- -const db = new Database();
const collection = db.collection("friends");
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists -Example
-interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const collection = db.collection("friends") as EdgeCollection<Friend>;
// even in TypeScript you still need to indicate the collection type
// if you want to create an edge collection
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists ---Parameters
--
-
-
-
-Optionaloptions: CreateCollectionOptions & {
    type?: CollectionType;
}Options for creating the collection.
-
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
-
-
document
--
-
- document(selector: DocumentSelector, options?: CollectionReadOptions): Promise<Document<T>> -
-
-
Retrieves the document matching the given key or id.
+Parameters
Optionaloptions: CreateCollectionOptions & {
    type?: CollectionType;
}Options for creating the collection.
+
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("potatoes");
await collection.create();
// the document collection "potatoes" now exists +Example
+const db = new Database();
const collection = db.collection("friends");
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists +Example
+interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const collection = db.collection("friends") as EdgeCollection<Friend>;
// even in TypeScript you still need to indicate the collection type
// if you want to create an edge collection
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists +
document
- document(selector, options?): Promise<Document<EntryResultType>>
- -
Retrieves the document matching the given key or id.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
- -const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123");
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} -Example
-const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", { graceful: true });
if (document) {
console.log(document);
} else {
console.error("Could not find document");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionReadOptionsOptions for retrieving the document.
-
Returns Promise<Document<T>>
- - selector: DocumentSelector
- document(selector: DocumentSelector, graceful: boolean): Promise<Document<T>> -
-
-
Retrieves the document matching the given key or id.
+ Optionaloptions: CollectionReadOptionsOptions for retrieving the document.
+
Returns Promise<Document<EntryResultType>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123");
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} +Example
+const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", { graceful: true });
if (document) {
console.log(document);
} else {
console.error("Could not find document");
} + -
-
- document(selector, graceful): Promise<Document<EntryResultType>>
- -
Retrieves the document matching the given key or id.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
- -const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123", false);
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} -Example
-const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", true);
if (document) {
console.log(document);
} else {
console.error("Could not find document");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
graceful: boolean
-If set to
true,nullis returned instead of an + - graceful: boolean
If set to
-true,nullis returned instead of an exception being thrown if the document does not exist.
Returns Promise<Document<T>>
- selector: DocumentSelector
- document
-Exists -
-
- document
Exists(selector: DocumentSelector, options?: DocumentExistsOptions): Promise<boolean>
- -
-
Checks whether a document matching the given key or id exists in this +
Returns Promise<Document<EntryResultType>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123", false);
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} +Example
+const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", true);
if (document) {
console.log(document);
} else {
console.error("Could not find document");
} + -
-
document
- document
Exists(selector, options?): Promise<boolean> - -
Checks whether a document matching the given key or id exists in this collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
const exists = await collection.documentExists("abc123");
if (!exists) {
console.log("Document does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
Optionaloptions: DocumentExistsOptions
Returns Promise<boolean>
- selector: DocumentSelector
- document
-Id -
-
- document
Id(selector: DocumentSelector): string
- -
-
Derives a document
+_idfrom the given selector for this collection. Optionaloptions: DocumentExistsOptions
Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const exists = await collection.documentExists("abc123");
if (!exists) {
console.log("Document does not exist");
} + -
-
document
- document
Id(selector): string - -
Derives a document
_idfrom the given selector for this collection.Throws an exception when passed a document or
- -_idfrom a different collection.Example
- -const db = new Database();
const collection = db.collection("some-collection");
const meta = await collection.save({ foo: "bar" }, { returnNew: true });
const doc = meta.new;
console.log(collection.documentId(meta)); // via meta._id
console.log(collection.documentId(doc)); // via doc._id
console.log(collection.documentId(meta._key)); // also works -Example
-const db = new Database();
const collection1 = db.collection("some-collection");
const collection2 = db.collection("other-collection");
const meta = await collection1.save({ foo: "bar" });
// Mixing collections is usually a mistake
console.log(collection1.documentId(meta)); // ok: same collection
console.log(collection2.documentId(meta)); // throws: wrong collection
console.log(collection2.documentId(meta._id)); // also throws
console.log(collection2.documentId(meta._key)); // ok but wrong collection --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
Returns string
- selector: DocumentSelector
- documents
--
-
- documents(selectors: (string | ObjectWithKey)[], options?: CollectionBatchReadOptions): Promise<Document<T>[]> -
-
-
Retrieves the documents matching the given key or id values.
+
Returns string
Example
+const db = new Database();
const collection = db.collection("some-collection");
const meta = await collection.save({ foo: "bar" }, { returnNew: true });
const doc = meta.new;
console.log(collection.documentId(meta)); // via meta._id
console.log(collection.documentId(doc)); // via doc._id
console.log(collection.documentId(meta._key)); // also works +Example
+const db = new Database();
const collection1 = db.collection("some-collection");
const collection2 = db.collection("other-collection");
const meta = await collection1.save({ foo: "bar" });
// Mixing collections is usually a mistake
console.log(collection1.documentId(meta)); // ok: same collection
console.log(collection2.documentId(meta)); // throws: wrong collection
console.log(collection2.documentId(meta._id)); // also throws
console.log(collection2.documentId(meta._key)); // ok but wrong collection + -
-
documents
- documents(selectors, options?): Promise<Document<EntryResultType>[]>
- -
Retrieves the documents matching the given key or id values.
Throws an exception when passed a document or
- -_idfrom a different collection, or if the document does not exist.Example
-const db = new Database();
const collection = db.collection("some-collection");
try {
const documents = await collection.documents(["abc123", "xyz456"]);
console.log(documents);
} catch (e: any) {
console.error("Could not find document");
} --Parameters
--
-
-
-
selectors: (string | ObjectWithKey)[]
-Array of document
_key,_idor objects with either +-Parameters
- selectors: (string | ObjectWithKey)[]
Array of document
-_key,_idor objects with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionBatchReadOptionsOptions for retrieving the documents.
-
Returns Promise<Document<T>[]>
- selectors: (string | ObjectWithKey)[]
- -drop
--
-
- drop(options?: CollectionDropOptions): Promise<ArangoApiResponse<Record<string, never>>> -
-
--
Deletes the collection from the database.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection ---Parameters
--
-
-
-
-Optionaloptions: CollectionDropOptionsOptions for dropping the collection.
-
Returns Promise<ArangoApiResponse<Record<string, never>>>
-
-
- -drop
-Index -
-
- drop
Index(selector: IndexSelector): Promise<ArangoApiResponse<{
    id: string;
}>>
- -
--
Deletes the index with the given name or
- -idfrom the database.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.dropIndex("some-index");
// The index "some-index" no longer exists ---Parameters
--
-
-
-
selector: IndexSelector
-Index name, id or object with either property.
-
Returns Promise<ArangoApiResponse<{
    id: string;
}>> -
-
- ensure
-Index -
-
- ensure
Index(details: EnsurePersistentIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a persistent index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); ---Parameters
--
-
-
-
details: EnsurePersistentIndexOptions
-Options for creating the persistent index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureTtlIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a TTL index on the collection if it does not already exist.
- -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "createdAt" timestamp one day after creation
await collection.ensureIndex({
type: "ttl",
fields: ["createdAt"],
expireAfter: 60 * 60 * 24 // 24 hours
}); -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "expiresAt" timestamp according to their value
await collection.ensureIndex({
type: "ttl",
fields: ["expiresAt"],
expireAfter: 0 // when attribute value is exceeded
}); ---Parameters
--
-
-
-
details: EnsureTtlIndexOptions
-Options for creating the TTL index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureMdiIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
Creates a multi-dimensional index on the collection if it does not already exist.
- -Example
+const db = new Database();
const collection = db.collection("some-points");
// Create a multi-dimensional index for the attributes x, y and z
await collection.ensureIndex({
type: "mdi",
fields: ["x", "y", "z"],
fieldValueTypes: "double"
}); - Optionaloptions: CollectionBatchReadOptionsOptions for retrieving the documents.
+
Returns Promise<Document<EntryResultType>[]>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const documents = await collection.documents(["abc123", "xyz456"]);
console.log(documents);
} catch (e: any) {
console.error("Could not find document");
} + -
-
drop
- drop(options?): Promise<ArangoApiResponse<Record<string, never>>>
Deletes the collection from the database.
+Parameters
Optionaloptions: CollectionDropOptionsOptions for dropping the collection.
+
Returns Promise<ArangoApiResponse<Record<string, never>>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection +
drop
- drop
Index(selector): Promise<ArangoApiResponse<{
    id: string;
}>> Deletes the index with the given name or
+idfrom the database.Parameters
- selector: IndexSelector
Index name, id or object with either property.
+
Returns Promise<ArangoApiResponse<{
    id: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.dropIndex("some-index");
// The index "some-index" no longer exists +- selector: IndexSelector
ensure
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
+Parameters
- details: EnsurePersistentIndexOptions
Options for creating the persistent index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); +- details: EnsurePersistentIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
+Parameters
- details: EnsureTtlIndexOptions
Options for creating the TTL index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "createdAt" timestamp one day after creation
await collection.ensureIndex({
type: "ttl",
fields: ["createdAt"],
expireAfter: 60 * 60 * 24 // 24 hours
}); +Example
+const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "expiresAt" timestamp according to their value
await collection.ensureIndex({
type: "ttl",
fields: ["expiresAt"],
expireAfter: 0 // when attribute value is exceeded
}); +- details: EnsureTtlIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
+Parameters
- details: EnsureMdiIndexOptions
Options for creating the multi-dimensional index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>-Example
const db = new Database();
const collection = db.collection("some-points");
// Create a multi-dimensional index for the attributes x, y and z
await collection.ensureIndex({
type: "mdi",
fields: ["x", "y", "z"],
fieldValueTypes: "double"
}); +
----Parameters
--
-
-
-
details: EnsureMdiIndexOptions
-Options for creating the multi-dimensional index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>
-- details: EnsureMdiIndexOptions
- ensure
Index(details: EnsureFulltextIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    fields: [string];
    minLength: number;
    type: "fulltext";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a fulltext index on the collection if it does not already exist.
- -Deprecated
Fulltext indexes have been deprecated in ArangoDB 3.10 and -should be replaced with ArangoSearch.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create a fulltext index for tokens longer than or equal to 3 characters
await collection.ensureIndex({
type: "fulltext",
fields: ["description"],
minLength: 3
}); ---Parameters
--
-
-
-
details: EnsureFulltextIndexOptions
-Options for creating the fulltext index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    fields: [string];
    minLength: number;
    type: "fulltext";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureGeoIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a geo index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create an index for GeoJSON data
await collection.ensureIndex({
type: "geo",
fields: ["lngLat"],
geoJson: true
}); ---Parameters
--
-
-
-
details: EnsureGeoIndexOptions
-Options for creating the geo index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureInvertedIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a inverted index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create an inverted index
await collection.ensureIndex({
type: "inverted",
fields: ["a", { name: "b", analyzer: "text_en" }]
}); ---Parameters
--
-
-
-
details: EnsureInvertedIndexOptions
-Options for creating the inverted index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>> -
-
exists
-figures
--
-
- figures(details?: boolean): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>
- -
--
Retrieves statistics for a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.figures();
// data contains the collection's figures --Parameters
--
-
-
-
-Optionaldetails: booleanwhether to return extended storage engine-specific details + +
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
+Parameters
- details: EnsureGeoIndexOptions
Options for creating the geo index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create an index for GeoJSON data
await collection.ensureIndex({
type: "geo",
fields: ["lngLat"],
geoJson: true
}); +- details: EnsureGeoIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
+Parameters
- details: EnsureInvertedIndexOptions
Options for creating the inverted index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create an inverted index
await collection.ensureIndex({
type: "inverted",
fields: ["a", { name: "b", analyzer: "text_en" }]
}); +- details: EnsureInvertedIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<Index & {
    isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
+Parameters
- details: EnsureIndexOptions
Options for creating the index.
+
Returns Promise<ArangoApiResponse<Index & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); +- details: EnsureIndexOptions
exists
figures
- figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>> Retrieves statistics for a collection.
+-Parameters
Optionaldetails: booleanwhether to return extended storage engine-specific details to the figures, which may cause additional load and impact performance
-
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>
- -first
-Example -
-
- first
Example(example: Partial<DocumentData<T>>): Promise<Document<T>>
- -
--
Retrieves a single document in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const doc = await collection.firstExample({ flavor: "strawberry" });
const cursor = await db.query(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
LIMIT 1
RETURN doc
`);
const doc = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the document.
-
Returns Promise<Document<T>>
-
-
- -fulltext
--
-
- fulltext(attribute: string, query: string, options?: SimpleQueryFulltextOptions): Promise<ArrayCursor<Document<T>>> -
-
--
Performs a fulltext query in the given
- -attributeon the collection.Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.fulltext("article", "needle");
const cursor = await db.query(aql`
FOR doc IN FULLTEXT(${collection}, "article", "needle")
RETURN doc
`); ---Parameters
--
-
-
-
attribute: string
-Name of the field to search.
-
- -
-
query: string
-Fulltext query string to search for.
-
- -
-
-Optionaloptions: SimpleQueryFulltextOptionsOptions for performing the fulltext query.
-
Returns Promise<ArrayCursor<Document<T>>>
-
-
- -get
--
-
- get(): Promise<ArangoApiResponse<CollectionMetadata>> -
-
--
Retrieves general information about the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.get();
// data contains general information about the collection -Returns Promise<ArangoApiResponse<CollectionMetadata>>
- -get
-Responsible Shard -
-
- get
Responsible Shard(document: Partial<Document<T>>): Promise<string>
- -
--
Retrieves the
- -shardIdof the shard responsible for the given document.Example
-const db = new Database();
const collection = db.collection("some-collection");
const responsibleShard = await collection.getResponsibleShard(); ---Parameters
--
-
-
-
document: Partial<Document<T>>
-Document in the collection to look up the
-shardIdof.
Returns Promise<string>
-
-
- import
--
-
- import(data: DocumentData<T>[], options?: CollectionImportOptions): Promise<CollectionImportResult> -
-
--
Bulk imports the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
{ _key: "jcd", password: "bionicman" },
{ _key: "jreyes", password: "amigo" },
{ _key: "ghermann", password: "zeitgeist" }
]
); ---Parameters
--
-
-
-
data: DocumentData<T>[]
-The data to import, as an array of document data.
-
- -
-
-Optionaloptions: CollectionImportOptionsOptions for importing the data.
-
Returns Promise<CollectionImportResult>
- -
-
- import(data: any[][], options?: CollectionImportOptions): Promise<CollectionImportResult> -
-
--
Bulk imports the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
[ "_key", "password" ],
[ "jcd", "bionicman" ],
[ "jreyes", "amigo" ],
[ "ghermann", "zeitgeist" ]
]
); --Parameters
--
-
-
-
data: any[][]
-The data to import, as an array containing a single array of +
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.figures();
// data contains the collection's figures + -
-
get
- get(): Promise<ArangoApiResponse<CollectionMetadata>>
Retrieves general information about the collection.
+Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.get();
// data contains general information about the collection +
get
Responsible Shard - get
Responsible Shard(document): Promise<string> Retrieves the
+shardIdof the shard responsible for the given document.Parameters
- document: Partial<Document<EntryResultType>>
Document in the collection to look up the
+shardIdof.
Returns Promise<string>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const responsibleShard = await collection.getResponsibleShard(); +- document: Partial<Document<EntryResultType>>
import
- import(data, options?): Promise<CollectionImportResult>
Bulk imports the given
+datainto the collection.Parameters
- data: DocumentData<EntryInputType>[]
The data to import, as an array of document data.
+ Optionaloptions: CollectionImportOptionsOptions for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
{ _key: "jcd", password: "bionicman" },
{ _key: "jreyes", password: "amigo" },
{ _key: "ghermann", password: "zeitgeist" }
]
); +- data: DocumentData<EntryInputType>[]
- import(data, options?): Promise<CollectionImportResult>
Bulk imports the given
+datainto the collection.-Parameters
- data: any[][]
The data to import, as an array containing a single array of attribute names followed by one or more arrays of attribute values for each document.
-
- -
-
-Optionaloptions: CollectionImportOptionsOptions for importing the data.
-
Returns Promise<CollectionImportResult>
-- data: any[][]
- import(data: string | Blob | Buffer, options?: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}): Promise<CollectionImportResult>
- -
-
Bulk imports the given
+datainto the collection. Optionaloptions: CollectionImportOptionsOptions for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
[ "_key", "password" ],
[ "jcd", "bionicman" ],
[ "jreyes", "amigo" ],
[ "ghermann", "zeitgeist" ]
]
); + -
-
- import(data, options?): Promise<CollectionImportResult>
- -
Bulk imports the given
datainto the collection.If
@@ -724,633 +185,109 @@typeis omitted,datamust contain one JSON array per line with the first array providing the attribute names and all other arrays providing attribute values for each document.Returns Promise
If
- -typeis set to"auto",datacan be in either of the formats supported by"documents"or"list".Example
- -const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'{"_key":"jcd","password":"bionicman"}\r\n' +
'{"_key":"jreyes","password":"amigo"}\r\n' +
'{"_key":"ghermann","password":"zeitgeist"}\r\n',
{ type: "documents" } // or "auto"
); -Example
- -const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'[{"_key":"jcd","password":"bionicman"},' +
'{"_key":"jreyes","password":"amigo"},' +
'{"_key":"ghermann","password":"zeitgeist"}]',
{ type: "list" } // or "auto"
); -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'["_key","password"]\r\n' +
'["jcd","bionicman"]\r\n' +
'["jreyes","amigo"]\r\n' +
'["ghermann","zeitgeist"]\r\n'
); --Parameters
--
-
-
-
data: string | Blob | Buffer
-The data to import as a Buffer (Node), Blob (browser) or +
-Parameters
- data: string | Buffer | Blob
The data to import as a Buffer (Node), Blob (browser) or string.
-
- -
-
-Optionaloptions: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}Options for importing the data.
-
Returns Promise<CollectionImportResult>
- data: string | Buffer | Blob
- -index
--
-
- index(selector: IndexSelector): Promise<Index> -
-
--
Returns an index description by name or
- -idif it exists.Example
-const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index"); ---Parameters
--
-
-
-
selector: IndexSelector
-Index name, id or object with either property.
-
Returns Promise<Index>
-
-
- -indexes
-- -list
--
-
- list(type?: SimpleQueryListType): Promise<ArrayCursor<string>> -
-
--
Retrieves a list of references for all documents in the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// const ids = await collection.list("id");
const ids = await db.query(aql`
FOR doc IN ${collection}
RETURN doc._id
`); -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// const keys = await collection.list("key");
const keys = await db.query(aql`
FOR doc IN ${collection}
RETURN doc._key
`); -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const paths = await collection.list("path");
const paths = await db.query(aql`
FOR doc IN ${collection}
RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
`); ---Parameters
--
-
-
-
-Optionaltype: SimpleQueryListTypeThe type of document reference to retrieve.
-
Returns Promise<ArrayCursor<string>>
-
-
- -load
-Indexes -
-
- load
Indexes(): Promise<boolean>
- -
--
(RocksDB only.) Instructs ArangoDB to load as many indexes of the -collection into memory as permitted by the memory limit.
- -Example
-const db = new Database();
const collection = db.collection("indexed-collection");
await collection.loadIndexes();
// the indexes are now loaded into memory -Returns Promise<boolean>
- -lookup
-By Keys -
-
- lookup
By Keys(keys: string[]): Promise<Document<T>[]>
- -
--
Retrieves all documents matching the given document keys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const keys = ["a", "b", "c"];
// const docs = await collection.byKeys(keys);
const cursor = await db.query(aql`
FOR key IN ${keys}
LET doc = DOCUMENT(${collection}, key)
RETURN doc
`);
const docs = await cursor.all(); ---Parameters
--
-
-
-
keys: string[]
-An array of document keys to look up.
-
Returns Promise<Document<T>[]>
-
-
- -properties
--
-
- properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>> -
-
--
Retrieves the collection's properties.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.properties();
// data contains the collection's properties -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- - properties(properties: CollectionPropertiesOptions): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>> -
-
--
Replaces the properties of the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.setProperties({ waitForSync: true });
// the collection will now wait for data being written to disk
// whenever a document is changed ---Parameters
--
-
-
-
properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
-
-
- -recalculate
-Count -
-
- recalculate
Count(): Promise<boolean>
- -
--
(RocksDB only.) Instructs ArangoDB to recalculate the collection's -document count to fix any inconsistencies.
- -Example
-const db = new Database();
const collection = db.collection("inconsistent-collection");
const badData = await collection.count();
// oh no, the collection count looks wrong -- fix it!
await collection.recalculateCount();
const goodData = await collection.count();
// goodData contains the collection's improved count -Returns Promise<boolean>
- remove
--
-
- remove(selector: DocumentSelector, options?: CollectionRemoveOptions): Promise<DocumentMetadata & {
    old?: Document<T>;
}>
- -
-
Removes an existing document from the collection.
+ Optionaloptions: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}Options for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'{"_key":"jcd","password":"bionicman"}\r\n' +
'{"_key":"jreyes","password":"amigo"}\r\n' +
'{"_key":"ghermann","password":"zeitgeist"}\r\n',
{ type: "documents" } // or "auto"
); +Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'[{"_key":"jcd","password":"bionicman"},' +
'{"_key":"jreyes","password":"amigo"},' +
'{"_key":"ghermann","password":"zeitgeist"}]',
{ type: "list" } // or "auto"
); +Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'["_key","password"]\r\n' +
'["jcd","bionicman"]\r\n' +
'["jreyes","amigo"]\r\n' +
'["ghermann","zeitgeist"]\r\n'
); + -
-
index
- index(selector): Promise<Index>
Returns an index description by name or
+idif it exists.Parameters
- selector: IndexSelector
Index name, id or object with either property.
+
Returns Promise<Index>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index"); +- selector: IndexSelector
indexes
- indexes<IndexType>(options?): Promise<IndexType[]>
Returns a list of all index descriptions for the collection.
+Type Parameters
- IndexType extends Index | HiddenIndex = Index
Parameters
Optionaloptions: IndexListOptionsOptions for fetching the index list.
+
Returns Promise<IndexType[]>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const indexes = await collection.indexes(); +Example
+const db = new Database();
const collection = db.collection("some-collection");
const allIndexes = await collection.indexes<HiddenIndex>({
withHidden: true
}); +
load
- load
Indexes(): Promise<boolean> Instructs ArangoDB to load as many indexes of the collection into memory +as permitted by the memory limit.
+Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("indexed-collection");
await collection.loadIndexes();
// the indexes are now loaded into memory +
properties
- properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Retrieves the collection's properties.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.properties();
// data contains the collection's properties +- properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Replaces the properties of the collection.
+Parameters
- properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.setProperties({ waitForSync: true });
// the collection will now wait for data being written to disk
// whenever a document is changed +
recalculate
- recalculate
Count(): Promise<boolean> Instructs ArangoDB to recalculate the collection's document count to fix +any inconsistencies.
+Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("inconsistent-collection");
const badData = await collection.count();
// oh no, the collection count looks wrong -- fix it!
await collection.recalculateCount();
const goodData = await collection.count();
// goodData contains the collection's improved count +
remove
- remove(selector, options?): Promise<DocumentMetadata & {
    old?: Document<EntryResultType>;
}> - -
Removes an existing document from the collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
- -const db = new Database();
const collection = db.collection("some-collection");
await collection.remove("abc123");
// document with key "abc123" deleted -Example
-const db = new Database();
const collection = db.collection("some-collection");
const doc = await collection.document("abc123");
await collection.remove(doc);
// document with key "abc123" deleted --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionRemoveOptionsOptions for removing the document.
-
Returns Promise<DocumentMetadata & {
    old?: Document<T>;
}> - selector: DocumentSelector
- remove
-All -
-
- remove
All(selectors: (string | ObjectWithKey)[], options?: Omit<CollectionRemoveOptions, "ifMatch">): Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Document<T>;
})[]>
- -
-
Removes existing documents from the collection.
+ Optionaloptions: CollectionRemoveOptionsOptions for removing the document.
+
Returns Promise<DocumentMetadata & {
    old?: Document<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.remove("abc123");
// document with key "abc123" deleted +Example
+const db = new Database();
const collection = db.collection("some-collection");
const doc = await collection.document("abc123");
await collection.remove(doc);
// document with key "abc123" deleted + -
-
remove
- remove
All(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Document<EntryResultType>;
})[]> - -
Removes existing documents from the collection.
Throws an exception when passed any document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.removeAll(["abc123", "def456"]);
// document with keys "abc123" and "def456" deleted --Parameters
--
-
-
-
selectors: (string | ObjectWithKey)[]
-Documents
_key,_idor objects with either of those +-Parameters
- selectors: (string | ObjectWithKey)[]
Documents
-_key,_idor objects with either of those properties (e.g. documents from this collection).
- -
-
-Optionaloptions: Omit<CollectionRemoveOptions, "ifMatch">Options for removing the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Document<T>;
})[]> - selectors: (string | ObjectWithKey)[]
- -remove
-By Example -
-
- remove
By Example(example: Partial<DocumentData<T>>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>
- -
--
Removes all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const { deleted } = await collection.removeByExample({
// flavor: "strawberry"
// });
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
REMOVE doc IN ${collection}
RETURN 1
)
`);
const deleted = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the document.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByExampleOptionsOptions for removing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>
-
-
- -remove
-By Keys -
-
- remove
By Keys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>
- -
--
Removes all documents matching the given document keys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const keys = ["a", "b", "c"];
// const { removed, ignored } = await collection.removeByKeys(keys);
const cursor = await db.query(aql`
FOR key IN ${keys}
LET doc = DOCUMENT(${collection}, key)
FILTER doc
REMOVE doc IN ${collection}
RETURN key
`);
const removed = await cursor.all();
const ignored = keys.filter((key) => !removed.includes(key)); ---Parameters
--
-
-
-
keys: string[]
-An array of document keys to remove.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByKeysOptionsOptions for removing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>
-
-
- rename
--
-
- rename(newName: string): Promise<ArangoApiResponse<CollectionMetadata>> -
-
-
Renames the collection and updates the instance's
-nametonewName.Additionally removes the instance from the Database's internal +
Optionaloptions: Omit<CollectionRemoveOptions, "ifMatch">Options for removing the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Document<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.removeAll(["abc123", "def456"]);
// document with keys "abc123" and "def456" deleted + -
-
rename
- rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>
- -
Renames the collection and updates the instance's
+nametonewName.Additionally removes the instance from the database.Database's internal cache.
Note: Renaming collections may not be supported when ArangoDB is running in a cluster configuration.
- -Example
-const db = new Database();
const collection1 = db.collection("some-collection");
await collection1.rename("other-collection");
const collection2 = db.collection("some-collection");
const collection3 = db.collection("other-collection");
// Note all three collection instances are different objects but
// collection1 and collection3 represent the same ArangoDB collection! ---Parameters
--
-
-
-
newName: string
-The new name of the collection.
-
Returns Promise<ArangoApiResponse<CollectionMetadata>>
-
-
replace
--
-
- replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}>
- -
-
Replaces an existing document in the collection.
+Parameters
- newName: string
The new name of the collection.
+
Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection1 = db.collection("some-collection");
await collection1.rename("other-collection");
const collection2 = db.collection("some-collection");
const collection3 = db.collection("other-collection");
// Note all three collection instances are different objects but
// collection1 and collection3 represent the same ArangoDB collection! + - newName: string
replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}> - -
Replaces an existing document in the collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.replace(
"a",
{ color: "red" },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "red" undefined --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
newData: DocumentData<T>
-The contents of the new document.
-
- -
-
-Optionaloptions: CollectionReplaceOptionsOptions for replacing the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}> - selector: DocumentSelector
- replace
-All -
-
- replace
All(newData: Object[], options?: Omit<CollectionReplaceOptions, "ifMatch">): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]>
- -
-
Replaces existing documents in the collection, identified by the
_keyor + - newData: DocumentData<EntryInputType>
The contents of the new document.
+ Optionaloptions: CollectionReplaceOptionsOptions for replacing the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.replace(
"a",
{ color: "red" },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "red" undefined + -
-
replace
- replace
All(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]> - -
Replaces existing documents in the collection, identified by the
- -_keyor_idof each document.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
await collection.save({ _key: "b", color: "green", count: 3 });
const result = await collection.replaceAll(
[
{ _key: "a", color: "red" },
{ _key: "b", color: "yellow", count: 2 }
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "red" undefined
console.log(result[1].new.color, result[1].new.count); // "yellow" 2 ---Parameters
--
-
-
-
newData: Object[]
-The documents to replace.
-
- -
-
-Optionaloptions: Omit<CollectionReplaceOptions, "ifMatch">Options for replacing the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]> -
-
replace
--
-
- replace
By Example(example: Partial<DocumentData<T>>, newValue: DocumentData<T>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>
- -
--
Replaces all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const newValue = { flavor: "chocolate" };
// const { replaced } = await collection.replaceByExample(
// { flavor: "strawberry" },
// newValue
// );
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
REPLACE doc WITH ${newValue} IN ${collection}
RETURN 1
)
`);
const replaced = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the documents.
-
- -
-
newValue: DocumentData<T>
-Document data to replace the matching documents with.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByExampleOptionsOptions for replacing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>
-
-
revision
--
-
- revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>
- -
--
Retrieves the collection revision ID.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.revision();
// data contains the collection's revision -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>
save
--
-
- save(data: DocumentData<T>, options?: CollectionInsertOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}>
- -
--
Inserts a new document with the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.save(
{ _key: "a", color: "blue", count: 1 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 1 ---Parameters
--
-
-
-
data: DocumentData<T>
-The contents of the new document.
-
- -
-
-Optionaloptions: CollectionInsertOptionsOptions for inserting the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}> -
-
save
--
-
- save
All(data: DocumentData<T>[], options?: CollectionInsertOptions): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]>
- -
--
Inserts new documents with the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.saveAll(
[
{ _key: "a", color: "blue", count: 1 },
{ _key: "b", color: "red", count: 2 },
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "blue" 1
console.log(result[1].new.color, result[1].new.count); // "red" 2 ---Parameters
--
-
-
-
data: DocumentData<T>[]
-The contents of the new documents.
-
- -
-
-Optionaloptions: CollectionInsertOptionsOptions for inserting the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]> -
-
truncate
--
-
- truncate(): Promise<ArangoApiResponse<CollectionMetadata>> -
-
--
Deletes all documents in the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.truncate();
// millions of documents cry out in terror and are suddenly silenced,
// the collection "some-collection" is now empty -Returns Promise<ArangoApiResponse<CollectionMetadata>>
update
--
-
- update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}>
- -
-
Updates an existing document in the collection.
+Parameters
- newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
The documents to replace.
+ Optionaloptions: Omit<CollectionReplaceOptions, "ifMatch">Options for replacing the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
await collection.save({ _key: "b", color: "green", count: 3 });
const result = await collection.replaceAll(
[
{ _key: "a", color: "red" },
{ _key: "b", color: "yellow", count: 2 }
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "red" undefined
console.log(result[1].new.color, result[1].new.count); // "yellow" 2 + - newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
revision
- revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>> Retrieves the collection revision ID.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.revision();
// data contains the collection's revision +
save
- save(data, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}> Inserts a new document with the given
+datainto the collection.Parameters
- data: DocumentData<EntryInputType>
The contents of the new document.
+ Optionaloptions: CollectionInsertOptionsOptions for inserting the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.save(
{ _key: "a", color: "blue", count: 1 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 1 +- data: DocumentData<EntryInputType>
save
- save
All(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]> Inserts new documents with the given
+datainto the collection.Parameters
- data: DocumentData<EntryInputType>[]
The contents of the new documents.
+ Optionaloptions: CollectionInsertOptionsOptions for inserting the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.saveAll(
[
{ _key: "a", color: "blue", count: 1 },
{ _key: "b", color: "red", count: 2 },
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "blue" 1
console.log(result[1].new.color, result[1].new.count); // "red" 2 +- data: DocumentData<EntryInputType>[]
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>
Deletes all documents in the collection.
+Parameters
Optionaloptions: CollectionTruncateOptions
Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.truncate();
// millions of documents cry out in terror and are suddenly silenced,
// the collection "some-collection" is now empty +
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}> - -
Updates an existing document in the collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.update(
"a",
{ count: 2 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 2 --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
newData: Patch<DocumentData<T>>
-The data for updating the document.
-
- -
-
-Optionaloptions: CollectionUpdateOptionsOptions for updating the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
}> - selector: DocumentSelector
- update
-All -
-
- update
All(newData: Object[], options?: Omit<CollectionUpdateOptions, "ifMatch">): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]>
- -
-
Updates existing documents in the collection, identified by the
_keyor + - newData: Patch<DocumentData<EntryInputType>>
The data for updating the document.
+ Optionaloptions: CollectionUpdateOptionsOptions for updating the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
const result = await collection.update(
"a",
{ count: 2 },
{ returnNew: true }
);
console.log(result.new.color, result.new.count); // "blue" 2 + -
-
update
- update
All(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]> - -
Updates existing documents in the collection, identified by the
- -_keyor_idof each document.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
await collection.save({ _key: "b", color: "green", count: 3 });
const result = await collection.updateAll(
[
{ _key: "a", count: 2 },
{ _key: "b", count: 4 }
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "blue" 2
console.log(result[1].new.color, result[1].new.count); // "green" 4 ---Parameters
--
-
-
-
newData: Object[]
-The data for updating the documents.
-
- -
-
-Optionaloptions: Omit<CollectionUpdateOptions, "ifMatch">Options for updating the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<T>;
    old?: Document<T>;
})[]> -
-
update
--
-
- update
By Example(example: Partial<DocumentData<T>>, newValue: Patch<DocumentData<T>>, options?: SimpleQueryUpdateByExampleOptions): Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>
- -
--
Updates all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const newData = { color: "red" };
// const { updated } = await collection.updateByExample(
// { flavor: "strawberry" },
// newValue
// );
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
UPDATE doc WITH ${newValue} IN ${collection}
RETURN 1
)
`);
const updated = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the documents.
-
- -
-
newValue: Patch<DocumentData<T>>
-Document data to update the matching documents with.
-
- -
-
-Optionaloptions: SimpleQueryUpdateByExampleOptionsOptions for updating the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Parameters
- newData: (Patch<DocumentData<EntryInputType>> & ({
    _key: string;
} | {
    _id: string;
}))[]The data for updating the documents.
+ Optionaloptions: Omit<CollectionUpdateOptions, "ifMatch">Options for updating the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Document<EntryResultType>;
    old?: Document<EntryResultType>;
})[]>
Example
const db = new Database();
const collection = db.collection("some-collection");
await collection.save({ _key: "a", color: "blue", count: 1 });
await collection.save({ _key: "b", color: "green", count: 3 });
const result = await collection.updateAll(
[
{ _key: "a", count: 2 },
{ _key: "b", count: 4 }
],
{ returnNew: true }
);
console.log(result[0].new.color, result[0].new.count); // "blue" 2
console.log(result[1].new.color, result[1].new.count); // "green" 4
+
-
\ No newline at end of file
diff --git a/devel/interfaces/connection.ProcessedResponse.html b/devel/interfaces/connection.ProcessedResponse.html
new file mode 100644
index 000000000..bf4a5ab24
--- /dev/null
+++ b/devel/interfaces/connection.ProcessedResponse.html
@@ -0,0 +1,25 @@
+
-
-EdgeCollection | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-by
-
-
-
-
-
-
-
-
-
- document
document
drop
ensure
-
-
- in
load
out
recalculate
remove
- replace
-replace
-
-
-
-
-
-
-save
-
-
- save
update
-update
-
-
-Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
-
-
-Interface EdgeCollection<T>
Represents an edge collection in a Database.
-See DocumentCollection for a more generic variant of this interface +
Interface EdgeCollection<EntryResultType, EntryInputType>
Represents an edge collection in a database.Database.
+See DocumentCollection for a more generic variant of this interface more suited for regular document collections.
-See also GraphEdgeCollection for the type representing an edge -collection in a Graph.
+See also graph.GraphEdgeCollection for the type representing an edge +collection in a graph.Graph.
When using TypeScript, collections can be cast to a specific edge document data type to increase type safety.
- -Example
interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.collection("friends") as EdgeCollection<Friend>;
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-Type to use for edge document data. Defaults to
-any.
Hierarchy
--
-
- DocumentCollection<T>
-
-
-
- EdgeCollection
- Index
-
-
-
-
-
Properties
-name
-
Methods
-all
-any
-by
Properties
-Readonly name
-name: string
-Name of the collection.
-Methods
-all
--
-
- all(options?: SimpleQueryAllOptions): Promise<ArrayCursor<Edge<T>>> -
-
--
Retrieves all documents in the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.all();
const cursor = await db.query(aql`
FOR doc IN ${collection}
RETURN doc
`); ---Parameters
--
-
-
-
-Optionaloptions: SimpleQueryAllOptionsOptions for retrieving the documents.
-
Returns Promise<ArrayCursor<Edge<T>>>
-
-
any
--
-
- any(): Promise<Edge<T>> -
-
--
Retrieves a random document from the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const doc = await collection.any();
const cursor = await db.query(aql`
FOR doc IN ${collection}
SORT RAND()
LIMIT 1
RETURN doc
`);
const doc = await cursor.next(); -Returns Promise<Edge<T>>
by
--
-
- by
Example(example: Partial<DocumentData<T>>, options?: SimpleQueryByExampleOptions): Promise<ArrayCursor<Edge<T>>>
- -
--
Retrieves all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.byExample({ flavor: "strawberry" });
const cursor = await db.query(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
RETURN doc
`); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for documents.
-
- -
-
-Optionaloptions: SimpleQueryByExampleOptionsOptions for retrieving the documents.
-
Returns Promise<ArrayCursor<Edge<T>>>
-
-
checksum
--
-
- checksum(options?: CollectionChecksumOptions): Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>>
- -
--
Retrieves the collection checksum.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.checksum();
// data contains the collection's checksum ---Parameters
--
-
-
-
-Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
-
Returns Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>> -
-
compact
--
-
- compact(): Promise<ArangoApiResponse<Record<string, never>>> -
-
--
Triggers compaction for a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.compact();
// Background compaction is triggered on the collection -Returns Promise<ArangoApiResponse<Record<string, never>>>
count
--
-
- count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>
- -
--
Retrieves information about the number of documents in a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.count();
// data contains the collection's count -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>
create
--
-
- create(options?: CreateCollectionOptions & {
    type?: CollectionType;
}): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- -
-
Creates a collection with the given
-optionsand the instance's name.See also createCollection and -createEdgeCollection.
-Note: When called on an EdgeCollection instance in TypeScript, -the
typeoption must still be set to the correct CollectionType. +Param: T
Type to use for edge document data. Defaults to
+any.Example
+interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const edges = db.collection("friends") as EdgeCollection<Friend>; +
interface EdgeCollection<EntryResultType, EntryInputType> {
    database: Database;
    name: string;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Edge<EntryResultType>>;
    document(selector, graceful): Promise<Edge<EntryResultType>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Edge<EntryResultType>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<Index & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    inEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    index(selector): Promise<Index>;
    indexes<IndexType>(options?): Promise<IndexType[]>;
    loadIndexes(): Promise<boolean>;
    outEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Edge<EntryResultType>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Edge<EntryResultType>;
    })[]>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
    truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
}
    database: Database;
    name: string;
    checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
        checksum: string;
        revision: string;
    }>>;
    compact(): Promise<ArangoApiResponse<Record<string, never>>>;
    count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
    }>>;
    create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    document(selector, options?): Promise<Edge<EntryResultType>>;
    document(selector, graceful): Promise<Edge<EntryResultType>>;
    documentExists(selector, options?): Promise<boolean>;
    documentId(selector): string;
    documents(selectors, options?): Promise<Edge<EntryResultType>[]>;
    drop(options?): Promise<ArangoApiResponse<Record<string, never>>>;
    dropIndex(selector): Promise<ArangoApiResponse<{
        id: string;
    }>>;
    edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        cacheEnabled: boolean;
        deduplicate: boolean;
        estimates: boolean;
        fields: string[];
        storedValues?: string[];
        type: "persistent";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        expireAfter: number;
        fields: [string];
        selectivityEstimate: number;
        type: "ttl";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        fieldValueTypes: "double";
        fields: string[];
        type: "mdi";
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        bestIndexedLevel: number;
        fields: [string, string] | [string];
        geoJson: boolean;
        legacyPolygons: boolean;
        maxNumCoverCells: number;
        type: "geo";
        worstIndexedLevel: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<GenericIndex & {
        analyzer: string;
        cache?: boolean;
        cleanupIntervalStep: number;
        commitIntervalMsec: number;
        consolidationIntervalMsec: number;
        consolidationPolicy: Required<TierConsolidationPolicy>;
        features: AnalyzerFeature[];
        fields: {
            analyzer?: string;
            cache?: boolean;
            features?: AnalyzerFeature[];
            includeAllFields?: boolean;
            name: string;
            nested?: InvertedIndexNestedField[];
            searchField?: boolean;
            trackListPositions?: boolean;
        }[];
        includeAllFields: boolean;
        optimizeTopK: string[];
        parallelism: number;
        primaryKeyCache?: boolean;
        primarySort: {
            cache?: boolean;
            compression: Compression;
            fields: {
                direction: Direction;
                field: string;
            }[];
        };
        searchField: boolean;
        storedValues: {
            cache?: boolean;
            compression: Compression;
            fields: string[];
        }[];
        trackListPositions: boolean;
        type: "inverted";
        writeBufferActive: number;
        writeBufferIdle: number;
        writeBufferSizeMax: number;
    } & {
        isNewlyCreated: boolean;
    }>>;
    ensureIndex(details): Promise<ArangoApiResponse<Index & {
        isNewlyCreated: boolean;
    }>>;
    exists(): Promise<boolean>;
    figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        count: number;
        figures: Record<string, any>;
    }>>;
    get(): Promise<ArangoApiResponse<CollectionMetadata>>;
    getResponsibleShard(document): Promise<string>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    import(data, options?): Promise<CollectionImportResult>;
    inEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    index(selector): Promise<Index>;
    indexes<IndexType>(options?): Promise<IndexType[]>;
    loadIndexes(): Promise<boolean>;
    outEdges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>;
    properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>;
    recalculateCount(): Promise<boolean>;
    remove(selector, options?): Promise<DocumentMetadata & {
        old?: Edge<EntryResultType>;
    }>;
    removeAll(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        old?: Edge<EntryResultType>;
    })[]>;
    rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>;
    replace(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    replaceAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
    revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
        revision: string;
    }>>;
    save(data, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    saveAll(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
    truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>;
    update(selector, newData, options?): Promise<DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    }>;
    updateAll(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
        _oldRev?: string;
    } & {
        new?: Edge<EntryResultType>;
        old?: Edge<EntryResultType>;
    })[]>;
}
Type Parameters
- EntryResultType extends Record<string, any> = any
- EntryInputType extends Record<string, any> = EntryResultType
Hierarchy (view full)
- DocumentCollection<EntryResultType, EntryInputType>
- EdgeCollection
Index
Properties
Methods
checksum
+compact
+count
+create
+document
+document
Properties
Readonly database
Database this collection belongs to.
+Readonly name
name: string
Name of the collection.
+Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>> Retrieves the collection checksum.
+Parameters
Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
+
Returns Promise<ArangoApiResponse<CollectionMetadata & {
    checksum: string;
    revision: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.checksum();
// data contains the collection's checksum +
compact
- compact(): Promise<ArangoApiResponse<Record<string, never>>>
Triggers compaction for a collection.
+Returns Promise<ArangoApiResponse<Record<string, never>>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.compact();
// Background compaction is triggered on the collection +
count
- count(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>> Retrieves information about the number of documents in a collection.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.count();
// data contains the collection's count +
create
- create(options?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- -
Creates a collection with the given
+optionsand the instance's name.See also database.Database#createCollection and +database.Database#createEdgeCollection.
+Note: When called on an EdgeCollection instance in TypeScript, +the
- -typeoption must still be set to the correct CollectionType. Otherwise this will result in the collection being created with the default type (i.e. as a document collection).Example
- -const db = new Database();
const collection = db.collection("potatoes");
await collection.create();
// the document collection "potatoes" now exists -Example
- -const db = new Database();
const collection = db.collection("friends");
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists -Example
-interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const collection = db.collection("friends") as EdgeCollection<Friend>;
// even in TypeScript you still need to indicate the collection type
// if you want to create an edge collection
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists ---Parameters
--
-
-
-
-Optionaloptions: CreateCollectionOptions & {
    type?: CollectionType;
}Options for creating the collection.
-
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
-
-
document
--
-
- document(selector: DocumentSelector, options?: CollectionReadOptions): Promise<Edge<T>> -
-
-
Retrieves the document matching the given key or id.
+Parameters
Optionaloptions: CreateCollectionOptions & {
    type?: CollectionType;
}Options for creating the collection.
+
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("potatoes");
await collection.create();
// the document collection "potatoes" now exists +Example
+const db = new Database();
const collection = db.collection("friends");
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists +Example
+interface Friend {
startDate: number;
endDate?: number;
}
const db = new Database();
const collection = db.collection("friends") as EdgeCollection<Friend>;
// even in TypeScript you still need to indicate the collection type
// if you want to create an edge collection
await collection.create({ type: CollectionType.EDGE_COLLECTION });
// the edge collection "friends" now exists +
document
- document(selector, options?): Promise<Edge<EntryResultType>>
- -
Retrieves the document matching the given key or id.
Throws an exception when passed a document or
- -_idfrom a different collection, or if the document does not exist.Example
- -const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123");
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} -Example
-const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", { graceful: true });
if (document) {
console.log(document);
} else {
console.error("Document does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionReadOptionsOptions for retrieving the document.
-
Returns Promise<Edge<T>>
- - selector: DocumentSelector
- document(selector: DocumentSelector, graceful: boolean): Promise<Edge<T>> -
-
-
Retrieves the document matching the given key or id.
+ Optionaloptions: CollectionReadOptionsOptions for retrieving the document.
+
Returns Promise<Edge<EntryResultType>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123");
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} +Example
+const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", { graceful: true });
if (document) {
console.log(document);
} else {
console.error("Document does not exist");
} + -
-
- document(selector, graceful): Promise<Edge<EntryResultType>>
- -
Retrieves the document matching the given key or id.
Throws an exception when passed a document or
- -_idfrom a different collection, or if the document does not exist.Example
- -const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123", false);
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} -Example
-const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", true);
if (document) {
console.log(document);
} else {
console.error("Document does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
graceful: boolean
-If set to
true,nullis returned instead of an + - graceful: boolean
If set to
-true,nullis returned instead of an exception being thrown if the document does not exist.
Returns Promise<Edge<T>>
- selector: DocumentSelector
- document
-Exists -
-
- document
Exists(selector: DocumentSelector, options?: DocumentExistsOptions): Promise<boolean>
- -
-
Checks whether a document matching the given key or id exists in this +
Returns Promise<Edge<EntryResultType>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const document = await collection.document("abc123", false);
console.log(document);
} catch (e: any) {
console.error("Could not find document");
} +Example
+const db = new Database();
const collection = db.collection("some-collection");
const document = await collection.document("abc123", true);
if (document) {
console.log(document);
} else {
console.error("Document does not exist");
} + -
-
document
- document
Exists(selector, options?): Promise<boolean> - -
Checks whether a document matching the given key or id exists in this collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
const exists = await collection.documentExists("abc123");
if (!exists) {
console.log("Document does not exist");
} --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
Optionaloptions: DocumentExistsOptions
Returns Promise<boolean>
- selector: DocumentSelector
- document
-Id -
-
- document
Id(selector: DocumentSelector): string
- -
-
Derives a document
+_idfrom the given selector for this collection. Optionaloptions: DocumentExistsOptions
Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const exists = await collection.documentExists("abc123");
if (!exists) {
console.log("Document does not exist");
} + -
-
document
- document
Id(selector): string - -
Derives a document
_idfrom the given selector for this collection.Throws an exception when passed a document or
- -_idfrom a different collection.Example
- -const db = new Database();
const collection = db.collection("some-collection");
const meta = await collection.save({ foo: "bar" }, { returnNew: true });
const doc = meta.new;
console.log(collection.documentId(meta)); // via meta._id
console.log(collection.documentId(doc)); // via doc._id
console.log(collection.documentId(meta._key)); // also works -Example
-const db = new Database();
const collection1 = db.collection("some-collection");
const collection2 = db.collection("other-collection");
const meta = await collection1.save({ foo: "bar" });
// Mixing collections is usually a mistake
console.log(collection1.documentId(meta)); // ok: same collection
console.log(collection2.documentId(meta)); // throws: wrong collection
console.log(collection2.documentId(meta._id)); // also throws
console.log(collection2.documentId(meta._key)); // ok but wrong collection --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
Returns string
- selector: DocumentSelector
- documents
--
-
- documents(selectors: (string | ObjectWithKey)[], options?: CollectionBatchReadOptions): Promise<Edge<T>[]> -
-
-
Retrieves the documents matching the given key or id values.
+
Returns string
Example
+const db = new Database();
const collection = db.collection("some-collection");
const meta = await collection.save({ foo: "bar" }, { returnNew: true });
const doc = meta.new;
console.log(collection.documentId(meta)); // via meta._id
console.log(collection.documentId(doc)); // via doc._id
console.log(collection.documentId(meta._key)); // also works +Example
+const db = new Database();
const collection1 = db.collection("some-collection");
const collection2 = db.collection("other-collection");
const meta = await collection1.save({ foo: "bar" });
// Mixing collections is usually a mistake
console.log(collection1.documentId(meta)); // ok: same collection
console.log(collection2.documentId(meta)); // throws: wrong collection
console.log(collection2.documentId(meta._id)); // also throws
console.log(collection2.documentId(meta._key)); // ok but wrong collection + -
-
documents
- documents(selectors, options?): Promise<Edge<EntryResultType>[]>
- -
Retrieves the documents matching the given key or id values.
Throws an exception when passed a document or
- -_idfrom a different collection, or if the document does not exist.Example
-const db = new Database();
const collection = db.collection("some-collection");
try {
const documents = await collection.documents(["abc123", "xyz456"]);
console.log(documents);
} catch (e: any) {
console.error("Could not find document");
} --Parameters
--
-
-
-
selectors: (string | ObjectWithKey)[]
-Array of document
_key,_idor objects with either +-Parameters
- selectors: (string | ObjectWithKey)[]
Array of document
-_key,_idor objects with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionBatchReadOptionsOptions for retrieving the documents.
-
Returns Promise<Edge<T>[]>
- selectors: (string | ObjectWithKey)[]
- -drop
--
-
- drop(options?: CollectionDropOptions): Promise<ArangoApiResponse<Record<string, never>>> -
-
--
Deletes the collection from the database.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection ---Parameters
--
-
-
-
-Optionaloptions: CollectionDropOptionsOptions for dropping the collection.
-
Returns Promise<ArangoApiResponse<Record<string, never>>>
-
-
- -drop
-Index -
-
- drop
Index(selector: IndexSelector): Promise<ArangoApiResponse<{
    id: string;
}>>
- -
--
Deletes the index with the given name or
- -idfrom the database.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.dropIndex("some-index");
// The index "some-index" no longer exists ---Parameters
--
-
-
-
selector: IndexSelector
-Index name, id or object with either property.
-
Returns Promise<ArangoApiResponse<{
    id: string;
}>> -
-
- edges
--
-
- edges(selector: DocumentSelector, options?: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>> -
-
-
Retrieves a list of all edges of the document matching the given +
Optionaloptions: CollectionBatchReadOptionsOptions for retrieving the documents.
+
Returns Promise<Edge<EntryResultType>[]>
Example
+const db = new Database();
const collection = db.collection("some-collection");
try {
const documents = await collection.documents(["abc123", "xyz456"]);
console.log(documents);
} catch (e: any) {
console.error("Could not find document");
} + -
-
drop
- drop(options?): Promise<ArangoApiResponse<Record<string, never>>>
Deletes the collection from the database.
+Parameters
Optionaloptions: CollectionDropOptionsOptions for dropping the collection.
+
Returns Promise<ArangoApiResponse<Record<string, never>>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection +
drop
- drop
Index(selector): Promise<ArangoApiResponse<{
    id: string;
}>> Deletes the index with the given name or
+idfrom the database.Parameters
- selector: IndexSelector
Index name, id or object with either property.
+
Returns Promise<ArangoApiResponse<{
    id: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.dropIndex("some-index");
// The index "some-index" no longer exists +- selector: IndexSelector
edges
- edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>
- -
Retrieves a list of all edges of the document matching the given
selector.Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.edges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["x", "y", "z"] --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
-
Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>
- selector: DocumentSelector
- ensure
-Index -
-
- ensure
Index(details: EnsurePersistentIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a persistent index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); ---Parameters
--
-
-
-
details: EnsurePersistentIndexOptions
-Options for creating the persistent index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureTtlIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a TTL index on the collection if it does not already exist.
- -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "createdAt" timestamp one day after creation
await collection.ensureIndex({
type: "ttl",
fields: ["createdAt"],
expireAfter: 60 * 60 * 24 // 24 hours
}); -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "expiresAt" timestamp according to their value
await collection.ensureIndex({
type: "ttl",
fields: ["expiresAt"],
expireAfter: 0 // when attribute value is exceeded
}); ---Parameters
--
-
-
-
details: EnsureTtlIndexOptions
-Options for creating the TTL index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureMdiIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
Creates a multi-dimensional index on the collection if it does not already exist.
- -Example
+const db = new Database();
const collection = db.collection("some-points");
// Create a multi-dimensional index for the attributes x, y and z
await collection.ensureIndex({
type: "mdi",
fields: ["x", "y", "z"],
fieldValueTypes: "double"
}); - Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
+
Returns Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>
Example
+const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.edges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["x", "y", "z"] + -
-
ensure
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
+Parameters
- details: EnsurePersistentIndexOptions
Options for creating the persistent index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); +- details: EnsurePersistentIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
+Parameters
- details: EnsureTtlIndexOptions
Options for creating the TTL index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "createdAt" timestamp one day after creation
await collection.ensureIndex({
type: "ttl",
fields: ["createdAt"],
expireAfter: 60 * 60 * 24 // 24 hours
}); +Example
+const db = new Database();
const collection = db.collection("some-collection");
// Expire documents with "expiresAt" timestamp according to their value
await collection.ensureIndex({
type: "ttl",
fields: ["expiresAt"],
expireAfter: 0 // when attribute value is exceeded
}); +- details: EnsureTtlIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
+Parameters
- details: EnsureMdiIndexOptions
Options for creating the multi-dimensional index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>-Example
const db = new Database();
const collection = db.collection("some-points");
// Create a multi-dimensional index for the attributes x, y and z
await collection.ensureIndex({
type: "mdi",
fields: ["x", "y", "z"],
fieldValueTypes: "double"
}); +
----Parameters
--
-
-
-
details: EnsureMdiIndexOptions
-Options for creating the multi-dimensional index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
} & {
    isNewlyCreated: boolean;
}>>
-- details: EnsureMdiIndexOptions
- ensure
Index(details: EnsureFulltextIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    fields: [string];
    minLength: number;
    type: "fulltext";
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a fulltext index on the collection if it does not already exist.
- -Deprecated
Fulltext indexes have been deprecated in ArangoDB 3.10 and -should be replaced with ArangoSearch.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create a fulltext index for tokens longer than or equal to 3 characters
await collection.ensureIndex({
type: "fulltext",
fields: ["description"],
minLength: 3
}); ---Parameters
--
-
-
-
details: EnsureFulltextIndexOptions
-Options for creating the fulltext index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    fields: [string];
    minLength: number;
    type: "fulltext";
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureGeoIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a geo index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create an index for GeoJSON data
await collection.ensureIndex({
type: "geo",
fields: ["lngLat"],
geoJson: true
}); ---Parameters
--
-
-
-
details: EnsureGeoIndexOptions
-Options for creating the geo index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
-
- ensure
Index(details: EnsureInvertedIndexOptions): Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>>
- -
--
Creates a inverted index on the collection if it does not already exist.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// Create an inverted index
await collection.ensureIndex({
type: "inverted",
fields: ["a", { name: "b", analyzer: "text_en" }]
}); ---Parameters
--
-
-
-
details: EnsureInvertedIndexOptions
-Options for creating the inverted index.
-
Returns Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>> -
-
exists
-figures
--
-
- figures(details?: boolean): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>
- -
--
Retrieves statistics for a collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.figures();
// data contains the collection's figures --Parameters
--
-
-
-
-Optionaldetails: booleanwhether to return extended storage engine-specific details + +
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
+Parameters
- details: EnsureGeoIndexOptions
Options for creating the geo index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    bestIndexedLevel: number;
    fields: [string, string] | [string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create an index for GeoJSON data
await collection.ensureIndex({
type: "geo",
fields: ["lngLat"],
geoJson: true
}); +- details: EnsureGeoIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
+Parameters
- details: EnsureInvertedIndexOptions
Options for creating the inverted index.
+
Returns Promise<ArangoApiResponse<GenericIndex & {
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
} & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create an inverted index
await collection.ensureIndex({
type: "inverted",
fields: ["a", { name: "b", analyzer: "text_en" }]
}); +- details: EnsureInvertedIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<Index & {
    isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
+Parameters
- details: EnsureIndexOptions
Options for creating the index.
+
Returns Promise<ArangoApiResponse<Index & {
    isNewlyCreated: boolean;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
// Create a unique index for looking up documents by username
await collection.ensureIndex({
type: "persistent",
fields: ["username"],
name: "unique-usernames",
unique: true
}); +- details: EnsureIndexOptions
exists
figures
- figures(details?): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>> Retrieves statistics for a collection.
+-Parameters
Optionaldetails: booleanwhether to return extended storage engine-specific details to the figures, which may cause additional load and impact performance
-
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>
- -first
-Example -
-
- first
Example(example: Partial<DocumentData<T>>): Promise<Edge<T>>
- -
--
Retrieves a single document in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const doc = await collection.firstExample({ flavor: "strawberry" });
const cursor = await db.query(aql`
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
LIMIT 1
RETURN doc
`);
const doc = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the document.
-
Returns Promise<Edge<T>>
-
-
- -fulltext
--
-
- fulltext(attribute: string, query: string, options?: SimpleQueryFulltextOptions): Promise<ArrayCursor<Edge<T>>> -
-
--
Performs a fulltext query in the given
- -attributeon the collection.Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const cursor = await collection.fulltext("article", "needle");
const cursor = await db.query(aql`
FOR doc IN FULLTEXT(${collection}, "article", "needle")
RETURN doc
`); ---Parameters
--
-
-
-
attribute: string
-Name of the field to search.
-
- -
-
query: string
-Fulltext query string to search for.
-
- -
-
-Optionaloptions: SimpleQueryFulltextOptionsOptions for performing the fulltext query.
-
Returns Promise<ArrayCursor<Edge<T>>>
-
-
- -get
--
-
- get(): Promise<ArangoApiResponse<CollectionMetadata>> -
-
--
Retrieves general information about the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.get();
// data contains general information about the collection -Returns Promise<ArangoApiResponse<CollectionMetadata>>
- -get
-Responsible Shard -
-
- get
Responsible Shard(document: Partial<Document<T>>): Promise<string>
- -
--
Retrieves the
- -shardIdof the shard responsible for the given document.Example
-const db = new Database();
const collection = db.collection("some-collection");
const responsibleShard = await collection.getResponsibleShard(); ---Parameters
--
-
-
-
document: Partial<Document<T>>
-Document in the collection to look up the
-shardIdof.
Returns Promise<string>
-
-
- import
--
-
- import(data: EdgeData<T>[], options?: CollectionImportOptions): Promise<CollectionImportResult> -
-
--
Bulk imports the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
{ _key: "x", _from: "vertices/a", _to: "vertices/b", weight: 1 },
{ _key: "y", _from: "vertices/a", _to: "vertices/c", weight: 2 }
]
); ---Parameters
--
-
-
-
data: EdgeData<T>[]
-The data to import, as an array of edge data.
-
- -
-
-Optionaloptions: CollectionImportOptionsOptions for importing the data.
-
Returns Promise<CollectionImportResult>
- -
-
- import(data: any[][], options?: CollectionImportOptions): Promise<CollectionImportResult> -
-
--
Bulk imports the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
[ "_key", "_from", "_to", "weight" ],
[ "x", "vertices/a", "vertices/b", 1 ],
[ "y", "vertices/a", "vertices/c", 2 ]
]
); --Parameters
--
-
-
-
data: any[][]
-The data to import, as an array containing a single array of +
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    count: number;
    figures: Record<string, any>;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.figures();
// data contains the collection's figures + -
-
get
- get(): Promise<ArangoApiResponse<CollectionMetadata>>
Retrieves general information about the collection.
+Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.get();
// data contains general information about the collection +
get
Responsible Shard - get
Responsible Shard(document): Promise<string> Retrieves the
+shardIdof the shard responsible for the given document.Parameters
- document: Partial<Document<EntryResultType>>
Document in the collection to look up the
+shardIdof.
Returns Promise<string>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const responsibleShard = await collection.getResponsibleShard(); +- document: Partial<Document<EntryResultType>>
import
- import(data, options?): Promise<CollectionImportResult>
Bulk imports the given
+datainto the collection.Parameters
- data: EdgeData<EntryInputType>[]
The data to import, as an array of edge data.
+ Optionaloptions: CollectionImportOptionsOptions for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
{ _key: "x", _from: "vertices/a", _to: "vertices/b", weight: 1 },
{ _key: "y", _from: "vertices/a", _to: "vertices/c", weight: 2 }
]
); +- data: EdgeData<EntryInputType>[]
- import(data, options?): Promise<CollectionImportResult>
Bulk imports the given
+datainto the collection.-Parameters
- data: any[][]
The data to import, as an array containing a single array of attribute names followed by one or more arrays of attribute values for each edge document.
-
- -
-
-Optionaloptions: CollectionImportOptionsOptions for importing the data.
-
Returns Promise<CollectionImportResult>
-- data: any[][]
- import(data: string | Blob | Buffer, options?: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}): Promise<CollectionImportResult>
- -
-
Bulk imports the given
+datainto the collection. Optionaloptions: CollectionImportOptionsOptions for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
[ "_key", "_from", "_to", "weight" ],
[ "x", "vertices/a", "vertices/b", 1 ],
[ "y", "vertices/a", "vertices/c", 2 ]
]
); + -
-
- import(data, options?): Promise<CollectionImportResult>
- -
Bulk imports the given
datainto the collection.If
@@ -784,745 +199,125 @@typeis omitted,datamust contain one JSON array per line with the first array providing the attribute names and all other arrays providing attribute values for each edge document.Returns Promise
If
- -typeis set to"auto",datacan be in either of the formats supported by"documents"or"list".Example
- -const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1}\r\n' +
'{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}\r\n',
{ type: "documents" } // or "auto"
); -Example
- -const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'[{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1},' +
'{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}]',
{ type: "list" } // or "auto"
); -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'["_key","_from","_to","weight"]\r\n' +
'["x","vertices/a","vertices/b",1]\r\n' +
'["y","vertices/a","vertices/c",2]\r\n'
); --Parameters
--
-
-
-
data: string | Blob | Buffer
-The data to import as a Buffer (Node), Blob (browser) or +
-Parameters
- data: string | Buffer | Blob
The data to import as a Buffer (Node), Blob (browser) or string.
-
- -
-
-Optionaloptions: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}Options for importing the data.
-
Returns Promise<CollectionImportResult>
- data: string | Buffer | Blob
- in
-Edges -
-
- in
Edges(selector: DocumentSelector, options?: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>
- -
-
Retrieves a list of all incoming edges of the document matching the given +
Optionaloptions: CollectionImportOptions & {
    type?: "documents" | "list" | "auto";
}Options for importing the data.
+
Returns Promise<CollectionImportResult>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1}\r\n' +
'{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}\r\n',
{ type: "documents" } // or "auto"
); +Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'[{"_key":"x","_from":"vertices/a","_to":"vertices/b","weight":1},' +
'{"_key":"y","_from":"vertices/a","_to":"vertices/c","weight":2}]',
{ type: "list" } // or "auto"
); +Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
'["_key","_from","_to","weight"]\r\n' +
'["x","vertices/a","vertices/b",1]\r\n' +
'["y","vertices/a","vertices/c",2]\r\n'
); + -
-
in
- in
Edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>> - -
Retrieves a list of all incoming edges of the document matching the given
selector.Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.inEdges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["z"] --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
-
Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>
- selector: DocumentSelector
- -index
--
-
- index(selector: IndexSelector): Promise<Index> -
-
--
Returns an index description by name or
- -idif it exists.Example
-const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index"); ---Parameters
--
-
-
-
selector: IndexSelector
-Index name, id or object with either property.
-
Returns Promise<Index>
-
-
- -indexes
-- -list
--
-
- list(type?: SimpleQueryListType): Promise<ArrayCursor<string>> -
-
--
Retrieves a list of references for all documents in the collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// const ids = await collection.list("id");
const ids = await db.query(aql`
FOR doc IN ${collection}
RETURN doc._id
`); -Example
- -const db = new Database();
const collection = db.collection("some-collection");
// const keys = await collection.list("key");
const keys = await db.query(aql`
FOR doc IN ${collection}
RETURN doc._key
`); -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const paths = await collection.list("path");
const paths = await db.query(aql`
FOR doc IN ${collection}
RETURN CONCAT("/_db/", CURRENT_DATABASE(), "/_api/document/", doc._id)
`); ---Parameters
--
-
-
-
-Optionaltype: SimpleQueryListTypeThe type of document reference to retrieve.
-
Returns Promise<ArrayCursor<string>>
-
-
- -load
-Indexes -
-
- load
Indexes(): Promise<boolean>
- -
--
(RocksDB only.) Instructs ArangoDB to load as many indexes of the -collection into memory as permitted by the memory limit.
- -Example
-const db = new Database();
const collection = db.collection("indexed-collection");
await collection.loadIndexes();
// the indexes are now loaded into memory -Returns Promise<boolean>
- -lookup
-By Keys -
-
- lookup
By Keys(keys: string[]): Promise<Edge<T>[]>
- -
--
Retrieves all documents matching the given document keys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const keys = ["a", "b", "c"];
// const docs = await collection.byKeys(keys);
const cursor = await db.query(aql`
FOR key IN ${keys}
LET doc = DOCUMENT(${collection}, key)
RETURN doc
`);
const docs = await cursor.all(); ---Parameters
--
-
-
-
keys: string[]
-An array of document keys to look up.
-
Returns Promise<Edge<T>[]>
-
-
- out
-Edges -
-
- out
Edges(selector: DocumentSelector, options?: CollectionEdgesOptions): Promise<ArangoApiResponse<CollectionEdgesResult<T>>>
- -
-
Retrieves a list of all outgoing edges of the document matching the given +
Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
+
Returns Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>
Example
+const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.inEdges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["z"] + -
-
index
- index(selector): Promise<Index>
Returns an index description by name or
+idif it exists.Parameters
- selector: IndexSelector
Index name, id or object with either property.
+
Returns Promise<Index>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index"); +- selector: IndexSelector
indexes
- indexes<IndexType>(options?): Promise<IndexType[]>
Returns a list of all index descriptions for the collection.
+Type Parameters
- IndexType extends Index | HiddenIndex = Index
Parameters
Optionaloptions: IndexListOptionsOptions for fetching the index list.
+
Returns Promise<IndexType[]>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const indexes = await collection.indexes(); +Example
+const db = new Database();
const collection = db.collection("some-collection");
const allIndexes = await collection.indexes<HiddenIndex>({
withHidden: true
}); +
load
- load
Indexes(): Promise<boolean> Instructs ArangoDB to load as many indexes of the collection into memory +as permitted by the memory limit.
+Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("indexed-collection");
await collection.loadIndexes();
// the indexes are now loaded into memory +
out
- out
Edges(selector, options?): Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>> - -
Retrieves a list of all outgoing edges of the document matching the given
selector.Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.outEdges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["x", "y"] --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
-
Returns Promise<ArangoApiResponse<CollectionEdgesResult<T>>>
- selector: DocumentSelector
- -properties
--
-
- properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>> -
-
--
Retrieves the collection's properties.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.properties();
// data contains the collection's properties -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
- - properties(properties: CollectionPropertiesOptions): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>> -
-
--
Replaces the properties of the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.setProperties({ waitForSync: true });
// the collection will now wait for data being written to disk
// whenever a document is changed ---Parameters
--
-
-
-
properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
-
-
- -recalculate
-Count -
-
- recalculate
Count(): Promise<boolean>
- -
--
(RocksDB only.) Instructs ArangoDB to recalculate the collection's -document count to fix any inconsistencies.
- -Example
-const db = new Database();
const collection = db.collection("inconsistent-collection");
const badData = await collection.count();
// oh no, the collection count looks wrong -- fix it!
await collection.recalculateCount();
const goodData = await collection.count();
// goodData contains the collection's improved count -Returns Promise<boolean>
- remove
--
-
- remove(selector: DocumentSelector, options?: CollectionRemoveOptions): Promise<DocumentMetadata & {
    old?: Edge<T>;
}>
- -
-
Removes an existing document from the collection.
+ Optionaloptions: CollectionEdgesOptionsOptions for retrieving the edges.
+
Returns Promise<ArangoApiResponse<CollectionEdgesResult<EntryResultType>>>
Example
+const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/a", "vertices/c"],
["z", "vertices/d", "vertices/a"],
]);
const edges = await collection.outEdges("vertices/a");
console.log(edges.map((edge) => edge._key)); // ["x", "y"] + -
-
properties
- properties(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Retrieves the collection's properties.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.properties();
// data contains the collection's properties +- properties(properties): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Replaces the properties of the collection.
+Parameters
- properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
const result = await collection.setProperties({ waitForSync: true });
// the collection will now wait for data being written to disk
// whenever a document is changed +
recalculate
- recalculate
Count(): Promise<boolean> Instructs ArangoDB to recalculate the collection's document count to fix +any inconsistencies.
+Returns Promise<boolean>
Example
+const db = new Database();
const collection = db.collection("inconsistent-collection");
const badData = await collection.count();
// oh no, the collection count looks wrong -- fix it!
await collection.recalculateCount();
const goodData = await collection.count();
// goodData contains the collection's improved count +
remove
- remove(selector, options?): Promise<DocumentMetadata & {
    old?: Edge<EntryResultType>;
}> - -
Removes an existing document from the collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
const doc = await collection.document("musadir");
await collection.remove(doc);
// document with key "musadir" deleted --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: CollectionRemoveOptionsOptions for removing the document.
-
Returns Promise<DocumentMetadata & {
    old?: Edge<T>;
}> - selector: DocumentSelector
- remove
-All -
-
- remove
All(selectors: DocumentSelector[], options?: CollectionRemoveOptions): Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Edge<T>;
})[]>
- -
-
Removes existing documents from the collection.
+ Optionaloptions: CollectionRemoveOptionsOptions for removing the document.
+
Returns Promise<DocumentMetadata & {
    old?: Edge<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
const doc = await collection.document("musadir");
await collection.remove(doc);
// document with key "musadir" deleted + -
-
remove
- remove
All(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Edge<EntryResultType>;
})[]> - -
Removes existing documents from the collection.
Throws an exception when passed any document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.removeAll(["musadir", "salman"]);
// document with keys "musadir" and "salman" deleted --Parameters
--
-
-
-
selectors: DocumentSelector[]
-Documents
_key,_idor objects with either of those +-Parameters
- selectors: DocumentSelector[]
Documents
-_key,_idor objects with either of those properties (e.g. documents from this collection).
- -
-
-Optionaloptions: CollectionRemoveOptionsOptions for removing the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Edge<T>;
})[]> - selectors: DocumentSelector[]
- -remove
-By Example -
-
- remove
By Example(example: Partial<DocumentData<T>>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>
- -
--
Removes all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
// const { deleted } = await collection.removeByExample({
// flavor: "strawberry"
// });
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
REMOVE doc IN ${collection}
RETURN 1
)
`);
const deleted = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the document.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByExampleOptionsOptions for removing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryRemoveByExampleResult>>
-
-
- -remove
-By Keys -
-
- remove
By Keys(keys: string[], options?: SimpleQueryRemoveByKeysOptions): Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>
- -
--
Removes all documents matching the given document keys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const keys = ["a", "b", "c"];
// const { removed, ignored } = await collection.removeByKeys(keys);
const cursor = await db.query(aql`
FOR key IN ${keys}
LET doc = DOCUMENT(${collection}, key)
FILTER doc
REMOVE doc IN ${collection}
RETURN key
`);
const removed = await cursor.all();
const ignored = keys.filter((key) => !removed.includes(key)); ---Parameters
--
-
-
-
keys: string[]
-An array of document keys to remove.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByKeysOptionsOptions for removing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryRemoveByKeysResult<T>>>
-
-
- rename
--
-
- rename(newName: string): Promise<ArangoApiResponse<CollectionMetadata>> -
-
-
Renames the collection and updates the instance's
-nametonewName.Additionally removes the instance from the Database's internal +
Optionaloptions: CollectionRemoveOptionsOptions for removing the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    old?: Edge<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.removeAll(["musadir", "salman"]);
// document with keys "musadir" and "salman" deleted + -
-
rename
- rename(newName): Promise<ArangoApiResponse<CollectionMetadata>>
- -
Renames the collection and updates the instance's
+nametonewName.Additionally removes the instance from the database.Database's internal cache.
Note: Renaming collections may not be supported when ArangoDB is running in a cluster configuration.
- -Example
-const db = new Database();
const collection1 = db.collection("some-collection");
await collection1.rename("other-collection");
const collection2 = db.collection("some-collection");
const collection3 = db.collection("other-collection");
// Note all three collection instances are different objects but
// collection1 and collection3 represent the same ArangoDB collection! ---Parameters
--
-
-
-
newName: string
-The new name of the collection.
-
Returns Promise<ArangoApiResponse<CollectionMetadata>>
-
-
replace
--
-
- replace(selector: DocumentSelector, newData: DocumentData<T>, options?: CollectionReplaceOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}>
- -
-
Replaces an existing document in the collection.
+Parameters
- newName: string
The new name of the collection.
+
Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection1 = db.collection("some-collection");
await collection1.rename("other-collection");
const collection2 = db.collection("some-collection");
const collection3 = db.collection("other-collection");
// Note all three collection instances are different objects but
// collection1 and collection3 represent the same ArangoDB collection! + - newName: string
replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}> - -
Replaces an existing document in the collection.
Throws an exception when passed a document or
- -_idfrom a different collection.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.replace(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false undefined --Parameters
--
-
-
-
selector: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
newData: DocumentData<T>
-The contents of the new document.
-
- -
-
-Optionaloptions: CollectionReplaceOptionsOptions for replacing the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}> - selector: DocumentSelector
- replace
-All -
-
- replace
All(newData: Object[], options?: CollectionReplaceOptions): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]>
- -
-
Replaces existing documents in the collection, identified by the
_keyor + - newData: DocumentData<EntryInputType>
The contents of the new document.
+ Optionaloptions: CollectionReplaceOptionsOptions for replacing the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.replace(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false undefined + -
-
replace
- replace
All(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]> - -
Replaces existing documents in the collection, identified by the
- -_keyor_idof each document.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
await collection.save(
{
_key: "salman",
_from: "users/rana",
_to: "users/salman",
active: false,
best: false
}
);
const result = await collection.replaceAll(
[
{ _key: "musadir", active: false },
{ _key: "salman", active: true, best: true }
],
{ returnNew: true }
);
console.log(result[0].new.active, result[0].new.best); // false undefined
console.log(result[1].new.active, result[1].new.best); // true true ---Parameters
--
-
-
-
newData: Object[]
-The documents to replace.
-
- -
-
-Optionaloptions: CollectionReplaceOptionsOptions for replacing the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]> -
-
replace
--
-
- replace
By Example(example: Partial<DocumentData<T>>, newValue: DocumentData<T>, options?: SimpleQueryRemoveByExampleOptions): Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>
- -
--
Replaces all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const newValue = { flavor: "chocolate" };
// const { replaced } = await collection.replaceByExample(
// { flavor: "strawberry" },
// newValue
// );
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
REPLACE doc WITH ${newValue} IN ${collection}
RETURN 1
)
`);
const replaced = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the documents.
-
- -
-
newValue: DocumentData<T>
-Document data to replace the matching documents with.
-
- -
-
-Optionaloptions: SimpleQueryRemoveByExampleOptionsOptions for replacing the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryReplaceByExampleResult>>
-
-
revision
--
-
- revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>
- -
--
Retrieves the collection revision ID.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.revision();
// data contains the collection's revision -Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>
save
--
-
- save(data: EdgeData<T>, options?: CollectionInsertOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}>
- -
--
Inserts a new document with the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("friends");
const result = await collection.save(
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ returnNew: true }
); ---Parameters
--
-
-
-
data: EdgeData<T>
-The contents of the new document.
-
- -
-
-Optionaloptions: CollectionInsertOptionsOptions for inserting the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}> -
-
save
--
-
- save
All(data: EdgeData<T>[], options?: CollectionInsertOptions): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]>
- -
--
Inserts new documents with the given
- -datainto the collection.Example
-const db = new Database();
const collection = db.collection("friends");
const result = await collection.saveAll(
[
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ _from: "users/rana", _to: "users/salman", active: true }
],
{ returnNew: true }
); ---Parameters
--
-
-
-
data: EdgeData<T>[]
-The contents of the new documents.
-
- -
-
-Optionaloptions: CollectionInsertOptionsOptions for inserting the documents.
-
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]> -
-
traversal
--
-
- traversal(startVertex: DocumentSelector, options?: TraversalOptions): Promise<any> -
-
-
Performs a traversal starting from the given
+startVertexand following -edges contained in this edge collection.Parameters
- newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
The documents to replace.
+ Optionaloptions: CollectionReplaceOptionsOptions for replacing the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
await collection.save(
{
_key: "salman",
_from: "users/rana",
_to: "users/salman",
active: false,
best: false
}
);
const result = await collection.replaceAll(
[
{ _key: "musadir", active: false },
{ _key: "salman", active: true, best: true }
],
{ returnNew: true }
);
console.log(result[0].new.active, result[0].new.best); // false undefined
console.log(result[1].new.active, result[1].new.best); // true true + - newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
revision
- revision(): Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>> Retrieves the collection revision ID.
+Returns Promise<ArangoApiResponse<CollectionMetadata & CollectionProperties & {
    revision: string;
}>>Example
+const db = new Database();
const collection = db.collection("some-collection");
const data = await collection.revision();
// data contains the collection's revision +
save
- save(data, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}> Inserts a new document with the given
+datainto the collection.Parameters
- data: EdgeData<EntryInputType>
The contents of the new document.
+ Optionaloptions: CollectionInsertOptionsOptions for inserting the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
const result = await collection.save(
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ returnNew: true }
); +- data: EdgeData<EntryInputType>
save
- save
All(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]> Inserts new documents with the given
+datainto the collection.Parameters
- data: EdgeData<EntryInputType>[]
The contents of the new documents.
+ Optionaloptions: CollectionInsertOptionsOptions for inserting the documents.
+
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]>Example
+const db = new Database();
const collection = db.collection("friends");
const result = await collection.saveAll(
[
{ _from: "users/rana", _to: "users/mudasir", active: false },
{ _from: "users/rana", _to: "users/salman", active: true }
],
{ returnNew: true }
); +- data: EdgeData<EntryInputType>[]
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionMetadata>>
Deletes all documents in the collection.
+Parameters
Optionaloptions: CollectionTruncateOptions
Returns Promise<ArangoApiResponse<CollectionMetadata>>
Example
+const db = new Database();
const collection = db.collection("some-collection");
await collection.truncate();
// millions of documents cry out in terror and are suddenly silenced,
// the collection "some-collection" is now empty +
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}> - -
Updates an existing document in the collection.
Throws an exception when passed a document or
-_idfrom a different collection.See also traversal.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and are -no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("edges");
await collection.import([
["_key", "_from", "_to"],
["x", "vertices/a", "vertices/b"],
["y", "vertices/b", "vertices/c"],
["z", "vertices/c", "vertices/d"],
]);
const startVertex = "vertices/a";
const cursor = await db.query(aql`
FOR vertex IN OUTBOUND ${startVertex}
RETURN vertex._key
`);
const result = await cursor.all();
console.log(result); // ["a", "b", "c", "d"] --Parameters
--
-
-
-
startVertex: DocumentSelector
-Document
_key,_idor object with either of those +-Parameters
- selector: DocumentSelector
Document
-_key,_idor object with either of those properties (e.g. a document from this collection).
- -
-
-Optionaloptions: TraversalOptionsOptions for performing the traversal.
-
Returns Promise<any>
- selector: DocumentSelector
- -truncate
--
-
- truncate(): Promise<ArangoApiResponse<CollectionMetadata>> -
-
--
Deletes all documents in the collection.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.truncate();
// millions of documents cry out in terror and are suddenly silenced,
// the collection "some-collection" is now empty -Returns Promise<ArangoApiResponse<CollectionMetadata>>
- -update
--
-
- update(selector: DocumentSelector, newData: Patch<DocumentData<T>>, options?: CollectionUpdateOptions): Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}>
- -
--
Updates an existing document in the collection.
-Throws an exception when passed a document or
- -_idfrom a different -collection.Example
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.update(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false true ---Parameters
--
-
-
-
selector: DocumentSelector
-Document
-_key,_idor object with either of those -properties (e.g. a document from this collection).
- -
-
newData: Patch<DocumentData<T>>
-The data for updating the document.
-
- -
-
-Optionaloptions: CollectionUpdateOptionsOptions for updating the document.
-
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
}> -
-
- update
-All -
-
- update
All(newData: Object[], options?: CollectionUpdateOptions): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]>
- -
-
Updates existing documents in the collection, identified by the
_keyor + - newData: Patch<DocumentData<EntryInputType>>
The data for updating the document.
+ Optionaloptions: CollectionUpdateOptionsOptions for updating the document.
+
Returns Promise<DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
}>Example
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
const result = await collection.update(
"musadir",
{ active: false },
{ returnNew: true }
);
console.log(result.new.active, result.new.best); // false true + -
-
update
- update
All(newData, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]> - -
Updates existing documents in the collection, identified by the
-_keyor_idof each document.--Parameters
--
-
-
-
newData: Object[]
-The data for updating the documents.
-
- -
-
-Optionaloptions: CollectionUpdateOptionsOptions for updating the documents.
-
-const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
await collection.save(
{
_key: "salman",
_from: "users/rana",
_to: "users/salman",
active: false,
best: false
}
);
const result = await collection.updateAll(
[
{ _key: "musadir", active: false },
{ _key: "salman", active: true, best: true }
],
{ returnNew: true }
);
console.log(result[0].new.active, result[0].new.best); // false true
console.log(result[1].new.active, result[1].new.best); // true true -
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<T>;
    old?: Edge<T>;
})[]> -
-
update
--
-
- update
By Example(example: Partial<DocumentData<T>>, newValue: Patch<DocumentData<T>>, options?: SimpleQueryUpdateByExampleOptions): Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>
- -
--
Updates all documents in the collection matching the given example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
- -Example
-const db = new Database();
const collection = db.collection("some-collection");
const newData = { color: "red" };
// const { updated } = await collection.updateByExample(
// { flavor: "strawberry" },
// newValue
// );
const cursor = await db.query(aql`
RETURN LENGTH(
FOR doc IN ${collection}
FILTER doc.flavor == "strawberry"
UPDATE doc WITH ${newValue} IN ${collection}
RETURN 1
)
`);
const updated = await cursor.next(); ---Parameters
--
-
-
-
example: Partial<DocumentData<T>>
-An object representing an example for the documents.
-
- -
-
newValue: Patch<DocumentData<T>>
-Document data to update the matching documents with.
-
- -
-
-Optionaloptions: SimpleQueryUpdateByExampleOptionsOptions for updating the documents.
-
Returns Promise<ArangoApiResponse<SimpleQueryUpdateByExampleResult>>
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Parameters
- newData: (Patch<DocumentData<EntryInputType>> & ({
    _key: string;
} | {
    _id: string;
}))[]The data for updating the documents.
+ Optionaloptions: CollectionUpdateOptionsOptions for updating the documents.
+
+const db = new Database();
const collection = db.collection("friends");
await collection.save(
{
_key: "musadir",
_from: "users/rana",
_to: "users/mudasir",
active: true,
best: true
}
);
await collection.save(
{
_key: "salman",
_from: "users/rana",
_to: "users/salman",
active: false,
best: false
}
);
const result = await collection.updateAll(
[
{ _key: "musadir", active: false },
{ _key: "salman", active: true, best: true }
],
{ returnNew: true }
);
console.log(result[0].new.active, result[0].new.best); // false true
console.log(result[1].new.active, result[1].new.best); // true true +
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
    _oldRev?: string;
} & {
    new?: Edge<EntryResultType>;
    old?: Edge<EntryResultType>;
})[]>
Interface ProcessedResponse<T>
Processed response object.
+interface ProcessedResponse<T> {
    arrayBuffer: (() => Promise<ArrayBuffer>);
    blob: (() => Promise<Blob>);
    body: null | ReadableStream<any>;
    bodyUsed: boolean;
    clone: (() => Response);
    formData: (() => Promise<FormData>);
    headers: Headers;
    json: (() => Promise<unknown>);
    ok: boolean;
    parsedBody?: T;
    redirected: boolean;
    request: Request;
    status: number;
    statusText: string;
    text: (() => Promise<string>);
    type: ResponseType;
    url: string;
}
    arrayBuffer: (() => Promise<ArrayBuffer>);
    blob: (() => Promise<Blob>);
    body: null | ReadableStream<any>;
    bodyUsed: boolean;
    clone: (() => Response);
    formData: (() => Promise<FormData>);
    headers: Headers;
    json: (() => Promise<unknown>);
    ok: boolean;
    parsedBody?: T;
    redirected: boolean;
    request: Request;
    status: number;
    statusText: string;
    text: (() => Promise<string>);
    type: ResponseType;
    url: string;
}
Type Parameters
Hierarchy
- Response
- ProcessedResponse
Index
Properties
array
Properties
Readonly array
array
Type declaration
- (): Promise<ArrayBuffer>
Returns Promise<ArrayBuffer>
Readonly blob
blob: (() => Promise<Blob>)
Type declaration
- (): Promise<Blob>
Returns Promise<Blob>
Readonly body
body: null | ReadableStream<any>
Readonly body
body
Readonly clone
clone: (() => Response)
Type declaration
- (): Response
Returns Response
Readonly form
form
Type declaration
- (): Promise<FormData>
Returns Promise<FormData>
Deprecated
This method is not recommended for parsing multipart/form-data bodies in server environments. +It is recommended to use a library such as @fastify/busboy as follows:
+Example
import { Busboy } from '@fastify/busboy'
import { Readable } from 'node:stream'
const response = await fetch('...')
const busboy = new Busboy({ headers: { 'content-type': response.headers.get('content-type') } })
// handle events emitted from `busboy`
Readable.fromWeb(response.body).pipe(busboy)
+Readonly headers
headers: Headers
Readonly json
json: (() => Promise<unknown>)
Type declaration
- (): Promise<unknown>
Returns Promise<unknown>
Readonly ok
ok: boolean
Optional parsed
Parsed response body.
+Readonly redirected
redirected: boolean
request
request: Request
Fetch request object.
+Readonly status
status: number
Readonly status
status
Readonly text
text: (() => Promise<string>)
Type declaration
- (): Promise<string>
Returns Promise<string>
Readonly type
type: ResponseType
Readonly url
url: string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Interface CursorExtras
Additional information about the cursor.
-Hierarchy
--
-
- CursorExtras
Properties
-Optional plan
-plan?: Record<string, any>
-Query execution plan for the executed query.
-Optional profile
-profile?: Record<string, number>
-Additional profiling information for the executed query.
-Optional stats
-stats?: CursorStats
-Additional statistics about the query execution.
-warnings
-warnings: {
    code: number;
    message: string;
}[]
-Â Â Â Â code: number;
    message: string;
}[]
Warnings encountered while executing the query.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Interface CursorExtras
Additional information about the cursor.
+interface CursorExtras {
    plan?: Record<string, any>;
    profile?: Record<string, number>;
    stats?: CursorStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
    plan?: Record<string, any>;
    profile?: Record<string, number>;
    stats?: CursorStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
Properties
Optional plan
plan?: Record<string, any>
Query execution plan for the executed query.
+Optional profile
profile?: Record<string, number>
Additional profiling information for the executed query.
+Optional stats
Additional statistics about the query execution.
+warnings
warnings: {
    code: number;
    message: string;
}[]
    code: number;
    message: string;
}[]
Warnings encountered while executing the query.
+Type declaration
code: number
message: string
-
\ No newline at end of file
diff --git a/devel/interfaces/error.SystemError.html b/devel/interfaces/error.SystemError.html
deleted file mode 100644
index d686748ae..000000000
--- a/devel/interfaces/error.SystemError.html
+++ /dev/null
@@ -1,97 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-cache
-CursorStats | arangojs
cache
-cache
- cache
-cursors
-
-
-cursors
-
-
-execution
-
-
-
-
-
-
-
-http
-
-
-
-
-
-peak
-
-
-scanned
-
-
-scanned
-
-
-writes
-
-
-writes
- cursors
cursors
execution
http
peak
scanned
scanned
writes
writes
-
-
-Interface CursorStats
Additional statics about the query execution of the cursor.
-Hierarchy
--
-
- CursorStats
- Index
-
-
-
Properties
-Properties
-cache
-cache
-Total number of index entries read from in-memory caches for indexes of +
Interface CursorStats
Additional statics about the query execution of the cursor.
+interface CursorStats {
    cacheHits: number;
    cacheMisses: number;
    cursorsCreated: number;
    cursorsRearmed: number;
    executionTime: number;
    filtered: number;
    fullCount?: number;
    httpRequests: number;
    nodes?: {
        calls: number;
        filter: number;
        id: number;
        items: number;
        runtime: number;
    }[];
    peakMemoryUsage: number;
    scannedFull: number;
    scannedIndex: number;
    writesExecuted: number;
    writesIgnored: number;
}
    cacheHits: number;
    cacheMisses: number;
    cursorsCreated: number;
    cursorsRearmed: number;
    executionTime: number;
    filtered: number;
    fullCount?: number;
    httpRequests: number;
    nodes?: {
        calls: number;
        filter: number;
        id: number;
        items: number;
        runtime: number;
    }[];
    peakMemoryUsage: number;
    scannedFull: number;
    scannedIndex: number;
    writesExecuted: number;
    writesIgnored: number;
}
Index
Properties
cache
cache
Total number of index entries read from in-memory caches for indexes of type edge or persistent.
-cache
-cache
-Total number of cache read attempts for index entries that could not be +
cache
cache
Total number of cache read attempts for index entries that could not be served from in-memory caches for indexes of type edge or persistent.
-cursors
-cursors
-Total number of cursor objects created during query execution.
-cursors
-cursors
-Total number of times an existing cursor object was repurposed.
-execution
-execution
-Execution time of the query in seconds.
-filtered
-filtered: number
-Total number of documents that were removed after executing a filter condition in a FilterNode.
-Optional full
-full
-Total number of documents that matched the search condition if the query’s final top-level LIMIT statement were not present.
-http
-http
-Total number of cluster-internal HTTP requests performed.
-Optional nodes
-nodes?: {
    calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]
-Â Â Â Â calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]
Runtime statistics per query execution node if profile was set to 2 or greater.
peak
-peak
-Maximum memory usage of the query while it was running.
-scanned
-scanned
-Total number of documents iterated over when scanning a collection without an index.
-scanned
-scanned
-Total number of documents iterated over when scanning a collection using an index.
-writes
-writes
-Total number of data-modification operations successfully executed.
-writes
-writes
-Total number of data-modification operations that were unsuccessful, but have been ignored because of query option ignoreErrors.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
cursors
cursors
Total number of cursor objects created during query execution.
+cursors
cursors
Total number of times an existing cursor object was repurposed.
+execution
execution
Execution time of the query in seconds.
+filtered
filtered: number
Total number of documents that were removed after executing a filter condition in a FilterNode.
+Optional full
full
Total number of documents that matched the search condition if the query’s final top-level LIMIT statement were not present.
+http
http
Total number of cluster-internal HTTP requests performed.
+Optional nodes
nodes?: {
    calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]
    calls: number;
    filter: number;
    id: number;
    items: number;
    runtime: number;
}[]
Runtime statistics per query execution node if profile was set to 2 or greater.
Type declaration
calls: number
Number of calls in this node.
+filter: number
id: number
Execution node ID to correlate this node with nodes in the
+extra.plan.items: number
Number of temporary result items returned by this node.
+runtime: number
Execution time of this node in seconds.
+
peak
peak
Maximum memory usage of the query while it was running.
+scanned
scanned
Total number of documents iterated over when scanning a collection without an index.
+scanned
scanned
Total number of documents iterated over when scanning a collection using an index.
+writes
writes
Total number of data-modification operations successfully executed.
+writes
writes
Total number of data-modification operations that were unsuccessful, but have been ignored because of query option ignoreErrors.
+
-
-
-
-
-
\ No newline at end of file
diff --git a/devel/interfaces/view.ArangoSearchViewStoredValueOptions.html b/devel/interfaces/view.ArangoSearchViewStoredValueOptions.html
index a060c3679..58e05530f 100644
--- a/devel/interfaces/view.ArangoSearchViewStoredValueOptions.html
+++ b/devel/interfaces/view.ArangoSearchViewStoredValueOptions.html
@@ -1,105 +1,12 @@
-Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/modules.html b/devel/modules.html
deleted file mode 100644
index 6861b4ef7..000000000
--- a/devel/modules.html
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-ArangoSearchViewStoredValueOptions | arangojs
-
-
-
-
-
-Interface ArangoSearchViewStoredValueOptions
Options for creating a stored value in an ArangoSearch View.
-Hierarchy
--
-
- ArangoSearchViewStoredValueOptions
- Index
-
-
-
Properties
-Properties
-Optional cache
-cache?: boolean
-(Enterprise Edition only.) If set to true, then stored values will
+
Interface ArangoSearchViewStoredValueOptions
Options for creating a stored value in an ArangoSearch View.
+interface ArangoSearchViewStoredValueOptions {
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}
Index
Properties
Properties
Optional cache
cache?: boolean
(Enterprise Edition only.) If set to true, then stored values will
always be cached in memory.
Default: false
Optional compression
-compression?: Compression
-How the attribute values should be compressed.
+Optional compression
How the attribute values should be compressed.
Default: "lz4"
fields
-fields: string[]
-Attribute paths for which values should be stored in the view index +
fields
fields: string[]
Attribute paths for which values should be stored in the view index
in addition to those used for sorting via primarySort.
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-
-
-arangojs
Index
-Modules
-analyzer
-aql
-collection
-connection
-cursor
-database
-documents
-error
-foxx-
-
-
\ No newline at end of file
diff --git a/devel/modules/analyzer.html b/devel/modules/analyzer.html
index 7175bf388..31417cd88 100644
--- a/devel/modules/analyzer.html
+++ b/devel/modules/analyzer.html
@@ -1,162 +1,49 @@
-Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/modules/aql.html b/devel/modules/aql.html
index 040a38a9e..2989e9a95 100644
--- a/devel/modules/aql.html
+++ b/devel/modules/aql.html
@@ -1,91 +1,14 @@
-
-
-analyzer | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module analyzer
import type { Analyzer } from "arangojs/analyzer";
-Module analyzer
import type { Analyzer } from "arangojs/analyzer.js";
+The "analyzer" module provides analyzer related types and interfaces for TypeScript.
-Index
-Classes
-Analyzer
-
Type Aliases
-Analyzer
Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Analyzer
+
Type Aliases
Analyzer
Functions
-
\ No newline at end of file
diff --git a/devel/modules/collection.html b/devel/modules/collection.html
index 6c1e9441d..a2df07097 100644
--- a/devel/modules/collection.html
+++ b/devel/modules/collection.html
@@ -1,175 +1,43 @@
-
-
-aql | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module aql
import { aql } from "arangojs/aql";
-The "aql" module provides the aql template string handler and +
Module aql
import { aql } from "arangojs/aql.js";
+The "aql" module provides the aql template string handler and helper functions, as well as associated types and interfaces for TypeScript.
The aql function and namespace is also re-exported by the "index" module.
-Index
-Interfaces
-Type Aliases
-Aql
Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Interfaces
Type Aliases
Aql
Functions
-
\ No newline at end of file
diff --git a/devel/modules/connection.html b/devel/modules/connection.html
index 46d24021c..a633d3aa1 100644
--- a/devel/modules/connection.html
+++ b/devel/modules/connection.html
@@ -1,92 +1,13 @@
-
-
-collection | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module collection
import type {
DocumentCollection,
EdgeCollection,
} from "arangojs/collection";
-Module collection
import type {
DocumentCollection,
EdgeCollection,
} from "arangojs/collection.js";
+The "collection" module provides collection related types and interfaces for TypeScript.
-Index
-Enumerations
-Interfaces
-Type Aliases
-Collection
Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Enumerations
Interfaces
Type Aliases
Collection
Functions
-
\ No newline at end of file
diff --git a/devel/modules/cursor.html b/devel/modules/cursor.html
index 5e6bf6737..5f12bfae7 100644
--- a/devel/modules/cursor.html
+++ b/devel/modules/cursor.html
@@ -1,78 +1,8 @@
-
-
-connection | arangojs
-
-
-
-
-
-
-
-
-
-Module connection
import type { Config } from "arangojs/connection";
-Module connection
import type { Config } from "arangojs/connection.js";
+The "connection" module provides connection and configuration related types for TypeScript.
-Index
-Type Aliases
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Interfaces
Type Aliases
-
\ No newline at end of file
diff --git a/devel/modules/database.html b/devel/modules/database.html
index 9d406ec92..03242acb2 100644
--- a/devel/modules/database.html
+++ b/devel/modules/database.html
@@ -1,206 +1,70 @@
-
-
-cursor | arangojs
-
-
-
-
-
-
-
-
-
-
-
-Module cursor
import type { ArrayCursor, BatchedArrayCursor } from "arangojs/cursor";
-Module cursor
import type { ArrayCursor, BatchedArrayCursor } from "arangojs/cursor.js";
+The "cursor" module provides cursor-related interfaces for TypeScript.
-Index
-Classes
-Interfaces
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Interfaces
-
\ No newline at end of file
diff --git a/devel/modules/documents.html b/devel/modules/documents.html
index 73b6e1b33..34da302c1 100644
--- a/devel/modules/documents.html
+++ b/devel/modules/documents.html
@@ -1,87 +1,14 @@
-
-
-database | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module database
import { Database } from "arangojs/database";
-The "database" module provides the Database class and associated +
Module database
import { Database } from "arangojs/database.js";
+The "database" module provides the Database class and associated types and interfaces for TypeScript.
The Database class is also re-exported by the "index" module.
-Index
-Enumerations
-Log
Classes
-Database
-
Type Aliases
-Access
Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Enumerations
Log
Classes
Database
+
Type Aliases
Access
Functions
-
\ No newline at end of file
diff --git a/devel/modules/error.html b/devel/modules/error.html
index 9f9d8d332..9ee8018ae 100644
--- a/devel/modules/error.html
+++ b/devel/modules/error.html
@@ -1,84 +1,14 @@
-
-
-documents | arangojs
-
-
-
-
-
-
-
-
-
-Module documents
import type { Document, Edge } from "arangojs/documents";
-Module documents
import type { Document, Edge } from "arangojs/documents.js";
+The "documents" module provides document/edge related types for TypeScript.
-Index
-Type Aliases
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Type Aliases
-
\ No newline at end of file
diff --git a/devel/modules/foxx_manifest.html b/devel/modules/foxx_manifest.html
index c85eddab2..7ef3bcce4 100644
--- a/devel/modules/foxx_manifest.html
+++ b/devel/modules/foxx_manifest.html
@@ -1,77 +1,10 @@
-
-
-error | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module error
import type { ArangoError, HttpError } from "arangojs/error";
-Module error
import type { ArangoError, HttpError } from "arangojs/error.js";
+The "error" module provides types and interfaces for TypeScript related to arangojs error handling.
-Index
-Classes
-Interfaces
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Functions
-
\ No newline at end of file
diff --git a/devel/modules/graph.html b/devel/modules/graph.html
index 6e3818da7..459c7c6eb 100644
--- a/devel/modules/graph.html
+++ b/devel/modules/graph.html
@@ -1,104 +1,20 @@
-
-
-foxx-manifest | arangojs
-
-
-
-
-
-
-
-
-
-Module foxx-manifest
import type { FoxxManifest } from "arangojs/foxx-manifest";
-Module foxx-manifest
import type { FoxxManifest } from "arangojs/foxx-manifest.js";
+The "foxx-manifest" module provides the Foxx manifest type for TypeScript.
Generated from JSON Schema
using json-schema-to-typescript.
Index
-Type Aliases
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Type Aliases
-
\ No newline at end of file
diff --git a/devel/modules/index.html b/devel/modules/index.html
index 2045a1480..63f8e8e77 100644
--- a/devel/modules/index.html
+++ b/devel/modules/index.html
@@ -1,92 +1,12 @@
-
-
-graph | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module graph
import type {
Graph,
GraphVertexCollection,
GraphEdgeCollection,
} from "arangojs/graph";
-Module graph
import type {
Graph,
GraphVertexCollection,
GraphEdgeCollection,
} from "arangojs/graph.js";
+The "graph" module provides graph related types and interfaces for TypeScript.
-Index
-Classes
-Type Aliases
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Type Aliases
Functions
-
\ No newline at end of file
diff --git a/devel/modules/indexes.html b/devel/modules/indexes.html
index f62a17ff4..2841c25f8 100644
--- a/devel/modules/indexes.html
+++ b/devel/modules/indexes.html
@@ -1,113 +1,30 @@
-
-
-index | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module index
import arangojs, { aql, Database } from "arangojs";
-Module index
import arangojs, { aql, Database } from "arangojs";
+The "index" module is the default entry point when importing the arangojs module or using the web build in the browser.
If you are just getting started, you probably want to use the -arangojs function, which is also the default export of this module, -or the Database class for which it is a wrapper.
-References
-Database
Re-exports Databaseaql
Re-exports aqldefault
Renames and re-exports arangojs
-
-
\ No newline at end of file
+arangojs function, which is also the default export of this module,
+or the database.Database class for which it is a wrapper.
+Generated using TypeDoc
References
Database
Re-exports Databaseaql
Re-exports aqldefault
Renames and re-exports arangojs
-
\ No newline at end of file
diff --git a/devel/modules/job.html b/devel/modules/job.html
index 06e257e85..268ad2b04 100644
--- a/devel/modules/job.html
+++ b/devel/modules/job.html
@@ -1,64 +1,2 @@
-
-
-indexes | arangojs
-
-
-
-
-
-
-
-
-
-Module indexes
import type {
FulltextIndex,
GeoIndex,
MdiIndex,
PersistentIndex,
PrimaryIndex,
TtlIndex,
} from "arangojs/indexes";
-Module indexes
import type {
FulltextIndex,
GeoIndex,
MdiIndex,
PersistentIndex,
PrimaryIndex,
TtlIndex,
} from "arangojs/indexes.js";
+The "indexes" module provides index-related types for TypeScript.
-Index
-Type Aliases
-Ensure
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Type Aliases
Ensure
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Module job
Index
Classes
Job
+
-
\ No newline at end of file
diff --git a/devel/modules/transaction.html b/devel/modules/transaction.html
index b637fe927..1359faf53 100644
--- a/devel/modules/transaction.html
+++ b/devel/modules/transaction.html
@@ -1,84 +1,10 @@
-
-
-route | arangojs
-
-
-
-
-
-
-
-
-
-Module route
import type { Route } from "arangojs/route";
-Module route
import type { Route } from "arangojs/route.js";
+The "route" module provides route related types and interfaces for TypeScript.
-Index
-Classes
-Route
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Route
+
-
\ No newline at end of file
diff --git a/devel/modules/view.html b/devel/modules/view.html
index 496d45561..5626abcbc 100644
--- a/devel/modules/view.html
+++ b/devel/modules/view.html
@@ -1,130 +1,31 @@
-
-
-transaction | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module transaction
import type { Transaction } from "arangojs/transaction";
-Module transaction
import type { Transaction } from "arangojs/transaction.js";
+The "transaction" module provides transaction related types and interfaces for TypeScript.
-Index
-Classes
-Type Aliases
-Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
Type Aliases
Functions
-
\ No newline at end of file
diff --git a/devel/types/analyzer.AnalyzerDescription.html b/devel/types/analyzer.AnalyzerDescription.html
index c2be9281a..a97d64f6b 100644
--- a/devel/types/analyzer.AnalyzerDescription.html
+++ b/devel/types/analyzer.AnalyzerDescription.html
@@ -1,102 +1,2 @@
-
-
-view | arangojs
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Module view
import type { ArangoSearchView } from "arangojs/view";
-Module view
import type { ArangoSearchView } from "arangojs/view.js";
+The "view" module provides View related types and interfaces for TypeScript.
-Index
-Classes
-View
-
Interfaces
-Type Aliases
-Arango
Functions
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Index
Classes
View
+
Interfaces
Type Aliases
Arango
Functions
-
-
-
-
-
-
-Type alias AnalyzerDescription
Analyzer
-An object describing an Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias AnalyzerDescription
Analyzer
An object describing an Analyzer.
+
-
-
-
-
-
-
-Type alias AnalyzerFeature
Analyzer
-Name of a feature enabled for an Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias AnalyzerFeature
Analyzer
Name of a feature enabled for an Analyzer.
+
-
-
-
-
-
-
-Type alias AqlAnalyzerDescription
Aql
    properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}
-Â Â Â Â properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}
An object describing an AQL Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias AqlAnalyzerDescription
Aql
    properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}
    properties: {
        batchSize: number;
        collapsePositions: boolean;
        keepNull: boolean;
        memoryLimit: number;
        queryString: string;
        returnType: "string" | "number" | "bool";
    };
    type: "aql";
}
An object describing an AQL Analyzer
+Type declaration
properties: {
    batchSize: number;
    collapsePositions: boolean;
    keepNull: boolean;
    memoryLimit: number;
    queryString: string;
    returnType: "string" | "number" | "bool";
}batch
Size: number collapse
Positions: boolean keep
Null: boolean memory
Limit: number query
String: string return
Type: "string" | "number" | "bool"
type: "aql"
-
-
-
-
-
-
-Type alias ClassificationAnalyzerDescription
Classification
    properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}
-Â Â Â Â properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}
(Enterprise Edition only.) An object describing a Classification Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ClassificationAnalyzerDescription
Classification
    properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}
    properties: {
        model_location: string;
        threshold: number;
        top_k: number;
    };
    type: "classification";
}
(Enterprise Edition only.) An object describing a Classification Analyzer
+Type declaration
properties: {
    model_location: string;
    threshold: number;
    top_k: number;
}model_
location: string threshold: number
top_
k: number
type: "classification"
-
-
-
-
-
-
-Type alias CollationAnalyzerDescription
Collation
    properties: {
        locale: string;
    };
    type: "collation";
}
-Â Â Â Â properties: {
        locale: string;
    };
    type: "collation";
}
An object describing a Collation Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CollationAnalyzerDescription
Collation
    properties: {
        locale: string;
    };
    type: "collation";
}
    properties: {
        locale: string;
    };
    type: "collation";
}
An object describing a Collation Analyzer
+Type declaration
properties: {
    locale: string;
}locale: string
type: "collation"
-
-
-
-
-
-
-Type alias CreateAnalyzerOptions
Create
-Analyzer type and its type-specific properties.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateAnalyzerOptions
Create
Analyzer type and its type-specific properties.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateClassificationAnalyzerOptions.html b/devel/types/analyzer.CreateClassificationAnalyzerOptions.html
index 397b78c91..e83388c6b 100644
--- a/devel/types/analyzer.CreateClassificationAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateClassificationAnalyzerOptions.html
@@ -1,132 +1,10 @@
-
-
-
-
-
-Type alias CreateAqlAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    };
    type: "aql";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    };
    type: "aql";
}
Options for creating an AQL Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    batchSize?: number;
    collapsePositions?: boolean;
    keepNull?: boolean;
    memoryLimit?: number;
    queryString: string;
    returnType?: "string" | "number" | "bool";
}-Additional properties for the Analyzer.
--
-
-
-
-OptionalbatchSize?: number Number between
1and1000that determines the batch size for reading +CreateAqlAnalyzerOptions | arangojs --Type alias CreateAqlAnalyzerOptions
CreateAql Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        batchSize?: number;
        collapsePositions?: boolean;
        keepNull?: boolean;
        memoryLimit?: number;
        queryString: string;
        returnType?: "string" | "number" | "bool";
    };
    type: "aql";
}Options for creating an AQL Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    batchSize?: number;
    collapsePositions?: boolean;
    keepNull?: boolean;
    memoryLimit?: number;
    queryString: string;
    returnType?: "string" | "number" | "bool";
}Additional properties for the Analyzer.
+OptionalbatchSize?: number Number between
1and1000that determines the batch size for reading data from the query.Default:
-1
--
-
-OptionalcollapsePositions?: boolean If set to
+true, the position is set to0for all members of the query result array. OptionalcollapsePositions?: boolean If set to
true, the position is set to0for all members of the query result array.Default:
-false
--
-
-OptionalkeepNull?: boolean If set to
+false,nullvalues will be discarded from the View index. OptionalkeepNull?: boolean If set to
false,nullvalues will be discarded from the View index.Default:
-true
--
-
-OptionalmemoryLimit?: number Memory limit for query execution in bytes.
+ OptionalmemoryLimit?: number Memory limit for query execution in bytes.
Default:
-1048576(1 MiB)
--
-
query
-String: string AQL query to be executed.
-
- -
-
-OptionalreturnType?: "string" | "number" | "bool" Data type of the returned tokens.
+ query
String: string AQL query to be executed.
+OptionalreturnType?: "string" | "number" | "bool" Data type of the returned tokens.
Default:
-"string"
--
-
type: "aql"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "aql"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateCollationAnalyzerOptions.html b/devel/types/analyzer.CreateCollationAnalyzerOptions.html
index cf12ce204..3ecbfe23d 100644
--- a/devel/types/analyzer.CreateCollationAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateCollationAnalyzerOptions.html
@@ -1,123 +1,7 @@
-
-
-
-
-
-Type alias CreateClassificationAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    };
    type: "classification";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    };
    type: "classification";
}
(Enterprise Edition only.) Options for creating a Classification Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    model_location: string;
    threshold?: number;
    top_k?: number;
}-Additional properties for the Analyzer.
--
-
-
-
model_
-location: string On-disk path to the trained fastText supervised model.
-
- -
-
-Optionalthreshold?: numberProbability threshold for which a label will be assigned to an input.
+CreateClassificationAnalyzerOptions | arangojs --Type alias CreateClassificationAnalyzerOptions
CreateClassification Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        threshold?: number;
        top_k?: number;
    };
    type: "classification";
}(Enterprise Edition only.) Options for creating a Classification Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    model_location: string;
    threshold?: number;
    top_k?: number;
}Additional properties for the Analyzer.
+model_
location: string On-disk path to the trained fastText supervised model.
+Optionalthreshold?: numberProbability threshold for which a label will be assigned to an input.
Default:
-0.99
--
-
-Optionaltop_k?: number Number of class labels that will be produced per input.
+ Optionaltop_k?: number Number of class labels that will be produced per input.
Default:
-1
--
-
type: "classification"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "classification"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateDelimiterAnalyzerOptions.html b/devel/types/analyzer.CreateDelimiterAnalyzerOptions.html
index 1c1ce039d..ddce985d5 100644
--- a/devel/types/analyzer.CreateDelimiterAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateDelimiterAnalyzerOptions.html
@@ -1,119 +1,7 @@
-
-
-
-
-
-Type alias CreateCollationAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "collation";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "collation";
}
Options for creating a Collation Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    locale: string;
}-Additional properties for the Analyzer.
--
-
-
-
locale: string
-Text locale.
+CreateCollationAnalyzerOptions | arangojs --Type alias CreateCollationAnalyzerOptions
CreateCollation Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "collation";
}Options for creating a Collation Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    locale: string;
}Additional properties for the Analyzer.
+locale: string
Text locale.
Format:
-language[_COUNTRY][.encoding][@variant]
--
-
type: "collation"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "collation"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateGeoJsonAnalyzerOptions.html b/devel/types/analyzer.CreateGeoJsonAnalyzerOptions.html
index 01142824b..5bd88e900 100644
--- a/devel/types/analyzer.CreateGeoJsonAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateGeoJsonAnalyzerOptions.html
@@ -1,138 +1,12 @@
-
-
-
-
-
-Type alias CreateDelimiterAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: string | {
        delimiter: string;
    };
    type: "delimiter";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: string | {
        delimiter: string;
    };
    type: "delimiter";
}
Options for creating a Delimiter Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: string | {
-
    delimiter: string;
}Additional properties for the Analyzer.
+CreateDelimiterAnalyzerOptions | arangojs --Type alias CreateDelimiterAnalyzerOptions
CreateDelimiter Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: string | {
        delimiter: string;
    };
    type: "delimiter";
}Options for creating a Delimiter Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: string | {
    delimiter: string;
}Additional properties for the Analyzer.
The value will be used as delimiter to split text into tokens as specified in RFC 4180, without starting new records on newlines.
-
--
-
type: "delimiter"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
type: "delimiter"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateGeoPointAnalyzerOptions.html b/devel/types/analyzer.CreateGeoPointAnalyzerOptions.html
index d426afc77..2ecd43c7a 100644
--- a/devel/types/analyzer.CreateGeoPointAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateGeoPointAnalyzerOptions.html
@@ -1,140 +1,11 @@
-
-
-
-
-
-Type alias CreateGeoJsonAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
Options for creating a GeoJSON Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    options?: {
        maxCells?: number;
        maxLevel?: number;
        minLevel?: number;
    };
    type?: "shape" | "centroid" | "point";
}-Additional properties for the Analyzer.
--
-
-
-
-Optionaloptions?: {
    maxCells?: number;
    maxLevel?: number;
    minLevel?: number;
}Options for fine-tuning geo queries.
+CreateGeoJsonAnalyzerOptions | arangojs --Type alias CreateGeoJsonAnalyzerOptions
CreateGeo Json Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geojson";
}Options for creating a GeoJSON Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    options?: {
        maxCells?: number;
        maxLevel?: number;
        minLevel?: number;
    };
    type?: "shape" | "centroid" | "point";
}Additional properties for the Analyzer.
+Optionaloptions?: {
    maxCells?: number;
    maxLevel?: number;
    minLevel?: number;
}-Options for fine-tuning geo queries.
Default:
-{ maxCells: 20, minLevel: 4, maxLevel: 23 }-
-
-
-
OptionalmaxCells?: number
- -
-
OptionalmaxLevel?: number
- -
-
OptionalminLevel?: number
--
-
-
-
-Optionaltype?: "shape" | "centroid" | "point"If set to
"centroid", only the centroid of the input geometry will be +OptionalmaxCells?: number OptionalmaxLevel?: number OptionalminLevel?: number
Optionaltype?: "shape" | "centroid" | "point"If set to
"centroid", only the centroid of the input geometry will be computed and indexed.If set to
"point"only GeoJSON objects of type Point will be indexed and all other geometry types will be ignored.Default:
-"shape"
--
-
type: "geojson"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "geojson"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateGeoS2AnalyzerOptions.html b/devel/types/analyzer.CreateGeoS2AnalyzerOptions.html
index 548de88b0..c937a0e87 100644
--- a/devel/types/analyzer.CreateGeoS2AnalyzerOptions.html
+++ b/devel/types/analyzer.CreateGeoS2AnalyzerOptions.html
@@ -1,148 +1,19 @@
-
-
-
-
-
-Type alias CreateGeoPointAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    };
    type: "geopoint";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    };
    type: "geopoint";
}
Options for creating a GeoPoint Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    latitude?: string[];
    longitude?: string[];
    options?: {
        maxLevel?: number;
        minCells?: number;
        minLevel?: number;
    };
}-Additional properties for the Analyzer.
--
-
-
-
-Optionallatitude?: string[]Attribute paths of the latitude value relative to the field for which the +
CreateGeoPointAnalyzerOptions | arangojs --Type alias CreateGeoPointAnalyzerOptions
CreateGeo Point Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        latitude?: string[];
        longitude?: string[];
        options?: {
            maxLevel?: number;
            minCells?: number;
            minLevel?: number;
        };
    };
    type: "geopoint";
}Options for creating a GeoPoint Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    latitude?: string[];
    longitude?: string[];
    options?: {
        maxLevel?: number;
        minCells?: number;
        minLevel?: number;
    };
}Additional properties for the Analyzer.
+Optionallatitude?: string[]Attribute paths of the latitude value relative to the field for which the Analyzer is defined in the View.
-
--
-
-Optionallongitude?: string[]Attribute paths of the longitude value relative to the field for which the +
Optionallongitude?: string[]Attribute paths of the longitude value relative to the field for which the Analyzer is defined in the View.
-
--
-
-Optionaloptions?: {
    maxLevel?: number;
    minCells?: number;
    minLevel?: number;
}Options for fine-tuning geo queries.
+ Optionaloptions?: {
    maxLevel?: number;
    minCells?: number;
    minLevel?: number;
}-Options for fine-tuning geo queries.
Default:
-{ maxCells: 20, minLevel: 4, maxLevel: 23 }-
-
-
-
OptionalmaxLevel?: number
- -
-
OptionalminCells?: number
- -
-
OptionalminLevel?: number
-
-
--
-
type: "geopoint"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
OptionalmaxLevel?: number OptionalminCells?: number OptionalminLevel?: number
-
-
type: "geopoint"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateIdentityAnalyzerOptions.html b/devel/types/analyzer.CreateIdentityAnalyzerOptions.html
index 1671c813f..532223dd1 100644
--- a/devel/types/analyzer.CreateIdentityAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateIdentityAnalyzerOptions.html
@@ -1,118 +1,6 @@
-
-
-
-
-
-Type alias CreateGeoS2AnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
(Enterprise Edition only.) Options for creating a Geo S2 Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    format?: "latLngDouble" | "latLngInt" | "s2Point";
    options?: {
        maxCells?: number;
        maxLevel?: number;
        minLevel?: number;
    };
    type?: "shape" | "centroid" | "point";
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalformat?: "latLngDouble" | "latLngInt" | "s2Point"If set to
"latLngDouble", each latitude and longitude value is stored +CreateGeoS2AnalyzerOptions | arangojs --Type alias CreateGeoS2AnalyzerOptions
CreateGeo S2 Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        format?: "latLngDouble" | "latLngInt" | "s2Point";
        options?: {
            maxCells?: number;
            maxLevel?: number;
            minLevel?: number;
        };
        type?: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}(Enterprise Edition only.) Options for creating a Geo S2 Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    format?: "latLngDouble" | "latLngInt" | "s2Point";
    options?: {
        maxCells?: number;
        maxLevel?: number;
        minLevel?: number;
    };
    type?: "shape" | "centroid" | "point";
}Additional properties for the Analyzer.
+Optionalformat?: "latLngDouble" | "latLngInt" | "s2Point"If set to
"latLngDouble", each latitude and longitude value is stored as an 8-byte floating-point value (16 bytes per coordinate pair).If set to
"latLngInt", each latitude and longitude value is stored as a 4-byte integer value (8 bytes per coordinate pair).If set to
"s2Point", each longitude-latitude pair is stored in the native format of Google S2 (24 bytes per coordinate pair).Default:
-"latLngDouble"
--
-
-Optionaloptions?: {
    maxCells?: number;
    maxLevel?: number;
    minLevel?: number;
}Options for fine-tuning geo queries.
+ Optionaloptions?: {
    maxCells?: number;
    maxLevel?: number;
    minLevel?: number;
}-Options for fine-tuning geo queries.
Default:
-{ maxCells: 20, minLevel: 4, maxLevel: 23 }-
-
-
-
OptionalmaxCells?: number
- -
-
OptionalmaxLevel?: number
- -
-
OptionalminLevel?: number
--
-
-
-
-Optionaltype?: "shape" | "centroid" | "point"If set to
"centroid", only the centroid of the input geometry will be +OptionalmaxCells?: number OptionalmaxLevel?: number OptionalminLevel?: number
Optionaltype?: "shape" | "centroid" | "point"If set to
"centroid", only the centroid of the input geometry will be computed and indexed.If set to
"point"only GeoJSON objects of type Point will be indexed and all other geometry types will be ignored.Default:
-"shape"
--
-
type: "geo_s2"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "geo_s2"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateMinHashAnalyzerOptions.html b/devel/types/analyzer.CreateMinHashAnalyzerOptions.html
index 7074a1ce7..68d6e3161 100644
--- a/devel/types/analyzer.CreateMinHashAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateMinHashAnalyzerOptions.html
@@ -1,126 +1,7 @@
-
-
-
-
-
-Type alias CreateIdentityAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties?: Record<string, never>;
    type: "identity";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties?: Record<string, never>;
    type: "identity";
}
Options for creating an Identity Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
-Optionalproperties?: Record<string, never>Additional properties for the Analyzer.
+CreateIdentityAnalyzerOptions | arangojs --Type alias CreateIdentityAnalyzerOptions
CreateIdentity Analyzer Options: {
    features?: AnalyzerFeature[];
    properties?: Record<string, never>;
    type: "identity";
}Options for creating an Identity Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+Optionalproperties?: Record<string, never>Additional properties for the Analyzer.
The
-identityAnalyzer does not take additional properties.
--
-
type: "identity"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
type: "identity"
Type of the Analyzer.
+
-
-
-
-
-
-
-
-Type alias CreateMinHashAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}
(Enterprise Edition only.) Options for creating a MinHash Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    analyzer: Omit<CreateAnalyzerOptions, "features">;
    numHashes: number;
}-Additional properties for the Analyzer.
--
-
-
-
analyzer: Omit<CreateAnalyzerOptions, "features">
-An Analyzer definition-like object with
-typeandpropertiesattributes.
- -
-
num
-Hashes: number Size of the MinHash signature.
-
- -
-
-
-
type: "minhash"
-Type of the Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateMinHashAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}
    features?: AnalyzerFeature[];
    properties: {
        analyzer: Omit<CreateAnalyzerOptions, "features">;
        numHashes: number;
    };
    type: "minhash";
}
(Enterprise Edition only.) Options for creating a MinHash Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    analyzer: Omit<CreateAnalyzerOptions, "features">;
    numHashes: number;
}Additional properties for the Analyzer.
+analyzer: Omit<CreateAnalyzerOptions, "features">
An Analyzer definition-like object with
+typeandpropertiesattributes.num
Hashes: number Size of the MinHash signature.
+
type: "minhash"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html b/devel/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html
index 3c9bc2c2e..c3156c7b8 100644
--- a/devel/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateNearestNeighborsAnalyzerOptions.html
@@ -1,127 +1,8 @@
-
-
-
-
-
-Type alias CreateMultiDelimiterAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
Options for creating a Multi-Delimiter Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    delimiters: string[];
}Additional properties for the Analyzer.
+CreateMultiDelimiterAnalyzerOptions | arangojs --Type alias CreateMultiDelimiterAnalyzerOptions
CreateMulti Delimiter Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}Options for creating a Multi-Delimiter Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    delimiters: string[];
}-Additional properties for the Analyzer.
The value will be used as delimiter to split text into tokens as specified in RFC 4180, without starting new records on newlines.
--
-
-
-
delimiters: string[]
--
-
-
-
type: "multi_delimiter"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
delimiters: string[]
type: "multi_delimiter"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateNgramAnalyzerOptions.html b/devel/types/analyzer.CreateNgramAnalyzerOptions.html
index bb5cfec19..8e4ec4beb 100644
--- a/devel/types/analyzer.CreateNgramAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateNgramAnalyzerOptions.html
@@ -1,130 +1,8 @@
-
-
-
-
-
-Type alias CreateNearestNeighborsAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        top_k?: number;
    };
    type: "nearest_neighbors";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        top_k?: number;
    };
    type: "nearest_neighbors";
}
(Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    model_location: string;
    top_k?: number;
}-Additional properties for the Analyzer.
--
-
-
-
model_
-location: string On-disk path to the trained fastText supervised model.
-
- -
-
-Optionaltop_k?: number Number of class labels that will be produced per input.
+CreateNearestNeighborsAnalyzerOptions | arangojs --Type alias CreateNearestNeighborsAnalyzerOptions
CreateNearest Neighbors Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        model_location: string;
        top_k?: number;
    };
    type: "nearest_neighbors";
}(Enterprise Edition only.) Options for creating a NearestNeighbors Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    model_location: string;
    top_k?: number;
}Additional properties for the Analyzer.
+model_
location: string On-disk path to the trained fastText supervised model.
+Optionaltop_k?: number Number of class labels that will be produced per input.
Default:
-1
--
-
type: "nearest_neighbors"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "nearest_neighbors"
Type of the Analyzer.
+
-
-
-
-
-
-
-
-Type alias CreateNgramAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
Options for creating an Ngram Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    max: number;
    min: number;
    preserveOriginal: boolean;
}-Additional properties for the Analyzer.
--
-
-
-
max: number
-Maximum n-gram length.
-
- -
-
min: number
-Minimum n-gram length.
-
- -
-
preserve
-Original: boolean Output the original value as well.
-
- -
-
-
-
type: "ngram"
-Type of the Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateNgramAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
    features?: AnalyzerFeature[];
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
Options for creating an Ngram Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    max: number;
    min: number;
    preserveOriginal: boolean;
}Additional properties for the Analyzer.
+max: number
Maximum n-gram length.
+min: number
Minimum n-gram length.
+preserve
Original: boolean Output the original value as well.
+
type: "ngram"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreatePipelineAnalyzerOptions.html b/devel/types/analyzer.CreatePipelineAnalyzerOptions.html
index 7663d12e2..e54a7dfb6 100644
--- a/devel/types/analyzer.CreatePipelineAnalyzerOptions.html
+++ b/devel/types/analyzer.CreatePipelineAnalyzerOptions.html
@@ -1,122 +1,6 @@
-
-
-
-
-
-Type alias CreateNormAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
Options for creating a Norm Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    accent?: boolean;
    case?: "lower" | "none" | "upper";
    locale: string;
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalaccent?: booleanPreserve accents in returned words.
+CreateNormAnalyzerOptions | arangojs --Type alias CreateNormAnalyzerOptions
CreateNorm Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}Options for creating a Norm Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    accent?: boolean;
    case?: "lower" | "none" | "upper";
    locale: string;
}Additional properties for the Analyzer.
+Optionalaccent?: booleanPreserve accents in returned words.
Default:
-false
--
-
-Optionalcase?: "lower" | "none" | "upper"Case conversion.
+ Optionalcase?: "lower" | "none" | "upper"Case conversion.
Default:
-"lower"
--
-
locale: string
-Text locale.
+ locale: string
Text locale.
Format:
-language[_COUNTRY][.encoding][@variant]
--
-
type: "norm"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "norm"
Type of the Analyzer.
+
-
-
-
-
-
-
-
-Type alias CreatePipelineAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}
Options for creating a Pipeline Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    pipeline: Omit<CreateAnalyzerOptions, "features">[];
}-Additional properties for the Analyzer.
--
-
-
-
pipeline: Omit<CreateAnalyzerOptions, "features">[]
-Definitions for Analyzers to chain in this Pipeline Analyzer.
-
- -
-
-
-
type: "pipeline"
-Type of the Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreatePipelineAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}
    features?: AnalyzerFeature[];
    properties: {
        pipeline: Omit<CreateAnalyzerOptions, "features">[];
    };
    type: "pipeline";
}
Options for creating a Pipeline Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    pipeline: Omit<CreateAnalyzerOptions, "features">[];
}Additional properties for the Analyzer.
+pipeline: Omit<CreateAnalyzerOptions, "features">[]
Definitions for Analyzers to chain in this Pipeline Analyzer.
+
type: "pipeline"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateStemAnalyzerOptions.html b/devel/types/analyzer.CreateStemAnalyzerOptions.html
index db49c6e5a..6425c0ef8 100644
--- a/devel/types/analyzer.CreateStemAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateStemAnalyzerOptions.html
@@ -1,122 +1,7 @@
-
-
-
-
-
-Type alias CreateSegmentationAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
Options for creating a Segmentation Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    break?: "all" | "alpha" | "graphic";
    case?: "lower" | "upper" | "none";
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalbreak?: "all" | "alpha" | "graphic"Which tokens should be returned.
+CreateSegmentationAnalyzerOptions | arangojs --Type alias CreateSegmentationAnalyzerOptions
CreateSegmentation Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        break?: "all" | "alpha" | "graphic";
        case?: "lower" | "upper" | "none";
    };
    type: "segmentation";
}Options for creating a Segmentation Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    break?: "all" | "alpha" | "graphic";
    case?: "lower" | "upper" | "none";
}Additional properties for the Analyzer.
+Optionalbreak?: "all" | "alpha" | "graphic"Which tokens should be returned.
Default:
-"alpha"
--
-
-Optionalcase?: "lower" | "upper" | "none"What case all returned tokens should be converted to if applicable.
+ Optionalcase?: "lower" | "upper" | "none"What case all returned tokens should be converted to if applicable.
Default:
-"none"
--
-
type: "segmentation"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "segmentation"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateStopwordsAnalyzerOptions.html b/devel/types/analyzer.CreateStopwordsAnalyzerOptions.html
index cd5fcb387..49e8266df 100644
--- a/devel/types/analyzer.CreateStopwordsAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateStopwordsAnalyzerOptions.html
@@ -1,127 +1,8 @@
-
-
-
-
-
-Type alias CreateStemAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "stem";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "stem";
}
Options for creating a Stem Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    locale: string;
}Additional properties for the Analyzer.
+CreateStemAnalyzerOptions | arangojs --Type alias CreateStemAnalyzerOptions
CreateStem Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        locale: string;
    };
    type: "stem";
}Options for creating a Stem Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    locale: string;
}-Additional properties for the Analyzer.
The value defines the text locale.
Format:
-language[_COUNTRY][.encoding][@variant]-
-
-
-
locale: string
--
-
-
-
type: "stem"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
locale: string
type: "stem"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateTextAnalyzerOptions.html b/devel/types/analyzer.CreateTextAnalyzerOptions.html
index b8319b766..83c33cde9 100644
--- a/devel/types/analyzer.CreateTextAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateTextAnalyzerOptions.html
@@ -1,161 +1,20 @@
-
-
-
-
-
-Type alias CreateStopwordsAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        hex?: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        hex?: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
Options for creating a Stopwords Analyzer
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    hex?: boolean;
    stopwords: string[];
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalhex?: booleanWhether stopword values should be interpreted as hex-encoded strings.
+CreateStopwordsAnalyzerOptions | arangojs --Type alias CreateStopwordsAnalyzerOptions
CreateStopwords Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        hex?: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}Options for creating a Stopwords Analyzer
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    hex?: boolean;
    stopwords: string[];
}Additional properties for the Analyzer.
+Optionalhex?: booleanWhether stopword values should be interpreted as hex-encoded strings.
Default:
-false
--
-
stopwords: string[]
-Array of strings that describe the tokens to be discarded.
-
--
-
type: "stopwords"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
stopwords: string[]
Array of strings that describe the tokens to be discarded.
+
-
-
type: "stopwords"
Type of the Analyzer.
+
-
\ No newline at end of file
diff --git a/devel/types/analyzer.CreateWildcardAnalyzerOptions.html b/devel/types/analyzer.CreateWildcardAnalyzerOptions.html
index 55e19376f..d9c90e499 100644
--- a/devel/types/analyzer.CreateWildcardAnalyzerOptions.html
+++ b/devel/types/analyzer.CreateWildcardAnalyzerOptions.html
@@ -1,126 +1,7 @@
-
-
-
-
-
-Type alias CreateTextAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    };
    type: "text";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    };
    type: "text";
}
Options for creating a Text Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    accent?: boolean;
    case?: "lower" | "none" | "upper";
    edgeNgram?: {
        max?: number;
        min?: number;
        preserveOriginal?: boolean;
    };
    locale: string;
    stemming?: boolean;
    stopwords?: string[];
    stopwordsPath?: string;
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalaccent?: booleanPreserve accents in returned words.
+CreateTextAnalyzerOptions | arangojs --Type alias CreateTextAnalyzerOptions
CreateText Analyzer Options: {
    features?: AnalyzerFeature[];
    properties: {
        accent?: boolean;
        case?: "lower" | "none" | "upper";
        edgeNgram?: {
            max?: number;
            min?: number;
            preserveOriginal?: boolean;
        };
        locale: string;
        stemming?: boolean;
        stopwords?: string[];
        stopwordsPath?: string;
    };
    type: "text";
}Options for creating a Text Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    accent?: boolean;
    case?: "lower" | "none" | "upper";
    edgeNgram?: {
        max?: number;
        min?: number;
        preserveOriginal?: boolean;
    };
    locale: string;
    stemming?: boolean;
    stopwords?: string[];
    stopwordsPath?: string;
}Additional properties for the Analyzer.
+Optionalaccent?: booleanPreserve accents in returned words.
Default:
-false
--
-
-Optionalcase?: "lower" | "none" | "upper"Case conversion.
+ Optionalcase?: "lower" | "none" | "upper"Case conversion.
Default:
-"lower"
--
-
-OptionaledgeNgram?: {
    max?: number;
    min?: number;
    preserveOriginal?: boolean;
}-If present, then edge n-grams are generated for each token (word).
--
-
-
-
Optionalmax?: number
- -
-
Optionalmin?: number
- -
-
OptionalpreserveOriginal?: boolean
- -
-
-
-
locale: string
-Text locale.
+ OptionaledgeNgram?: {
    max?: number;
    min?: number;
    preserveOriginal?: boolean;
}If present, then edge n-grams are generated for each token (word).
+Optionalmax?: numberOptionalmin?: numberOptionalpreserveOriginal?: boolean
locale: string
Text locale.
Format:
-language[_COUNTRY][.encoding][@variant]
--
-
-Optionalstemming?: booleanApply stemming on returned words.
+ Optionalstemming?: booleanApply stemming on returned words.
Default:
-true
--
-
-Optionalstopwords?: string[]Words to omit from result.
+ Optionalstopwords?: string[]Words to omit from result.
Defaults to the words loaded from the file at
-stopwordsPath.
--
-
-OptionalstopwordsPath?: string Path with a
+languagesub-directory containing files with words to omit. OptionalstopwordsPath?: string Path with a
languagesub-directory containing files with words to omit.Defaults to the path specified in the server-side environment variable
-IRESEARCH_TEXT_STOPWORD_PATHor the current working directory of the ArangoDB process.
--
-
type: "text"
-Type of the Analyzer.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
type: "text"
Type of the Analyzer.
+
-
-
-
-
-
-
-
-Type alias CreateWildcardAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}
-Â Â Â Â features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}
Options for creating a Wildcard Analyzer.
-
-
Type declaration
--
-
-
-
-Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
-
- -
-
properties: {
-
    analyzer?: Omit<CreateAnalyzerOptions, "features">;
    ngramSize: string;
}-Additional properties for the Analyzer.
--
-
-
-
-Optionalanalyzer?: Omit<CreateAnalyzerOptions, "features">An Analyzer definition-like object with
-typeandpropertiesattributes.
- -
-
ngram
-Size: string N-gram length. Must be a positive integer greater than or equal to 2.
-
- -
-
-
-
type: "wildcard"
-Type of the Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateWildcardAnalyzerOptions
Create
    features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}
    features?: AnalyzerFeature[];
    properties: {
        analyzer?: Omit<CreateAnalyzerOptions, "features">;
        ngramSize: string;
    };
    type: "wildcard";
}
Options for creating a Wildcard Analyzer.
+Type declaration
Optionalfeatures?: AnalyzerFeature[]Features to enable for this Analyzer.
+properties: {
    analyzer?: Omit<CreateAnalyzerOptions, "features">;
    ngramSize: string;
}Additional properties for the Analyzer.
+Optionalanalyzer?: Omit<CreateAnalyzerOptions, "features">An Analyzer definition-like object with
+typeandpropertiesattributes.ngram
Size: string N-gram length. Must be a positive integer greater than or equal to 2.
+
type: "wildcard"
Type of the Analyzer.
+
-
-
-
-
-
-
-Type alias DelimiterAnalyzerDescription
Delimiter
    properties: {
        delimiter: string;
    };
    type: "delimiter";
}
-Â Â Â Â properties: {
        delimiter: string;
    };
    type: "delimiter";
}
An object describing a Delimiter Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias DelimiterAnalyzerDescription
Delimiter
    properties: {
        delimiter: string;
    };
    type: "delimiter";
}
    properties: {
        delimiter: string;
    };
    type: "delimiter";
}
An object describing a Delimiter Analyzer.
+Type declaration
properties: {
    delimiter: string;
}delimiter: string
type: "delimiter"
-
-
-
-
-
-
-
-
-Type alias GenericAnalyzerDescription
Shared attributes of all Analyzer descriptions.
-
-
Type declaration
--
-
-
-
features: AnalyzerFeature[]
-Features enabled for this Analyzer.
-
- -
-
name: string
-A unique name for this Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GenericAnalyzerDescription
Shared attributes of all Analyzer descriptions.
+Type declaration
features: AnalyzerFeature[]
Features enabled for this Analyzer.
+name: string
A unique name for this Analyzer.
+
-
-
-
-
-
-
-Type alias GeoJsonAnalyzerDescription
Geo
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
-Â Â Â Â properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
An object describing a GeoJSON Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GeoJsonAnalyzerDescription
Geo
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        type: "shape" | "centroid" | "point";
    };
    type: "geojson";
}
An object describing a GeoJSON Analyzer
+Type declaration
properties: {
    description: {
        maxCells: number;
        maxLevel: number;
        minLevel: number;
    };
    type: "shape" | "centroid" | "point";
}description: {
    maxCells: number;
    maxLevel: number;
    minLevel: number;
}max
Cells: number max
Level: number min
Level: number
type: "shape" | "centroid" | "point"
type: "geojson"
-
-
-
-
-
-
-Type alias GeoPointAnalyzerDescription
Geo
    properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}
-Â Â Â Â properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}
An object describing a GeoPoint Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GeoPointAnalyzerDescription
Geo
    properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}
    properties: {
        description: {
            maxLevel: number;
            minCells: number;
            minLevel: number;
        };
        latitude: string[];
        longitude: string[];
    };
    type: "geopoint";
}
An object describing a GeoPoint Analyzer
+Type declaration
properties: {
    description: {
        maxLevel: number;
        minCells: number;
        minLevel: number;
    };
    latitude: string[];
    longitude: string[];
}description: {
    maxLevel: number;
    minCells: number;
    minLevel: number;
}max
Level: number min
Cells: number min
Level: number
latitude: string[]
longitude: string[]
type: "geopoint"
-
-
-
-
-
-
-Type alias GeoS2AnalyzerDescription
Geo
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
-Â Â Â Â properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
(Enterprise Edition only.) An object describing a GeoS2 Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GeoS2AnalyzerDescription
Geo
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
    properties: {
        description: {
            maxCells: number;
            maxLevel: number;
            minLevel: number;
        };
        format: "latLngDouble" | "latLngInt" | "s2Point";
        type: "shape" | "centroid" | "point";
    };
    type: "geo_s2";
}
(Enterprise Edition only.) An object describing a GeoS2 Analyzer
+Type declaration
properties: {
    description: {
        maxCells: number;
        maxLevel: number;
        minLevel: number;
    };
    format: "latLngDouble" | "latLngInt" | "s2Point";
    type: "shape" | "centroid" | "point";
}description: {
    maxCells: number;
    maxLevel: number;
    minLevel: number;
}max
Cells: number max
Level: number min
Level: number
format: "latLngDouble" | "latLngInt" | "s2Point"
type: "shape" | "centroid" | "point"
type: "geo_s2"
-
-
-
-
-
-
-Type alias IdentityAnalyzerDescription
Identity
    properties: Record<string, never>;
    type: "identity";
}
-Â Â Â Â properties: Record<string, never>;
    type: "identity";
}
An object describing an Identity Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias IdentityAnalyzerDescription
Identity
    properties: Record<string, never>;
    type: "identity";
}
    properties: Record<string, never>;
    type: "identity";
}
An object describing an Identity Analyzer.
+Type declaration
properties: Record<string, never>
type: "identity"
-
-
-
-
-
-
-Type alias MinHashAnalyzerDescription
Min
    properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}
-Â Â Â Â properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}
(Enterprise Edition only.) An object describing a MinHash Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias MinHashAnalyzerDescription
Min
    properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}
    properties: {
        analyzer: Omit<AnalyzerDescription, "name" | "features">;
        numHashes: number;
    };
    type: "minhash";
}
(Enterprise Edition only.) An object describing a MinHash Analyzer
+Type declaration
properties: {
    analyzer: Omit<AnalyzerDescription, "name" | "features">;
    numHashes: number;
}analyzer: Omit<AnalyzerDescription, "name" | "features">
num
Hashes: number
type: "minhash"
-
-
-
-
-
-
-Type alias MultiDelimiterAnalyzerDescription
Multi
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
-Â Â Â Â properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
An object describing a Multi Delimiter Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias MultiDelimiterAnalyzerDescription
Multi
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
    properties: {
        delimiters: string[];
    };
    type: "multi_delimiter";
}
An object describing a Multi Delimiter Analyzer.
+Type declaration
properties: {
    delimiters: string[];
}delimiters: string[]
type: "multi_delimiter"
-
-
-
-
-
-
-Type alias NearestNeighborsAnalyzerDescription
Nearest
    properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}
-Â Â Â Â properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}
(Enterprise Edition only.) An object describing a NearestNeighbors Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias NearestNeighborsAnalyzerDescription
Nearest
    properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}
    properties: {
        model_location: string;
        top_k: number;
    };
    type: "nearest_neighbors";
}
(Enterprise Edition only.) An object describing a NearestNeighbors Analyzer
+Type declaration
properties: {
    model_location: string;
    top_k: number;
}model_
location: string top_
k: number
type: "nearest_neighbors"
-
-
-
-
-
-
-Type alias NgramAnalyzerDescription
Ngram
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
-Â Â Â Â properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
An object describing an Ngram Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias NgramAnalyzerDescription
Ngram
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
    properties: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    type: "ngram";
}
An object describing an Ngram Analyzer.
+Type declaration
properties: {
    max: number;
    min: number;
    preserveOriginal: boolean;
}max: number
min: number
preserve
Original: boolean
type: "ngram"
-
-
-
-
-
-
-Type alias NormAnalyzerDescription
Norm
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
-Â Â Â Â properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
An object describing a Norm Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias NormAnalyzerDescription
Norm
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        locale: string;
    };
    type: "norm";
}
An object describing a Norm Analyzer.
+Type declaration
properties: {
    accent: boolean;
    case: "lower" | "none" | "upper";
    locale: string;
}accent: boolean
case: "lower" | "none" | "upper"
locale: string
type: "norm"
-
-
-
-
-
-
-Type alias PipelineAnalyzerDescription
Pipeline
    properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}
-Â Â Â Â properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}
An object describing a Pipeline Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias PipelineAnalyzerDescription
Pipeline
    properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}
    properties: {
        pipeline: Omit<AnalyzerDescription, "name" | "features">[];
    };
    type: "pipeline";
}
An object describing a Pipeline Analyzer
+Type declaration
properties: {
    pipeline: Omit<AnalyzerDescription, "name" | "features">[];
}pipeline: Omit<AnalyzerDescription, "name" | "features">[]
type: "pipeline"
-
-
-
-
-
-
-Type alias SegmentationAnalyzerDescription
Segmentation
    properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
-Â Â Â Â properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
An object describing a Segmentation Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SegmentationAnalyzerDescription
Segmentation
    properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
    properties: {
        break: "all" | "alpha" | "graphic";
        case: "lower" | "upper" | "none";
    };
    type: "segmentation";
}
An object describing a Segmentation Analyzer
+Type declaration
properties: {
    break: "all" | "alpha" | "graphic";
    case: "lower" | "upper" | "none";
}break: "all" | "alpha" | "graphic"
case: "lower" | "upper" | "none"
type: "segmentation"
-
-
-
-
-
-
-Type alias StemAnalyzerDescription
Stem
    properties: {
        locale: string;
    };
    type: "stem";
}
-Â Â Â Â properties: {
        locale: string;
    };
    type: "stem";
}
An object describing a Stem Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias StemAnalyzerDescription
Stem
    properties: {
        locale: string;
    };
    type: "stem";
}
    properties: {
        locale: string;
    };
    type: "stem";
}
An object describing a Stem Analyzer.
+Type declaration
properties: {
    locale: string;
}locale: string
type: "stem"
-
-
-
-
-
-
-Type alias StopwordsAnalyzerDescription
Stopwords
    properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
-Â Â Â Â properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
An object describing a Stopwords Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias StopwordsAnalyzerDescription
Stopwords
    properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
    properties: {
        hex: boolean;
        stopwords: string[];
    };
    type: "stopwords";
}
An object describing a Stopwords Analyzer
+Type declaration
properties: {
    hex: boolean;
    stopwords: string[];
}hex: boolean
stopwords: string[]
type: "stopwords"
-
-
-
-
-
-
-Type alias TextAnalyzerDescription
Text
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}
-Â Â Â Â properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}
An object describing a Text Analyzer.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias TextAnalyzerDescription
Text
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}
    properties: {
        accent: boolean;
        case: "lower" | "none" | "upper";
        edgeNgram: {
            max: number;
            min: number;
            preserveOriginal: boolean;
        };
        locale: string;
        stemming: boolean;
        stopwords: string[];
        stopwordsPath: string;
    };
    type: "text";
}
An object describing a Text Analyzer.
+Type declaration
properties: {
    accent: boolean;
    case: "lower" | "none" | "upper";
    edgeNgram: {
        max: number;
        min: number;
        preserveOriginal: boolean;
    };
    locale: string;
    stemming: boolean;
    stopwords: string[];
    stopwordsPath: string;
}accent: boolean
case: "lower" | "none" | "upper"
edge
Ngram: {
    max: number;
    min: number;
    preserveOriginal: boolean;
}max: number
min: number
preserve
Original: boolean
locale: string
stemming: boolean
stopwords: string[]
stopwords
Path: string
type: "text"
-
-
-
-
-
-
-Type alias WildcardAnalyzerDescription
Wildcard
    properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}
-Â Â Â Â properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}
An object describing a Wildcard Analyzer
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias WildcardAnalyzerDescription
Wildcard
    properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}
    properties: {
        analyzer?: Omit<AnalyzerDescription, "name" | "features">;
        ngramSize: number;
    };
    type: "wildcard";
}
An object describing a Wildcard Analyzer
+Type declaration
properties: {
    analyzer?: Omit<AnalyzerDescription, "name" | "features">;
    ngramSize: number;
}Optionalanalyzer?: Omit<AnalyzerDescription, "name" | "features">ngram
Size: number
type: "wildcard"
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionBatchReadOptions.html b/devel/types/collection.CollectionBatchReadOptions.html
index 90e540e96..2eef8e397 100644
--- a/devel/types/collection.CollectionBatchReadOptions.html
+++ b/devel/types/collection.CollectionBatchReadOptions.html
@@ -1,116 +1,8 @@
-
-AqlValue | arangojs
-
-
-Type alias AqlValue
Aql
-A value that can be used in an AQL template string or passed to an AQL +
Type alias AqlValue
Aql
A value that can be used in an AQL template string or passed to an AQL helper function.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionChecksumOptions.html b/devel/types/collection.CollectionChecksumOptions.html
index e275ab6f7..17810746e 100644
--- a/devel/types/collection.CollectionChecksumOptions.html
+++ b/devel/types/collection.CollectionChecksumOptions.html
@@ -1,122 +1,8 @@
-
-
-
-
-
-Type alias CollectionBatchReadOptions
Collection
    allowDirtyRead?: boolean;
}
-Â Â Â Â allowDirtyRead?: boolean;
}
Options for retrieving multiple documents from a collection.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +CollectionBatchReadOptions | arangojs --Type alias CollectionBatchReadOptions
CollectionBatch Read Options: {
    allowDirtyRead?: boolean;
    ignoreRevs?: boolean;
}Options for retrieving multiple documents from a collection.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
-- \ No newline at end of file +Generated using TypeDoc
OptionalignoreRevs?: boolean If set to
+false, the existing document will only be modified if its +_revproperty matches the same property on the new data.Default:
+true
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionDropOptions.html b/devel/types/collection.CollectionDropOptions.html
index cf6c0622f..59755a852 100644
--- a/devel/types/collection.CollectionDropOptions.html
+++ b/devel/types/collection.CollectionDropOptions.html
@@ -1,117 +1,6 @@
-
-
-
-
-
-Type alias CollectionChecksumOptions
Collection
    withData?: boolean;
    withRevisions?: boolean;
}
-Â Â Â Â withData?: boolean;
    withRevisions?: boolean;
}
Options for retrieving a collection checksum.
-
-
Type declaration
--
-
-
-
-OptionalwithData?: boolean If set to
true, document data will be included in the calculation +CollectionChecksumOptions | arangojs --Type alias CollectionChecksumOptions
CollectionChecksum Options: {
    withData?: boolean;
    withRevisions?: boolean;
}Options for retrieving a collection checksum.
+Type declaration
OptionalwithData?: boolean If set to
true, document data will be included in the calculation of the checksum.Default:
-false
--
-
-OptionalwithRevisions?: boolean If set to
true, revision IDs will be included in the calculation + OptionalwithRevisions?: boolean If set to
true, revision IDs will be included in the calculation of the checksum.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionEdgesOptions.html b/devel/types/collection.CollectionEdgesOptions.html
index da837b61f..357eb84fe 100644
--- a/devel/types/collection.CollectionEdgesOptions.html
+++ b/devel/types/collection.CollectionEdgesOptions.html
@@ -1,116 +1,5 @@
-
-
-
-
-
-Type alias CollectionDropOptions
Collection
    isSystem?: boolean;
}
-Â Â Â Â isSystem?: boolean;
}
Options for dropping collections.
-
-
Type declaration
--
-
-
-
-OptionalisSystem?: boolean Whether the collection is a system collection. If the collection is a +
CollectionDropOptions | arangojs --Type alias CollectionDropOptions
CollectionDrop Options: {
    isSystem?: boolean;
}Options for dropping collections.
+Type declaration
OptionalisSystem?: boolean Whether the collection is a system collection. If the collection is a system collection, this option must be set to
trueor ArangoDB will refuse to drop the collection.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionEdgesResult.html b/devel/types/collection.CollectionEdgesResult.html
index 8f7f9ceb8..e980bc957 100644
--- a/devel/types/collection.CollectionEdgesResult.html
+++ b/devel/types/collection.CollectionEdgesResult.html
@@ -1,124 +1,2 @@
-
-
-
-
-
-Type alias CollectionEdgesOptions
Collection
    allowDirtyRead?: boolean;
}
-Â Â Â Â allowDirtyRead?: boolean;
}
Options for retrieving a document's edges from a collection.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +CollectionEdgesOptions | arangojs --Type alias CollectionEdgesOptions
CollectionEdges Options: {
    allowDirtyRead?: boolean;
}Options for retrieving a document's edges from a collection.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-Type alias CollectionEdgesResult<T>
Collection
    edges: Edge<T>[];
    stats: {
        filtered: number;
        scannedIndex: number;
    };
}
-Â Â Â Â edges: Edge<T>[];
    stats: {
        filtered: number;
        scannedIndex: number;
    };
}
Result of retrieving edges in a collection.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
Type declaration
--
-
-
-
edges: Edge<T>[]
- -
-
stats: {
-
    filtered: number;
    scannedIndex: number;
}-
-
-
-
filtered: number
- -
-
scanned
Index: number
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/types/collection.CollectionImportOptions.html b/devel/types/collection.CollectionImportOptions.html
index 220e89750..9ffb5e6ae 100644
--- a/devel/types/collection.CollectionImportOptions.html
+++ b/devel/types/collection.CollectionImportOptions.html
@@ -1,43 +1,9 @@
-
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionImportResult.html b/devel/types/collection.CollectionImportResult.html
index 7cbaa7667..db3bc3923 100644
--- a/devel/types/collection.CollectionImportResult.html
+++ b/devel/types/collection.CollectionImportResult.html
@@ -1,138 +1,9 @@
-
-
-
-
-
-Type alias CollectionImportOptions
Collection
    complete?: boolean;
    details?: boolean;
    fromPrefix?: string;
    onDuplicate?: "error" | "update" | "replace" | "ignore";
    overwrite?: boolean;
    toPrefix?: string;
    waitForSync?: boolean;
}
-Â Â Â Â complete?: boolean;
    details?: boolean;
    fromPrefix?: string;
    onDuplicate?: "error" | "update" | "replace" | "ignore";
    overwrite?: boolean;
    toPrefix?: string;
    waitForSync?: boolean;
}
Options for bulk importing documents into a collection.
-
-
Type declaration
--
-
-
-
-Optionalcomplete?: booleanIf set to
-true, the import will abort if any error occurs.
- -
-
-Optionaldetails?: booleanWhether the response should contain additional details about documents +
CollectionImportOptions | arangojs --Type alias CollectionImportOptions
CollectionImport Options: {
    complete?: boolean;
    details?: boolean;
    fromPrefix?: string;
    onDuplicate?: "error" | "update" | "replace" | "ignore";
    overwrite?: boolean;
    toPrefix?: string;
    waitForSync?: boolean;
}Options for bulk importing documents into a collection.
+Type declaration
Optionalcomplete?: booleanIf set to
+true, the import will abort if any error occurs.Optionaldetails?: booleanWhether the response should contain additional details about documents that could not be imported.
-
--
-
-OptionalfromPrefix?: string (Edge collections only.) Prefix to prepend to
-_fromattribute values.
- -
-
-OptionalonDuplicate?: "error" | "update" | "replace" | "ignore" Controls behavior when a unique constraint is violated on the document key.
+ OptionalfromPrefix?: string (Edge collections only.) Prefix to prepend to
+_fromattribute values.OptionalonDuplicate?: "error" | "update" | "replace" | "ignore" Controls behavior when a unique constraint is violated on the document key.
"error": the document will not be imported."update: the document will be merged into the existing document.
@@ -46,103 +12,8 @@
OptionalonDuplicate Default:
-"error"
--
-
-Optionaloverwrite?: booleanIf set to
+true, the collection is truncated before the data is imported. Optionaloverwrite?: booleanIf set to
true, the collection is truncated before the data is imported.Default:
-false
--
-
-OptionaltoPrefix?: string (Edge collections only.) Prefix to prepend to
-_toattribute values.
- -
-
-OptionalwaitFor Sync?: boolean Whether to wait for the documents to have been synced to disk.
-
-- \ No newline at end of file +Generated using TypeDoc
OptionaltoPrefix?: string (Edge collections only.) Prefix to prepend to
+_toattribute values.OptionalwaitFor Sync?: boolean Whether to wait for the documents to have been synced to disk.
+
-
-
-
-
-
-
-
-Type alias CollectionImportResult
Collection
    created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}
-Â Â Â Â created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}
Result of a collection bulk import.
-
-
Type declaration
--
-
-
-
created: number
-Number of new documents imported.
-
- -
-
-Optionaldetails?: string[]Additional details about any errors encountered during the import.
-
- -
-
empty: number
-Number of empty documents.
-
- -
-
error: false
-Whether the import failed.
-
- -
-
errors: number
-Number of documents that failed with an error.
-
- -
-
ignored: number
-Number of documents that failed with an error that is ignored.
-
- -
-
updated: number
-Number of documents updated.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CollectionImportResult
Collection
    created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}
    created: number;
    details?: string[];
    empty: number;
    error: false;
    errors: number;
    ignored: number;
    updated: number;
}
Result of a collection bulk import.
+Type declaration
created: number
Number of new documents imported.
+Optionaldetails?: string[]Additional details about any errors encountered during the import.
+empty: number
Number of empty documents.
+error: false
Whether the import failed.
+errors: number
Number of documents that failed with an error.
+ignored: number
Number of documents that failed with an error that is ignored.
+updated: number
Number of documents updated.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionKeyOptions.html b/devel/types/collection.CollectionKeyOptions.html
index 144194cde..55d566ed5 100644
--- a/devel/types/collection.CollectionKeyOptions.html
+++ b/devel/types/collection.CollectionKeyOptions.html
@@ -1,128 +1,8 @@
-
-
-
-
-
-Type alias CollectionInsertOptions
Collection
    mergeObjects?: boolean;
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
-Â Â Â Â mergeObjects?: boolean;
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
Options for inserting a new document into a collection.
-
-
Type declaration
--
-
-
-
-OptionalmergeObjects?: boolean If set to
false, object properties that already exist in the old +CollectionInsertOptions | arangojs --Type alias CollectionInsertOptions
CollectionInsert Options: {
    keepNull?: boolean;
    mergeObjects?: boolean;
    overwriteMode?: "ignore" | "update" | "replace" | "conflict";
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}Options for inserting a new document into a collection.
+Type declaration
OptionalkeepNull?: boolean If set to
+false, properties with a value ofnullwill be removed from +the new document.Default:
+trueOptionalmergeObjects?: boolean If set to
false, object properties that already exist in the old document will be overwritten rather than merged when an existing document with the same_keyor_idis updated. This does not affect arrays.Default:
-true
--
-
-OptionaloverwriteMode?: "ignore" | "update" | "replace" | "conflict" Defines what should happen if a document with the same
_keyor_id+ OptionaloverwriteMode?: "ignore" | "update" | "replace" | "conflict" Defines what should happen if a document with the same
_keyor_idalready exists, instead of throwing an exception.Default: `"conflict"
-
--
-
-OptionalrefillIndex Caches?: boolean If set to
true, new entries will be added to in-memory index caches if + OptionalrefillIndex Caches?: boolean If set to
true, new entries will be added to in-memory index caches if document insertions affect the edge index or cache-enabled persistent indexes.Default:
-false
--
-
-OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenew+ OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenewproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+ OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object. Has no effect ifsilentis set totrue. This option is only available whenoverwriteModeis set to"update"or"replace".Default:
-false
--
-
-Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can + Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can be used to reduce network traffic.Default:
-false
--
-
-OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up +
OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up in the stored document and the attribute value is compared numerically to the value of the versioning attribute in the supplied document that is supposed to update/replace it.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning. OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionKeyProperties.html b/devel/types/collection.CollectionKeyProperties.html
index e422b6af4..d6737c227 100644
--- a/devel/types/collection.CollectionKeyProperties.html
+++ b/devel/types/collection.CollectionKeyProperties.html
@@ -1,130 +1,7 @@
-
-
-
-
-
-Type alias CollectionKeyOptions
Collection
    allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}
-Â Â Â Â allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}
An object defining the collection's key generation.
-
-
Type declaration
--
-
-
-
-OptionalallowUser Keys?: boolean Unless set to
false, documents can be created with a user-specified +CollectionKeyOptions | arangojs --Type alias CollectionKeyOptions
CollectionKey Options: {
    allowUserKeys?: boolean;
    increment?: number;
    offset?: number;
    type?: KeyGenerator;
}An object defining the collection's key generation.
+Type declaration
OptionalallowUser Keys?: boolean Unless set to
false, documents can be created with a user-specified_keyattribute.Default:
-true
--
-
-Optionalincrement?: number(Autoincrement only.) How many steps to increment the key each time.
-
- -
-
-Optionaloffset?: number(Autoincrement only.) Initial offset for the key.
-
- -
-
-Optionaltype?: KeyGeneratorType of key generator to use.
-
-- \ No newline at end of file +Generated using TypeDoc
Optionalincrement?: number(Autoincrement only.) How many steps to increment the key each time.
+Optionaloffset?: number(Autoincrement only.) Initial offset for the key.
+Optionaltype?: KeyGeneratorType of key generator to use.
+
-
-
-
-
-
-
-
-Type alias CollectionKeyProperties
Collection
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}
-Â Â Â Â allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}
An object defining the collection's key generation.
-
-
Type declaration
--
-
-
-
allow
-User Keys: boolean Whether documents can be created with a user-specified
-_keyattribute.
- -
-
-Optionalincrement?: number(Autoincrement only.) How many steps to increment the key each time.
-
- -
-
last
-Value: number Most recent key that has been generated.
-
- -
-
-Optionaloffset?: number(Autoincrement only.) Initial offset for the key.
-
- -
-
type: KeyGenerator
-Type of key generator to use.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CollectionKeyProperties
Collection
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}
    allowUserKeys: boolean;
    increment?: number;
    lastValue: number;
    offset?: number;
    type: KeyGenerator;
}
An object defining the collection's key generation.
+Type declaration
allow
User Keys: boolean Whether documents can be created with a user-specified
+_keyattribute.Optionalincrement?: number(Autoincrement only.) How many steps to increment the key each time.
+last
Value: number Most recent key that has been generated.
+Optionaloffset?: number(Autoincrement only.) Initial offset for the key.
+type: KeyGenerator
Type of key generator to use.
+
-
-
-
-
-
-
-
-Type alias CollectionMetadata
Collection
    globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}
-Â Â Â Â globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}
General information about a collection.
-
-
Type declaration
--
-
-
-
globally
-Unique Id: string A globally unique identifier for this collection.
-
- -
-
name: string
-Collection name.
-
- -
-
status: CollectionStatus
-An integer indicating the collection loading status.
-
- -
-
type: CollectionType
-An integer indicating the collection type.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CollectionMetadata
Collection
    globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}
    globallyUniqueId: string;
    name: string;
    status: CollectionStatus;
    type: CollectionType;
}
General information about a collection.
+Type declaration
globally
Unique Id: string A globally unique identifier for this collection.
+name: string
Collection name.
+status: CollectionStatus
An integer indicating the collection loading status.
+type: CollectionType
An integer indicating the collection type.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionPropertiesOptions.html b/devel/types/collection.CollectionPropertiesOptions.html
index aa1fe5c00..3036341ec 100644
--- a/devel/types/collection.CollectionPropertiesOptions.html
+++ b/devel/types/collection.CollectionPropertiesOptions.html
@@ -1,139 +1,13 @@
-
-
-
-
-
-Type alias CollectionProperties
Collection
    cacheEnabled: boolean;
    computedValues: ComputedValueProperties[];
    distributeShardsLike?: string;
    isDisjoint?: string;
    isSmart?: boolean;
    keyOptions: CollectionKeyProperties;
    numberOfShards?: number;
    replicationFactor?: number | "satellite";
    schema: SchemaProperties | null;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    statusString: string;
    syncByRevision: boolean;
    waitForSync: boolean;
    writeConcern: number;
}
-Â Â Â Â cacheEnabled: boolean;
    computedValues: ComputedValueProperties[];
    distributeShardsLike?: string;
    isDisjoint?: string;
    isSmart?: boolean;
    keyOptions: CollectionKeyProperties;
    numberOfShards?: number;
    replicationFactor?: number | "satellite";
    schema: SchemaProperties | null;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    statusString: string;
    syncByRevision: boolean;
    waitForSync: boolean;
    writeConcern: number;
}
An object defining the properties of a collection.
-
-
Type declaration
--
-
-
-
cache
-Enabled: boolean Whether the in-memory hash cache is enabled for this collection.
-
- -
-
computed
-Values: ComputedValueProperties[] Computed values applied to documents in this collection.
-
- -
-
-OptionaldistributeShards Like?: string (Enterprise Edition cluster only.) If set to a collection name, sharding +
CollectionProperties | arangojs --Type alias CollectionProperties
CollectionProperties: {
    cacheEnabled: boolean;
    computedValues: ComputedValueProperties[];
    distributeShardsLike?: string;
    isDisjoint?: string;
    isSmart?: boolean;
    keyOptions: CollectionKeyProperties;
    numberOfShards?: number;
    replicationFactor?: number | "satellite";
    schema: SchemaProperties | null;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    statusString: string;
    syncByRevision: boolean;
    waitForSync: boolean;
    writeConcern: number;
}An object defining the properties of a collection.
+Type declaration
cache
Enabled: boolean Whether the in-memory hash cache is enabled for this collection.
+computed
Values: ComputedValueProperties[] Computed values applied to documents in this collection.
+OptionaldistributeShards Like?: string (Enterprise Edition cluster only.) If set to a collection name, sharding of the new collection will follow the rules for that collection. As long as the new collection exists, the indicated collection can not be dropped.
-
--
-
-OptionalisDisjoint?: string (Enterprise Edition only.) Whether the SmartGraph this collection belongs to is disjoint.
-
- -
-
-OptionalisSmart?: boolean (Enterprise Edition only.) Whether the collection is used in a SmartGraph or EnterpriseGraph.
-
- -
-
key
-Options: CollectionKeyProperties An object defining the collection's key generation.
-
- -
-
-OptionalnumberOf Shards?: number (Cluster only.) Number of shards of this collection.
-
- -
-
-OptionalreplicationFactor?: number | "satellite" (Cluster only.) Replication factor of the collection.
-
- -
-
schema: SchemaProperties | null
-Properties for validating documents in the collection.
-
- -
-
-OptionalshardKeys?: string[] (Cluster only.) Keys of this collection that will be used for +
OptionalisDisjoint?: string (Enterprise Edition only.) Whether the SmartGraph this collection belongs to is disjoint.
+OptionalisSmart?: boolean (Enterprise Edition only.) Whether the collection is used in a SmartGraph or EnterpriseGraph.
+key
Options: CollectionKeyProperties An object defining the collection's key generation.
+OptionalnumberOf Shards?: number (Cluster only.) Number of shards of this collection.
+OptionalreplicationFactor?: number | "satellite" (Cluster only.) Replication factor of the collection.
+schema: SchemaProperties | null
Properties for validating documents in the collection.
+OptionalshardKeys?: string[] (Cluster only.) Keys of this collection that will be used for sharding.
-
--
-
-OptionalshardingStrategy?: ShardingStrategy (Cluster only.) Sharding strategy of the collection.
-
- -
-
-OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute used for sharding.
-
- -
-
-OptionalsmartJoin Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key +
OptionalshardingStrategy?: ShardingStrategy (Cluster only.) Sharding strategy of the collection.
+OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute used for sharding.
+OptionalsmartJoin Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key value of the referred-to smart join collection.
-
--
-
status
-String: string A human-readable representation of the collection loading status.
-
- -
-
sync
-By Revision: boolean Whether the newer revision-based replication protocol is enabled for +
status
String: string A human-readable representation of the collection loading status.
+sync
By Revision: boolean Whether the newer revision-based replication protocol is enabled for this collection.
-
--
-
wait
-For Sync: boolean Whether data should be synchronized to disk before returning from +
wait
For Sync: boolean Whether data should be synchronized to disk before returning from a document create, update, replace or removal operation.
-
--
-
write
-Concern: number (Cluster only.) Write concern for this collection.
-
-- \ No newline at end of file +Generated using TypeDoc
write
Concern: number (Cluster only.) Write concern for this collection.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionReadOptions.html b/devel/types/collection.CollectionReadOptions.html
index 52e8f493e..3f62d46d9 100644
--- a/devel/types/collection.CollectionReadOptions.html
+++ b/devel/types/collection.CollectionReadOptions.html
@@ -1,132 +1,12 @@
-
-
-
-
-
-Type alias CollectionPropertiesOptions
Collection
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    replicationFactor?: number | "satellite";
    schema?: SchemaOptions;
    waitForSync?: boolean;
    writeConcern?: number;
}
-Â Â Â Â cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    replicationFactor?: number | "satellite";
    schema?: SchemaOptions;
    waitForSync?: boolean;
    writeConcern?: number;
}
Options for setting a collection's properties.
-See properties and properties.
-
-
Type declaration
--
-
-
-
-OptionalcacheEnabled?: boolean Whether the in-memory hash cache is enabled for this collection.
+CollectionPropertiesOptions | arangojs --Type alias CollectionPropertiesOptions
CollectionProperties Options: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    replicationFactor?: number | "satellite";
    schema?: SchemaOptions;
    waitForSync?: boolean;
    writeConcern?: number;
}Options for setting a collection's properties.
+See DocumentCollection#properties and EdgeCollection#properties.
+Type declaration
OptionalcacheEnabled?: boolean Whether the in-memory hash cache is enabled for this collection.
Default:
-false
--
-
-OptionalcomputedValues?: ComputedValueOptions[] Computed values to apply to documents in this collection.
-
- -
-
-OptionalreplicationFactor?: number | "satellite" (Cluster only.) How many copies of each document should be kept in the +
OptionalcomputedValues?: ComputedValueOptions[] Computed values to apply to documents in this collection.
+OptionalreplicationFactor?: number | "satellite" (Cluster only.) How many copies of each document should be kept in the cluster.
Default:
-1
--
-
-Optionalschema?: SchemaOptionsOptions for validating documents in this collection.
-
- -
-
-OptionalwaitFor Sync?: boolean Whether data should be synchronized to disk before returning from +
Optionalschema?: SchemaOptionsOptions for validating documents in this collection.
+OptionalwaitFor Sync?: boolean Whether data should be synchronized to disk before returning from a document create, update, replace or removal operation.
-
--
-
-OptionalwriteConcern?: number (Cluster only.) Write concern for this collection.
-
-- \ No newline at end of file +Generated using TypeDoc
OptionalwriteConcern?: number (Cluster only.) Write concern for this collection.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionRemoveOptions.html b/devel/types/collection.CollectionRemoveOptions.html
index d28f19dfc..a244a864e 100644
--- a/devel/types/collection.CollectionRemoveOptions.html
+++ b/devel/types/collection.CollectionRemoveOptions.html
@@ -1,139 +1,16 @@
-
-
-
-
-
-Type alias CollectionReadOptions
Collection
    allowDirtyRead?: boolean;
    graceful?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}
-Â Â Â Â allowDirtyRead?: boolean;
    graceful?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}
Options for retrieving a document from a collection.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +CollectionReadOptions | arangojs --Type alias CollectionReadOptions
CollectionRead Options: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}Options for retrieving a document from a collection.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
--
-
-Optionalgraceful?: booleanIf set to
true,nullis returned instead of an exception being thrown + Optionalgraceful?: booleanIf set to
-true,nullis returned instead of an exception being thrown if the document does not exist.
--
-
-OptionalifMatch?: string If set to a document revision, the request will fail with an error if the +
OptionalifMatch?: string If set to a document revision, the request will fail with an error if the document exists but its
-_revdoes not match the given revision.
--
-
-OptionalifNone Match?: string If set to a document revision, the request will fail with an error if the +
OptionalifNone Match?: string If set to a document revision, the request will fail with an error if the document exists and its
-_revmatches the given revision. Note that anHttpErrorwith code 304 will be thrown instead of anArangoError.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionReplaceOptions.html b/devel/types/collection.CollectionReplaceOptions.html
index 9aae0d7bf..432fae0f1 100644
--- a/devel/types/collection.CollectionReplaceOptions.html
+++ b/devel/types/collection.CollectionReplaceOptions.html
@@ -1,158 +1,26 @@
-
-
-
-
-
-Type alias CollectionRemoveOptions
Collection
    ifMatch?: string;
    refillIndexCaches?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
-Â Â Â Â ifMatch?: string;
    refillIndexCaches?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
Options for removing a document from a collection.
-
-
Type declaration
--
-
-
-
-OptionalifMatch?: string If set to a document revision, the document will only be removed if its +
CollectionRemoveOptions | arangojs --Type alias CollectionRemoveOptions
CollectionRemove Options: {
    ifMatch?: string;
    refillIndexCaches?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}Options for removing a document from a collection.
+Type declaration
OptionalifMatch?: string If set to a document revision, the document will only be removed if its
-_revmatches the given revision.
--
-
-OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be + OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be deleted if document removals affect the edge index or cache-enabled persistent indexes.Default:
-false
--
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+ OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can + Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can be used to reduce network traffic.Default:
-false
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, changes will be synchronized to disk before returning. OptionalwaitFor Sync?: boolean If set to
true, changes will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CollectionTruncateOptions.html b/devel/types/collection.CollectionTruncateOptions.html
new file mode 100644
index 000000000..3fcc409c8
--- /dev/null
+++ b/devel/types/collection.CollectionTruncateOptions.html
@@ -0,0 +1,5 @@
+
-
-
-
-
-Type alias CollectionReplaceOptions
Collection
    ifMatch?: string;
    ignoreRevs?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
-Â Â Â Â ifMatch?: string;
    ignoreRevs?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
Options for replacing an existing document in a collection.
-
-
Type declaration
--
-
-
-
-OptionalifMatch?: string If set to a document revision, the document will only be replaced if its +
CollectionReplaceOptions | arangojs --Type alias CollectionReplaceOptions
CollectionReplace Options: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}Options for replacing an existing document in a collection.
+Type declaration
OptionalifMatch?: string If set to a document revision, the document will only be replaced if its
-_revmatches the given revision.
--
-
-OptionalignoreRevs?: boolean If set to
false, the existing document will only be modified if its + OptionalignoreRevs?: boolean If set to
false, the existing document will only be modified if its_revproperty matches the same property on the new data.Default:
-true
--
-
-OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be + OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be updated if document replacements affect the edge index or cache-enabled persistent indexes.Default:
-false
--
-
-OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenew+ OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenewproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+ OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can + Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can be used to reduce network traffic.Default:
-false
--
-
-OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up +
OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up in the stored document and the attribute value is compared numerically to the value of the versioning attribute in the supplied document that is supposed to update/replace it.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning. OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
Type alias CollectionTruncateOptions
Collection
    compact?: boolean;
    waitForSync?: boolean;
}
    compact?: boolean;
    waitForSync?: boolean;
}
Options for truncating collections.
+Type declaration
Optionalcompact?: booleanWhether the collection should be compacted after truncation.
+OptionalwaitFor Sync?: boolean Whether data should be synchronized to disk before returning from this +operation.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.ComputedValueOptions.html b/devel/types/collection.ComputedValueOptions.html
index 391627951..12a9168de 100644
--- a/devel/types/collection.ComputedValueOptions.html
+++ b/devel/types/collection.ComputedValueOptions.html
@@ -1,143 +1,17 @@
-
-
-
-
-
-Type alias CollectionUpdateOptions
Collection
    ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
-Â Â Â Â ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}
Options for updating a document in a collection.
-
-
Type declaration
--
-
-
-
-OptionalifMatch?: string If set to a document revision, the document will only be updated if its +
CollectionUpdateOptions | arangojs --Type alias CollectionUpdateOptions
CollectionUpdate Options: {
    ifMatch?: string;
    ignoreRevs?: boolean;
    keepNull?: boolean;
    mergeObjects?: boolean;
    refillIndexCaches?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    silent?: boolean;
    versionAttribute?: string;
    waitForSync?: boolean;
}Options for updating a document in a collection.
+Type declaration
OptionalifMatch?: string If set to a document revision, the document will only be updated if its
-_revmatches the given revision.
--
-
-OptionalignoreRevs?: boolean If set to
false, the existing document will only be modified if its + OptionalignoreRevs?: boolean If set to
false, the existing document will only be modified if its_revproperty matches the same property on the new data.Default:
-true
--
-
-OptionalkeepNull?: boolean If set to
false, properties with a value ofnullwill be removed from + OptionalkeepNull?: boolean If set to
false, properties with a value ofnullwill be removed from the new document.Default:
-true
--
-
-OptionalmergeObjects?: boolean If set to
false, object properties that already exist in the old + OptionalmergeObjects?: boolean If set to
false, object properties that already exist in the old document will be overwritten rather than merged. This does not affect arrays.Default:
-true
--
-
-OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be + OptionalrefillIndex Caches?: boolean If set to
true, existing entries in in-memory index caches will be updated if document updates affect the edge index or cache-enabled persistent indexes.Default:
-false
--
-
-OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenew+ OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenewproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+ OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object. Has no effect ifsilentis set totrue.Default:
-false
--
-
-Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can + Optionalsilent?: booleanIf set to
true, no data will be returned by the server. This option can be used to reduce network traffic.Default:
-false
--
-
-OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up +
OptionalversionAttribute?: string If set, the attribute with the name specified by the option is looked up in the stored document and the attribute value is compared numerically to the value of the versioning attribute in the supplied document that is supposed to update/replace it.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning. OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.ComputedValueProperties.html b/devel/types/collection.ComputedValueProperties.html
index 69efb6603..800154e87 100644
--- a/devel/types/collection.ComputedValueProperties.html
+++ b/devel/types/collection.ComputedValueProperties.html
@@ -1,138 +1,12 @@
-
-
-
-
-
-Type alias ComputedValueOptions
Computed
    computeOn?: WriteOperation[];
    expression: string | AqlLiteral | AqlQuery;
    failOnWarning?: boolean;
    keepNull?: boolean;
    name: string;
    overwrite?: boolean;
}
-Â Â Â Â computeOn?: WriteOperation[];
    expression: string | AqlLiteral | AqlQuery;
    failOnWarning?: boolean;
    keepNull?: boolean;
    name: string;
    overwrite?: boolean;
}
Options for creating a computed value.
-
-
Type declaration
--
-
-
-
-OptionalcomputeOn?: WriteOperation[] Which operations should result in the value being computed.
+ComputedValueOptions | arangojs --Type alias ComputedValueOptions
ComputedValue Options: {
    computeOn?: WriteOperation[];
    expression: string | AqlLiteral | AqlQuery;
    failOnWarning?: boolean;
    keepNull?: boolean;
    name: string;
    overwrite?: boolean;
}Options for creating a computed value.
+Type declaration
OptionalcomputeOn?: WriteOperation[] Which operations should result in the value being computed.
Default:
-["insert", "update", "replace"]
--
-
expression: string | AqlLiteral | AqlQuery
-AQL
+RETURNexpression that computes the value. expression: string | AqlLiteral | AqlQuery
AQL
RETURNexpression that computes the value.Note that when passing an AQL query object, the
-bindVarswill be ignored.
--
-
-OptionalfailOn Warning?: boolean Whether the write operation should fail if the expression produces a +
OptionalfailOn Warning?: boolean Whether the write operation should fail if the expression produces a warning.
Default:
-false
--
-
-OptionalkeepNull?: boolean If set to
false, the field will be unset if the expression evaluates to + OptionalkeepNull?: boolean If set to
false, the field will be unset if the expression evaluates tonull. Otherwise the field will be set to the valuenull. Has no effect ifoverwriteis set tofalse.Default:
-true
--
-
name: string
-Name of the target attribute of the computed value.
-
- -
-
-Optionaloverwrite?: booleanIf set to
false, the computed value will not be applied if the + name: string
Name of the target attribute of the computed value.
+Optionaloverwrite?: booleanIf set to
false, the computed value will not be applied if the expression evaluates tonull.Default:
-true
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.CreateCollectionOptions.html b/devel/types/collection.CreateCollectionOptions.html
index 42f6f7c78..d6f9e2856 100644
--- a/devel/types/collection.CreateCollectionOptions.html
+++ b/devel/types/collection.CreateCollectionOptions.html
@@ -1,186 +1,33 @@
-
-
-
-
-
-Type alias ComputedValueProperties
Computed
    computeOn: WriteOperation[];
    expression: string;
    failOnWarning: boolean;
    keepNull: boolean;
    name: string;
    overwrite: boolean;
}
-Â Â Â Â computeOn: WriteOperation[];
    expression: string;
    failOnWarning: boolean;
    keepNull: boolean;
    name: string;
    overwrite: boolean;
}
Properties defining a computed value.
-
-
Type declaration
--
-
-
-
compute
-On: WriteOperation[] Which operations should result in the value being computed.
-
- -
-
expression: string
-AQL
-RETURNexpression that computes the value.
- -
-
fail
-On Warning: boolean Whether the write operation should fail if the expression produces a +
ComputedValueProperties | arangojs --Type alias ComputedValueProperties
ComputedValue Properties: {
    computeOn: WriteOperation[];
    expression: string;
    failOnWarning: boolean;
    keepNull: boolean;
    name: string;
    overwrite: boolean;
}Properties defining a computed value.
+Type declaration
compute
On: WriteOperation[] Which operations should result in the value being computed.
+expression: string
AQL
+RETURNexpression that computes the value.fail
On Warning: boolean Whether the write operation should fail if the expression produces a warning.
-
--
-
keep
-Null: boolean If set to
false, the field will be unset if the expression evaluates to + keep
Null: boolean If set to
-false, the field will be unset if the expression evaluates tonull. Otherwise the field will be set to the valuenull. Has no effect ifoverwriteis set tofalse.
--
-
name: string
-Name of the target attribute of the computed value.
-
- -
-
overwrite: boolean
-If set to
false, the computed value will not be applied if the + name: string
Name of the target attribute of the computed value.
+overwrite: boolean
If set to
-false, the computed value will not be applied if the expression evaluates tonull.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/collection.DocumentExistsOptions.html b/devel/types/collection.DocumentExistsOptions.html
index 2ff022012..8dfe27e3f 100644
--- a/devel/types/collection.DocumentExistsOptions.html
+++ b/devel/types/collection.DocumentExistsOptions.html
@@ -1,120 +1,9 @@
-
-
-
-
-
-Type alias CreateCollectionOptions
Create
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    distributeShardsLike?: string;
    enforceReplicationFactor?: boolean;
    keyOptions?: CollectionKeyOptions;
    numberOfShards?: number;
    replicationFactor?: number;
    schema?: SchemaOptions;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    waitForSync?: boolean;
    waitForSyncReplication?: boolean;
    writeConcern?: number;
}
-Â Â Â Â cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    distributeShardsLike?: string;
    enforceReplicationFactor?: boolean;
    keyOptions?: CollectionKeyOptions;
    numberOfShards?: number;
    replicationFactor?: number;
    schema?: SchemaOptions;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    waitForSync?: boolean;
    waitForSyncReplication?: boolean;
    writeConcern?: number;
}
Options for creating a collection.
-See createCollection, createEdgeCollection -and create or create.
-
-
Type declaration
--
-
-
-
-OptionalcacheEnabled?: boolean Whether the in-memory hash cache is enabled for this collection.
-
- -
-
-OptionalcomputedValues?: ComputedValueOptions[] Computed values to apply to documents in this collection.
-
- -
-
-OptionaldistributeShards Like?: string (Enterprise Edition cluster only.) If set to a collection name, sharding +
CreateCollectionOptions | arangojs --Type alias CreateCollectionOptions
CreateCollection Options: {
    cacheEnabled?: boolean;
    computedValues?: ComputedValueOptions[];
    distributeShardsLike?: string;
    enforceReplicationFactor?: boolean;
    keyOptions?: CollectionKeyOptions;
    numberOfShards?: number;
    replicationFactor?: number;
    schema?: SchemaOptions;
    shardKeys?: string[];
    shardingStrategy?: ShardingStrategy;
    smartGraphAttribute?: string;
    smartJoinAttribute?: string;
    waitForSync?: boolean;
    waitForSyncReplication?: boolean;
    writeConcern?: number;
}Options for creating a collection.
+See database.Database#createCollection, database.Database#createEdgeCollection +and DocumentCollection#create or EdgeCollection#create.
+Type declaration
OptionalcacheEnabled?: boolean Whether the in-memory hash cache is enabled for this collection.
+OptionalcomputedValues?: ComputedValueOptions[] Computed values to apply to documents in this collection.
+OptionaldistributeShards Like?: string (Enterprise Edition cluster only.) If set to a collection name, sharding of the new collection will follow the rules for that collection. As long as the new collection exists, the indicated collection can not be dropped.
-
--
-
-OptionalenforceReplication Factor?: boolean (Cluster only.) Unless set to
false, the server will check whether + OptionalenforceReplication Factor?: boolean (Cluster only.) Unless set to
false, the server will check whether enough replicas are available at creation time and bail out otherwise.Default:
-true
--
-
-OptionalkeyOptions?: CollectionKeyOptions An object defining the collection's key generation.
-
- -
-
-OptionalnumberOf Shards?: number (Cluster only.) Number of shards to distribute the collection across.
+ OptionalkeyOptions?: CollectionKeyOptions An object defining the collection's key generation.
+OptionalnumberOf Shards?: number (Cluster only.) Number of shards to distribute the collection across.
Default:
-1
--
-
-OptionalreplicationFactor?: number (Cluster only.) How many copies of each document should be kept in the +
OptionalreplicationFactor?: number (Cluster only.) How many copies of each document should be kept in the cluster.
Default:
-1
--
-
-Optionalschema?: SchemaOptionsOptions for validating documents in the collection.
-
- -
-
-OptionalshardKeys?: string[] (Cluster only.) Document attributes to use to determine the target shard +
Optionalschema?: SchemaOptionsOptions for validating documents in the collection.
+OptionalshardKeys?: string[] (Cluster only.) Document attributes to use to determine the target shard for each document.
Default:
-["_key"]
--
-
-OptionalshardingStrategy?: ShardingStrategy (Cluster only.) Sharding strategy to use.
-
- -
-
-OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute used for sharding.
-
- -
-
-OptionalsmartJoin Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key +
OptionalshardingStrategy?: ShardingStrategy (Cluster only.) Sharding strategy to use.
+OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute used for sharding.
+OptionalsmartJoin Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key value of the referred-to smart join collection.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning from + OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning from a document create, update, replace or removal operation.Default:
-false
--
-
-OptionalwaitFor Sync Replication?: boolean (Cluster only.) Unless set to
false, the server will wait for all + OptionalwaitFor Sync Replication?: boolean (Cluster only.) Unless set to
false, the server will wait for all replicas to create the collection before returning.Default:
-true
--
-
-OptionalwriteConcern?: number (Cluster only.) Write concern for this collection.
-
-- \ No newline at end of file +Generated using TypeDoc
OptionalwriteConcern?: number (Cluster only.) Write concern for this collection.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.DocumentOperationFailure.html b/devel/types/collection.DocumentOperationFailure.html
index 19667b413..91388bb84 100644
--- a/devel/types/collection.DocumentOperationFailure.html
+++ b/devel/types/collection.DocumentOperationFailure.html
@@ -1,122 +1,5 @@
-
-
-
-
-
-Type alias DocumentExistsOptions
Document
    ifMatch?: string;
    ifNoneMatch?: string;
}
-Â Â Â Â ifMatch?: string;
    ifNoneMatch?: string;
}
Options for checking whether a document exists in a collection.
-
-
Type declaration
--
-
-
-
-OptionalifMatch?: string If set to a document revision, the document will only match if its
_rev+DocumentExistsOptions | arangojs --Type alias DocumentExistsOptions
DocumentExists Options: {
    allowDirtyRead?: boolean;
    ifMatch?: string;
    ifNoneMatch?: string;
}Options for checking whether a document exists in a collection.
+Type declaration
OptionalallowDirty Read?: boolean If set to
+true, the request will explicitly permit ArangoDB to return a +potentially dirty or stale result and arangojs will load balance the +request without distinguishing between leaders and followers.OptionalifMatch?: string If set to a document revision, the document will only match if its
-_revmatches the given revision.
--
-
-OptionalifNone Match?: string If set to a document revision, the document will only match if its
_rev+ OptionalifNone Match?: string If set to a document revision, the document will only match if its
-_revdoes not match the given revision.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias DocumentOperationFailure
Document
    error: true;
    errorMessage: string;
    errorNum: number;
}
-Â Â Â Â error: true;
    errorMessage: string;
    errorNum: number;
}
Represents a bulk operation failure for an individual document.
-
-
Type declaration
--
-
-
-
error: true
-Indicates that the operation failed.
-
- -
-
error
-Message: string Human-readable description of the failure.
-
- -
-
error
-Num: number Numeric representation of the failure.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias DocumentOperationFailure
Document
    error: true;
    errorMessage: string;
    errorNum: number;
}
    error: true;
    errorMessage: string;
    errorNum: number;
}
Represents a bulk operation failure for an individual document.
+Type declaration
error: true
Indicates that the operation failed.
+error
Message: string Human-readable description of the failure.
+error
Num: number Numeric representation of the failure.
+
-
-
-
-
-
-
-
-Type alias DocumentOperationMetadata
Metadata returned by a document operation.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias DocumentOperationMetadata
Metadata returned by a document operation.
+Type declaration
Optional_oldRev?: string Revision of the document that was updated or replaced by this operation.
+
Type alias IndexListOptions
Index
    withHidden?: boolean;
    withStats?: boolean;
}
    withHidden?: boolean;
    withStats?: boolean;
}
Type declaration
OptionalwithHidden?: boolean If set to
+true, includes internal indexes as well as indexes that are +not yet fully built but are in the building phase.You should cast the resulting indexes to
+HiddenIndexto ensure internal +and incomplete indexes are accurately represented.Default:
+false.OptionalwithStats?: boolean If set to
+true, includes additional information about each index.Default:
+false
-
-
-
-
-
-
-Type alias KeyGenerator
Key
-Type of key generator.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias KeyGenerator
Key
Type of key generator.
+
-
\ No newline at end of file
diff --git a/devel/types/collection.SchemaProperties.html b/devel/types/collection.SchemaProperties.html
index 54318c33f..bf7f80888 100644
--- a/devel/types/collection.SchemaProperties.html
+++ b/devel/types/collection.SchemaProperties.html
@@ -1,126 +1,6 @@
-
-
-
-
-
-
-Type alias SchemaOptions
Options for validating collection documents.
-
-
Type declaration
--
-
-
-
-Optionallevel?: ValidationLevelWhen validation should be applied.
+SchemaOptions | arangojs --Type alias SchemaOptions
Options for validating collection documents.
+Type declaration
Optionallevel?: ValidationLevelWhen validation should be applied.
Default:
-"strict"
--
-
-Optionalmessage?: stringMessage to be used if validation fails.
-
- -
-
rule: any
-JSON Schema description of the validation schema for documents.
-
-- \ No newline at end of file +Generated using TypeDoc
Optionalmessage?: stringMessage to be used if validation fails.
+rule: any
JSON Schema description of the validation schema for documents.
+
-
-
-
-
-
-
-
-Type alias SchemaProperties
Schema
    level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}
-Â Â Â Â level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}
Properties for validating documents in a collection.
-
-
Type declaration
--
-
-
-
level: ValidationLevel
-When validation should be applied.
-
- -
-
message: string
-Message to be used if validation fails.
-
- -
-
rule: any
-JSON Schema description of the validation schema for documents.
-
- -
-
type: "json"
-Type of document validation.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SchemaProperties
Schema
    level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}
    level: ValidationLevel;
    message: string;
    rule: any;
    type: "json";
}
Properties for validating documents in a collection.
+Type declaration
level: ValidationLevel
When validation should be applied.
+message: string
Message to be used if validation fails.
+rule: any
JSON Schema description of the validation schema for documents.
+type: "json"
Type of document validation.
+
-
-
-
-
-
-
-Type alias ShardingStrategy
Sharding
-Strategy for sharding a collection.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ShardingStrategy
Sharding
Strategy for sharding a collection.
+
-
-
-
-
-
-
-
-Type alias SimpleQueryAllOptions
Simple
    batchSize?: number;
    limit?: number;
    skip?: number;
    stream?: boolean;
    ttl?: number;
}
-Â Â Â Â batchSize?: number;
    limit?: number;
    skip?: number;
    stream?: boolean;
    ttl?: number;
}
Options for retrieving all documents in a collection.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-OptionalbatchSize?: number Number of result values to be transferred by the server in each -network roundtrip (or "batch").
-Must be greater than zero.
-See also QueryOptions.
-
- -
-
-Optionallimit?: numberMaximum number of documents to return.
-
- -
-
-Optionalskip?: numberNumber of documents to skip in the query.
-
- -
-
-Optionalstream?: booleanIf set to
-true, the query will be executed as a streaming query.See also QueryOptions.
-
- -
-
-Optionalttl?: numberTime-to-live for the cursor in seconds. The cursor results may be -garbage collected by ArangoDB after this much time has passed.
-See also QueryOptions.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryByExampleOptions.html b/devel/types/collection.SimpleQueryByExampleOptions.html
deleted file mode 100644
index 1bd2fb27c..000000000
--- a/devel/types/collection.SimpleQueryByExampleOptions.html
+++ /dev/null
@@ -1,134 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryByExampleOptions
Simple
    batchSize?: number;
    limit?: number;
    skip?: number;
    ttl?: number;
}
-Â Â Â Â batchSize?: number;
    limit?: number;
    skip?: number;
    ttl?: number;
}
Options for retrieving documents by example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-OptionalbatchSize?: number Number of result values to be transferred by the server in each -network roundtrip (or "batch").
-Must be greater than zero.
-See also QueryOptions.
-
- -
-
-Optionallimit?: numberMaximum number of documents to return.
-
- -
-
-Optionalskip?: numberNumber of documents to skip in the query.
-
- -
-
-Optionalttl?: numberTime-to-live for the cursor in seconds. The cursor results may be -garbage collected by ArangoDB after this much time has passed.
-See also QueryOptions.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryFulltextOptions.html b/devel/types/collection.SimpleQueryFulltextOptions.html
deleted file mode 100644
index babe74802..000000000
--- a/devel/types/collection.SimpleQueryFulltextOptions.html
+++ /dev/null
@@ -1,125 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryFulltextOptions
Simple
    index?: string;
    limit?: number;
    skip?: number;
}
-Â Â Â Â index?: string;
    limit?: number;
    skip?: number;
}
Options for performing a fulltext query.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-Optionalindex?: stringUnique identifier of the fulltext index to use to perform the query.
-
- -
-
-Optionallimit?: numberMaximum number of documents to return.
-
- -
-
-Optionalskip?: numberNumber of documents to skip in the query.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryListType.html b/devel/types/collection.SimpleQueryListType.html
deleted file mode 100644
index 49ea802ee..000000000
--- a/devel/types/collection.SimpleQueryListType.html
+++ /dev/null
@@ -1,111 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryRemoveByExampleOptions.html b/devel/types/collection.SimpleQueryRemoveByExampleOptions.html
deleted file mode 100644
index 40f00b19e..000000000
--- a/devel/types/collection.SimpleQueryRemoveByExampleOptions.html
+++ /dev/null
@@ -1,123 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryRemoveByExampleOptions
Simple
    limit?: number;
    waitForSync?: boolean;
}
-Â Â Â Â limit?: number;
    waitForSync?: boolean;
}
Options for removing documents by example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-Optionallimit?: numberMaximum number of documents to return.
-
- -
-
-OptionalwaitFor Sync?: boolean If set to
-true, the request will wait until all modifications have been -synchronized to disk before returning successfully.Default:
-false
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryRemoveByExampleResult.html b/devel/types/collection.SimpleQueryRemoveByExampleResult.html
deleted file mode 100644
index 60e2de7de..000000000
--- a/devel/types/collection.SimpleQueryRemoveByExampleResult.html
+++ /dev/null
@@ -1,118 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryRemoveByExampleResult
Simple
    deleted: number;
}
-Â Â Â Â deleted: number;
}
Result of removing documents by an example.
-See removeByExample and removeByExample.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
deleted: number
-Number of documents removed.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryRemoveByKeysOptions.html b/devel/types/collection.SimpleQueryRemoveByKeysOptions.html
deleted file mode 100644
index e7ee9eb79..000000000
--- a/devel/types/collection.SimpleQueryRemoveByKeysOptions.html
+++ /dev/null
@@ -1,131 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryRemoveByKeysOptions
Simple
    returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
-Â Â Â Â returnOld?: boolean;
    silent?: boolean;
    waitForSync?: boolean;
}
Options for removing documents by keys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-OptionalreturnOld?: boolean If set to
-true, the complete old document will be returned as theold-property on the result object. Has no effect ifsilentis set totrue.Default:
-false
- -
-
-Optionalsilent?: booleanIf set to
-true, no data will be returned by the server. This option can -be used to reduce network traffic.Default:
-false
- -
-
-OptionalwaitFor Sync?: boolean If set to
-true, the request will wait until all modifications have been -synchronized to disk before returning successfully.Default:
-false
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryRemoveByKeysResult.html b/devel/types/collection.SimpleQueryRemoveByKeysResult.html
deleted file mode 100644
index 48e563986..000000000
--- a/devel/types/collection.SimpleQueryRemoveByKeysResult.html
+++ /dev/null
@@ -1,131 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-Type alias SimpleQueryRemoveByKeysResult<T>
Simple
    ignored: number;
    old?: DocumentMetadata[] | Document<T>[];
    removed: number;
}
-Â Â Â Â ignored: number;
    old?: DocumentMetadata[] | Document<T>[];
    removed: number;
}
Result of removing documents by keys.
-See removeByKeys and removeByKeys.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
Type declaration
--
-
-
-
ignored: number
-Number of documents not removed.
-
- -
-
-Optionalold?: DocumentMetadata[] | Document<T>[]Documents that have been removed.
-
- -
-
removed: number
-Number of documents removed.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryReplaceByExampleOptions.html b/devel/types/collection.SimpleQueryReplaceByExampleOptions.html
deleted file mode 100644
index b31000591..000000000
--- a/devel/types/collection.SimpleQueryReplaceByExampleOptions.html
+++ /dev/null
@@ -1,110 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryReplaceByExampleOptions
Options for replacing documents by example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryReplaceByExampleResult.html b/devel/types/collection.SimpleQueryReplaceByExampleResult.html
deleted file mode 100644
index 709a97f3e..000000000
--- a/devel/types/collection.SimpleQueryReplaceByExampleResult.html
+++ /dev/null
@@ -1,118 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryReplaceByExampleResult
Simple
    replaced: number;
}
-Â Â Â Â replaced: number;
}
Result of replacing documents by an example.
-See replaceByExample and replaceByExample.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
replaced: number
-Number of documents replaced.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryUpdateByExampleOptions.html b/devel/types/collection.SimpleQueryUpdateByExampleOptions.html
deleted file mode 100644
index 4e42937f7..000000000
--- a/devel/types/collection.SimpleQueryUpdateByExampleOptions.html
+++ /dev/null
@@ -1,136 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryUpdateByExampleOptions
Simple
    keepNull?: boolean;
    limit?: number;
    mergeObjects?: boolean;
    waitForSync?: boolean;
}
-Â Â Â Â keepNull?: boolean;
    limit?: number;
    mergeObjects?: boolean;
    waitForSync?: boolean;
}
Options for updating documents by example.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-OptionalkeepNull?: boolean If set to
-false, properties with a value ofnullwill be removed from -the new document.Default:
-true
- -
-
-Optionallimit?: numberMaximum number of documents to return.
-
- -
-
-OptionalmergeObjects?: boolean If set to
-false, object properties that already exist in the old -document will be overwritten rather than merged. This does not affect -arrays.Default:
-true
- -
-
-OptionalwaitFor Sync?: boolean If set to
-true, the request will wait until all modifications have been -synchronized to disk before returning successfully.Default:
-false
-
-
\ No newline at end of file
diff --git a/devel/types/collection.SimpleQueryUpdateByExampleResult.html b/devel/types/collection.SimpleQueryUpdateByExampleResult.html
deleted file mode 100644
index ca0273322..000000000
--- a/devel/types/collection.SimpleQueryUpdateByExampleResult.html
+++ /dev/null
@@ -1,118 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SimpleQueryUpdateByExampleResult
Simple
    updated: number;
}
-Â Â Â Â updated: number;
}
Result of updating documents by an example.
-See updateByExample and updateByExample.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and can be -replaced with AQL queries.
-
-
Type declaration
--
-
-
-
updated: number
-Number of documents updated.
-
-
-
\ No newline at end of file
diff --git a/devel/types/collection.TraversalOptions.html b/devel/types/collection.TraversalOptions.html
deleted file mode 100644
index 9744524c3..000000000
--- a/devel/types/collection.TraversalOptions.html
+++ /dev/null
@@ -1,235 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias TraversalOptions
Traversal
    direction?: "inbound" | "outbound" | "any";
    expander?: string;
    filter?: string;
    init?: string;
    itemOrder?: "forward" | "backward";
    maxDepth?: number;
    maxIterations?: number;
    minDepth?: number;
    order?: "preorder" | "postorder" | "preorder-expander";
    sort?: string;
    strategy?: "depthfirst" | "breadthfirst";
    uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    };
    visitor?: string;
}
-Â Â Â Â direction?: "inbound" | "outbound" | "any";
    expander?: string;
    filter?: string;
    init?: string;
    itemOrder?: "forward" | "backward";
    maxDepth?: number;
    maxIterations?: number;
    minDepth?: number;
    order?: "preorder" | "postorder" | "preorder-expander";
    sort?: string;
    strategy?: "depthfirst" | "breadthfirst";
    uniqueness?: {
        edges?: "none" | "global" | "path";
        vertices?: "none" | "global" | "path";
    };
    visitor?: string;
}
Options for performing a graph traversal.
- -Deprecated
Simple Queries have been deprecated in ArangoDB 3.4 and are -no longer supported in ArangoDB 3.12. They can be replaced with AQL queries.
-
-
Type declaration
--
-
-
-
-Optionaldirection?: "inbound" | "outbound" | "any"Direction of the traversal, relative to the starting vertex if
-expander-is not set.
- -
-
-Optionalexpander?: stringA string evaluating to the body of a JavaScript function to be executed -on the server to use when
-directionis not set.The code has access to three variables:
-config,vertex,path. -The code must return an array of objects withedgeandvertex-attributes representing the connections for the vertex.Note: This code will be evaluated and executed on the -server inside ArangoDB's embedded JavaScript environment and can not -access any other variables.
-See the official ArangoDB documentation for -the JavaScript
-@arangodbmodule -for information about accessing the database from within ArangoDB's -server-side JavaScript environment.
- -
-
-Optionalfilter?: stringA string evaluating to the body of a JavaScript function to be executed -on the server to filter nodes.
-The code has access to three variables:
-config,vertex,path. -The code may include a return statement for the following values:-
-
"exclude": The vertex will not be visited.
-"prune": The edges of the vertex will not be followed.
-""orundefined: The vertex will be visited and its edges followed.
-- an array including any of the above values. -
Note: This code will be evaluated and executed on the -server inside ArangoDB's embedded JavaScript environment and can not -access any other variables.
-See the official ArangoDB documentation for -the JavaScript
-@arangodbmodule -for information about accessing the database from within ArangoDB's -server-side JavaScript environment.
- -
-
-Optionalinit?: stringA string evaluating to the body of a JavaScript function to be executed -on the server to initialize the traversal result object.
-The code has access to two variables:
-config,result. -The code may modify theresultobject.Note: This code will be evaluated and executed on the -server inside ArangoDB's embedded JavaScript environment and can not -access any other variables.
-See the official ArangoDB documentation for -the JavaScript
-@arangodbmodule -for information about accessing the database from within ArangoDB's -server-side JavaScript environment.
- -
-
-OptionalitemOrder?: "forward" | "backward" Item iteration order.
-
- -
-
-OptionalmaxDepth?: number If specified, only nodes in at most this depth will be visited.
-
- -
-
-OptionalmaxIterations?: number Maximum number of iterations before a traversal is aborted because of a -potential endless loop.
-
- -
-
-OptionalminDepth?: number If specified, only nodes in at least this depth will be visited.
-
- -
-
-Optionalorder?: "preorder" | "postorder" | "preorder-expander"Traversal order.
-
- -
-
-Optionalsort?: stringA string evaluating to the body of a JavaScript function to be executed -on the server to sort edges if
-expanderis not set.The code has access to two variables representing edges:
-l,r. -The code must return-1ifl < r,1ifl > ror0if both -values are equal.Note: This code will be evaluated and executed on the -server inside ArangoDB's embedded JavaScript environment and can not -access any other variables.
-See the official ArangoDB documentation for -the JavaScript
-@arangodbmodule -for information about accessing the database from within ArangoDB's -server-side JavaScript environment.
- -
-
-Optionalstrategy?: "depthfirst" | "breadthfirst"Traversal strategy.
-
- -
-
-Optionaluniqueness?: {
    edges?: "none" | "global" | "path";
    vertices?: "none" | "global" | "path";
}-Specifies uniqueness for vertices and edges.
--
-
-
-
-Optionaledges?: "none" | "global" | "path"Uniqueness for edges.
-
- -
-
-Optionalvertices?: "none" | "global" | "path"Uniqueness for vertices.
-
- -
-
-
-
-Optionalvisitor?: stringA string evaluating to the body of a JavaScript function to be executed -on the server when a node is visited.
-The code has access to five variables:
-config,result,vertex, -path,connected. -The code may modify theresultobject.Note: This code will be evaluated and executed on the -server inside ArangoDB's embedded JavaScript environment and can not -access any other variables.
-See the official ArangoDB documentation for -the JavaScript
-@arangodbmodule -for information about accessing the database from within ArangoDB's -server-side JavaScript environment.
-
-
\ No newline at end of file
diff --git a/devel/types/collection.ValidationLevel.html b/devel/types/collection.ValidationLevel.html
index ac32cb99e..f7d1b593e 100644
--- a/devel/types/collection.ValidationLevel.html
+++ b/devel/types/collection.ValidationLevel.html
@@ -1,23 +1,4 @@
-Generated using TypeDoc
-
-ValidationLevel | arangojs
-
-
-Type alias ValidationLevel
Validation
-When a validation should be applied.
+Type alias ValidationLevel
Validation
When a validation should be applied.
"none": No validation."new": Newly inserted documents are validated.
@@ -25,90 +6,4 @@
Type alias ValidationLevel
"strict": New and modified documents are always validated.
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-Type alias WriteOperation
Write
-Write operation that can result in a computed value being computed.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias WriteOperation
Write
Write operation that can result in a computed value being computed.
+
-
-
-
-
-
-
-
-Type alias AgentOptions
Options for creating the Node.js http.Agent or https.Agent.
In browser environments this option can be used to pass additional options -to the underlying calls of the -xhr module.
-See also http.Agent
-and https.Agent
-(when using TLS).
-
-
\ No newline at end of file
diff --git a/devel/types/connection.ArangoApiResponse.html b/devel/types/connection.ArangoApiResponse.html
index dbec6802c..6bd54523e 100644
--- a/devel/types/connection.ArangoApiResponse.html
+++ b/devel/types/connection.ArangoApiResponse.html
@@ -1,75 +1,2 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-Type alias ArangoApiResponse<T>
Extends the given base type T with the generic HTTP API response properties.
Type Parameters
--
-
-
-
T
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoApiResponse<T>
Extends the given base type T with the generic HTTP API response properties.
Type Parameters
-
-
-
-
-
-
-
-Type alias ArangoResponseMetadata
Arango
    code: number;
    error: false;
}
-Â Â Â Â code: number;
    error: false;
}
Generic properties shared by all ArangoDB HTTP API responses.
-
-
Type declaration
--
-
-
-
code: number
-Response status code, typically
-200.
- -
-
error: false
-Indicates that the request was successful.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoResponseMetadata
Arango
    code: number;
    error: false;
}
    code: number;
    error: false;
}
Generic properties shared by all ArangoDB HTTP API responses.
+Type declaration
code: number
Response status code, typically
+200.error: false
Indicates that the request was successful.
+
-
-
-
-
-
-
-
-Type alias BasicAuthCredentials
Basic
    password?: string;
    username: string;
}
-Â Â Â Â password?: string;
    username: string;
}
Credentials for HTTP Basic authentication.
-
-
Type declaration
--
-
-
-
-Optionalpassword?: stringPassword to use for authentication. Defaults to an empty string.
-
- -
-
username: string
-Username to use for authentication, e.g.
-"root".
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias BasicAuthCredentials
Basic
    password?: string;
    username: string;
}
    password?: string;
    username: string;
}
Credentials for HTTP Basic authentication.
+Type declaration
Optionalpassword?: stringPassword to use for authentication. Defaults to an empty string.
+username: string
Username to use for authentication, e.g.
+"root".
-
-
-
-
-
-
-
-Type alias BearerAuthCredentials
Bearer
    token: string;
}
-Â Â Â Â token: string;
}
Credentials for HTTP Bearer token authentication.
-
-
Type declaration
--
-
-
-
token: string
-Bearer token to use for authentication.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias BearerAuthCredentials
Bearer
    token: string;
}
    token: string;
}
Credentials for HTTP Bearer token authentication.
+Type declaration
token: string
Bearer token to use for authentication.
+
-Params | arangojs
-
-RequestInterceptors | arangojs
-
-RequestOptions | arangojs
-
-XhrOptions | arangojs
-
-AccessLevel | arangojs
-
-AccessLevel | arangojs AqlUserFunction | arangojs
-
-AqlUserFunction | arangojs ArangoUser | arangojs
-
-ArangoUser | arangojs AstNode | arangojs
-
-AstNode | arangojs ClusterImbalanceInfo | arangojs
-
-ClusterImbalanceInfo | arangojs ClusterRebalanceMove | arangojs
-
-ClusterRebalanceMove | arangojs ClusterRebalanceOptions | arangojs
-
-ClusterRebalanceResult | arangojs
-
-ClusterRebalanceResult | arangojs ClusterRebalanceState | arangojs
-
-ClusterRebalanceState | arangojs CreateDatabaseOptions | arangojs
-
-CreateDatabaseUser | arangojs
-
-CreateUserOptions | arangojs
-
-DatabaseInfo | arangojs
-
-ExplainOptions | arangojs
-
-ExplainPlan | arangojs
-
-ExplainPlan | arangojs ExplainStats | arangojs
-
-ExplainStats | arangojs HotBackupList | arangojs
-
-HotBackupList | arangojs HotBackupOptions | arangojs
-
-HotBackupResult | arangojs
-
-HotBackupResult | arangojs InstallServiceOptions | arangojs
-
-LogEntries | arangojs
-
-LogEntries | arangojs LogEntriesOptions | arangojs
-
-LogLevelLabel | arangojs
-
-LogLevelLabel | arangojs LogLevelSetting | arangojs
-
-LogLevelSetting | arangojs LogMessage | arangojs
-
-LogMessage | arangojs LogSortDirection | arangojs
-
-LogSortDirection | arangojs MultiExplainResult | arangojs
-
-MultiExplainResult | arangojs MultiServiceDependency | arangojs
-
-ParseResult | arangojs
-
-ParseResult | arangojs QueryInfo | arangojs
-
-QueryInfo | arangojs QueryOptimizerRule | arangojs
-
-QueryOptimizerRule | arangojs QueryOptions | arangojs
-
-QueryTracking | arangojs
-
-QueryTrackingOptions | arangojs
-
-QueueTimeMetrics | arangojs
-
-ReplaceServiceOptions | arangojs
-
-ServiceConfiguration | arangojs
-
-ServiceInfo | arangojs
-
-ServiceInfo | arangojs ServiceSummary | arangojs
-
-ServiceTestDefaultReport | arangojs
-
-ServiceTestDefaultReport | arangojs ServiceTestDefaultTest | arangojs
-
-ServiceTestDefaultTest | arangojs ServiceTestStats | arangojs
-
-ServiceTestStats | arangojs ServiceTestStreamReport | arangojs
-
-ServiceTestStreamReport | arangojs ServiceTestStreamTest | arangojs
-
-ServiceTestStreamTest | arangojs ServiceTestSuite | arangojs
-
-ServiceTestSuite | arangojs ServiceTestSuiteReport | arangojs
-
-ServiceTestSuiteReport | arangojs ServiceTestSuiteTest | arangojs
-
-ServiceTestSuiteTest | arangojs ServiceTestTapReport | arangojs
-
-ServiceTestTapReport | arangojs ServiceTestXunitReport | arangojs
-
-ServiceTestXunitTest | arangojs
-
-SingleExplainResult | arangojs
-
-SingleExplainResult | arangojs SingleServiceDependency | arangojs
-
-SwaggerJson | arangojs
-
-SwaggerJson | arangojs TransactionCollections | arangojs
-
-TransactionDetails | arangojs
-
-TransactionDetails | arangojs TransactionOptions | arangojs
-
-UninstallServiceOptions | arangojs
-
-UpgradeServiceOptions | arangojs
-
-UserAccessLevelOptions | arangojs
-
-UserOptions | arangojs
-
-VersionInfo | arangojs
-
-VersionInfo | arangojs Document | arangojs
-
-Document | arangojs DocumentData | arangojs
-
-DocumentData | arangojs DocumentMetadata | arangojs
-
-DocumentSelector | arangojs
-
-Edge | arangojs
-
-Edge | arangojs EdgeData | arangojs
-
-EdgeData | arangojs EdgeMetadata | arangojs
-
-EdgeMetadata | arangojs ObjectWithId | arangojs
-
-ObjectWithId | arangojs ObjectWithKey | arangojs
-
-ObjectWithKey | arangojs Patch | arangojs
-
-Configuration | arangojs
-
-Configuration | arangojs Dependency | arangojs
-
-Dependency | arangojs File | arangojs
-
-File | arangojs FoxxManifest | arangojs
-
-FoxxManifest | arangojs AddEdgeDefinitionOptions | arangojs
-
-AddVertexCollectionOptions | arangojs
-
-CreateGraphOptions | arangojs
-
-EdgeDefinition | arangojs
-
-EdgeDefinition | arangojs EdgeDefinitionOptions | arangojs
-
-EdgeDefinitionOptions | arangojs GraphCollectionInsertOptions | arangojs
-
-GraphCollectionReadOptions | arangojs
-
-GraphCollectionRemoveOptions | arangojs
-
-GraphCollectionReplaceOptions | arangojs
-
-GraphInfo | arangojs
-
-ReplaceEdgeDefinitionOptions | arangojs
-
-EnsureFulltextIndexOptions | arangojs
-
-EnsureGeoIndexOptions | arangojs
-
-EnsureGeoIndexOptions | arangojs EnsureIndexOptions | arangojs EnsureInvertedIndexOptions | arangojs
-
-EnsureMdiIndexOptions | arangojs
-
-EnsurePersistentIndexOptions | arangojs
-
-EnsureTtlIndexOptions | arangojs
-
-FulltextIndex | arangojs
-
-GenericIndex | arangojs
-
-GeoIndex | arangojs
-
-GeoIndex | arangojs HiddenIndex | arangojs Index | arangojs
-
-Index | arangojs IndexDetails | arangojs IndexSelector | arangojs
-
-IndexSelector | arangojs InternalArangosearchIndex | arangojs InternalIndex | arangojs InvertedIndex | arangojs
-
-InvertedIndex | arangojs InvertedIndexFieldOptions | arangojs
-
-InvertedIndexNestedField | arangojs
-
-InvertedIndexNestedFieldOptions | arangojs
-
-InvertedIndexPrimarySortFieldOptions | arangojs
-
-InvertedIndexPrimarySortFieldOptions | arangojs InvertedIndexStoredValueOptions | arangojs
-
-MdiIndex | arangojs
-
-MdiIndex | arangojs ObjectWithId | arangojs
-
-ObjectWithId | arangojs ObjectWithName | arangojs
-
-ObjectWithName | arangojs PersistentIndex | arangojs
-
-PersistentIndex | arangojs PrimaryIndex | arangojs
-
-PrimaryIndex | arangojs TtlIndex | arangojs
-
-TtlIndex | arangojs TransactionAbortOptions | arangojs
-
-TransactionCommitOptions | arangojs
-
-TransactionStatus | arangojs
-
-TransactionStatus | arangojs ArangoSearchViewDescription | arangojs
-
-ArangoSearchViewDescription | arangojs ArangoSearchViewLink | arangojs
-
-ArangoSearchViewLink | arangojs ArangoSearchViewLinkOptions | arangojs
-
-ArangoSearchViewPatchPropertiesOptions | arangojs
-
-ArangoSearchViewPatchPropertiesOptions | arangojs ArangoSearchViewProperties | arangojs
-
-ArangoSearchViewProperties | arangojs ArangoSearchViewPropertiesOptions | arangojs
-
-BytesAccumConsolidationPolicy | arangojs
-
-Compression | arangojs
-
-Compression | arangojs CreateArangoSearchViewOptions | arangojs
-
-CreateArangoSearchViewOptions | arangojs CreateSearchAliasViewOptions | arangojs
-
-CreateSearchAliasViewOptions | arangojs CreateViewOptions | arangojs
-
-CreateViewOptions | arangojs Direction | arangojs
-
-Direction | arangojs GenericViewDescription | arangojs
-
-GenericViewDescription | arangojs SearchAliasViewDescription | arangojs
-
-SearchAliasViewDescription | arangojs SearchAliasViewIndexOptions | arangojs
-
-SearchAliasViewIndexOptions | arangojs SearchAliasViewPatchIndexOptions | arangojs
-
-SearchAliasViewPatchIndexOptions | arangojs SearchAliasViewPatchPropertiesOptions | arangojs
-
-SearchAliasViewPatchPropertiesOptions | arangojs SearchAliasViewProperties | arangojs
-
-SearchAliasViewProperties | arangojs SearchAliasViewPropertiesOptions | arangojs
-
-SearchAliasViewPropertiesOptions | arangojs TierConsolidationPolicy | arangojs
-
-ViewDescription | arangojs
-
-ViewDescription | arangojs ViewPatchPropertiesOptions | arangojs
-
-ViewPatchPropertiesOptions | arangojs ViewProperties | arangojs
-
-ViewProperties | arangojs ViewPropertiesOptions | arangojs
-
-ViewPropertiesOptions | arangojs
-
-Headers | arangojs
-
-LoadBalancingStrategy | arangojs
-
-
\ No newline at end of file
diff --git a/devel/types/connection.Params.html b/devel/types/connection.Params.html
deleted file mode 100644
index f2ed05ea0..000000000
--- a/devel/types/connection.Params.html
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-
-Type alias Config
Config: {
    agent?: any;
    agentOptions?: AgentOptions & RequestInterceptors;
    arangoVersion?: number;
    auth?: BasicAuthCredentials | BearerAuthCredentials;
    databaseName?: string;
    headers?: Headers;
    loadBalancingStrategy?: LoadBalancingStrategy;
    maxRetries?: false | number;
    precaptureStackTraces?: boolean;
    responseQueueTimeSamples?: number;
    retryOnConflict?: number;
    url?: string | string[];
}
-Â Â Â Â agent?: any;
    agentOptions?: AgentOptions & RequestInterceptors;
    arangoVersion?: number;
    auth?: BasicAuthCredentials | BearerAuthCredentials;
    databaseName?: string;
    headers?: Headers;
    loadBalancingStrategy?: LoadBalancingStrategy;
    maxRetries?: false | number;
    precaptureStackTraces?: boolean;
    responseQueueTimeSamples?: number;
    retryOnConflict?: number;
    url?: string | string[];
}
Options for configuring arangojs.
-
-
\ No newline at end of file
diff --git a/devel/types/connection.Headers.html b/devel/types/connection.Headers.html
deleted file mode 100644
index 1d12ad11d..000000000
--- a/devel/types/connection.Headers.html
+++ /dev/null
@@ -1,72 +0,0 @@
-Type declaration
--
-
-
-
-Optionalagent?: anyAn http
-Agentinstance to use for connections.By default a new
-Agentinstance will be created using theagentOptions.This option has no effect when using the browser version of arangojs.
-See also
-http.Agent-andhttps.Agent-(when using TLS).
- -
-
-OptionalagentOptions?: AgentOptions & RequestInterceptors Options used to create that underlying HTTP/HTTPS
-Agent(or thexhr-module when using arangojs in the browser). This will be ignored if -agentis also provided.The option
-maxSocketsis also used to limit how many requests -arangojs will perform concurrently. The maximum number of requests is -equal tomaxSockets.Note: arangojs will limit the number of concurrent requests based on -this value even if an
-agentis provided.Note: when using
-ROUND_ROBINload balancing and passing an array of -URLs in theurloption, the default value ofmaxSocketswill be set -to3 * url.lengthinstead of3.Default (Node.js):
-{ maxSockets: 3, keepAlive: true, keepAliveMsecs: 1000 }Default (browser):
-{ maxSockets: 3, useXDR: true, withCredentials: true }
- -
-
-OptionalarangoVersion?: number Numeric representation of the ArangoDB version the driver should expect. +
Config | arangojs Type alias Config
Config: {
    afterResponse?: ((err, res?) => void | Promise<void>);
    arangoVersion?: number;
    auth?: BasicAuthCredentials | BearerAuthCredentials;
    beforeRequest?: ((req) => void | Promise<void>);
    credentials?: "omit" | "include" | "same-origin";
    databaseName?: string;
    headers?: Headers | Record<string, string>;
    keepalive?: boolean;
    loadBalancingStrategy?: LoadBalancingStrategy;
    maxRetries?: false | number;
    onError?: ((err) => void | Promise<void>);
    poolSize?: number;
    precaptureStackTraces?: boolean;
    responseQueueTimeSamples?: number;
    retryOnConflict?: number;
    url?: string | string[];
}Options for configuring arangojs.
+-Type declaration
OptionalafterResponse?: ((err, res?) => void | Promise<void>) Callback that will be invoked when the server response has been received +and processed or when the request has been failed without a response.
+The originating request will be available as the
+requestproperty +on either the error or response object.- (err, res?): void | Promise<void>
Parameters
- err: NetworkError | null
Error encountered when handling this request or
+null. Optionalres: globalThis.Response & {
    request: globalThis.Request;
}Response object for this request, if no error occurred.
+
Returns void | Promise<void>
- err: NetworkError | null
OptionalarangoVersion?: number Numeric representation of the ArangoDB version the driver should expect. The format is defined as
XYYZZwhereXis the major version,Yis the zero-filled two-digit minor version andZis the zero-filled two-digit bugfix version, e.g.30102for 3.1.2,20811for 2.8.11.Depending on this value certain methods may become unavailable or change their behavior to remain compatible with different versions of ArangoDB.
-Default:
-30900
--
-
-Optionalauth?: BasicAuthCredentials | BearerAuthCredentials Optionalauth?: BasicAuthCredentials | BearerAuthCredentialsCredentials to use for authentication.
+See also database.Database#useBasicAuth and +database.Database#useBearerAuth.
Default:
-{ username: "root", password: "" }
--
-
-OptionaldatabaseName?: string Name of the database to use.
+ OptionalbeforeRequest?: ((req) => void | Promise<void>) Callback that will be invoked with the finished request object before it +is finalized. In the browser the request may already have been sent.
+- (req): void | Promise<void>
Parameters
- req: globalThis.Request
Request object or XHR instance used for this request.
+
Returns void | Promise<void>
- req: globalThis.Request
Optionalcredentials?: "omit" | "include" | "same-origin"(Browser only.) Determines whether credentials (e.g. cookies) will be sent +with requests to the ArangoDB server.
+If set to
+same-origin, credentials will only be included with requests +on the same URL origin as the invoking script. If set toinclude, +credentials will always be sent. If set toomit, credentials will be +excluded from all requests.Default:
+same-originOptionaldatabaseName?: string Name of the database to use.
Default:
-"_system"
--
-
-Optionalheaders?: HeadersAn object with additional headers to send with every request.
+ Optionalheaders?: Headers | Record<string, string>An object with additional headers to send with every request.
If an
-"authorization"header is provided, it will be overridden when -using useBasicAuth, useBearerAuth or +using database.Database#useBasicAuth, database.Database#useBearerAuth or theauthconfiguration option.
--
-
-OptionalloadBalancing Strategy?: LoadBalancingStrategy Determines the behavior when multiple URLs are provided:
+ Optionalkeepalive?: booleanIf set to
+true, requests will keep the underlying connection open until +it times out or is closed. In browsers this prevents requests from being +cancelled when the user navigates away from the page.Default:
+trueOptionalloadBalancing Strategy?: LoadBalancingStrategy Determines the behavior when multiple URLs are provided:
"NONE": No load balancing. All requests will be handled by the first URL in the list until a network error is encountered. On network error, @@ -91,10 +49,7 @@OptionalloadBalancing
Default:
-"NONE"
--
-
-OptionalmaxRetries?: false | number Determines the behavior when a request fails because the underlying +
OptionalmaxRetries?: false | number Determines the behavior when a request fails because the underlying connection to the server could not be opened (i.e.
ECONNREFUSEDin Node.js):-
@@ -117,33 +72,30 @@
OptionalmaxRetriesNote: To set the number of retries when a write-write conflict is encountered, see retryOnConflictinstead.Default:
-0
--
-
-OptionalprecaptureStack Traces?: boolean If set to
true, arangojs will generate stack traces every time a request + OptionalonError?: ((err) => void | Promise<void>) Callback that will be invoked when a request
+- (err): void | Promise<void>
Parameters
- err: Error
Error encountered when handling this request.
+
Returns void | Promise<void>
- err: Error
OptionalpoolSize?: number Maximum number of parallel requests arangojs will perform. If any +additional requests are attempted, they will be enqueued until one of the +active requests has completed.
+Note: when using
+ROUND_ROBINload balancing and passing an array of +URLs in theurloption, the default value of this option will be set to +3 * url.lengthinstead of3.Default:
+3OptionalprecaptureStack Traces?: boolean If set to
true, arangojs will generate stack traces every time a request is initiated and augment the stack traces of any errors it generates.Warning: This will cause arangojs to generate stack traces in advance even if the request does not result in an error. Generating stack traces may negatively impact performance.
-
--
-
-OptionalresponseQueue Time Samples?: number Limits the number of values of server-reported response queue times that -will be stored and accessible using queueTime. If set to +
OptionalresponseQueue Time Samples?: number Limits the number of values of server-reported response queue times that +will be stored and accessible using database.Database#queueTime. If set to a finite value, older values will be discarded to make room for new values when that limit is reached.
Default:
-10
--
-
-OptionalretryOn Conflict?: number If set to a positive number, requests will automatically be retried at +
OptionalretryOn Conflict?: number If set to a positive number, requests will automatically be retried at most this many times if they result in a write-write conflict.
Default:
-0
--
-
-Optionalurl?: string | string[]Base URL of the ArangoDB server or list of server URLs.
-When working with a cluster, the method acquireHostList +
Optionalurl?: string | string[]-Base URL of the ArangoDB server or list of server URLs.
+When working with a cluster, the method database.Database#acquireHostList can be used to automatically pick up additional coordinators/followers at any point.
When running ArangoDB on a unix socket, e.g.
/tmp/arangodb.sock, the @@ -166,53 +118,4 @@Optionalurl --
-
- Defined in connection.ts:319
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-Type alias Headers
Headers: Record<string, string>
-An arbitrary object with string values representing HTTP headers and their -values.
-Header names should always be lowercase.
-
-
-
\ No newline at end of file
diff --git a/devel/types/connection.LoadBalancingStrategy.html b/devel/types/connection.LoadBalancingStrategy.html
index 15d600418..dc71078ac 100644
--- a/devel/types/connection.LoadBalancingStrategy.html
+++ b/devel/types/connection.LoadBalancingStrategy.html
@@ -1,23 +1,4 @@
-Generated using TypeDoc
-
-LoadBalancingStrategy | arangojs
-
-
-Type alias LoadBalancingStrategy
Load
-Determines the behavior when multiple URLs are used:
+Type alias LoadBalancingStrategy
Load
Determines the behavior when multiple URLs are used:
"NONE": No load balancing. All requests will be handled by the first URL in the list until a network error is encountered. On network error, @@ -29,53 +10,4 @@Type alias LoadBalancingStrategy
"ROUND_ROBIN": Every sequential request uses the next URL in the list.
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-Type alias Params
Params: Record<string, any>
-An arbitrary object with scalar values representing query string parameters -and their values.
-
-
-
\ No newline at end of file
diff --git a/devel/types/connection.RequestInterceptors.html b/devel/types/connection.RequestInterceptors.html
deleted file mode 100644
index 10143f978..000000000
--- a/devel/types/connection.RequestInterceptors.html
+++ /dev/null
@@ -1,116 +0,0 @@
-Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias RequestInterceptors
Request
    after?: ((err: ArangojsError | null, res?: ArangojsResponse) => void);
    before?: ((req: ClientRequest) => void);
}
-Â Â Â Â after?: ((err: ArangojsError | null, res?: ArangojsResponse) => void);
    before?: ((req: ClientRequest) => void);
}
Additional options for intercepting the request/response. These methods -are primarily intended for tracking network related metrics.
-
-
Type declaration
--
-
-
-
-Optionalafter?: ((err: ArangojsError | null, res?: ArangojsResponse) => void)-
-
-
-
-
-
- (err: ArangojsError | null, res?: ArangojsResponse): void -
-
--
Callback that will be invoked when the server response has been received -and processed or when the request has been failed without a response.
-The originating request will be available as the
-requestproperty -on either the error or response object.--Parameters
--
-
-
-
err: ArangojsError | null
-Error encountered when handling this request or
-null.
- -
-
-Optionalres: ArangojsResponseResponse object for this request, if no error occurred.
-
Returns void
-
-
- -
-
-
-
-Optionalbefore?: ((req: ClientRequest) => void)-
-
-
-
-
-
- (req: ClientRequest): void -
-
--
Callback that will be invoked with the finished request object before it -is finalized. In the browser the request may already have been sent.
---Parameters
--
-
-
-
req: ClientRequest
-Request object or XHR instance used for this request.
-
Returns void
-
-
-
-
-
-
\ No newline at end of file
diff --git a/devel/types/connection.RequestOptions.html b/devel/types/connection.RequestOptions.html
index 47f7d3a72..9950983e3 100644
--- a/devel/types/connection.RequestOptions.html
+++ b/devel/types/connection.RequestOptions.html
@@ -1,127 +1,22 @@
-Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/connection.XhrOptions.html b/devel/types/connection.XhrOptions.html
deleted file mode 100644
index a760200ac..000000000
--- a/devel/types/connection.XhrOptions.html
+++ /dev/null
@@ -1,120 +0,0 @@
-
-
-
-
-
-Type alias RequestOptions
Request
    allowDirtyRead?: boolean;
    basePath?: string;
    body?: any;
    expectBinary?: boolean;
    headers?: Headers;
    isBinary?: boolean;
    method?: string;
    path?: string;
    qs?: string | Params;
    retryOnConflict?: number;
    timeout?: number;
}
-Â Â Â Â allowDirtyRead?: boolean;
    basePath?: string;
    body?: any;
    expectBinary?: boolean;
    headers?: Headers;
    isBinary?: boolean;
    method?: string;
    path?: string;
    qs?: string | Params;
    retryOnConflict?: number;
    timeout?: number;
}
Options for performing a request with arangojs.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean Whether ArangoDB is allowed to perform a dirty read to respond to this +
RequestOptions | arangojs --Type alias RequestOptions
RequestOptions: {
    allowDirtyRead?: boolean;
    basePath?: string;
    body?: any;
    expectBinary?: boolean;
    headers?: Headers | Record<string, string>;
    isBinary?: boolean;
    method?: string;
    path?: string;
    retryOnConflict?: number;
    search?: URLSearchParams | Record<string, any>;
    timeout?: number;
}Options for performing a request with arangojs.
+Type declaration
OptionalallowDirty Read?: boolean Whether ArangoDB is allowed to perform a dirty read to respond to this request. If set to
-true, the response may reflect a dirty state from a non-authoritative server.
--
-
-OptionalbasePath?: string Optional prefix path to prepend to the
-path.
- -
-
-Optionalbody?: anyRequest body data.
-
- -
-
-OptionalexpectBinary?: boolean If set to
true, the response body will not be interpreted as JSON and + OptionalbasePath?: string Optional prefix path to prepend to the
+path.Optionalbody?: anyRequest body data.
+OptionalexpectBinary?: boolean If set to
-true, the response body will not be interpreted as JSON and instead passed as-is.
--
-
-Optionalheaders?: HeadersHTTP headers to pass along with this request in addition to the default +
Optionalheaders?: Headers | Record<string, string>HTTP headers to pass along with this request in addition to the default headers generated by arangojs.
-
--
-
-OptionalisBinary?: boolean If set to
true, the request body will not be converted to JSON and + OptionalisBinary?: boolean If set to
-true, the request body will not be converted to JSON and instead passed as-is.
--
-
-Optionalmethod?: stringHTTP method to use in order to perform the request.
+ Optionalmethod?: stringHTTP method to use in order to perform the request.
Default:
-"GET"
--
-
-Optionalpath?: stringURL path, relative to the
-basePathand server domain.
- -
-
-Optionalqs?: string | ParamsURL parameters to pass as part of the query string.
-
- -
-
-OptionalretryOn Conflict?: number If set to a positive number, the request will automatically be retried at +
Optionalpath?: stringURL path, relative to the
+basePathand server domain.OptionalretryOn Conflict?: number If set to a positive number, the request will automatically be retried at most this many times if it results in a write-write conflict.
Default:
-config.retryOnConflict
--
-
-Optionaltimeout?: numberTime in milliseconds after which arangojs will abort the request if the +
Optionalsearch?: URLSearchParams | Record<string, any>URL parameters to pass as part of the query string.
+Optionaltimeout?: numberTime in milliseconds after which arangojs will abort the request if the socket has not already timed out.
-See also
-agentOptions.timeoutin Config.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias XhrOptions
Xhr
    beforeSend?: ((xhrObject: any) => void);
    maxSockets?: number;
    timeout?: number;
    useXdr?: boolean;
    withCredentials?: boolean;
    xhr?: any;
}
-Â Â Â Â beforeSend?: ((xhrObject: any) => void);
    maxSockets?: number;
    timeout?: number;
    useXdr?: boolean;
    withCredentials?: boolean;
    xhr?: any;
}
Options of the xhr module that can be set using agentOptions when using
-arangojs in the browser. Additionally maxSockets can be used to control
-the maximum number of parallel requests.
See also: xhr on npm.
-
Type declaration
--
-
-
-
-OptionalbeforeSend?: ((xhrObject: any) => void) -
-
-
-
-
-
- (xhrObject: any): void -
-
--
Callback that will be invoked immediately before the
-sendmethod of the -request is called.See also RequestInterceptors.
---Parameters
--
-
-
-
xhrObject: any
Returns void
-
-
- -
-
-
-
-OptionalmaxSockets?: number Maximum number of parallel requests arangojs will perform. If any -additional requests are attempted, they will be enqueued until one of the -active requests has completed.
-
- -
-
-Optionaltimeout?: numberNumber of milliseconds to wait for a response.
-Default:
-0(disabled)
- -
-
-OptionaluseXdr?: boolean (Internet Explorer 10 and lower only.) Whether
-XDomainRequestshould be -used instead ofXMLHttpRequest. Only required for performing -cross-domain requests in older versions of Internet Explorer.
- -
-
-OptionalwithCredentials?: boolean Specifies whether browser credentials (e.g. cookies) should be sent if -performing a cross-domain request.
- -
- -
-
-Optionalxhr?: any
-XMLHttpRequestobject to use instead of the native implementation.
-
-
\ No newline at end of file
diff --git a/devel/types/database.AccessLevel.html b/devel/types/database.AccessLevel.html
index ee0de5cec..4e92179b1 100644
--- a/devel/types/database.AccessLevel.html
+++ b/devel/types/database.AccessLevel.html
@@ -1,122 +1,2 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias AccessLevel
Access
-Access level for an ArangoDB user's access to a collection or database.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias AccessLevel
Access
Access level for an ArangoDB user's access to a collection or database.
+
-
-
-
-
-
-
-
-Type alias AqlUserFunction
Aql
    code: string;
    isDeterministic: boolean;
    name: string;
}
-Â Â Â Â code: string;
    isDeterministic: boolean;
    name: string;
}
Definition of an AQL User Function.
-
-
Type declaration
--
-
-
-
code: string
-Implementation of the AQL User Function.
-
- -
-
is
-Deterministic: boolean Whether the function is deterministic.
-See createFunction.
-
- -
-
name: string
-Name of the AQL User Function.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias AqlUserFunction
Aql
    code: string;
    isDeterministic: boolean;
    name: string;
}
    code: string;
    isDeterministic: boolean;
    name: string;
}
Definition of an AQL User Function.
+Type declaration
code: string
Implementation of the AQL User Function.
+is
Deterministic: boolean Whether the function is deterministic.
+ +name: string
Name of the AQL User Function.
+
-
-
-
-
-
-
-
-Type alias ArangoUser
Arango
    active: boolean;
    extra: Record<string, any>;
    user: string;
}
-Â Â Â Â active: boolean;
    extra: Record<string, any>;
    user: string;
}
Properties of an ArangoDB user object.
-
-
Type declaration
--
-
-
-
active: boolean
-Whether the ArangoDB user account is enabled and can authenticate.
-
- -
-
extra: Record<string, any>
-Additional information to store about this user.
-
- -
-
user: string
-ArangoDB username of the user.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoUser
Arango
    active: boolean;
    extra: Record<string, any>;
    user: string;
}
    active: boolean;
    extra: Record<string, any>;
    user: string;
}
Properties of an ArangoDB user object.
+Type declaration
active: boolean
Whether the ArangoDB user account is enabled and can authenticate.
+extra: Record<string, any>
Additional information to store about this user.
+user: string
ArangoDB username of the user.
+
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/types/database.ClusterImbalanceInfo.html b/devel/types/database.ClusterImbalanceInfo.html
index d6e6cfe46..237b0018e 100644
--- a/devel/types/database.ClusterImbalanceInfo.html
+++ b/devel/types/database.ClusterImbalanceInfo.html
@@ -1,191 +1,18 @@
-
-
-
-
-
-
-
-
-Type alias ClusterImbalanceInfo
Cluster
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}
-Â Â Â Â leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}
Information about a cluster imbalance.
-
-
Type declaration
--
-
-
-
leader: {
-
    imbalance: number;
    leaderDupl: number[];
    numberShards: number[];
    targetWeight: number[];
    totalShards: number;
    totalWeight: number;
    weightUsed: number[];
}-Information about the leader imbalance.
--
-
-
-
imbalance: number
-The measure of the total imbalance. A high value indicates a high imbalance.
-
- -
-
leader
-Dupl: number[] The measure of the leader shard distribution. The higher the number, the worse the distribution.
-
- -
-
number
-Shards: number[] The number of leader shards per DB-Server.
-
- -
-
target
-Weight: number[] The ideal weight of leader shards per DB-Server.
-
- -
-
total
-Shards: number The sum of shards, counting leader shards only.
-
- -
-
total
-Weight: number The sum of all weights.
-
- -
-
weight
-Used: number[] The weight of leader shards per DB-Server. A leader has a weight of 1 by default but it is higher if collections can only be moved together because of
-distributeShardsLike.
- -
-
-
-
shards: {
-
    imbalance: number;
    numberShards: number[];
    sizeUsed: number[];
    targetSize: number[];
    totalShards: number;
    totalShardsFromSystemCollections: number;
    totalUsed: number;
}-Information about the shard imbalance.
--
-
-
-
imbalance: number
-The measure of the total imbalance. A high value indicates a high imbalance.
-
- -
-
number
-Shards: number[] The number of leader and follower shards per DB-Server.
-
- -
-
size
-Used: number[] The size of shards per DB-Server.
-
- -
-
target
-Size: number[] The ideal size of shards per DB-Server.
-
- -
-
total
-Shards: number The sum of shards, counting leader and follower shards.
-
- -
-
total
-Shards From System Collections: number The sum of system collection shards, counting leader shards only.
-
- -
-
total
-Used: number The sum of the sizes.
-
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ClusterImbalanceInfo
Cluster
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}
    leader: {
        imbalance: number;
        leaderDupl: number[];
        numberShards: number[];
        targetWeight: number[];
        totalShards: number;
        totalWeight: number;
        weightUsed: number[];
    };
    shards: {
        imbalance: number;
        numberShards: number[];
        sizeUsed: number[];
        targetSize: number[];
        totalShards: number;
        totalShardsFromSystemCollections: number;
        totalUsed: number;
    };
}
Information about a cluster imbalance.
+Type declaration
leader: {
    imbalance: number;
    leaderDupl: number[];
    numberShards: number[];
    targetWeight: number[];
    totalShards: number;
    totalWeight: number;
    weightUsed: number[];
}Information about the leader imbalance.
+imbalance: number
The measure of the total imbalance. A high value indicates a high imbalance.
+leader
Dupl: number[] The measure of the leader shard distribution. The higher the number, the worse the distribution.
+number
Shards: number[] The number of leader shards per DB-Server.
+target
Weight: number[] The ideal weight of leader shards per DB-Server.
+total
Shards: number The sum of shards, counting leader shards only.
+total
Weight: number The sum of all weights.
+weight
Used: number[] The weight of leader shards per DB-Server. A leader has a weight of 1 by default but it is higher if collections can only be moved together because of
+distributeShardsLike.
shards: {
    imbalance: number;
    numberShards: number[];
    sizeUsed: number[];
    targetSize: number[];
    totalShards: number;
    totalShardsFromSystemCollections: number;
    totalUsed: number;
}Information about the shard imbalance.
+imbalance: number
The measure of the total imbalance. A high value indicates a high imbalance.
+number
Shards: number[] The number of leader and follower shards per DB-Server.
+size
Used: number[] The size of shards per DB-Server.
+target
Size: number[] The ideal size of shards per DB-Server.
+total
Shards: number The sum of shards, counting leader and follower shards.
+total
Shards From System Collections: number The sum of system collection shards, counting leader shards only.
+total
Used: number The sum of the sizes.
+
-
-
-
-
-
-
-Type alias ClusterRebalanceMove
Cluster
    collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}
-Â Â Â Â collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}
-
Type declaration
--
-
-
-
collection: number
-Collection ID of the collection the shard belongs to.
-
- -
-
from: string
-The server name from which to move.
-
- -
-
is
-Leader: boolean True if this is a leader move shard operation.
-
- -
-
shard: string
-Shard ID of the shard to be moved.
-
- -
-
to: string
-The ID of the destination server.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ClusterRebalanceMove
Cluster
    collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}
    collection: number;
    from: string;
    isLeader: boolean;
    shard: string;
    to: string;
}
Type declaration
collection: number
Collection ID of the collection the shard belongs to.
+from: string
The server name from which to move.
+is
Leader: boolean True if this is a leader move shard operation.
+shard: string
Shard ID of the shard to be moved.
+to: string
The ID of the destination server.
+
-
\ No newline at end of file
diff --git a/devel/types/database.ClusterRebalanceResult.html b/devel/types/database.ClusterRebalanceResult.html
index 1d1fccb69..1c9b6cce3 100644
--- a/devel/types/database.ClusterRebalanceResult.html
+++ b/devel/types/database.ClusterRebalanceResult.html
@@ -1,135 +1,4 @@
-
-
-
-
-
-Type alias ClusterRebalanceOptions
Cluster
    databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}
-Â Â Â Â databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}
Options for rebalancing the cluster.
-
-
Type declaration
--
-
-
-
-OptionaldatabasesExcluded?: string[] A list of database names to exclude from the analysis.
+ClusterRebalanceOptions | arangojs --Type alias ClusterRebalanceOptions
ClusterRebalance Options: {
    databasesExcluded?: string[];
    excludeSystemCollections?: boolean;
    leaderChanges?: boolean;
    maximumNumberOfMoves?: number;
    moveFollowers?: boolean;
    moveLeaders?: boolean;
    piFactor?: number;
}Options for rebalancing the cluster.
+Type declaration
OptionaldatabasesExcluded?: string[] A list of database names to exclude from the analysis.
Default:
-[]
--
-
-OptionalexcludeSystem Collections?: boolean Ignore system collections in the rebalance plan.
+ OptionalexcludeSystem Collections?: boolean Ignore system collections in the rebalance plan.
Default:
-false
--
-
-OptionalleaderChanges?: boolean Allow leader changes without moving data.
+ OptionalleaderChanges?: boolean Allow leader changes without moving data.
Default:
-true
--
-
-OptionalmaximumNumber Of Moves?: number Maximum number of moves to be computed.
+ OptionalmaximumNumber Of Moves?: number Maximum number of moves to be computed.
Default:
-1000
--
-
-OptionalmoveFollowers?: boolean Allow moving followers.
+ OptionalmoveFollowers?: boolean Allow moving followers.
Default:
-false
--
-
-OptionalmoveLeaders?: boolean Allow moving leaders.
+ OptionalmoveLeaders?: boolean Allow moving leaders.
Default:
-false
--
-
-OptionalpiFactor?: number Default:
-256**6
-- \ No newline at end of file +Generated using TypeDoc
OptionalpiFactor?: number Default:
+256**6
-
-
-
-
-
-
-Type alias ClusterRebalanceResult
Cluster
    imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}
-Â Â Â Â imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}
-
Type declaration
--
-
-
-
imbalance
-After: ClusterImbalanceInfo Expected imbalance after the suggested move shard operations are applied.
-
- -
-
imbalance
-Before: ClusterImbalanceInfo Imbalance before the suggested move shard operations are applied.
-
- -
-
moves: ClusterRebalanceMove[]
-Suggested move shard operations.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ClusterRebalanceResult
Cluster
    imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}
    imbalanceAfter: ClusterImbalanceInfo;
    imbalanceBefore: ClusterImbalanceInfo;
    moves: ClusterRebalanceMove[];
}
Type declaration
imbalance
After: ClusterImbalanceInfo Expected imbalance after the suggested move shard operations are applied.
+imbalance
Before: ClusterImbalanceInfo Imbalance before the suggested move shard operations are applied.
+moves: ClusterRebalanceMove[]
Suggested move shard operations.
+
-
-
-
-
-
-
-Type alias ClusterRebalanceState
Cluster
    pendingMoveShards: number;
    todoMoveShards: number;
}
-Â Â Â Â pendingMoveShards: number;
    todoMoveShards: number;
}
Information about the current state of the cluster imbalance.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ClusterRebalanceState
Cluster
    pendingMoveShards: number;
    todoMoveShards: number;
}
    pendingMoveShards: number;
    todoMoveShards: number;
}
Information about the current state of the cluster imbalance.
+Type declaration
pending
Move Shards: number The number of pending move shard operations.
+todo
Move Shards: number The number of planned move shard operations.
+
-
\ No newline at end of file
diff --git a/devel/types/database.CreateDatabaseUser.html b/devel/types/database.CreateDatabaseUser.html
index f322cb44b..90a8e97bb 100644
--- a/devel/types/database.CreateDatabaseUser.html
+++ b/devel/types/database.CreateDatabaseUser.html
@@ -1,143 +1,8 @@
-
-
-
-
-
-Type alias CreateDatabaseOptions
Create
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    users?: CreateDatabaseUser[];
    writeConcern?: number;
}
-Â Â Â Â replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    users?: CreateDatabaseUser[];
    writeConcern?: number;
}
Options for creating a database.
-See createDatabase.
-
-
Type declaration
--
-
-
-
-OptionalreplicationFactor?: "satellite" | number (Cluster only.) Default replication factor for new collections in this +
CreateDatabaseOptions | arangojs --Type alias CreateDatabaseOptions
CreateDatabase Options: {
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    users?: CreateDatabaseUser[];
    writeConcern?: number;
}Options for creating a database.
+ +Type declaration
OptionalreplicationFactor?: "satellite" | number (Cluster only.) Default replication factor for new collections in this database.
Setting this to
-1disables replication. Setting this to"satellite"will replicate to every DBServer.
--
-
-Optionalsharding?: "" | "flexible" | "single"(Cluster only.) The sharding method to use for new collections in the +
Optionalsharding?: "" | "flexible" | "single"(Cluster only.) The sharding method to use for new collections in the database.
-
--
-
-Optionalusers?: CreateDatabaseUser[]Database users to create with the database.
-
- -
-
-OptionalwriteConcern?: number (Cluster only.) Default write concern for new collections created in this +
Optionalusers?: CreateDatabaseUser[]Database users to create with the database.
+OptionalwriteConcern?: number (Cluster only.) Default write concern for new collections created in this database.
-
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.CreateUserOptions.html b/devel/types/database.CreateUserOptions.html
index 1889c44ad..6933dd2e3 100644
--- a/devel/types/database.CreateUserOptions.html
+++ b/devel/types/database.CreateUserOptions.html
@@ -1,143 +1,8 @@
-
-
-
-
-
-Type alias CreateDatabaseUser
Create
    active?: boolean;
    extra?: Record<string, any>;
    passwd?: string;
    username: string;
}
-Â Â Â Â active?: boolean;
    extra?: Record<string, any>;
    passwd?: string;
    username: string;
}
Database user to create with a database.
-
-
Type declaration
--
-
-
-
-Optionalactive?: booleanWhether the user is active.
+CreateDatabaseUser | arangojs --Type alias CreateDatabaseUser
CreateDatabase User: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd?: string;
    username: string;
}Database user to create with a database.
+Type declaration
Optionalactive?: booleanWhether the user is active.
Default:
-true
--
-
-Optionalextra?: Record<string, any>Additional data to store with the user object.
-
- -
-
-Optionalpasswd?: stringPassword of the user to create.
+ Optionalextra?: Record<string, any>Additional data to store with the user object.
+Optionalpasswd?: stringPassword of the user to create.
Default:
-""
--
-
username: string
-Username of the user to create.
-
-- \ No newline at end of file +Generated using TypeDoc
username: string
Username of the user to create.
+
-
\ No newline at end of file
diff --git a/devel/types/database.DatabaseInfo.html b/devel/types/database.DatabaseInfo.html
index 37561f091..aceef9085 100644
--- a/devel/types/database.DatabaseInfo.html
+++ b/devel/types/database.DatabaseInfo.html
@@ -1,157 +1,13 @@
-
-
-
-
-
-Type alias CreateUserOptions
Create
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
    user: string;
}
-Â Â Â Â active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
    user: string;
}
Options for creating an ArangoDB user.
-
-
Type declaration
--
-
-
-
-Optionalactive?: booleanWhether the ArangoDB user account is enabled and can authenticate.
+CreateUserOptions | arangojs --Type alias CreateUserOptions
CreateUser Options: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
    user: string;
}Options for creating an ArangoDB user.
+Type declaration
Optionalactive?: booleanWhether the ArangoDB user account is enabled and can authenticate.
Default:
-true
--
-
-Optionalextra?: Record<string, any>Additional information to store about this user.
+ Optionalextra?: Record<string, any>Additional information to store about this user.
Default:
-{}
--
-
passwd: string
-Password the ArangoDB user will use for authentication.
-
- -
-
user: string
-ArangoDB username of the user.
-
-- \ No newline at end of file +Generated using TypeDoc
passwd: string
Password the ArangoDB user will use for authentication.
+user: string
ArangoDB username of the user.
+
-
\ No newline at end of file
diff --git a/devel/types/database.ExplainOptions.html b/devel/types/database.ExplainOptions.html
index 0d98c43de..848e50034 100644
--- a/devel/types/database.ExplainOptions.html
+++ b/devel/types/database.ExplainOptions.html
@@ -1,148 +1,13 @@
-
-
-
-
-
-Type alias DatabaseInfo
Database
    id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}
-Â Â Â Â id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}
Object describing a database.
-See get.
-
-
Type declaration
--
-
-
-
id: string
-Unique identifier of the database.
-
- -
-
is
-System: boolean Whether the database is the system database.
-
- -
-
name: string
-Name of the database.
-
- -
-
path: string
-File system path of the database.
-
- -
-
-OptionalreplicationFactor?: "satellite" | number (Cluster only.) Default replication factor for new collections in this +
DatabaseInfo | arangojs --Type alias DatabaseInfo
DatabaseInfo: {
    id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}Object describing a database.
+See Database#get.
+Type declaration
id: string
Unique identifier of the database.
+is
System: boolean Whether the database is the system database.
+name: string
Name of the database.
+path: string
File system path of the database.
+OptionalreplicationFactor?: "satellite" | number (Cluster only.) Default replication factor for new collections in this database.
-
--
-
-Optionalsharding?: "" | "flexible" | "single"(Cluster only.) The sharding method to use for new collections in the +
Optionalsharding?: "" | "flexible" | "single"(Cluster only.) The sharding method to use for new collections in the database.
-
--
-
-OptionalwriteConcern?: number (Cluster only.) Default write concern for new collections created in this +
OptionalwriteConcern?: number (Cluster only.) Default write concern for new collections created in this database.
-
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.ExplainPlan.html b/devel/types/database.ExplainPlan.html
index b689aa612..c3c2c2738 100644
--- a/devel/types/database.ExplainPlan.html
+++ b/devel/types/database.ExplainPlan.html
@@ -1,153 +1,9 @@
-
-
-
-
-
-Type alias ExplainOptions
Explain
    allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}
-Â Â Â Â allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}
Options for explaining a query.
-See explain.
-
-
Type declaration
--
-
-
-
-OptionalallPlans?: boolean If set to true, all possible execution plans will be returned as the +
ExplainOptions | arangojs --Type alias ExplainOptions
ExplainOptions: {
    allPlans?: boolean;
    maxNumberOfPlans?: number;
    optimizer?: {
        rules: string[];
    };
}Options for explaining a query.
+See Database#explain.
+Type declaration
OptionalallPlans?: boolean If set to true, all possible execution plans will be returned as the
plansproperty. Otherwise only the optimal execution plan will be returned as theplanproperty.Default:
-false
--
-
-OptionalmaxNumber Of Plans?: number Maximum number of plans that the optimizer is allowed to generate. +
OptionalmaxNumber Of Plans?: number Maximum number of plans that the optimizer is allowed to generate. Setting this to a low value limits the amount of work the optimizer does.
-
--
-
-Optionaloptimizer?: {
    rules: string[];
}An object with a
rulesproperty specifying a list of optimizer rules to + Optionaloptimizer?: {
    rules: string[];
}-An object with a
-rulesproperty specifying a list of optimizer rules to be included or excluded by the optimizer for this query. Prefix a rule name with+to include it, or-to exclude it. The nameallacts as an alias matching all optimizer rules.-
-
-
-
rules: string[]
-
-
-- \ No newline at end of file +Generated using TypeDoc
rules: string[]
-
-
-
-
-
-
-
-Type alias ExplainPlan
Explain
    collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}
-Â Â Â Â collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}
Plan explaining query execution.
-
-
Type declaration
--
-
-
-
collections: {
-
    name: string;
    type: "read" | "write";
}[]Information about collections involved in the query.
-
- -
-
estimated
-Cost: number Total estimated cost of the plan.
-
- -
-
estimated
-Nr Items: number Estimated number of items returned by the query.
-
- -
-
is
-Modification Query: boolean Whether the query is a data modification query.
-
- -
-
nodes: {
-
    dependencies: number[];
    estimatedCost: number;
    estimatedNrItems: number;
    id: number;
    type: string;
    [key: string]: any;
}[]Execution nodes in this plan.
-
- -
-
rules: string[]
-Rules applied by the optimizer.
-
- -
-
variables: {
-
    id: number;
    name: string;
}[]Variables used in the query.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ExplainPlan
Explain
    collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}
    collections: {
        name: string;
        type: "read" | "write";
    }[];
    estimatedCost: number;
    estimatedNrItems: number;
    isModificationQuery: boolean;
    nodes: {
        dependencies: number[];
        estimatedCost: number;
        estimatedNrItems: number;
        id: number;
        type: string;
        [key: string]: any;
    }[];
    rules: string[];
    variables: {
        id: number;
        name: string;
    }[];
}
Plan explaining query execution.
+Type declaration
collections: {
    name: string;
    type: "read" | "write";
}[]Information about collections involved in the query.
+estimated
Cost: number Total estimated cost of the plan.
+estimated
Nr Items: number Estimated number of items returned by the query.
+is
Modification Query: boolean Whether the query is a data modification query.
+nodes: {
    dependencies: number[];
    estimatedCost: number;
    estimatedNrItems: number;
    id: number;
    type: string;
    [key: string]: any;
}[]Execution nodes in this plan.
+rules: string[]
Rules applied by the optimizer.
+variables: {
    id: number;
    name: string;
}[]Variables used in the query.
+
-
-
-
-
-
-
-
-Type alias ExplainStats
Explain
    executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}
-Â Â Â Â executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}
Optimizer statistics for an explained query.
-
-
Type declaration
--
-
-
-
execution
-Time: number Time in seconds needed to explain the query.
-
- -
-
peak
-Memory Usage: number Maximum memory usage in bytes of the query during explain.
-
- -
-
plans
-Created: number Total number of plans created.
-
- -
-
rules
-Executed: number Total number of rules executed for this query.
-
- -
-
rules
-Skipped: number Number of rules skipped for this query.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ExplainStats
Explain
    executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}
    executionTime: number;
    peakMemoryUsage: number;
    plansCreated: number;
    rulesExecuted: number;
    rulesSkipped: number;
}
Optimizer statistics for an explained query.
+Type declaration
execution
Time: number Time in seconds needed to explain the query.
+peak
Memory Usage: number Maximum memory usage in bytes of the query during explain.
+plans
Created: number Total number of plans created.
+rules
Executed: number Total number of rules executed for this query.
+rules
Skipped: number Number of rules skipped for this query.
+
-
-
-
-
-
-
-
-Type alias HotBackupList
Hot
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}
-Â Â Â Â list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}
(Enterprise Edition only.) List of known hot backups.
-
-
Type declaration
--
-
-
-
list: Record<string, HotBackupResult & {
    available: boolean;
    countIncludesFilesOnly: boolean;
    keys: any[];
    nrPiecesPresent: number;
    version: string;
}>
- -
-
server: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias HotBackupList
Hot
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}
    list: Record<string, HotBackupResult & {
        available: boolean;
        countIncludesFilesOnly: boolean;
        keys: any[];
        nrPiecesPresent: number;
        version: string;
    }>;
    server: string;
}
(Enterprise Edition only.) List of known hot backups.
+Type declaration
list: Record<string, HotBackupResult & {
    available: boolean;
    countIncludesFilesOnly: boolean;
    keys: any[];
    nrPiecesPresent: number;
    version: string;
}>server: string
-
\ No newline at end of file
diff --git a/devel/types/database.HotBackupResult.html b/devel/types/database.HotBackupResult.html
index 43b1a1fd0..15edda8e0 100644
--- a/devel/types/database.HotBackupResult.html
+++ b/devel/types/database.HotBackupResult.html
@@ -1,137 +1,2 @@
-
-
-
-
-
-Type alias HotBackupOptions
Hot
    allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}
-Â Â Â Â allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}
(Enterprise Edition only.) Options for creating a hot backup.
-
-
Type declaration
--
-
-
-
-OptionalallowInconsistent?: boolean If set to
trueand no global transaction lock can be acquired within the +HotBackupOptions | arangojs --Type alias HotBackupOptions
HotBackup Options: {
    allowInconsistent?: boolean;
    force?: boolean;
    label?: string;
    timeout?: number;
}(Enterprise Edition only.) Options for creating a hot backup.
+Type declaration
OptionalallowInconsistent?: boolean If set to
trueand no global transaction lock can be acquired within the given timeout, a possibly inconsistent backup is taken.Default:
-false
--
-
-Optionalforce?: boolean(Enterprise Edition cluster only.) If set to
trueand no global + Optionalforce?: boolean(Enterprise Edition cluster only.) If set to
trueand no global transaction lock can be acquired within the given timeout, all running transactions are forcefully aborted to ensure that a consistent backup can be created.Default:
-false.
--
-
-Optionallabel?: stringLabel to appended to the backup's identifier.
+ Optionallabel?: stringLabel to appended to the backup's identifier.
Default: If omitted or empty, a UUID will be generated.
-
--
-
-Optionaltimeout?: numberTime in seconds that the operation will attempt to get a consistent +
Optionaltimeout?: numberTime in seconds that the operation will attempt to get a consistent snapshot.
Default:
-120.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias HotBackupResult
Hot
    datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}
-Â Â Â Â datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}
(Enterprise Edition only.) Result of a hot backup.
-
-
Type declaration
--
-
-
-
datetime: string
- -
-
id: string
- -
-
nrDBServers: number
- -
-
nr
Files: number
- -
-
potentially
Inconsistent: boolean
- -
-
size
In Bytes: number
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias HotBackupResult
Hot
    datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}
    datetime: string;
    id: string;
    nrDBServers: number;
    nrFiles: number;
    potentiallyInconsistent: boolean;
    sizeInBytes: number;
}
(Enterprise Edition only.) Result of a hot backup.
+Type declaration
datetime: string
id: string
nrDBServers: number
nr
Files: number potentially
Inconsistent: boolean size
In Bytes: number
-
\ No newline at end of file
diff --git a/devel/types/database.LogEntries.html b/devel/types/database.LogEntries.html
index b43dfa027..7c2160c0e 100644
--- a/devel/types/database.LogEntries.html
+++ b/devel/types/database.LogEntries.html
@@ -1,137 +1,2 @@
-
-
-
-
-
-Type alias InstallServiceOptions
Install
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    legacy?: boolean;
    setup?: boolean;
}
-Â Â Â Â configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    legacy?: boolean;
    setup?: boolean;
}
Options for installing the service.
-See installService.
-
-
Type declaration
--
-
-
-
-Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
-See also getServiceConfiguration.
-
- -
-
-Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
-See also getServiceDependencies.
-
- -
-
-Optionaldevelopment?: booleanWhether the service should be installed in development mode.
-See also setServiceDevelopmentMode.
+InstallServiceOptions | arangojs --Type alias InstallServiceOptions
InstallService Options: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    legacy?: boolean;
    setup?: boolean;
}Options for installing the service.
+ +Type declaration
Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
+See also Database#getServiceConfiguration.
+Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
+See also Database#getServiceDependencies.
+Optionaldevelopment?: booleanWhether the service should be installed in development mode.
+See also Database#setServiceDevelopmentMode.
Default:
-false
--
-
-Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
+ Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
This overrides the
enginesoption in the service manifest (if any).Default:
-false
--
-
-Optionalsetup?: booleanWhether the "setup" script should be executed.
+ Optionalsetup?: booleanWhether the "setup" script should be executed.
Default:
-true
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias LogEntries
Log
    level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}
-Â Â Â Â level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}
An object representing a list of log entries.
-
-
Type declaration
--
-
-
-
level: LogLevel[]
- -
-
lid: number[]
- -
-
text: string[]
- -
-
timestamp: number[]
- -
-
topic: string[]
- -
-
total
Amount: number
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias LogEntries
Log
    level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}
    level: LogLevel[];
    lid: number[];
    text: string[];
    timestamp: number[];
    topic: string[];
    totalAmount: number;
}
An object representing a list of log entries.
+Type declaration
level: LogLevel[]
lid: number[]
text: string[]
timestamp: number[]
topic: string[]
total
Amount: number
-
\ No newline at end of file
diff --git a/devel/types/database.LogLevelLabel.html b/devel/types/database.LogLevelLabel.html
index d125e9146..08c11c728 100644
--- a/devel/types/database.LogLevelLabel.html
+++ b/devel/types/database.LogLevelLabel.html
@@ -1,122 +1,2 @@
-
-
-
-
-
-Type alias LogEntriesOptions
Log
    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}
-Â Â Â Â level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}
Options for retrieving log entries.
-
-
Type declaration
--
-
-
-
-Optionallevel?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>If set, only log entries with this log level will be returned.
-
- -
-
-Optionaloffset?: numberIf set, this many log entries will be skipped.
-
- -
-
-Optionalsearch?: stringIf set, only log entries containing the specified text will be returned.
-
- -
-
-Optionalsize?: numberIf set, only this many entries will be returned.
-
- -
-
-Optionalsort?: LogSortDirectionIf set to
"desc", log entries will be returned in reverse chronological +LogEntriesOptions | arangojs --Type alias LogEntriesOptions
LogEntries Options: {
    level?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
    offset?: number;
    search?: string;
    size?: number;
    sort?: LogSortDirection;
    start?: number;
    upto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>;
}Options for retrieving log entries.
+Type declaration
Optionallevel?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>If set, only log entries with this log level will be returned.
+Optionaloffset?: numberIf set, this many log entries will be skipped.
+Optionalsearch?: stringIf set, only log entries containing the specified text will be returned.
+Optionalsize?: numberIf set, only this many entries will be returned.
+Optionalsort?: LogSortDirectionIf set to
"desc", log entries will be returned in reverse chronological order.Default:
-"asc".
--
-
-Optionalstart?: numberIf set, only log entries with an
lidgreater than or equal to this value + Optionalstart?: numberIf set, only log entries with an
-lidgreater than or equal to this value will be returned.
--
-
-Optionalupto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>Maximum log level of the entries to retrieve.
+ Optionalupto?: LogLevel | LogLevelLabel | Lowercase<LogLevelLabel>Maximum log level of the entries to retrieve.
Default:
-INFO.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-Type alias LogLevelLabel
Log
-String representation of the logging level of a log entry.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias LogLevelLabel
Log
String representation of the logging level of a log entry.
+
-
-
-
-
-
-
-
-Type alias LogLevelSetting
Logging level setting.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
\ No newline at end of file
diff --git a/devel/types/database.LogMessage.html b/devel/types/database.LogMessage.html
index 6d8422456..79663136c 100644
--- a/devel/types/database.LogMessage.html
+++ b/devel/types/database.LogMessage.html
@@ -1,135 +1,2 @@
-
-
-
-
-
-
-
-
-Type alias LogMessage
Log
    date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}
-Â Â Â Â date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}
An object representing a single log entry.
-
-
Type declaration
--
-
-
-
date: string
- -
-
id: number
- -
-
level: LogLevelLabel
- -
-
message: string
- -
-
topic: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias LogMessage
Log
    date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}
    date: string;
    id: number;
    level: LogLevelLabel;
    message: string;
    topic: string;
}
An object representing a single log entry.
+Type declaration
date: string
id: number
level: LogLevelLabel
message: string
topic: string
-
-
-
-
-
-
-Type alias LogSortDirection
Log
-Log sorting direction, ascending or descending.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias LogSortDirection
Log
Log sorting direction, ascending or descending.
+
-
-
-
-
-
-
-
-Type alias MultiExplainResult
Multi
    cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
-Â Â Â Â cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
Result of explaining a query with multiple plans.
-
-
Type declaration
--
-
-
-
cacheable: boolean
-Whether it would be possible to cache the query.
-
- -
-
plans: ExplainPlan[]
-Query plans.
-
- -
-
stats: ExplainStats
-Optimizer statistics for the explained query.
-
- -
-
warnings: {
-
    code: number;
    message: string;
}[]Warnings encountered while planning the query execution.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias MultiExplainResult
Multi
    cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
    cacheable: boolean;
    plans: ExplainPlan[];
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
Result of explaining a query with multiple plans.
+Type declaration
cacheable: boolean
Whether it would be possible to cache the query.
+plans: ExplainPlan[]
Query plans.
+stats: ExplainStats
Optimizer statistics for the explained query.
+warnings: {
    code: number;
    message: string;
}[]Warnings encountered while planning the query execution.
+
-
\ No newline at end of file
diff --git a/devel/types/database.ParseResult.html b/devel/types/database.ParseResult.html
index 6c2764686..8e8ac7771 100644
--- a/devel/types/database.ParseResult.html
+++ b/devel/types/database.ParseResult.html
@@ -1,141 +1,6 @@
-
-
-
-
-
-Type alias MultiServiceDependency
Multi
    current?: string[];
    description?: string;
    multiple: true;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
-Â Â Â Â current?: string[];
    description?: string;
    multiple: true;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
Object describing a multi-service dependency defined by a Foxx service.
-
-
Type declaration
--
-
-
-
-Optionalcurrent?: string[]Current mount points the dependency is resolved to.
-
- -
-
-Optionaldescription?: stringHuman-readable description of the dependency.
-
- -
-
multiple: true
-Whether this is a multi-service dependency.
-
- -
-
name: string
-Name of the service the dependency expects to match.
-
- -
-
required: boolean
-Whether the dependency must be matched in order for the service +
MultiServiceDependency | arangojs --Type alias MultiServiceDependency
MultiService Dependency: {
    current?: string[];
    description?: string;
    multiple: true;
    name: string;
    required: boolean;
    title: string;
    version: string;
}Object describing a multi-service dependency defined by a Foxx service.
+Type declaration
Optionalcurrent?: string[]Current mount points the dependency is resolved to.
+Optionaldescription?: stringHuman-readable description of the dependency.
+multiple: true
Whether this is a multi-service dependency.
+name: string
Name of the service the dependency expects to match.
+required: boolean
Whether the dependency must be matched in order for the service to be operational.
-
--
-
title: string
-Formatted name of the dependency.
-
- -
-
version: string
-Version of the service the dependency expects to match.
-
-- \ No newline at end of file +Generated using TypeDoc
title: string
Formatted name of the dependency.
+version: string
Version of the service the dependency expects to match.
+
-
-
-
-
-
-
-
-Type alias ParseResult
Parse
    ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}
-Â Â Â Â ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}
Result of parsing a query.
-
-
Type declaration
--
-
-
-
ast: AstNode[]
-Abstract syntax tree (AST) of the query.
-
- -
-
bind
-Vars: string[] Names of all bind parameters used in the query.
-
- -
-
collections: string[]
-Names of all collections involved in the query.
-
- -
-
parsed: boolean
-Whether the query was parsed.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ParseResult
Parse
    ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}
    ast: AstNode[];
    bindVars: string[];
    collections: string[];
    parsed: boolean;
}
Result of parsing a query.
+Type declaration
ast: AstNode[]
Abstract syntax tree (AST) of the query.
+bind
Vars: string[] Names of all bind parameters used in the query.
+collections: string[]
Names of all collections involved in the query.
+parsed: boolean
Whether the query was parsed.
+
-
-
-
-
-
-
-
-Type alias QueryInfo
Query
    bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}
-Â Â Â Â bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}
Object describing a query.
-
-
Type declaration
--
-
-
-
bind
-Vars: Record<string, any> Bind parameters used in the query.
-
- -
-
database: string
-Name of the database the query runs in.
-
- -
-
id: string
-Unique identifier for this query.
-
- -
-
peak
-Memory Usage: number Maximum memory usage in bytes of the query.
-
- -
-
query: string
-Query string (potentially truncated).
-
- -
-
run
-Time: number Query's running time in seconds.
-
- -
-
started: string
-Date and time the query was started.
-
- -
-
state: "executing" | "finished" | "killed"
-Query's current execution state.
-
- -
-
stream: boolean
-Whether the query uses a streaming cursor.
-
- -
-
user: string
-Name of the user that started the query.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias QueryInfo
Query
    bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}
    bindVars: Record<string, any>;
    database: string;
    id: string;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}
Object describing a query.
+Type declaration
bind
Vars: Record<string, any> Bind parameters used in the query.
+database: string
Name of the database the query runs in.
+id: string
Unique identifier for this query.
+peak
Memory Usage: number Maximum memory usage in bytes of the query.
+query: string
Query string (potentially truncated).
+run
Time: number Query's running time in seconds.
+started: string
Date and time the query was started.
+state: "executing" | "finished" | "killed"
Query's current execution state.
+stream: boolean
Whether the query uses a streaming cursor.
+user: string
Name of the user that started the query.
+
-
-
-
-
-
-
-
-Type alias QueryOptimizerRule
Query
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}
-Â Â Â Â flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}
Optimizer rule for AQL queries.
-
-
Type declaration
--
-
-
-
flags: {
-
    canBeDisabled: boolean;
    canCreateAdditionalPlans: boolean;
    clusterOnly: boolean;
    disabledByDefault: boolean;
    enterpriseOnly: boolean;
    hidden: boolean;
}-
-
-
-
can
Be Disabled: boolean
- -
-
can
Create Additional Plans: boolean
- -
-
cluster
Only: boolean
- -
-
disabled
By Default: boolean
- -
-
enterprise
Only: boolean
- -
-
hidden: boolean
- -
-
-
-
name: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias QueryOptimizerRule
Query
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}
    flags: {
        canBeDisabled: boolean;
        canCreateAdditionalPlans: boolean;
        clusterOnly: boolean;
        disabledByDefault: boolean;
        enterpriseOnly: boolean;
        hidden: boolean;
    };
    name: string;
}
Optimizer rule for AQL queries.
+Type declaration
flags: {
    canBeDisabled: boolean;
    canCreateAdditionalPlans: boolean;
    clusterOnly: boolean;
    disabledByDefault: boolean;
    enterpriseOnly: boolean;
    hidden: boolean;
}can
Be Disabled: boolean can
Create Additional Plans: boolean cluster
Only: boolean disabled
By Default: boolean enterprise
Only: boolean hidden: boolean
name: string
-
\ No newline at end of file
diff --git a/devel/types/database.QueryTracking.html b/devel/types/database.QueryTracking.html
index 546ebb6b9..54bcc156a 100644
--- a/devel/types/database.QueryTracking.html
+++ b/devel/types/database.QueryTracking.html
@@ -1,150 +1,9 @@
-
-
-
-
-
-Type alias QueryOptions
Query
    allowDirtyRead?: boolean;
    allowRetry?: boolean;
    batchSize?: number;
    cache?: boolean;
    count?: boolean;
    failOnWarning?: boolean;
    fillBlockCache?: boolean;
    fullCount?: boolean;
    intermediateCommitCount?: number;
    intermediateCommitSize?: number;
    maxNodesPerCallstack?: number;
    maxPlans?: number;
    maxRuntime?: number;
    maxTransactionSize?: number;
    maxWarningsCount?: number;
    memoryLimit?: number;
    optimizer?: {
        rules: string[];
    };
    profile?: boolean | number;
    retryOnConflict?: number;
    satelliteSyncWait?: number;
    skipInaccessibleCollections?: boolean;
    stream?: boolean;
    timeout?: number;
    ttl?: number;
}
-Â Â Â Â allowDirtyRead?: boolean;
    allowRetry?: boolean;
    batchSize?: number;
    cache?: boolean;
    count?: boolean;
    failOnWarning?: boolean;
    fillBlockCache?: boolean;
    fullCount?: boolean;
    intermediateCommitCount?: number;
    intermediateCommitSize?: number;
    maxNodesPerCallstack?: number;
    maxPlans?: number;
    maxRuntime?: number;
    maxTransactionSize?: number;
    maxWarningsCount?: number;
    memoryLimit?: number;
    optimizer?: {
        rules: string[];
    };
    profile?: boolean | number;
    retryOnConflict?: number;
    satelliteSyncWait?: number;
    skipInaccessibleCollections?: boolean;
    stream?: boolean;
    timeout?: number;
    ttl?: number;
}
Options for executing a query.
-See query.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the query will be executed with support for dirty reads +QueryOptions | arangojs --Type alias QueryOptions
QueryOptions: {
    allowDirtyRead?: boolean;
    allowRetry?: boolean;
    batchSize?: number;
    cache?: boolean;
    count?: boolean;
    failOnWarning?: boolean;
    fillBlockCache?: boolean;
    fullCount?: boolean;
    intermediateCommitCount?: number;
    intermediateCommitSize?: number;
    maxNodesPerCallstack?: number;
    maxPlans?: number;
    maxRuntime?: number;
    maxTransactionSize?: number;
    maxWarningsCount?: number;
    memoryLimit?: number;
    optimizer?: {
        rules: string[];
    };
    profile?: boolean | number;
    retryOnConflict?: number;
    satelliteSyncWait?: number;
    skipInaccessibleCollections?: boolean;
    stream?: boolean;
    timeout?: number;
    ttl?: number;
}Options for executing a query.
+See Database#query.
+Type declaration
OptionalallowDirty Read?: boolean If set to
@@ -33,246 +8,73 @@true, the query will be executed with support for dirty reads enabled, permitting ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.OptionalallowDirty modification queries (e.g. using INSERT,UPDATE,REPLACEorREMOVE) and only when using ArangoDB 3.4 or later.Default:
-false
--
-
-OptionalallowRetry?: boolean If set to
true, cursor results will be stored by ArangoDB in such a way + OptionalallowRetry?: boolean If set to
true, cursor results will be stored by ArangoDB in such a way that batch reads can be retried in the case of a communication error.Default:
-false
--
-
-OptionalbatchSize?: number Number of result values to be transferred by the server in each +
OptionalbatchSize?: number Number of result values to be transferred by the server in each network roundtrip (or "batch").
Must be greater than zero.
-
--
-
-Optionalcache?: booleanIf set to
false, the AQL query results cache lookup will be skipped for + Optionalcache?: booleanIf set to
false, the AQL query results cache lookup will be skipped for this query.Default:
-true
--
-
-Optionalcount?: booleanUnless set to
false, the number of result values in the result set will + Optionalcount?: booleanUnless set to
false, the number of result values in the result set will be returned in thecountattribute. This may be disabled by default in a future version of ArangoDB if calculating this value has a performance impact for some queries.Default:
-true.
--
-
-OptionalfailOn Warning?: boolean If set to
true, the query will throw an exception and abort if it would + OptionalfailOn Warning?: boolean If set to
-true, the query will throw an exception and abort if it would otherwise produce a warning.
--
-
-OptionalfillBlock Cache?: boolean If set to
false, the query data will not be stored in the RocksDB block + OptionalfillBlock Cache?: boolean If set to
-false, the query data will not be stored in the RocksDB block cache. This can be used to avoid thrashing he block cache when reading a lot of data.
--
-
-OptionalfullCount?: boolean If set to
trueand the query has aLIMITclause, the total number of + OptionalfullCount?: boolean If set to
-trueand the query has aLIMITclause, the total number of values matched before the last top-levelLIMITin the query was applied will be returned in theextra.stats.fullCountattribute.
--
-
-OptionalintermediateCommit Count?: number (RocksDB only.) Maximum number of operations after which an intermediate +
OptionalintermediateCommit Count?: number Maximum number of operations after which an intermediate commit is +automatically performed.
+OptionalintermediateCommit Size?: number Maximum total size of operations in bytes after which an intermediate commit is automatically performed.
-
--
-
-OptionalintermediateCommit Size?: number (RocksDB only.) Maximum total size of operations in bytes after which an -intermediate commit is automatically performed.
-
- -
-
-OptionalmaxNodes Per Callstack?: number Controls after how many execution nodes in a query a stack split should be +
OptionalmaxNodes Per Callstack?: number Controls after how many execution nodes in a query a stack split should be performed.
Default:
-250(200on macOS)
--
-
-OptionalmaxPlans?: number Limits the maximum number of plans that will be created by the AQL query +
OptionalmaxPlans?: number Limits the maximum number of plans that will be created by the AQL query optimizer.
-
--
-
-OptionalmaxRuntime?: number Maximum allowed execution time before the query will be killed in seconds.
+ OptionalmaxRuntime?: number Maximum allowed execution time before the query will be killed in seconds.
If set to
0, the query will be allowed to run indefinitely.Default:
-0
--
-
-OptionalmaxTransaction Size?: number (RocksDB only.) Maximum size of transactions in bytes.
-
- -
-
-OptionalmaxWarnings Count?: number Limits the maximum number of warnings a query will return.
-
- -
-
-OptionalmemoryLimit?: number Maximum memory size in bytes that the query is allowed to use. +
OptionalmaxTransaction Size?: number Maximum size of transactions in bytes.
+OptionalmaxWarnings Count?: number Limits the maximum number of warnings a query will return.
+OptionalmemoryLimit?: number Maximum memory size in bytes that the query is allowed to use. Exceeding this value will result in the query failing with an error.
If set to
0, the memory limit is disabled.Default:
-0
--
-
-Optionaloptimizer?: {
    rules: string[];
}An object with a
rulesproperty specifying a list of optimizer rules to + Optionaloptimizer?: {
    rules: string[];
}-An object with a
-rulesproperty specifying a list of optimizer rules to be included or excluded by the optimizer for this query. Prefix a rule name with+to include it, or-to exclude it. The nameallacts as an alias matching all optimizer rules.-
-
-
-
rules: string[]
--
-
-
-
-Optionalprofile?: boolean | numberIf set to
1ortrue, additional query profiling information will be +rules: string[]
Optionalprofile?: boolean | numberIf set to
1ortrue, additional query profiling information will be returned in theextra.profileattribute if the query is not served from the result cache.If set to
-2, the query will return execution stats per query plan node in theextra.stats.nodesattribute. Additionally the query plan is returned inextra.plan.
--
-
-OptionalretryOn Conflict?: number If set to a positive number, the query will automatically be retried at +
OptionalretryOn Conflict?: number If set to a positive number, the query will automatically be retried at most this many times if it results in a write-write conflict.
Default:
-0
--
-
-OptionalsatelliteSync Wait?: number (Enterprise Edition cluster only.) Limits the maximum time in seconds a +
OptionalsatelliteSync Wait?: number (Enterprise Edition cluster only.) Limits the maximum time in seconds a DBServer will wait to bring satellite collections involved in the query into sync. Exceeding this value will result in the query being stopped.
Default:
-60
--
-
-OptionalskipInaccessible Collections?: boolean (Enterprise Edition cluster only.) If set to
true, collections + OptionalskipInaccessible Collections?: boolean (Enterprise Edition cluster only.) If set to
-true, collections inaccessible to current user will result in an access error instead of being treated as empty.
--
-
-Optionalstream?: booleanIf set to
-true, the query will be executed as a streaming query.
- -
-
-Optionaltimeout?: numberMaximum time in milliseconds arangojs will wait for a server response. +
Optionalstream?: booleanIf set to
+true, the query will be executed as a streaming query.Optionaltimeout?: numberMaximum time in milliseconds arangojs will wait for a server response. Exceeding this value will result in the request being cancelled.
Note: Setting a timeout for the client does not guarantee the query will be killed by ArangoDB if it is already being executed. See the
-maxRuntimeoption for limiting the execution time within ArangoDB.
--
-
-Optionalttl?: numberTime-to-live for the cursor in seconds. The cursor results may be +
Optionalttl?: numberTime-to-live for the cursor in seconds. The cursor results may be garbage collected by ArangoDB after this much time has passed.
Default:
-30
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.QueryTrackingOptions.html b/devel/types/database.QueryTrackingOptions.html
index fd3185769..70ce0c739 100644
--- a/devel/types/database.QueryTrackingOptions.html
+++ b/devel/types/database.QueryTrackingOptions.html
@@ -1,152 +1,11 @@
-
-
-
-
-
-Type alias QueryTracking
Query
    enabled: boolean;
    maxQueryStringLength: number;
    maxSlowQueries: number;
    slowQueryThreshold: number;
    trackBindVars: boolean;
    trackSlowQueries: boolean;
}
-Â Â Â Â enabled: boolean;
    maxQueryStringLength: number;
    maxSlowQueries: number;
    slowQueryThreshold: number;
    trackBindVars: boolean;
    trackSlowQueries: boolean;
}
Information about query tracking.
-
-
Type declaration
--
-
-
-
enabled: boolean
-Whether query tracking is enabled.
-
- -
-
max
-Query String Length: number Maximum query string length in bytes that is kept in the list.
-
- -
-
max
-Slow Queries: number Maximum number of slow queries that is kept in the list.
-
- -
-
slow
-Query Threshold: number Threshold execution time in seconds for when a query is +
QueryTracking | arangojs --Type alias QueryTracking
QueryTracking: {
    enabled: boolean;
    maxQueryStringLength: number;
    maxSlowQueries: number;
    slowQueryThreshold: number;
    trackBindVars: boolean;
    trackSlowQueries: boolean;
}Information about query tracking.
+Type declaration
enabled: boolean
Whether query tracking is enabled.
+max
Query String Length: number Maximum query string length in bytes that is kept in the list.
+max
Slow Queries: number Maximum number of slow queries that is kept in the list.
+slow
Query Threshold: number Threshold execution time in seconds for when a query is considered slow.
-
--
-
track
-Bind Vars: boolean Whether bind parameters are being tracked along with queries.
-
- -
-
track
-Slow Queries: boolean Whether slow queries are being tracked.
-
-- \ No newline at end of file +Generated using TypeDoc
track
Bind Vars: boolean Whether bind parameters are being tracked along with queries.
+track
Slow Queries: boolean Whether slow queries are being tracked.
+
-
\ No newline at end of file
diff --git a/devel/types/database.QueueTimeMetrics.html b/devel/types/database.QueueTimeMetrics.html
index fe4b7a5f1..0f973b0e5 100644
--- a/devel/types/database.QueueTimeMetrics.html
+++ b/devel/types/database.QueueTimeMetrics.html
@@ -1,159 +1,9 @@
-
-
-
-
-
-Type alias QueryTrackingOptions
Query
    enabled?: boolean;
    maxQueryStringLength?: number;
    maxSlowQueries?: number;
    slowQueryThreshold?: number;
    trackBindVars?: boolean;
    trackSlowQueries?: boolean;
}
-Â Â Â Â enabled?: boolean;
    maxQueryStringLength?: number;
    maxSlowQueries?: number;
    slowQueryThreshold?: number;
    trackBindVars?: boolean;
    trackSlowQueries?: boolean;
}
Options for query tracking.
-See queryTracking.
-
-
Type declaration
--
-
-
-
-Optionalenabled?: booleanIf set to
-false, neither queries nor slow queries will be tracked.
- -
-
-OptionalmaxQuery String Length?: number Maximum query string length in bytes that will be kept in the list.
-
- -
-
-OptionalmaxSlow Queries?: number Maximum number of slow queries to be kept in the list.
-
- -
-
-OptionalslowQuery Threshold?: number Threshold execution time in seconds for when a query will be +
QueryTrackingOptions | arangojs --Type alias QueryTrackingOptions
QueryTracking Options: {
    enabled?: boolean;
    maxQueryStringLength?: number;
    maxSlowQueries?: number;
    slowQueryThreshold?: number;
    trackBindVars?: boolean;
    trackSlowQueries?: boolean;
}Options for query tracking.
+ +Type declaration
Optionalenabled?: booleanIf set to
+false, neither queries nor slow queries will be tracked.OptionalmaxQuery String Length?: number Maximum query string length in bytes that will be kept in the list.
+OptionalmaxSlow Queries?: number Maximum number of slow queries to be kept in the list.
+OptionalslowQuery Threshold?: number Threshold execution time in seconds for when a query will be considered slow.
-
--
-
-OptionaltrackBind Vars?: boolean If set to
-true, bind parameters will be tracked along with queries.
- -
-
-OptionaltrackSlow Queries?: boolean If set to
trueandenabledis also set totrue, slow queries will be + OptionaltrackBind Vars?: boolean If set to
+true, bind parameters will be tracked along with queries.OptionaltrackSlow Queries?: boolean If set to
-trueandenabledis also set totrue, slow queries will be tracked if their execution time exceedsslowQueryThreshold.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.ReplaceServiceOptions.html b/devel/types/database.ReplaceServiceOptions.html
index 0ce64e3e3..c8af39c93 100644
--- a/devel/types/database.ReplaceServiceOptions.html
+++ b/devel/types/database.ReplaceServiceOptions.html
@@ -1,165 +1,21 @@
-
-QueueTimeMetrics | arangojs
-
-
-Type alias QueueTimeMetrics
Queue
    getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}
-Â Â Â Â getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}
An object providing methods for accessing queue time metrics of the most +
Type alias QueueTimeMetrics
Queue
    getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}
    getAvg: (() => number);
    getLatest: (() => number | undefined);
    getValues: (() => [number, number][]);
}
An object providing methods for accessing queue time metrics of the most recently received server responses if the server supports this feature.
-
-
-Type declaration
--
-
-
-
get
-Avg: (() => number) -
-
-
-
-
-
- (): number -
-
-
Returns the average queue time of the most recently received responses +
Type declaration
get
Avg: (() => number) -Returns the average queue time of the most recently received responses in seconds.
-Returns number
- -
-get
-Latest: (() => number | undefined) -
-
-
-
-
-
- (): number | undefined -
-
--
Returns the queue time of the most recently received response in seconds.
-Returns number | undefined
- -
get
-Values: (() => [number, number][]) -
-
-
-
-
-
- (): [number, number][] -
-
-
Returns a list of the most recently received queue time values as tuples +
- (): number
Returns number
get
Latest: (() => number | undefined) Returns the queue time of the most recently received response in seconds.
+- (): number | undefined
Returns number | undefined
get
Values: (() => [number, number][]) -Returns a list of the most recently received queue time values as tuples of the timestamp of the response being processed in milliseconds and the queue time in seconds.
-Returns [number, number][]
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
- (): [number, number][]
Returns [number, number][]
-
\ No newline at end of file
diff --git a/devel/types/database.ServiceConfiguration.html b/devel/types/database.ServiceConfiguration.html
index d68021ab7..c23f2f6eb 100644
--- a/devel/types/database.ServiceConfiguration.html
+++ b/devel/types/database.ServiceConfiguration.html
@@ -1,159 +1,15 @@
-
-
-
-
-
-Type alias ReplaceServiceOptions
Replace
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
-Â Â Â Â configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
Options for replacing a service.
-See replaceService.
-
-
Type declaration
--
-
-
-
-Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
-See also getServiceConfiguration.
-
- -
-
-Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
-See also getServiceDependencies.
-
- -
-
-Optionaldevelopment?: booleanWhether the service should be installed in development mode.
-See also setServiceDevelopmentMode.
+ReplaceServiceOptions | arangojs --Type alias ReplaceServiceOptions
ReplaceService Options: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}Options for replacing a service.
+ +Type declaration
Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
+See also Database#getServiceConfiguration.
+Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
+See also Database#getServiceDependencies.
+Optionaldevelopment?: booleanWhether the service should be installed in development mode.
+See also Database#setServiceDevelopmentMode.
Default:
-false
--
-
-Optionalforce?: booleanIf set to
true, replacing a service that does not already exist will + Optionalforce?: booleanIf set to
true, replacing a service that does not already exist will fall back to installing the new service.Default:
-false
--
-
-Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
+ Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
This overrides the
enginesoption in the service manifest (if any).Default:
-false
--
-
-Optionalsetup?: booleanWhether the "setup" script should be executed.
+ Optionalsetup?: booleanWhether the "setup" script should be executed.
Default:
-true
--
-
-Optionalteardown?: booleanWhether the existing service's "teardown" script should be executed +
Optionalteardown?: booleanWhether the existing service's "teardown" script should be executed prior to removing that service.
Default:
-true
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.ServiceInfo.html b/devel/types/database.ServiceInfo.html
index a31acc1e2..355bc99c0 100644
--- a/devel/types/database.ServiceInfo.html
+++ b/devel/types/database.ServiceInfo.html
@@ -1,170 +1,13 @@
-
-
-
-
-
-Type alias ServiceConfiguration
Service
    current: any;
    currentRaw: any;
    default?: any;
    description?: string;
    required: boolean;
    title: string;
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool";
}
-Â Â Â Â current: any;
    currentRaw: any;
    default?: any;
    description?: string;
    required: boolean;
    title: string;
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool";
}
Object describing a configuration option of a Foxx service.
-
-
Type declaration
--
-
-
-
current: any
-Processed current value of the configuration option as exposed in the +
ServiceConfiguration | arangojs --Type alias ServiceConfiguration
ServiceConfiguration: {
    current: any;
    currentRaw: any;
    default?: any;
    description?: string;
    required: boolean;
    title: string;
    type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool";
}Object describing a configuration option of a Foxx service.
+Type declaration
current: any
Processed current value of the configuration option as exposed in the service code.
-
--
-
current
-Raw: any Current value of the configuration option as stored internally.
-
- -
-
-Optionaldefault?: anyDefault value of the configuration option.
-
- -
-
-Optionaldescription?: stringHuman-readable description of the configuration option.
-
- -
-
required: boolean
-Whether the configuration option must be set in order for the service +
current
Raw: any Current value of the configuration option as stored internally.
+Optionaldefault?: anyDefault value of the configuration option.
+Optionaldescription?: stringHuman-readable description of the configuration option.
+required: boolean
Whether the configuration option must be set in order for the service to be operational.
-
--
-
title: string
-Formatted name of the configuration option.
-
- -
-
type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool"
-Data type of the configuration value.
+ title: string
Formatted name of the configuration option.
+type: "integer" | "boolean" | "string" | "number" | "json" | "password" | "int" | "bool"
Data type of the configuration value.
Note:
-"int"and"bool"are historical synonyms for"integer"and"boolean". The"password"type is synonymous with"string"but can be used to distinguish values which should not be displayed in plain text by software when managing the service.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ServiceInfo
Service
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}
-Â Â Â Â checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}
Object describing a Foxx service in detail.
-
-
Type declaration
--
-
-
-
checksum: string
-Internal checksum of the service's initial source bundle.
-
- -
-
development: boolean
-Whether development mode is enabled for this service.
-
- -
-
legacy: boolean
-Whether the service is running in legacy compatibility mode.
-
- -
-
manifest: FoxxManifest
-Content of the service manifest of this service.
-
- -
-
mount: string
-Service mount point, relative to the database.
-
- -
-
-Optionalname?: stringName defined in the service manifest.
-
- -
-
options: {
-
    configuration: Record<string, any>;
    dependencies: Record<string, string>;
}-Options for this service.
--
-
-
-
configuration: Record<string, any>
-Configuration values set for this service.
-
- -
-
dependencies: Record<string, string>
-Service dependency configuration of this service.
-
- -
-
-
-
path: string
-File system path of the service.
-
- -
-
-Optionalversion?: stringVersion defined in the service manifest.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceInfo
Service
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}
    checksum: string;
    development: boolean;
    legacy: boolean;
    manifest: FoxxManifest;
    mount: string;
    name?: string;
    options: {
        configuration: Record<string, any>;
        dependencies: Record<string, string>;
    };
    path: string;
    version?: string;
}
Object describing a Foxx service in detail.
+Type declaration
checksum: string
Internal checksum of the service's initial source bundle.
+development: boolean
Whether development mode is enabled for this service.
+legacy: boolean
Whether the service is running in legacy compatibility mode.
+manifest: FoxxManifest
Content of the service manifest of this service.
+mount: string
Service mount point, relative to the database.
+Optionalname?: stringName defined in the service manifest.
+options: {
    configuration: Record<string, any>;
    dependencies: Record<string, string>;
}Options for this service.
+configuration: Record<string, any>
Configuration values set for this service.
+dependencies: Record<string, string>
Service dependency configuration of this service.
+
path: string
File system path of the service.
+Optionalversion?: stringVersion defined in the service manifest.
+
-
\ No newline at end of file
diff --git a/devel/types/database.ServiceTestDefaultReport.html b/devel/types/database.ServiceTestDefaultReport.html
index e8052408c..263a7ae4d 100644
--- a/devel/types/database.ServiceTestDefaultReport.html
+++ b/devel/types/database.ServiceTestDefaultReport.html
@@ -1,135 +1,2 @@
-
-
-
-
-
-Type alias ServiceSummary
Service
    development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}
-Â Â Â Â development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}
Object briefly describing a Foxx service.
-
-
Type declaration
--
-
-
-
development: boolean
-Whether development mode is enabled for this service.
-
- -
-
legacy: boolean
-Whether the service is running in legacy compatibility mode.
-
- -
-
mount: string
-Service mount point, relative to the database.
-
- -
-
-Optionalname?: stringName defined in the service manifest.
-
- -
-
provides: Record<string, string>
-Service dependencies the service expects to be able to match as a mapping +
ServiceSummary | arangojs --Type alias ServiceSummary
ServiceSummary: {
    development: boolean;
    legacy: boolean;
    mount: string;
    name?: string;
    provides: Record<string, string>;
    version?: string;
}Object briefly describing a Foxx service.
+Type declaration
development: boolean
Whether development mode is enabled for this service.
+legacy: boolean
Whether the service is running in legacy compatibility mode.
+mount: string
Service mount point, relative to the database.
+Optionalname?: stringName defined in the service manifest.
+provides: Record<string, string>
Service dependencies the service expects to be able to match as a mapping from dependency names to versions the service is compatible with.
-
--
-
-Optionalversion?: stringVersion defined in the service manifest.
-
-- \ No newline at end of file +Generated using TypeDoc
Optionalversion?: stringVersion defined in the service manifest.
+
-
-
-
-
-
-
-
-Type alias ServiceTestDefaultReport
Service
    failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}
-Â Â Â Â failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}
Test results for a Foxx service's tests using the default reporter.
-
-
Type declaration
--
-
-
-
failures: ServiceTestDefaultTest[]
- -
-
passes: ServiceTestDefaultTest[]
- -
-
pending: ServiceTestDefaultTest[]
- -
-
stats: ServiceTestStats
- -
-
tests: ServiceTestDefaultTest[]
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestDefaultReport
Service
    failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}
    failures: ServiceTestDefaultTest[];
    passes: ServiceTestDefaultTest[];
    pending: ServiceTestDefaultTest[];
    stats: ServiceTestStats;
    tests: ServiceTestDefaultTest[];
}
Test results for a Foxx service's tests using the default reporter.
+Type declaration
failures: ServiceTestDefaultTest[]
passes: ServiceTestDefaultTest[]
pending: ServiceTestDefaultTest[]
stats: ServiceTestStats
tests: ServiceTestDefaultTest[]
-
-
-
-
-
-
-
-Type alias ServiceTestDefaultTest
Service
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
-Â Â Â Â duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
Test results for a single test case using the default reporter.
-
-
Type declaration
--
-
-
-
duration: number
- -
-
Optionalerr?: string
- -
-
full
Title: string
- -
-
title: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestDefaultTest
Service
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
Test results for a single test case using the default reporter.
+Type declaration
duration: number
Optionalerr?: stringfull
Title: string title: string
-
-
-
-
-
-
-
-Type alias ServiceTestStats
Service
    duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}
-Â Â Â Â duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}
Test stats for a Foxx service's tests.
-
-
Type declaration
--
-
-
-
duration: number
-Total test duration in milliseconds.
-
- -
-
failures: number
-Number of tests that failed.
-
- -
-
passes: number
-Number of tests that ran successfully.
-
- -
-
pending: number
-Number of tests skipped or not executed.
-
- -
-
tests: number
-Total number of tests found.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestStats
Service
    duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}
    duration: number;
    failures: number;
    passes: number;
    pending: number;
    tests: number;
}
Test stats for a Foxx service's tests.
+Type declaration
duration: number
Total test duration in milliseconds.
+failures: number
Number of tests that failed.
+passes: number
Number of tests that ran successfully.
+pending: number
Number of tests skipped or not executed.
+tests: number
Total number of tests found.
+
-
-
-
-
-
-
-Type alias ServiceTestStreamReport
Service
    total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]
-Â Â Â Â total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]
Test results for a Foxx service's tests using the stream reporter.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestStreamReport
Service
    total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]
    total: number;
}] | ["pass", ServiceTestStreamTest] | ["fail", ServiceTestStreamTest] | ["end", ServiceTestStats])[]
Test results for a Foxx service's tests using the stream reporter.
+
-
-
-
-
-
-
-
-Type alias ServiceTestStreamTest
Service
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
-Â Â Â Â duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
Test results for a single test case using the stream reporter.
-
-
Type declaration
--
-
-
-
duration: number
- -
-
Optionalerr?: string
- -
-
full
Title: string
- -
-
title: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestStreamTest
Service
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
    duration: number;
    err?: string;
    fullTitle: string;
    title: string;
}
Test results for a single test case using the stream reporter.
+Type declaration
duration: number
Optionalerr?: stringfull
Title: string title: string
-
-
-
-
-
-
-
-Type alias ServiceTestSuite
Service
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}
-Â Â Â Â suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}
Test results for a single test suite using the suite reporter.
-
-
Type declaration
--
-
-
-
suites: ServiceTestSuite[]
- -
-
tests: ServiceTestSuiteTest[]
- -
-
title: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestSuite
Service
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
    title: string;
}
Test results for a single test suite using the suite reporter.
+Type declaration
suites: ServiceTestSuite[]
tests: ServiceTestSuiteTest[]
title: string
-
-
-
-
-
-
-
-Type alias ServiceTestSuiteReport
Service
    stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}
-Â Â Â Â stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}
Test results for a Foxx service's tests using the suite reporter.
-
-
Type declaration
--
-
-
-
stats: ServiceTestStats
- -
-
suites: ServiceTestSuite[]
- -
-
tests: ServiceTestSuiteTest[]
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestSuiteReport
Service
    stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}
    stats: ServiceTestStats;
    suites: ServiceTestSuite[];
    tests: ServiceTestSuiteTest[];
}
Test results for a Foxx service's tests using the suite reporter.
+Type declaration
stats: ServiceTestStats
suites: ServiceTestSuite[]
tests: ServiceTestSuiteTest[]
-
-
-
-
-
-
-
-Type alias ServiceTestSuiteTest
Service
    duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}
-Â Â Â Â duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}
Test results for a single test case using the suite reporter.
-
-
Type declaration
--
-
-
-
duration: number
- -
-
Optionalerr?: any
- -
-
result: "pending" | "pass" | "fail"
- -
-
title: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestSuiteTest
Service
    duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}
    duration: number;
    err?: any;
    result: "pending" | "pass" | "fail";
    title: string;
}
Test results for a single test case using the suite reporter.
+Type declaration
duration: number
Optionalerr?: anyresult: "pending" | "pass" | "fail"
title: string
-
-
-
-
-
-
-Type alias ServiceTestTapReport
Service
-Test results for a Foxx service's tests in TAP format.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ServiceTestTapReport
Service
Test results for a Foxx service's tests in TAP format.
+
-
\ No newline at end of file
diff --git a/devel/types/database.ServiceTestXunitTest.html b/devel/types/database.ServiceTestXunitTest.html
index a6d58b121..4bdad4cb7 100644
--- a/devel/types/database.ServiceTestXunitTest.html
+++ b/devel/types/database.ServiceTestXunitTest.html
@@ -1,123 +1,3 @@
-
-ServiceTestXunitReport | arangojs
-
-
-Type alias ServiceTestXunitReport
Service
    errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]
-Â Â Â Â errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]
Test results for a Foxx service's tests in XUnit format using the JSONML +
Type alias ServiceTestXunitReport
Service
    errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]
    errors: number;
    failures: number;
    skip: number;
    tests: number;
    time: number;
    timestamp: number;
}, ...ServiceTestXunitTest[]]
Test results for a Foxx service's tests in XUnit format using the JSONML representation.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type declaration
errors: number
failures: number
skip: number
tests: number
time: number
timestamp: number
-
\ No newline at end of file
diff --git a/devel/types/database.SingleExplainResult.html b/devel/types/database.SingleExplainResult.html
index e232a5fca..d7c3d1d71 100644
--- a/devel/types/database.SingleExplainResult.html
+++ b/devel/types/database.SingleExplainResult.html
@@ -1,141 +1,6 @@
-
-ServiceTestXunitTest | arangojs
-
-
-Type alias ServiceTestXunitTest
Service
    classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]
-Â Â Â Â classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]
Test results for a single test case in XUnit format using the JSONML +
Type alias ServiceTestXunitTest
Service
    classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]
    classname: string;
    name: string;
    time: number;
}] | ["testcase", {
    classname: string;
    name: string;
    time: number;
}, ["failure", {
    message: string;
    type: string;
}, string]]
Test results for a single test case in XUnit format using the JSONML representation.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias SingleExplainResult
Single
    cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
-Â Â Â Â cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
Result of explaining a query with a single plan.
-
-
Type declaration
--
-
-
-
cacheable: boolean
-Whether it would be possible to cache the query.
-
- -
-
plan: ExplainPlan
-Query plan.
-
- -
-
stats: ExplainStats
-Optimizer statistics for the explained query.
-
- -
-
warnings: {
-
    code: number;
    message: string;
}[]Warnings encountered while planning the query execution.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SingleExplainResult
Single
    cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
    cacheable: boolean;
    plan: ExplainPlan;
    stats: ExplainStats;
    warnings: {
        code: number;
        message: string;
    }[];
}
Result of explaining a query with a single plan.
+Type declaration
cacheable: boolean
Whether it would be possible to cache the query.
+plan: ExplainPlan
Query plan.
+stats: ExplainStats
Optimizer statistics for the explained query.
+warnings: {
    code: number;
    message: string;
}[]Warnings encountered while planning the query execution.
+
-
\ No newline at end of file
diff --git a/devel/types/database.SwaggerJson.html b/devel/types/database.SwaggerJson.html
index ffd10478d..2fb161fa3 100644
--- a/devel/types/database.SwaggerJson.html
+++ b/devel/types/database.SwaggerJson.html
@@ -1,143 +1,2 @@
-
-
-
-
-
-Type alias SingleServiceDependency
Single
    current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
-Â Â Â Â current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}
Object describing a single-service dependency defined by a Foxx service.
-
-
Type declaration
--
-
-
-
-Optionalcurrent?: stringCurrent mount point the dependency is resolved to.
-
- -
-
-Optionaldescription?: stringHuman-readable description of the dependency.
-
- -
-
multiple: false
-Whether this is a multi-service dependency.
-
- -
-
name: string
-Name of the service the dependency expects to match.
-
- -
-
required: boolean
-Whether the dependency must be matched in order for the service +
SingleServiceDependency | arangojs --Type alias SingleServiceDependency
SingleService Dependency: {
    current?: string;
    description?: string;
    multiple: false;
    name: string;
    required: boolean;
    title: string;
    version: string;
}Object describing a single-service dependency defined by a Foxx service.
+Type declaration
Optionalcurrent?: stringCurrent mount point the dependency is resolved to.
+Optionaldescription?: stringHuman-readable description of the dependency.
+multiple: false
Whether this is a multi-service dependency.
+name: string
Name of the service the dependency expects to match.
+required: boolean
Whether the dependency must be matched in order for the service to be operational.
-
--
-
title: string
-Formatted name of the dependency.
-
- -
-
version: string
-Version of the service the dependency expects to match.
-
-- \ No newline at end of file +Generated using TypeDoc
title: string
Formatted name of the dependency.
+version: string
Version of the service the dependency expects to match.
+
-
-
-
-
-
-
-
-Type alias SwaggerJson
Swagger
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}
-Â Â Â Â info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}
OpenAPI 2.0 description of a Foxx service.
-
-
Type declaration
--
-
-
-
[key: string]: any
- -
-
info: {
-
    description: string;
    license: string;
    title: string;
    version: string;
}-
-
-
-
description: string
- -
-
license: string
- -
-
title: string
- -
-
version: string
- -
-
-
-
path: {
-
    [key: string]: any;
}-
-
-
-
[key: string]: any
-
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SwaggerJson
Swagger
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}
    info: {
        description: string;
        license: string;
        title: string;
        version: string;
    };
    path: {
        [key: string]: any;
    };
    [key: string]: any;
}
OpenAPI 2.0 description of a Foxx service.
+Type declaration
[key: string]: any
info: {
    description: string;
    license: string;
    title: string;
    version: string;
}description: string
license: string
title: string
version: string
path: {
    [key: string]: any;
}[key: string]: any
-
\ No newline at end of file
diff --git a/devel/types/database.TransactionDetails.html b/devel/types/database.TransactionDetails.html
index 9b96e212d..2e81b1144 100644
--- a/devel/types/database.TransactionDetails.html
+++ b/devel/types/database.TransactionDetails.html
@@ -1,134 +1,5 @@
-
-
-
-
-
-Type alias TransactionCollections
Transaction
    exclusive?: (string | ArangoCollection)[] | string | ArangoCollection;
    read?: (string | ArangoCollection)[] | string | ArangoCollection;
    write?: (string | ArangoCollection)[] | string | ArangoCollection;
}
-Â Â Â Â exclusive?: (string | ArangoCollection)[] | string | ArangoCollection;
    read?: (string | ArangoCollection)[] | string | ArangoCollection;
    write?: (string | ArangoCollection)[] | string | ArangoCollection;
}
Collections involved in a transaction.
-
-
Type declaration
--
-
-
-
-Optionalexclusive?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from or +
TransactionCollections | arangojs --Type alias TransactionCollections
TransactionCollections: {
    exclusive?: (string | ArangoCollection)[] | string | ArangoCollection;
    read?: (string | ArangoCollection)[] | string | ArangoCollection;
    write?: (string | ArangoCollection)[] | string | ArangoCollection;
}Collections involved in a transaction.
+Type declaration
Optionalexclusive?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from or written to during the transaction with no other writes being able to run in parallel.
-
--
-
-Optionalread?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from +
Optionalread?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from during the transaction.
-
--
-
-Optionalwrite?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from or +
Optionalwrite?: (string | ArangoCollection)[] | string | ArangoCollectionAn array of collections or a single collection that will be read from or written to during the transaction.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias TransactionDetails
Transaction
    id: string;
    state: "running" | "committed" | "aborted";
}
-Â Â Â Â id: string;
    state: "running" | "committed" | "aborted";
}
Details for a transaction.
-See also TransactionStatus.
-
-
Type declaration
--
-
-
-
id: string
-Unique identifier of the transaction.
-
- -
-
state: "running" | "committed" | "aborted"
-Status (or "state") of the transaction.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias TransactionDetails
Transaction
    id: string;
    state: "running" | "committed" | "aborted";
}
    id: string;
    state: "running" | "committed" | "aborted";
}
Details for a transaction.
+See also transaction.TransactionStatus.
+Type declaration
id: string
Unique identifier of the transaction.
+state: "running" | "committed" | "aborted"
Status (or "state") of the transaction.
+
-
\ No newline at end of file
diff --git a/devel/types/database.UninstallServiceOptions.html b/devel/types/database.UninstallServiceOptions.html
index 17caaabb0..9b7bd1460 100644
--- a/devel/types/database.UninstallServiceOptions.html
+++ b/devel/types/database.UninstallServiceOptions.html
@@ -1,138 +1,9 @@
-
-
-
-
-
-Type alias TransactionOptions
Transaction
    allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    waitForSync?: boolean;
}
-Â Â Â Â allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    waitForSync?: boolean;
}
Options for how the transaction should be performed.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +TransactionOptions | arangojs --Type alias TransactionOptions
TransactionOptions: {
    allowDirtyRead?: boolean;
    allowImplicit?: boolean;
    lockTimeout?: number;
    maxTransactionSize?: number;
    skipFastLockRound?: boolean;
    waitForSync?: boolean;
}Options for how the transaction should be performed.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
--
-
-OptionalallowImplicit?: boolean Whether the transaction may read from collections not specified for this +
OptionalallowImplicit?: boolean Whether the transaction may read from collections not specified for this transaction. If set to
false, accessing any collections not specified will result in the transaction being aborted to avoid potential deadlocks.Default:
-true.
--
-
-OptionallockTimeout?: number Determines how long the database will wait while attempting to gain locks +
OptionallockTimeout?: number Determines how long the database will wait while attempting to gain locks on collections used by the transaction before timing out.
-
--
-
-OptionalmaxTransaction Size?: number (RocksDB only.) Determines the transaction size limit in bytes.
-
- -
-
-OptionalwaitFor Sync?: boolean Determines whether to force the transaction to write all data to disk +
OptionalmaxTransaction Size?: number Determines the transaction size limit in bytes.
+OptionalskipFast Lock Round?: boolean If set to
+true, the fast lock round will be skipped, which makes each +locking operation take longer but guarantees deterministic locking order +and may avoid deadlocks when many concurrent transactions are queued and +try to access the same collection with an exclusive lock.OptionalwaitFor Sync?: boolean Determines whether to force the transaction to write all data to disk before returning.
-
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.UpgradeServiceOptions.html b/devel/types/database.UpgradeServiceOptions.html
index 84058403b..52256c14e 100644
--- a/devel/types/database.UpgradeServiceOptions.html
+++ b/devel/types/database.UpgradeServiceOptions.html
@@ -1,165 +1,21 @@
-
-
-
-
-
-Type alias UninstallServiceOptions
Uninstall
    force?: boolean;
    teardown?: boolean;
}
-Â Â Â Â force?: boolean;
    teardown?: boolean;
}
Options for uninstalling a service.
-See uninstallService.
-
-
Type declaration
--
-
-
-
-Optionalforce?: booleanIf set to
true, uninstalling a service that does not already exist +UninstallServiceOptions | arangojs --Type alias UninstallServiceOptions
UninstallService Options: {
    force?: boolean;
    teardown?: boolean;
}Options for uninstalling a service.
+ +Type declaration
Optionalforce?: booleanIf set to
true, uninstalling a service that does not already exist will be considered successful.Default:
-false
--
-
-Optionalteardown?: booleanWhether the service's "teardown" script should be executed +
Optionalteardown?: booleanWhether the service's "teardown" script should be executed prior to removing that service.
Default:
-true
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.UserAccessLevelOptions.html b/devel/types/database.UserAccessLevelOptions.html
index c12c4233f..9341b3148 100644
--- a/devel/types/database.UserAccessLevelOptions.html
+++ b/devel/types/database.UserAccessLevelOptions.html
@@ -1,136 +1,7 @@
-
-
-
-
-
-Type alias UpgradeServiceOptions
Upgrade
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
-Â Â Â Â configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}
Options for upgrading a service.
-See upgradeService.
-
-
Type declaration
--
-
-
-
-Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
-See also getServiceConfiguration.
-
- -
-
-Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
-See also getServiceDependencies.
-
- -
-
-Optionaldevelopment?: booleanWhether the service should be installed in development mode.
-See also setServiceDevelopmentMode.
+UpgradeServiceOptions | arangojs --Type alias UpgradeServiceOptions
UpgradeService Options: {
    configuration?: Record<string, any>;
    dependencies?: Record<string, string>;
    development?: boolean;
    force?: boolean;
    legacy?: boolean;
    setup?: boolean;
    teardown?: boolean;
}Options for upgrading a service.
+ +Type declaration
Optionalconfiguration?: Record<string, any>An object mapping configuration option names to values.
+See also Database#getServiceConfiguration.
+Optionaldependencies?: Record<string, string>An object mapping dependency aliases to mount points.
+See also Database#getServiceDependencies.
+Optionaldevelopment?: booleanWhether the service should be installed in development mode.
+See also Database#setServiceDevelopmentMode.
Default:
-false
--
-
-Optionalforce?: booleanUnless set to
true, upgrading a service that does not already exist will + Optionalforce?: booleanUnless set to
true, upgrading a service that does not already exist will fall back to installing the new service.Default:
-false
--
-
-Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
+ Optionallegacy?: booleanWhether the service should be installed in legacy compatibility mode
This overrides the
enginesoption in the service manifest (if any).Default:
-false
--
-
-Optionalsetup?: booleanWhether the "setup" script should be executed.
+ Optionalsetup?: booleanWhether the "setup" script should be executed.
Default:
-true
--
-
-Optionalteardown?: booleanWhether the existing service's "teardown" script should be executed +
Optionalteardown?: booleanWhether the existing service's "teardown" script should be executed prior to upgrading that service.
Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.UserOptions.html b/devel/types/database.UserOptions.html
index d97ab3c60..ee2fe7746 100644
--- a/devel/types/database.UserOptions.html
+++ b/devel/types/database.UserOptions.html
@@ -1,139 +1,7 @@
-
-
-
-
-
-Type alias UserAccessLevelOptions
User
    collection?: ArangoCollection | string;
    database?: Database | string;
}
-Â Â Â Â collection?: ArangoCollection | string;
    database?: Database | string;
}
Options for accessing or manipulating access levels.
-
-
Type declaration
--
-
-
-
-Optionalcollection?: ArangoCollection | stringThe collection to access or manipulate the access level of.
-
- -
-
-Optionaldatabase?: Database | stringThe database to access or manipulate the access level of.
+UserAccessLevelOptions | arangojs --Type alias UserAccessLevelOptions
UserAccess Level Options: {
    collection?: ArangoCollection | string;
    database?: Database | string;
}Options for accessing or manipulating access levels.
+Type declaration
Optionalcollection?: ArangoCollection | stringThe collection to access or manipulate the access level of.
+Optionaldatabase?: Database | stringThe database to access or manipulate the access level of.
If
-collectionis anArangoCollection, this option defaults to the database the collection is contained in. Otherwise this option defaults to the current database.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/database.VersionInfo.html b/devel/types/database.VersionInfo.html
index dfef50ad4..6c3b6c407 100644
--- a/devel/types/database.VersionInfo.html
+++ b/devel/types/database.VersionInfo.html
@@ -1,144 +1,6 @@
-
-
-
-
-
-Type alias UserOptions
User
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
}
-Â Â Â Â active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
}
Options for modifying an ArangoDB user.
-
-
Type declaration
--
-
-
-
-Optionalactive?: booleanWhether the ArangoDB user account is enabled and can authenticate.
+UserOptions | arangojs --Type alias UserOptions
UserOptions: {
    active?: boolean;
    extra?: Record<string, any>;
    passwd: string;
}Options for modifying an ArangoDB user.
+Type declaration
Optionalactive?: booleanWhether the ArangoDB user account is enabled and can authenticate.
Default:
-true
--
-
-Optionalextra?: Record<string, any>Additional information to store about this user.
+ Optionalextra?: Record<string, any>Additional information to store about this user.
Default:
-{}
--
-
passwd: string
-Password the ArangoDB user will use for authentication.
-
-- \ No newline at end of file +Generated using TypeDoc
passwd: string
Password the ArangoDB user will use for authentication.
+
-
-
-
-
-
-
-
-Type alias VersionInfo
Version
    details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}
-Â Â Â Â details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}
Result of retrieving database version information.
-
-
Type declaration
--
-
-
-
-Optionaldetails?: {
    [key: string]: string;
}-Additional information about the ArangoDB server.
--
-
-
-
[key: string]: string
- -
-
-
-
license: "community" | "enterprise"
-ArangoDB license type or "edition".
-
- -
-
server: string
-Value identifying the server type, i.e.
-"arango".
- -
-
version: string
-ArangoDB server version.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias VersionInfo
Version
    details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}
    details?: {
        [key: string]: string;
    };
    license: "community" | "enterprise";
    server: string;
    version: string;
}
Result of retrieving database version information.
+Type declaration
Optionaldetails?: {
    [key: string]: string;
}Additional information about the ArangoDB server.
+[key: string]: string
license: "community" | "enterprise"
ArangoDB license type or "edition".
+server: string
Value identifying the server type, i.e.
+"arango".version: string
ArangoDB server version.
+
-
-
-
-
-
-
-
-
-
-Type alias Document<T>
Type representing a document stored in a collection.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Document<T>
Type representing a document stored in a collection.
+Type Parameters
-
-
-
-
-
-
-
-
-
-Type alias DocumentData<T>
Type representing an object that can be stored in a collection.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias DocumentData<T>
Type representing an object that can be stored in a collection.
+Type Parameters
-
\ No newline at end of file
diff --git a/devel/types/documents.DocumentSelector.html b/devel/types/documents.DocumentSelector.html
index e1cc27551..611f058a3 100644
--- a/devel/types/documents.DocumentSelector.html
+++ b/devel/types/documents.DocumentSelector.html
@@ -1,71 +1,5 @@
-
-
-
-
-
-Type alias DocumentMetadata
Document
    _id: string;
    _key: string;
    _rev: string;
}
-Â Â Â Â _id: string;
    _key: string;
    _rev: string;
}
Common ArangoDB metadata properties of a document.
-
-
Type declaration
--
-
-
-
_id: string
-Unique ID of the document, which is composed of the collection name +
DocumentMetadata | arangojs --Type alias DocumentMetadata
DocumentMetadata: {
    _id: string;
    _key: string;
    _rev: string;
}Common ArangoDB metadata properties of a document.
+Type declaration
_id: string
Unique ID of the document, which is composed of the collection name and the document
-_key.
--
-
_key: string
-Key of the document, which uniquely identifies the document within its +
_key: string
Key of the document, which uniquely identifies the document within its collection.
-
--
-
_rev: string
-Revision of the document data.
-
-- \ No newline at end of file +Generated using TypeDoc
_rev: string
Revision of the document data.
+
-
\ No newline at end of file
diff --git a/devel/types/documents.Edge.html b/devel/types/documents.Edge.html
index 613a38711..fc3b845c9 100644
--- a/devel/types/documents.Edge.html
+++ b/devel/types/documents.Edge.html
@@ -1,73 +1,2 @@
-
-DocumentSelector | arangojs
-
-
-
-Type alias DocumentSelector
A value that can be used to identify a document within a collection in +
Type alias DocumentSelector
A value that can be used to identify a document within a collection in
arangojs methods, i.e. a partial ArangoDB document or the value of a
document's _key or _id.
See DocumentMetadata.
-
-
-
\ No newline at end of file
+
+Generated using TypeDoc
-
-
-
-
-
-
-
-
-
-Type alias Edge<T>
Type representing an edge document stored in an edge collection.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Edge<T>
Type representing an edge document stored in an edge collection.
+Type Parameters
-
-
-
-
-
-
-
-
-
-Type alias EdgeData<T>
Type representing an object that can be stored in an edge collection.
-Type Parameters
--
-
-
-
T extends Record<string, any> = any
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias EdgeData<T>
Type representing an object that can be stored in an edge collection.
+Type Parameters
-
-
-
-
-
-
-
-Type alias EdgeMetadata
Edge
    _from: string;
    _to: string;
}
-Â Â Â Â _from: string;
    _to: string;
}
ArangoDB metadata defining the relations of an edge document.
-
-
Type declaration
--
-
-
-
_from: string
-Unique ID of the document that acts as the edge's start vertex.
-
- -
-
_to: string
-Unique ID of the document that acts as the edge's end vertex.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias EdgeMetadata
Edge
    _from: string;
    _to: string;
}
    _from: string;
    _to: string;
}
ArangoDB metadata defining the relations of an edge document.
+Type declaration
_from: string
Unique ID of the document that acts as the edge's start vertex.
+_to: string
Unique ID of the document that acts as the edge's end vertex.
+
-
-
-
-
-
-
-
-Type alias ObjectWithId
Object
    _id: string;
    [key: string]: any;
}
-Â Â Â Â _id: string;
    [key: string]: any;
}
An object with an ArangoDB document _id property.
See DocumentMetadata.
-
-
Type declaration
--
-
-
-
[key: string]: any
- -
-
_id: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ObjectWithId
Object
    _id: string;
    [key: string]: any;
}
    _id: string;
    [key: string]: any;
}
An object with an ArangoDB document _id property.
Type declaration
[key: string]: any
_id: string
-
-
-
-
-
-
-
-Type alias ObjectWithKey
Object
    _key: string;
    [key: string]: any;
}
-Â Â Â Â _key: string;
    [key: string]: any;
}
An object with an ArangoDB document _key property.
See DocumentMetadata.
-
-
Type declaration
--
-
-
-
[key: string]: any
- -
-
_key: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ObjectWithKey
Object
    _key: string;
    [key: string]: any;
}
    _key: string;
    [key: string]: any;
}
An object with an ArangoDB document _key property.
Type declaration
[key: string]: any
_key: string
-
\ No newline at end of file
diff --git a/devel/types/foxx_manifest.Configuration.html b/devel/types/foxx_manifest.Configuration.html
index 8af94b601..9f209d55c 100644
--- a/devel/types/foxx_manifest.Configuration.html
+++ b/devel/types/foxx_manifest.Configuration.html
@@ -1,81 +1,6 @@
-
-Patch | arangojs
-
-
-
-
-
-
-Type alias Patch<T>
Type representing patch data for a given object type to represent a payload +
Type alias Patch<T>
Type representing patch data for a given object type to represent a payload ArangoDB can apply in a document PATCH request (i.e. a partial update).
This differs from Partial in that it also applies itself to any nested
objects recursively.
Type Parameters
--
-
-
-
T = Record<string, any>
-
-
\ No newline at end of file
+Generated using TypeDoc
Type Parameters
-
-
-
-
-
-
-
-Type alias Configuration
Configuration: {
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}
-Â Â Â Â default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}
A configuration option.
-
-
Type declaration
--
-
-
-
-Optionaldefault?: anyThe default value for this option in plain JSON. Can be omitted to provide no default value.
-
- -
-
-Optionaldescription?: stringA human-readable description of the option.
-
- -
-
-Optionalrequired?: booleanWhether the service can not function without this option. Defaults to true unless a default value is provided.
-
- -
-
type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"
-The type of value expected for this option.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Configuration
Configuration: {
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}
    default?: any;
    description?: string;
    required?: boolean;
    type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool";
}
A configuration option.
+Type declaration
Optionaldefault?: anyThe default value for this option in plain JSON. Can be omitted to provide no default value.
+Optionaldescription?: stringA human-readable description of the option.
+Optionalrequired?: booleanWhether the service can not function without this option. Defaults to true unless a default value is provided.
+type: "integer" | "boolean" | "number" | "string" | "json" | "password" | "int" | "bool"
The type of value expected for this option.
+
-
-
-
-
-
-
-
-Type alias Dependency
Dependency: {
    description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}
-Â Â Â Â description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}
A service dependency.
-
-
Type declaration
--
-
-
-
-Optionaldescription?: stringA description of how the API is used or why it is needed.
-
- -
-
-Optionalmultiple?: booleanWhether the dependency can be specified more than once.
-
- -
-
-Optionalname?: stringName of the API the service expects.
-
- -
-
-Optionalrequired?: booleanWhether the service can not function without this dependency.
-
- -
-
-Optionalversion?: stringThe semantic version ranges of the API the service expects.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Dependency
Dependency: {
    description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}
    description?: string;
    multiple?: boolean;
    name?: string;
    required?: boolean;
    version?: string;
}
A service dependency.
+Type declaration
Optionaldescription?: stringA description of how the API is used or why it is needed.
+Optionalmultiple?: booleanWhether the dependency can be specified more than once.
+Optionalname?: stringName of the API the service expects.
+Optionalrequired?: booleanWhether the service can not function without this dependency.
+Optionalversion?: stringThe semantic version ranges of the API the service expects.
+
-
-
-
-
-
-
-
-Type alias File
File: {
    gzip?: boolean;
    path: string;
    type?: string;
}
-Â Â Â Â gzip?: boolean;
    path: string;
    type?: string;
}
A service file asset.
-
-
Type declaration
--
-
-
-
-Optionalgzip?: booleanIf set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.
-
- -
-
path: string
-Relative path of the file or folder within the service.
-
- -
-
-Optionaltype?: stringThe MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias File
File: {
    gzip?: boolean;
    path: string;
    type?: string;
}
    gzip?: boolean;
    path: string;
    type?: string;
}
A service file asset.
+Type declaration
Optionalgzip?: booleanIf set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML.
+path: string
Relative path of the file or folder within the service.
+Optionaltype?: stringThe MIME content type of the file. Defaults to an intelligent guess based on the filename's extension.
+
-
-
-
-
-
-
-
-Type alias FoxxManifest
Foxx
    author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}
-Â Â Â Â author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}
Schema for ArangoDB Foxx service manifests.
-
-
Type declaration
--
-
-
-
-Optionalauthor?: stringThe full name of the author of the service (i.e. you). This will be shown in the web interface.
-
- -
-
-Optionalconfiguration?: Record<string, Configuration>An object defining the configuration options this service requires.
-
- -
-
-Optionalcontributors?: string[]A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.
-
- -
-
-OptionaldefaultDocument?: string If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".
-
- -
-
-Optionaldependencies?: Record<string, string | Dependency>The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.
-
- -
-
-Optionaldescription?: stringA human-readable description of the service. This will be shown in the web interface.
-
- -
-
-Optionalengines?: Record<string, string> & {
    arangodb?: string;
}An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.
-
- -
-
-Optionalfiles?: Record<string, string | File>An object defining file assets served by this service.
-
- -
-
-Optionalkeywords?: string[]A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.
-
- -
-
-Optionallib?: stringThe relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.
-
- -
-
-Optionallicense?: stringA string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.
-
- -
-
-Optionalmain?: stringThe relative path to the main entry point of this service (relative to lib), e.g. "index.js".
-
- -
-
-Optionalname?: stringThe name of the Foxx service. This will be shown in the web interface.
-
- -
-
-Optionalprovides?: Record<string, string>The dependencies this provides, i.e. which APIs it claims to be compatible with.
-
- -
-
-Optionalscripts?: Record<string, string>An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.
-
- -
-
-Optionaltests?: string | string[]A path/pattern or list of paths/patterns of JavaScript tests provided for this service.
-
- -
-
-Optionalthumbnail?: stringThe filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.
-
- -
-
-Optionalversion?: stringThe version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias FoxxManifest
Foxx
    author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}
    author?: string;
    configuration?: Record<string, Configuration>;
    contributors?: string[];
    defaultDocument?: string;
    dependencies?: Record<string, string | Dependency>;
    description?: string;
    engines?: Record<string, string> & {
        arangodb?: string;
    };
    files?: Record<string, string | File>;
    keywords?: string[];
    lib?: string;
    license?: string;
    main?: string;
    name?: string;
    provides?: Record<string, string>;
    scripts?: Record<string, string>;
    tests?: string | string[];
    thumbnail?: string;
    version?: string;
}
Schema for ArangoDB Foxx service manifests.
+Type declaration
Optionalauthor?: stringThe full name of the author of the service (i.e. you). This will be shown in the web interface.
+Optionalconfiguration?: Record<string, Configuration>An object defining the configuration options this service requires.
+Optionalcontributors?: string[]A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface.
+OptionaldefaultDocument?: string If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html".
+Optionaldependencies?: Record<string, string | Dependency>The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with.
+Optionaldescription?: stringA human-readable description of the service. This will be shown in the web interface.
+Optionalengines?: Record<string, string> & {
    arangodb?: string;
}An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with.
+Optionalfiles?: Record<string, string | File>An object defining file assets served by this service.
+Optionalkeywords?: string[]A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services.
+Optionallib?: stringThe relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest.
+Optionallicense?: stringA string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface.
+Optionalmain?: stringThe relative path to the main entry point of this service (relative to lib), e.g. "index.js".
+Optionalname?: stringThe name of the Foxx service. This will be shown in the web interface.
+Optionalprovides?: Record<string, string>The dependencies this provides, i.e. which APIs it claims to be compatible with.
+Optionalscripts?: Record<string, string>An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services.
+Optionaltests?: string | string[]A path/pattern or list of paths/patterns of JavaScript tests provided for this service.
+Optionalthumbnail?: stringThe filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160.
+Optionalversion?: stringThe version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface.
+
-
\ No newline at end of file
diff --git a/devel/types/graph.AddVertexCollectionOptions.html b/devel/types/graph.AddVertexCollectionOptions.html
index ce7a0bdf9..0f84ffe5a 100644
--- a/devel/types/graph.AddVertexCollectionOptions.html
+++ b/devel/types/graph.AddVertexCollectionOptions.html
@@ -1,79 +1,3 @@
-
-
-
-
-
-Type alias AddEdgeDefinitionOptions
-
Type declaration
--
-
-
-
-Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid +
AddEdgeDefinitionOptions | arangojs --Type alias AddEdgeDefinitionOptions
Type declaration
Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid SmartGraph.
-
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/graph.CreateGraphOptions.html b/devel/types/graph.CreateGraphOptions.html
index 7ba423ceb..169caa52d 100644
--- a/devel/types/graph.CreateGraphOptions.html
+++ b/devel/types/graph.CreateGraphOptions.html
@@ -1,126 +1,25 @@
-
-
-
-
-
-Type alias AddVertexCollectionOptions
-
Type declaration
--
-
-
-
-Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid +
AddVertexCollectionOptions | arangojs --Type alias AddVertexCollectionOptions
Type declaration
Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid SmartGraph.
-
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/graph.EdgeDefinition.html b/devel/types/graph.EdgeDefinition.html
index e3a030588..f7918923c 100644
--- a/devel/types/graph.EdgeDefinition.html
+++ b/devel/types/graph.EdgeDefinition.html
@@ -1,88 +1,5 @@
-
-
-
-
-
-Type alias CreateGraphOptions
Create
    isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}
-Â Â Â Â isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}
Option for creating a graph.
-
-
Type declaration
--
-
-
-
-OptionalisDisjoint?: boolean (Enterprise Edition cluster only.) If set to
true, the graph will be +CreateGraphOptions | arangojs --Type alias CreateGraphOptions
CreateGraph Options: {
    isDisjoint?: boolean;
    isSmart?: boolean;
    numberOfShards?: number;
    orphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection;
    replicationFactor?: number | "satellite";
    satellites?: (string | ArangoCollection)[];
    smartGraphAttribute?: string;
    waitForSync?: boolean;
    writeConcern?: number;
}Option for creating a graph.
+Type declaration
OptionalisDisjoint?: boolean (Enterprise Edition cluster only.) If set to
true, the graph will be created as a Disjoint SmartGraph.Default:
-false
--
-
-OptionalisSmart?: boolean (Enterprise Edition cluster only.) If set to
true, the graph will be + OptionalisSmart?: boolean (Enterprise Edition cluster only.) If set to
true, the graph will be created as a SmartGraph.Default:
-false
--
-
-OptionalnumberOf Shards?: number (Cluster only.) Number of shards that is used for every collection +
OptionalnumberOf Shards?: number (Cluster only.) Number of shards that is used for every collection within this graph.
Has no effect when
-replicationFactoris set to"satellite".
--
-
-OptionalorphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection Additional vertex collections. Documents within these collections do not +
OptionalorphanCollections?: (string | ArangoCollection)[] | string | ArangoCollection Additional vertex collections. Documents within these collections do not have edges within this graph.
-
--
-
-OptionalreplicationFactor?: number | "satellite" (Cluster only.) Replication factor used when initially creating +
OptionalreplicationFactor?: number | "satellite" (Cluster only.) Replication factor used when initially creating collections for this graph.
Default:
-1
--
-
-Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid +
Optionalsatellites?: (string | ArangoCollection)[](Enterprise Edition cluster only.) Collections to be included in a Hybrid SmartGraph.
-
--
-
-OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key +
OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key value to use for smart sharding.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
true, the request will wait until all modifications have been + OptionalwaitFor Sync?: boolean If set to
true, the request will wait until all modifications have been synchronized to disk before returning successfully.Default:
-false
--
-
-OptionalwriteConcern?: number (Cluster only.) Write concern for new collections in the graph.
+ OptionalwriteConcern?: number (Cluster only.) Write concern for new collections in the graph.
Has no effect when
-replicationFactoris set to"satellite".
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias EdgeDefinition
Edge
    collection: string;
    from: string[];
    to: string[];
}
-Â Â Â Â collection: string;
    from: string[];
    to: string[];
}
Definition of a relation in a Graph.
-
-
Type declaration
--
-
-
-
collection: string
-Name of the collection containing the edges.
-
- -
-
from: string[]
-Array of names of collections containing the start vertices.
-
- -
-
to: string[]
-Array of names of collections containing the end vertices.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias EdgeDefinition
Edge
    collection: string;
    from: string[];
    to: string[];
}
    collection: string;
    from: string[];
    to: string[];
}
Definition of a relation in a graph.Graph.
+Type declaration
collection: string
Name of the collection containing the edges.
+from: string[]
Array of names of collections containing the start vertices.
+to: string[]
Array of names of collections containing the end vertices.
+
-
-
-
-
-
-
-
-Type alias EdgeDefinitionOptions
Edge
    collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}
-Â Â Â Â collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}
An edge definition used to define a collection of edges in a Graph.
-
-
Type declaration
--
-
-
-
collection: string | ArangoCollection
-Collection containing the edges.
-
- -
-
from: (string | ArangoCollection)[] | string | ArangoCollection
-Collection or collections containing the start vertices.
-
- -
-
to: (string | ArangoCollection)[] | string | ArangoCollection
-Collection or collections containing the end vertices.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias EdgeDefinitionOptions
Edge
    collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}
    collection: string | ArangoCollection;
    from: (string | ArangoCollection)[] | string | ArangoCollection;
    to: (string | ArangoCollection)[] | string | ArangoCollection;
}
An edge definition used to define a collection of edges in a graph.Graph.
+Type declaration
collection: string | ArangoCollection
Collection containing the edges.
+from: (string | ArangoCollection)[] | string | ArangoCollection
Collection or collections containing the start vertices.
+to: (string | ArangoCollection)[] | string | ArangoCollection
Collection or collections containing the end vertices.
+
-
\ No newline at end of file
diff --git a/devel/types/graph.GraphCollectionReadOptions.html b/devel/types/graph.GraphCollectionReadOptions.html
index 036d50a5a..e97fd1b04 100644
--- a/devel/types/graph.GraphCollectionReadOptions.html
+++ b/devel/types/graph.GraphCollectionReadOptions.html
@@ -1,95 +1,12 @@
-
-
-
-
-
-Type alias GraphCollectionInsertOptions
Graph
    returnNew?: boolean;
    waitForSync?: boolean;
}
-Â Â Â Â returnNew?: boolean;
    waitForSync?: boolean;
}
Options for inserting a document into a graph collection.
-
-
Type declaration
--
-
-
-
-OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenew+GraphCollectionInsertOptions | arangojs --Type alias GraphCollectionInsertOptions
GraphCollection Insert Options: {
    returnNew?: boolean;
    waitForSync?: boolean;
}Options for inserting a document into a graph collection.
+Type declaration
OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenewproperty on the result object.Default:
-false
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning. OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/graph.GraphCollectionRemoveOptions.html b/devel/types/graph.GraphCollectionRemoveOptions.html
index 2f332f4df..0d7a022a3 100644
--- a/devel/types/graph.GraphCollectionRemoveOptions.html
+++ b/devel/types/graph.GraphCollectionRemoveOptions.html
@@ -1,93 +1,10 @@
-
-
-
-
-
-Type alias GraphCollectionReadOptions
Graph
    allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}
-Â Â Â Â allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}
Options for retrieving a document from a graph collection.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +GraphCollectionReadOptions | arangojs --Type alias GraphCollectionReadOptions
GraphCollection Read Options: {
    allowDirtyRead?: boolean;
    graceful?: boolean;
    rev?: string;
}Options for retrieving a document from a graph collection.
+Type declaration
OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.Default:
-false
--
-
-Optionalgraceful?: booleanIf set to
true,nullis returned instead of an exception being thrown + Optionalgraceful?: booleanIf set to
true,nullis returned instead of an exception being thrown if the document does not exist.Default:
-false
--
-
-Optionalrev?: stringIf set to a document revision, the document will only be returned if its +
Optionalrev?: stringIf set to a document revision, the document will only be returned if its
-_revproperty matches this value.See also DocumentMetadata.
-
-- \ No newline at end of file +Generated using TypeDoc
See also documents.DocumentMetadata.
+
-
\ No newline at end of file
diff --git a/devel/types/graph.GraphCollectionReplaceOptions.html b/devel/types/graph.GraphCollectionReplaceOptions.html
index 270fc85d4..41e6b46e2 100644
--- a/devel/types/graph.GraphCollectionReplaceOptions.html
+++ b/devel/types/graph.GraphCollectionReplaceOptions.html
@@ -1,105 +1,16 @@
-
-
-
-
-
-Type alias GraphCollectionRemoveOptions
Graph
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
-Â Â Â Â returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
Options for removing a document from a graph collection.
-
-
Type declaration
--
-
-
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+GraphCollectionRemoveOptions | arangojs --Type alias GraphCollectionRemoveOptions
GraphCollection Remove Options: {
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}Options for removing a document from a graph collection.
+Type declaration
OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object.Default:
-false
--
-
-Optionalrev?: stringIf set to a document revision, the document will only be removed if its +
Optionalrev?: stringIf set to a document revision, the document will only be removed if its
-_revproperty matches this value.See also DocumentMetadata.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning.See also documents.DocumentMetadata.
+ OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/graph.GraphInfo.html b/devel/types/graph.GraphInfo.html
index 8c36908fc..6c6d9ad52 100644
--- a/devel/types/graph.GraphInfo.html
+++ b/devel/types/graph.GraphInfo.html
@@ -1,123 +1,19 @@
-
-
-
-
-
-Type alias GraphCollectionReplaceOptions
Graph
    keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
-Â Â Â Â keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}
Options for replacing a document in a graph collection.
-
-
Type declaration
--
-
-
-
-OptionalkeepNull?: boolean If set to
false, properties with a value ofnullwill be removed from +GraphCollectionReplaceOptions | arangojs --Type alias GraphCollectionReplaceOptions
GraphCollection Replace Options: {
    keepNull?: boolean;
    returnNew?: boolean;
    returnOld?: boolean;
    rev?: string;
    waitForSync?: boolean;
}Options for replacing a document in a graph collection.
+Type declaration
OptionalkeepNull?: boolean If set to
false, properties with a value ofnullwill be removed from the new document.Default:
-true
--
-
-OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenew+ OptionalreturnNew?: boolean If set to
true, the complete new document will be returned as thenewproperty on the result object.Default:
-false
--
-
-OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theold+ OptionalreturnOld?: boolean If set to
true, the complete old document will be returned as theoldproperty on the result object.Default:
-false
--
-
-Optionalrev?: stringIf set to a document revision, the document will only be modified if its +
Optionalrev?: stringIf set to a document revision, the document will only be modified if its
-_revproperty matches this value.See also DocumentMetadata.
-
--
-
-OptionalwaitFor Sync?: boolean If set to
+true, data will be synchronized to disk before returning.See also documents.DocumentMetadata.
+ OptionalwaitFor Sync?: boolean If set to
true, data will be synchronized to disk before returning.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/graph.ReplaceEdgeDefinitionOptions.html b/devel/types/graph.ReplaceEdgeDefinitionOptions.html
index e3b84af86..853040dd0 100644
--- a/devel/types/graph.ReplaceEdgeDefinitionOptions.html
+++ b/devel/types/graph.ReplaceEdgeDefinitionOptions.html
@@ -1,79 +1,3 @@
-
-
-
-
-
-Type alias GraphInfo
Graph
    edgeDefinitions: EdgeDefinition[];
    isDisjoint?: boolean;
    isSatellite?: boolean;
    isSmart?: boolean;
    name: string;
    numberOfShards?: number;
    orphanCollections: string[];
    replicationFactor?: number;
    smartGraphAttribute?: string;
    writeConcern?: number;
}
-Â Â Â Â edgeDefinitions: EdgeDefinition[];
    isDisjoint?: boolean;
    isSatellite?: boolean;
    isSmart?: boolean;
    name: string;
    numberOfShards?: number;
    orphanCollections: string[];
    replicationFactor?: number;
    smartGraphAttribute?: string;
    writeConcern?: number;
}
General information about a graph.
-
-
Type declaration
--
-
-
-
edge
-Definitions: EdgeDefinition[] Definitions for the relations of the graph.
-
- -
-
-OptionalisDisjoint?: boolean (Enterprise Edition cluster only.) If set to
true, the graph has been +GraphInfo | arangojs --Type alias GraphInfo
GraphInfo: {
    edgeDefinitions: EdgeDefinition[];
    isDisjoint?: boolean;
    isSatellite?: boolean;
    isSmart?: boolean;
    name: string;
    numberOfShards?: number;
    orphanCollections: string[];
    replicationFactor?: number;
    smartGraphAttribute?: string;
    writeConcern?: number;
}General information about a graph.
+Type declaration
edge
Definitions: EdgeDefinition[] Definitions for the relations of the graph.
+OptionalisDisjoint?: boolean (Enterprise Edition cluster only.) If set to
-true, the graph has been created as a Disjoint SmartGraph.
--
-
-OptionalisSatellite?: boolean (Enterprise Edition cluster only.) If set to
true, the graph is a + OptionalisSatellite?: boolean (Enterprise Edition cluster only.) If set to
-true, the graph is a SatelliteGraph.
--
-
-OptionalisSmart?: boolean (Enterprise Edition cluster only.) If set to
true, the graph has been + OptionalisSmart?: boolean (Enterprise Edition cluster only.) If set to
-true, the graph has been created as a SmartGraph.
--
-
name: string
-Name of the graph.
-
- -
-
-OptionalnumberOf Shards?: number (Cluster only.) Number of shards that is used for every collection +
name: string
Name of the graph.
+OptionalnumberOf Shards?: number (Cluster only.) Number of shards that is used for every collection within this graph.
-
--
-
orphan
-Collections: string[] Additional vertex collections. Documents within these collections do not +
orphan
Collections: string[] Additional vertex collections. Documents within these collections do not have edges within this graph.
-
--
-
-OptionalreplicationFactor?: number (Cluster only.) Replication factor used when initially creating +
OptionalreplicationFactor?: number (Cluster only.) Replication factor used when initially creating collections for this graph.
-
--
-
-OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key +
OptionalsmartGraph Attribute?: string (Enterprise Edition cluster only.) Attribute containing the shard key value to use for smart sharding.
-
--
-
-OptionalwriteConcern?: number (Cluster only.) Write concern for new collections in the graph.
-
-- \ No newline at end of file +Generated using TypeDoc
OptionalwriteConcern?: number (Cluster only.) Write concern for new collections in the graph.
+
-
\ No newline at end of file
diff --git a/devel/types/indexes.EnsureFulltextIndexOptions.html b/devel/types/indexes.EnsureFulltextIndexOptions.html
deleted file mode 100644
index 75afaaa31..000000000
--- a/devel/types/indexes.EnsureFulltextIndexOptions.html
+++ /dev/null
@@ -1,109 +0,0 @@
-
-
-
-
-Type alias ReplaceEdgeDefinitionOptions
Replace
    satellites?: string[];
}
-Â Â Â Â satellites?: string[];
}
-
Type declaration
--
-
-
-
-Optionalsatellites?: string[](Enterprise Edition cluster only.) Collections to be included in a Hybrid +
ReplaceEdgeDefinitionOptions | arangojs --Type alias ReplaceEdgeDefinitionOptions
ReplaceEdge Definition Options: {
    satellites?: string[];
}Type declaration
Optionalsatellites?: string[](Enterprise Edition cluster only.) Collections to be included in a Hybrid SmartGraph.
-
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias EnsureFulltextIndexOptions
Ensure
    fields: [string];
    inBackground?: boolean;
    minLength?: number;
    name?: string;
    type: "fulltext";
}
-Â Â Â Â fields: [string];
    inBackground?: boolean;
    minLength?: number;
    name?: string;
    type: "fulltext";
}
Options for creating a fulltext index.
- -Deprecated
Fulltext indexes have been deprecated in ArangoDB 3.10 and -should be replaced with ArangoSearch.
-
-
Type declaration
--
-
-
-
fields: [string]
-An array containing exactly one attribute path.
-
- -
-
-OptionalinBackground?: boolean If set to
-true, the index will be created in the background to reduce -the write-lock duration for the collection during index creation.Default:
-false
- -
-
-OptionalminLength?: number Minimum character length of words to index.
-
- -
-
-Optionalname?: stringA unique name for this index.
-
- -
-
type: "fulltext"
-Type of this index.
-
-
-
\ No newline at end of file
diff --git a/devel/types/indexes.EnsureGeoIndexOptions.html b/devel/types/indexes.EnsureGeoIndexOptions.html
index 223d23179..519651362 100644
--- a/devel/types/indexes.EnsureGeoIndexOptions.html
+++ b/devel/types/indexes.EnsureGeoIndexOptions.html
@@ -1,81 +1,31 @@
-Generated using TypeDoc
-
-
-
-
-
-
-Type alias EnsureGeoIndexOptions
Ensure
    fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}
-Â Â Â Â fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}
Options for creating a geo index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias EnsureGeoIndexOptions
Ensure
    fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}
    fields: [string, string];
    geoJson?: false;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
} | {
    fields: [string];
    geoJson?: boolean;
    inBackground?: boolean;
    legacyPolygons?: boolean;
    name?: string;
    type: "geo";
}
Options for creating a geo index.
+Type declaration
fields: [string, string]
Attribute paths for the document's latitude and longitude values.
+OptionalgeoJson?: false If set to
+true,fieldsmust be an array containing a single attribute +path and the attribute value must be an array with two values, the first +of which will be interpreted as the longitude and the second of which will +be interpreted as the latitude of the document.Default:
+falseOptionalinBackground?: boolean If set to
+true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.Default:
+falseOptionallegacyPolygons?: boolean If set to
+true, the index will use pre-3.10 rules for parsing +GeoJSON polygons. This option is always implicitlytruewhen using +ArangoDB 3.9 or lower.Optionalname?: stringA unique name for this index.
+type: "geo"
Type declaration
fields: [string]
An array containing the attribute path for an array containing two values, +the first of which will be interpreted as the latitude, the second as the +longitude. If
+geoJsonis set totrue, the order is reversed to match +the GeoJSON format.OptionalgeoJson?: boolean If set to
+true,fieldsmust be an array containing a single attribute +path and the attribute value must be an array with two values, the first +of which will be interpreted as the longitude and the second of which will +be interpreted as the latitude of the document.Default:
+falseOptionalinBackground?: boolean If set to
+true, the index will be created in the background to reduce +the write-lock duration for the collection during index creation.Default:
+falseOptionallegacyPolygons?: boolean If set to
+true, the index will use pre-3.10 rules for parsing +GeoJSON polygons. This option is always implicitlytruewhen using +ArangoDB 3.9 or lower.Optionalname?: stringA unique name for this index.
+type: "geo"
Type alias EnsureIndexOptions
Ensure
Options for creating an index.
+
-
\ No newline at end of file
diff --git a/devel/types/indexes.EnsureMdiIndexOptions.html b/devel/types/indexes.EnsureMdiIndexOptions.html
index 10da7b0af..7e2dfdcc2 100644
--- a/devel/types/indexes.EnsureMdiIndexOptions.html
+++ b/devel/types/indexes.EnsureMdiIndexOptions.html
@@ -1,111 +1,11 @@
-
-
-
-
-
-Type alias EnsureInvertedIndexOptions
Ensure
    analyzer?: string;
    cache?: boolean;
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    features?: AnalyzerFeature[];
    fields: (string | InvertedIndexFieldOptions)[];
    inBackground?: boolean;
    includeAllFields?: boolean;
    name?: string;
    optimizeTopK?: string[];
    parallelism?: number;
    primaryKeyCache?: boolean;
    primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    };
    searchField?: boolean;
    storedValues?: InvertedIndexStoredValueOptions[];
    trackListPositions?: boolean;
    type: "inverted";
    writeBufferActive?: number;
    writeBufferIdle?: number;
    writeBufferSizeMax?: number;
}
-Â Â Â Â analyzer?: string;
    cache?: boolean;
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    features?: AnalyzerFeature[];
    fields: (string | InvertedIndexFieldOptions)[];
    inBackground?: boolean;
    includeAllFields?: boolean;
    name?: string;
    optimizeTopK?: string[];
    parallelism?: number;
    primaryKeyCache?: boolean;
    primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    };
    searchField?: boolean;
    storedValues?: InvertedIndexStoredValueOptions[];
    trackListPositions?: boolean;
    type: "inverted";
    writeBufferActive?: number;
    writeBufferIdle?: number;
    writeBufferSizeMax?: number;
}
Options for creating an inverted index.
-
-
Type declaration
--
-
-
-
-Optionalanalyzer?: stringName of the default Analyzer to apply to the values of indexed fields.
+EnsureInvertedIndexOptions | arangojs --Type alias EnsureInvertedIndexOptions
EnsureInverted Index Options: {
    analyzer?: string;
    cache?: boolean;
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    features?: AnalyzerFeature[];
    fields: (string | InvertedIndexFieldOptions)[];
    inBackground?: boolean;
    includeAllFields?: boolean;
    name?: string;
    optimizeTopK?: string[];
    parallelism?: number;
    primaryKeyCache?: boolean;
    primarySort?: {
        cache?: boolean;
        compression?: Compression;
        fields: InvertedIndexPrimarySortFieldOptions[];
    };
    searchField?: boolean;
    storedValues?: InvertedIndexStoredValueOptions[];
    trackListPositions?: boolean;
    type: "inverted";
    writeBufferActive?: number;
    writeBufferIdle?: number;
    writeBufferSizeMax?: number;
}Options for creating an inverted index.
+Type declaration
Optionalanalyzer?: stringName of the default Analyzer to apply to the values of indexed fields.
Default:
-"identity"
--
-
-Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization + Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization values will always be cached in memory.Default:
-false
--
-
-OptionalcleanupInterval Step?: number Wait at least this many commits between removing unused files in the +
OptionalcleanupInterval Step?: number Wait at least this many commits between removing unused files in the ArangoSearch data directory.
Default:
-2
--
-
-OptionalcommitInterval Msec?: number Wait at least this many milliseconds between committing View data store +
OptionalcommitInterval Msec?: number Wait at least this many milliseconds between committing View data store changes and making documents visible to queries.
Default:
-1000
--
-
-OptionalconsolidationInterval Msec?: number Wait at least this many milliseconds between applying +
OptionalconsolidationInterval Msec?: number Wait at least this many milliseconds between applying
consolidationPolicyto consolidate View data store and possibly release space on the filesystem.Default:
-1000
--
-
-OptionalconsolidationPolicy?: TierConsolidationPolicy The consolidation policy to apply for selecting which segments should be +
OptionalconsolidationPolicy?: TierConsolidationPolicy The consolidation policy to apply for selecting which segments should be merged.
Default:
-{ type: "tier" }
--
-
-Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for the default Analyzer.
+ Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for the default Analyzer.
Defaults to the Analyzer's features.
-
--
-
fields: (string | InvertedIndexFieldOptions)[]
-An array of attribute paths or objects specifying options for the fields.
-
- -
-
-OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce + fields: (string | InvertedIndexFieldOptions)[]
An array of attribute paths or objects specifying options for the fields.
+OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.Default:
-false
--
-
-OptionalincludeAll Fields?: boolean If set to
true, all document attributes are indexed, excluding any + OptionalincludeAll Fields?: boolean If set to
true, all document attributes are indexed, excluding any sub-attributes configured in thefieldsarray. Theanalyzerandfeaturesproperties apply to the sub-attributes. This option only applies when using the index in a SearchAlias View.Default:
-false
--
-
-Optionalname?: stringA unique name for this index.
-
- -
-
-OptionaloptimizeTopK?: string[] An array of strings defining sort expressions to optimize.
-
- -
-
-Optionalparallelism?: numberThe number of threads to use for indexing the fields.
+ Optionalname?: stringA unique name for this index.
+OptionaloptimizeTopK?: string[] An array of strings defining sort expressions to optimize.
+Optionalparallelism?: numberThe number of threads to use for indexing the fields.
Default:
-2
--
-
-OptionalprimaryKey Cache?: boolean (Enterprise Edition only.) If set to
true, then the primary key column + OptionalprimaryKey Cache?: boolean (Enterprise Edition only.) If set to
true, then the primary key column will always be cached in memory.Default:
-false
--
-
-OptionalprimarySort?: {
    cache?: boolean;
    compression?: Compression;
    fields: InvertedIndexPrimarySortFieldOptions[];
}-Primary sort order to optimize AQL queries using a matching sort order.
--
-
-
-
-Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then primary sort columns + OptionalprimarySort?: {
    cache?: boolean;
    compression?: Compression;
    fields: InvertedIndexPrimarySortFieldOptions[];
}Primary sort order to optimize AQL queries using a matching sort order.
+Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then primary sort columns will always be cached in memory.Default:
-false
--
-
-Optionalcompression?: CompressionHow the primary sort data should be compressed.
+ Optionalcompression?: CompressionHow the primary sort data should be compressed.
Default:
-"lz4"
--
-
fields: InvertedIndexPrimarySortFieldOptions[]
-An array of fields to sort the index by.
-
--
-
-OptionalsearchField?: boolean If set to
truearray values will by default be indexed using the same + fields: InvertedIndexPrimarySortFieldOptions[]
An array of fields to sort the index by.
+
-
-
OptionalsearchField?: boolean If set to
truearray values will by default be indexed using the same behavior as ArangoSearch Views. This option only applies when using the index in a SearchAlias View.Default:
-false
--
-
-OptionalstoredValues?: InvertedIndexStoredValueOptions[] An array of attribute paths that will be stored in the index but can not +
OptionalstoredValues?: InvertedIndexStoredValueOptions[] An array of attribute paths that will be stored in the index but can not be used for index lookups or sorting but can avoid full document lookups.
-
--
-
-OptionaltrackList Positions?: boolean If set to
true, the position of values in array values are tracked and + OptionaltrackList Positions?: boolean If set to
true, the position of values in array values are tracked and need to be specified in queries. Otherwise all values in an array are treated as equivalent. This option only applies when using the index in a SearchAlias View.Default:
-false
--
-
type: "inverted"
-Type of this index.
-
- -
-
-OptionalwriteBuffer Active?: number Maximum number of concurrent active writers (segments) that perform a +
type: "inverted"
Type of this index.
+OptionalwriteBuffer Active?: number Maximum number of concurrent active writers (segments) that perform a transaction.
Default:
-0(disabled)
--
-
-OptionalwriteBuffer Idle?: number Maximum number of writers (segments) cached in the pool.
+ OptionalwriteBuffer Idle?: number Maximum number of writers (segments) cached in the pool.
Default:
-64
--
-
-OptionalwriteBuffer Size Max?: number Maximum memory byte size per writer (segment) before a writer (segment) +
OptionalwriteBuffer Size Max?: number Maximum memory byte size per writer (segment) before a writer (segment) flush is triggered.
Default:
-33554432(32 MiB)
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/indexes.EnsurePersistentIndexOptions.html b/devel/types/indexes.EnsurePersistentIndexOptions.html
index c22c43c21..0c82f1d75 100644
--- a/devel/types/indexes.EnsurePersistentIndexOptions.html
+++ b/devel/types/indexes.EnsurePersistentIndexOptions.html
@@ -1,137 +1,25 @@
-
-
-
-
-
-Type alias EnsureMdiIndexOptions
Ensure
    fieldValueTypes: "double";
    fields: string[];
    inBackground?: boolean;
    name?: string;
    type: "mdi";
    unique?: boolean;
}
-Â Â Â Â fieldValueTypes: "double";
    fields: string[];
    inBackground?: boolean;
    name?: string;
    type: "mdi";
    unique?: boolean;
}
Options for creating a MDI index.
-
-
Type declaration
--
-
-
-
field
-Value Types: "double" Data type of the dimension attributes.
-
- -
-
fields: string[]
-An array containing attribute paths for the dimensions.
-
- -
-
-OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce +EnsureMdiIndexOptions | arangojs --Type alias EnsureMdiIndexOptions
EnsureMdi Index Options: {
    fieldValueTypes: "double";
    fields: string[];
    inBackground?: boolean;
    name?: string;
    type: "mdi";
    unique?: boolean;
}Options for creating a MDI index.
+Type declaration
field
Value Types: "double" Data type of the dimension attributes.
+fields: string[]
An array containing attribute paths for the dimensions.
+OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.Default:
-false
--
-
-Optionalname?: stringA unique name for this index.
-
- -
-
type: "mdi"
-Type of this index.
-
- -
-
-Optionalunique?: booleanIf set to
+true, a unique index will be created. Optionalname?: stringA unique name for this index.
+type: "mdi"
Type of this index.
+Optionalunique?: booleanIf set to
true, a unique index will be created.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/indexes.EnsureTtlIndexOptions.html b/devel/types/indexes.EnsureTtlIndexOptions.html
index 1297ad1ae..760e3123c 100644
--- a/devel/types/indexes.EnsureTtlIndexOptions.html
+++ b/devel/types/indexes.EnsureTtlIndexOptions.html
@@ -1,107 +1,10 @@
-
-
-
-
-
-Type alias EnsurePersistentIndexOptions
Ensure
    cacheEnabled?: boolean;
    deduplicate?: boolean;
    estimates?: boolean;
    fields: string[];
    inBackground?: boolean;
    name?: string;
    sparse?: boolean;
    storedValues?: string[];
    type: "persistent";
    unique?: boolean;
}
-Â Â Â Â cacheEnabled?: boolean;
    deduplicate?: boolean;
    estimates?: boolean;
    fields: string[];
    inBackground?: boolean;
    name?: string;
    sparse?: boolean;
    storedValues?: string[];
    type: "persistent";
    unique?: boolean;
}
Options for creating a persistent index.
-
-
Type declaration
--
-
-
-
-OptionalcacheEnabled?: boolean If set to
true, an in-memory hash cache will be put in front of the +EnsurePersistentIndexOptions | arangojs --Type alias EnsurePersistentIndexOptions
EnsurePersistent Index Options: {
    cacheEnabled?: boolean;
    deduplicate?: boolean;
    estimates?: boolean;
    fields: string[];
    inBackground?: boolean;
    name?: string;
    sparse?: boolean;
    storedValues?: string[];
    type: "persistent";
    unique?: boolean;
}Options for creating a persistent index.
+Type declaration
OptionalcacheEnabled?: boolean If set to
true, an in-memory hash cache will be put in front of the persistent index.Default:
-false
--
-
-Optionaldeduplicate?: booleanIf set to
false, inserting duplicate index values from the same + Optionaldeduplicate?: booleanIf set to
false, inserting duplicate index values from the same document will lead to a unique constraint error if this is a unique index.Default:
-true
--
-
-Optionalestimates?: booleanIf set to
false, index selectivity estimates will be disabled for this + Optionalestimates?: booleanIf set to
false, index selectivity estimates will be disabled for this index.Default:
-true
--
-
fields: string[]
-An array of attribute paths.
-
- -
-
-OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce + fields: string[]
An array of attribute paths.
+OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.Default:
-false
--
-
-Optionalname?: stringA unique name for this index.
-
- -
-
-Optionalsparse?: booleanIf set to
true, the index will omit documents that do not contain at + Optionalname?: stringA unique name for this index.
+Optionalsparse?: booleanIf set to
true, the index will omit documents that do not contain at least one of the attribute paths infieldsand these documents will be ignored for uniqueness checks.Default:
-false
--
-
-OptionalstoredValues?: string[] An array of attribute paths that will be stored in the index but can not +
OptionalstoredValues?: string[] An array of attribute paths that will be stored in the index but can not be used for index lookups or sorting but can avoid full document lookups.
-
--
-
type: "persistent"
-Type of this index.
-
- -
-
-Optionalunique?: booleanIf set to
+true, a unique index will be created. type: "persistent"
Type of this index.
+Optionalunique?: booleanIf set to
true, a unique index will be created.Default:
-false
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/indexes.FulltextIndex.html b/devel/types/indexes.FulltextIndex.html
deleted file mode 100644
index 75118a674..000000000
--- a/devel/types/indexes.FulltextIndex.html
+++ /dev/null
@@ -1,84 +0,0 @@
-
-
-
-
-
-Type alias EnsureTtlIndexOptions
Ensure
    expireAfter: number;
    fields: [string];
    inBackground?: boolean;
    name?: string;
    type: "ttl";
}
-Â Â Â Â expireAfter: number;
    fields: [string];
    inBackground?: boolean;
    name?: string;
    type: "ttl";
}
Options for creating a TTL index.
-
-
Type declaration
--
-
-
-
expire
-After: number Duration in seconds after the attribute value at which the document will +
EnsureTtlIndexOptions | arangojs --Type alias EnsureTtlIndexOptions
EnsureTtl Index Options: {
    expireAfter: number;
    fields: [string];
    inBackground?: boolean;
    name?: string;
    type: "ttl";
}Options for creating a TTL index.
+Type declaration
expire
After: number Duration in seconds after the attribute value at which the document will be considered as expired.
-
--
-
fields: [string]
-An array containing exactly one attribute path.
-
- -
-
-OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce + fields: [string]
An array containing exactly one attribute path.
+OptionalinBackground?: boolean If set to
true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.Default:
-false
--
-
-Optionalname?: stringA unique name for this index.
-
- -
-
type: "ttl"
-Type of this index.
-
-- \ No newline at end of file +Generated using TypeDoc
Optionalname?: stringA unique name for this index.
+type: "ttl"
Type of this index.
+
-
-
-
-
-
-
-Type alias FulltextIndex
Fulltext
    fields: [string];
    minLength: number;
    type: "fulltext";
}
-Â Â Â Â fields: [string];
    minLength: number;
    type: "fulltext";
}
An object representing a fulltext index.
- -Deprecated
Fulltext indexes have been deprecated in ArangoDB 3.10 and -should be replaced with ArangoSearch.
-
-
-
\ No newline at end of file
diff --git a/devel/types/indexes.GenericIndex.html b/devel/types/indexes.GenericIndex.html
index 662d97336..3adb40f59 100644
--- a/devel/types/indexes.GenericIndex.html
+++ b/devel/types/indexes.GenericIndex.html
@@ -1,101 +1,8 @@
-Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/indexes.GeoIndex.html b/devel/types/indexes.GeoIndex.html
index a8ce8ee16..557c003a0 100644
--- a/devel/types/indexes.GeoIndex.html
+++ b/devel/types/indexes.GeoIndex.html
@@ -1,81 +1,2 @@
-
-
-
-
-
-Type alias GenericIndex
Generic
    id: string;
    name: string;
    sparse: boolean;
    unique: boolean;
}
-Â Â Â Â id: string;
    name: string;
    sparse: boolean;
    unique: boolean;
}
Shared attributes of all index types.
-
-
Type declaration
--
-
-
-
id: string
-A unique identifier for this index.
-
- -
-
name: string
-A unique name for this index.
-
- -
-
sparse: boolean
-Whether documents not containing at least one of the attribute paths +
GenericIndex | arangojs --Type alias GenericIndex
GenericIndex: {
    figures?: Record<string, any>;
    id: string;
    name: string;
    sparse: boolean;
    unique: boolean;
}Shared attributes of all index types.
+Type declaration
Optionalfigures?: Record<string, any>Additional stats about this index.
+id: string
A unique identifier for this index.
+name: string
A unique name for this index.
+sparse: boolean
Whether documents not containing at least one of the attribute paths are omitted by this index.
-
--
-
unique: boolean
-Whether this index enforces uniqueness for values of its attribute paths.
-
-- \ No newline at end of file +Generated using TypeDoc
unique: boolean
Whether this index enforces uniqueness for values of its attribute paths.
+
-
-
-
-
-
-
-Type alias GeoIndex
Geo
    bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}
-Â Â Â Â bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}
An object representing a geo index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GeoIndex
Geo
    bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}
    bestIndexedLevel: number;
    fields: [string] | [string, string];
    geoJson: boolean;
    legacyPolygons: boolean;
    maxNumCoverCells: number;
    type: "geo";
    worstIndexedLevel: number;
}
An object representing a geo index.
+Type declaration
best
Indexed Level: number fields: [string] | [string, string]
geo
Json: boolean legacy
Polygons: boolean max
Num Cover Cells: number type: "geo"
worst
Indexed Level: number
Type alias HiddenIndex
An object representing a potentially hidden index.
+This type can be used to cast the result of collection.indexes to better
+reflect the actual data returned by the server when using the withHidden
+option:
const indexes = await collection.indexes<HiddenIndex>({
withHidden: true
}));
// indexes may include internal indexes and indexes with a "progress"
// property
+Type declaration
Optionalprogress?: numberProgress of this index if it is still being created.
+
-
-
-
-
-
-
-Type alias Index
Index: GeoIndex | FulltextIndex | PersistentIndex | PrimaryIndex | TtlIndex | MdiIndex | InvertedIndex
-An object representing an index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Index
An object representing an index.
+Type alias IndexDetails
Type declaration
Optionalfigures?: Record<string, any>Optionalprogress?: number
-
-
-
-
-
-
-
-Type alias IndexSelector
Index name, id or object with a name or id property.
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias IndexSelector
Index name, id or object with a name or id property.
Type alias InternalArangosearchIndex
Internal
    analyzers: string[];
    fields: Record<string, Record<string, any>>;
    figures?: Record<string, any>;
    id: string;
    includeAllFields: boolean;
    storeValues: "none" | "id";
    trackListPositions: boolean;
    type: "arangosearch";
    view: string;
}
    analyzers: string[];
    fields: Record<string, Record<string, any>>;
    figures?: Record<string, any>;
    id: string;
    includeAllFields: boolean;
    storeValues: "none" | "id";
    trackListPositions: boolean;
    type: "arangosearch";
    view: string;
}
An object representing an arangosearch index.
+Type declaration
analyzers: string[]
fields: Record<string, Record<string, any>>
Optionalfigures?: Record<string, any>id: string
include
All Fields: boolean store
Values: "none" | "id" track
List Positions: boolean type: "arangosearch"
view: string
Type alias InternalIndex
An object representing an internal index.
+
-
-
-
-
-
-
-Type alias InvertedIndex
Inverted
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}
-Â Â Â Â analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}
An object representing an inverted index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias InvertedIndex
Inverted
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}
    analyzer: string;
    cache?: boolean;
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: Required<TierConsolidationPolicy>;
    features: AnalyzerFeature[];
    fields: {
        analyzer?: string;
        cache?: boolean;
        features?: AnalyzerFeature[];
        includeAllFields?: boolean;
        name: string;
        nested?: InvertedIndexNestedField[];
        searchField?: boolean;
        trackListPositions?: boolean;
    }[];
    includeAllFields: boolean;
    optimizeTopK: string[];
    parallelism: number;
    primaryKeyCache?: boolean;
    primarySort: {
        cache?: boolean;
        compression: Compression;
        fields: {
            direction: Direction;
            field: string;
        }[];
    };
    searchField: boolean;
    storedValues: {
        cache?: boolean;
        compression: Compression;
        fields: string[];
    }[];
    trackListPositions: boolean;
    type: "inverted";
    writeBufferActive: number;
    writeBufferIdle: number;
    writeBufferSizeMax: number;
}
An object representing an inverted index.
+Type declaration
analyzer: string
Optionalcache?: booleancleanup
Interval Step: number commit
Interval Msec: number consolidation
Interval Msec: number consolidation
Policy: Required<TierConsolidationPolicy> features: AnalyzerFeature[]
fields: {
    analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
    trackListPositions?: boolean;
}[]include
All Fields: boolean optimize
TopK: string[] parallelism: number
OptionalprimaryKey Cache?: boolean primary
Sort: {
    cache?: boolean;
    compression: Compression;
    fields: {
        direction: Direction;
        field: string;
    }[];
}Optionalcache?: booleancompression: Compression
fields: {
    direction: Direction;
    field: string;
}[]
search
Field: boolean stored
Values: {
    cache?: boolean;
    compression: Compression;
    fields: string[];
}[]track
List Positions: boolean type: "inverted"
write
Buffer Active: number write
Buffer Idle: number write
Buffer Size Max: number
-
\ No newline at end of file
diff --git a/devel/types/indexes.InvertedIndexNestedField.html b/devel/types/indexes.InvertedIndexNestedField.html
index 43da9e605..fb15e7859 100644
--- a/devel/types/indexes.InvertedIndexNestedField.html
+++ b/devel/types/indexes.InvertedIndexNestedField.html
@@ -1,95 +1,3 @@
-
-
-
-
-
-Type alias InvertedIndexFieldOptions
Inverted
    analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
    trackListPositions?: boolean;
}
-Â Â Â Â analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
    trackListPositions?: boolean;
}
Options for an attribute path in an inverted index.
-
-
Type declaration
--
-
-
-
-Optionalanalyzer?: stringName of the Analyzer to apply to the values of this field.
+InvertedIndexFieldOptions | arangojs --Type alias InvertedIndexFieldOptions
InvertedIndex Field Options: {
    analyzer?: string;
    cache?: boolean;
    features?: AnalyzerFeature[];
    includeAllFields?: boolean;
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
    trackListPositions?: boolean;
}Options for an attribute path in an inverted index.
+Type declaration
Optionalanalyzer?: stringName of the Analyzer to apply to the values of this field.
Defaults to the
-analyzerspecified on the index itself.
--
-
-Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization + Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization values will always be cached in memory.Defaults to the value of
-cachespecified on the index itself.
--
-
-Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for this field's Analyzer.
+ Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for this field's Analyzer.
Defaults to the features of the Analyzer.
-
--
-
-OptionalincludeAll Fields?: boolean If set to
true, all document attributes are indexed, excluding any + OptionalincludeAll Fields?: boolean If set to
true, all document attributes are indexed, excluding any sub-attributes configured in thefieldsarray. Theanalyzerandfeaturesproperties apply to the sub-attributes. This option only applies when using the index in a SearchAlias View.Defaults to the value of
-includeAllFieldsspecified on the index itself.
--
-
name: string
-An attribute path.
-
- -
-
-Optionalnested?: (string | InvertedIndexNestedFieldOptions)[](Enterprise Edition only.) Sub-objects to index to allow querying for +
name: string
An attribute path.
+Optionalnested?: (string | InvertedIndexNestedFieldOptions)[](Enterprise Edition only.) Sub-objects to index to allow querying for co-occurring values.
-
--
-
-OptionalsearchField?: boolean If set to
truearray values will be indexed using the same behavior as + OptionalsearchField?: boolean If set to
truearray values will be indexed using the same behavior as ArangoSearch Views. This option only applies when using the index in a SearchAlias View.Defaults to the value of
-searchFieldspecified on the index itself.
--
-
-OptionaltrackList Positions?: boolean If set to
true, the position of values in array values are tracked and + OptionaltrackList Positions?: boolean If set to
true, the position of values in array values are tracked and need to be specified in queries. Otherwise all values in an array are treated as equivalent. This option only applies when using the index in a SearchAlias View.Defaults to the value of
-trackListPositionsspecified on the index itself.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/indexes.InvertedIndexNestedFieldOptions.html b/devel/types/indexes.InvertedIndexNestedFieldOptions.html
index e252b68fc..30bc046b4 100644
--- a/devel/types/indexes.InvertedIndexNestedFieldOptions.html
+++ b/devel/types/indexes.InvertedIndexNestedFieldOptions.html
@@ -1,110 +1,13 @@
-
-InvertedIndexNestedField | arangojs
-
-
-Type alias InvertedIndexNestedField
Inverted
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}
-Â Â Â Â analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}
(Enterprise Edition only.) An object representing a nested field in an +
Type alias InvertedIndexNestedField
Inverted
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: InvertedIndexNestedField[];
    searchField?: boolean;
}
(Enterprise Edition only.) An object representing a nested field in an inverted index.
-
-
Type declaration
--
-
-
-
Optionalanalyzer?: string
- -
-
Optionalfeatures?: AnalyzerFeature[]
- -
-
name: string
- -
-
Optionalnested?: InvertedIndexNestedField[]
- -
-
OptionalsearchField?: boolean
-
-
\ No newline at end of file
+Generated using TypeDoc
Type declaration
Optionalanalyzer?: stringOptionalfeatures?: AnalyzerFeature[]name: string
Optionalnested?: InvertedIndexNestedField[]OptionalsearchField?: boolean
-
\ No newline at end of file
diff --git a/devel/types/indexes.InvertedIndexPrimarySortFieldOptions.html b/devel/types/indexes.InvertedIndexPrimarySortFieldOptions.html
index 7568a3e23..f64587945 100644
--- a/devel/types/indexes.InvertedIndexPrimarySortFieldOptions.html
+++ b/devel/types/indexes.InvertedIndexPrimarySortFieldOptions.html
@@ -1,92 +1,4 @@
-
-
-
-
-
-Type alias InvertedIndexNestedFieldOptions
Inverted
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}
-Â Â Â Â analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}
(Enterprise Edition only.) Options for a nested field in an inverted index.
-
-
Type declaration
--
-
-
-
-Optionalanalyzer?: stringName of the Analyzer to apply to the values of this field.
+InvertedIndexNestedFieldOptions | arangojs --Type alias InvertedIndexNestedFieldOptions
InvertedIndex Nested Field Options: {
    analyzer?: string;
    features?: AnalyzerFeature[];
    name: string;
    nested?: (string | InvertedIndexNestedFieldOptions)[];
    searchField?: boolean;
}(Enterprise Edition only.) Options for a nested field in an inverted index.
+Type declaration
Optionalanalyzer?: stringName of the Analyzer to apply to the values of this field.
Defaults to the
-analyzerspecified on the parent options or on the index itself.
--
-
-Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for this field's Analyzer.
+ Optionalfeatures?: AnalyzerFeature[]List of Analyzer features to enable for this field's Analyzer.
Defaults to the features of the Analyzer.
-
--
-
name: string
-An attribute path.
-
- -
-
-Optionalnested?: (string | InvertedIndexNestedFieldOptions)[]Sub-objects to index to allow querying for co-occurring values.
-
- -
-
-OptionalsearchField?: boolean If set to
truearray values will be indexed using the same behavior as + name: string
An attribute path.
+Optionalnested?: (string | InvertedIndexNestedFieldOptions)[]Sub-objects to index to allow querying for co-occurring values.
+OptionalsearchField?: boolean If set to
truearray values will be indexed using the same behavior as ArangoSearch Views. This option only applies when using the index in a SearchAlias View.Defaults to the value of
-searchFieldspecified on the index itself.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-
-Type alias InvertedIndexPrimarySortFieldOptions
Options for defining a primary sort field on an inverted index.
-
-
Type declaration
--
-
-
-
direction: Direction
-The sorting direction.
-
- -
-
field: string
-The attribute path to sort by.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias InvertedIndexPrimarySortFieldOptions
Options for defining a primary sort field on an inverted index.
+Type declaration
direction: Direction
The sorting direction.
+field: string
The attribute path to sort by.
+
-
\ No newline at end of file
diff --git a/devel/types/indexes.MdiIndex.html b/devel/types/indexes.MdiIndex.html
index a1a3d8d9b..935b770c0 100644
--- a/devel/types/indexes.MdiIndex.html
+++ b/devel/types/indexes.MdiIndex.html
@@ -1,81 +1,2 @@
-
-
-
-
-
-Type alias InvertedIndexStoredValueOptions
Inverted
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}
-Â Â Â Â cache?: boolean;
    compression?: Compression;
    fields: string[];
}
Options for defining a stored value on an inverted index.
-
-
Type declaration
--
-
-
-
-Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then stored values will +InvertedIndexStoredValueOptions | arangojs --Type alias InvertedIndexStoredValueOptions
InvertedIndex Stored Value Options: {
    cache?: boolean;
    compression?: Compression;
    fields: string[];
}Options for defining a stored value on an inverted index.
+Type declaration
Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then stored values will always be cached in memory.Default:
-false
--
-
-Optionalcompression?: CompressionHow the attribute values should be compressed.
+ Optionalcompression?: CompressionHow the attribute values should be compressed.
Default:
-"lz4"
--
-
fields: string[]
-The attribute paths to store.
-
-- \ No newline at end of file +Generated using TypeDoc
fields: string[]
The attribute paths to store.
+
-
-
-
-
-
-
-Type alias MdiIndex
Mdi
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
}
-Â Â Â Â fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
}
An object representing a MDI index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias MdiIndex
Mdi
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
}
    fieldValueTypes: "double";
    fields: string[];
    type: "mdi";
}
An object representing a MDI index.
+Type declaration
field
Value Types: "double" fields: string[]
type: "mdi"
-
-
-
-
-
-
-Type alias ObjectWithId
Object
    id: string;
    [key: string]: any;
}
-Â Â Â Â id: string;
    [key: string]: any;
}
-
Type declaration
--
-
-
-
[key: string]: any
- -
-
id: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ObjectWithId
Object
    id: string;
    [key: string]: any;
}
    id: string;
    [key: string]: any;
}
Type declaration
[key: string]: any
id: string
-
-
-
-
-
-
-Type alias ObjectWithName
Object
    name: string;
    [key: string]: any;
}
-Â Â Â Â name: string;
    [key: string]: any;
}
-
Type declaration
--
-
-
-
[key: string]: any
- -
-
name: string
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ObjectWithName
Object
    name: string;
    [key: string]: any;
}
    name: string;
    [key: string]: any;
}
Type declaration
[key: string]: any
name: string
-
-
-
-
-
-
-Type alias PersistentIndex
Persistent
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}
-Â Â Â Â cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}
An object representing a persistent index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias PersistentIndex
Persistent
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}
    cacheEnabled: boolean;
    deduplicate: boolean;
    estimates: boolean;
    fields: string[];
    storedValues?: string[];
    type: "persistent";
}
An object representing a persistent index.
+Type declaration
cache
Enabled: boolean deduplicate: boolean
estimates: boolean
fields: string[]
OptionalstoredValues?: string[] type: "persistent"
-
-
-
-
-
-
-Type alias PrimaryIndex
Primary
    fields: string[];
    selectivityEstimate: number;
    type: "primary";
}
-Â Â Â Â fields: string[];
    selectivityEstimate: number;
    type: "primary";
}
An object representing a primary index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias PrimaryIndex
Primary
    fields: string[];
    selectivityEstimate: number;
    type: "primary";
}
    fields: string[];
    selectivityEstimate: number;
    type: "primary";
}
An object representing a primary index.
+Type declaration
fields: string[]
selectivity
Estimate: number type: "primary"
-
-
-
-
-
-
-Type alias TtlIndex
Ttl
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}
-Â Â Â Â expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}
An object representing a TTL index.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias TtlIndex
Ttl
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}
    expireAfter: number;
    fields: [string];
    selectivityEstimate: number;
    type: "ttl";
}
An object representing a TTL index.
+Type declaration
expire
After: number fields: [string]
selectivity
Estimate: number type: "ttl"
-
\ No newline at end of file
diff --git a/devel/types/transaction.TransactionCommitOptions.html b/devel/types/transaction.TransactionCommitOptions.html
index 39afa47c8..9a00c1986 100644
--- a/devel/types/transaction.TransactionCommitOptions.html
+++ b/devel/types/transaction.TransactionCommitOptions.html
@@ -1,72 +1,5 @@
-
-
-
-
-
-Type alias TransactionAbortOptions
Transaction
    allowDirtyRead?: boolean;
}
-Â Â Â Â allowDirtyRead?: boolean;
}
Options for how the transaction should be aborted.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +TransactionAbortOptions | arangojs --Type alias TransactionAbortOptions
TransactionAbort Options: {
    allowDirtyRead?: boolean;
}Options for how the transaction should be aborted.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
-- \ No newline at end of file +Generated using TypeDoc
-
\ No newline at end of file
diff --git a/devel/types/transaction.TransactionStatus.html b/devel/types/transaction.TransactionStatus.html
index c27cac52f..edba0a7e0 100644
--- a/devel/types/transaction.TransactionStatus.html
+++ b/devel/types/transaction.TransactionStatus.html
@@ -1,75 +1,5 @@
-
-
-
-
-
-Type alias TransactionCommitOptions
Transaction
    allowDirtyRead?: boolean;
}
-Â Â Â Â allowDirtyRead?: boolean;
}
Options for how the transaction should be committed.
-
-
Type declaration
--
-
-
-
-OptionalallowDirty Read?: boolean If set to
true, the request will explicitly permit ArangoDB to return a +TransactionCommitOptions | arangojs --Type alias TransactionCommitOptions
TransactionCommit Options: {
    allowDirtyRead?: boolean;
}Options for how the transaction should be committed.
+Type declaration
OptionalallowDirty Read?: boolean If set to
-true, the request will explicitly permit ArangoDB to return a potentially dirty or stale result and arangojs will load balance the request without distinguishing between leaders and followers.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias TransactionStatus
Transaction
    id: string;
    status: "running" | "committed" | "aborted";
}
-Â Â Â Â id: string;
    status: "running" | "committed" | "aborted";
}
Status of a given transaction.
-See also TransactionDetails.
-
-
Type declaration
--
-
-
-
id: string
-Unique identifier of the transaction.
-
- -
-
status: "running" | "committed" | "aborted"
-Status of the transaction.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias TransactionStatus
Transaction
    id: string;
    status: "running" | "committed" | "aborted";
}
    id: string;
    status: "running" | "committed" | "aborted";
}
Status of a given transaction.
+See also database.TransactionDetails.
+Type declaration
id: string
Unique identifier of the transaction.
+status: "running" | "committed" | "aborted"
Status of the transaction.
+
-
-
-
-
-
-
-Type alias ArangoSearchViewDescription
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoSearchViewDescription
Type declaration
type: "arangosearch"
-
-
-
-
-
-
-
-Type alias ArangoSearchViewLink
Arango
    analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}
-Â Â Â Â analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}
A link definition for an ArangoSearch View.
-
-
Type declaration
--
-
-
-
analyzers: string[]
- -
-
cache: boolean
- -
-
fields: Record<string, ArangoSearchViewLink>
- -
-
include
All Fields: boolean
- -
-
Optionalnested?: Record<string, ArangoSearchViewLink>
- -
-
store
Values: "none" | "id"
- -
-
track
List Positions: boolean
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoSearchViewLink
Arango
    analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}
    analyzers: string[];
    cache: boolean;
    fields: Record<string, ArangoSearchViewLink>;
    includeAllFields: boolean;
    nested?: Record<string, ArangoSearchViewLink>;
    storeValues: "none" | "id";
    trackListPositions: boolean;
}
A link definition for an ArangoSearch View.
+Type declaration
analyzers: string[]
cache: boolean
fields: Record<string, ArangoSearchViewLink>
include
All Fields: boolean Optionalnested?: Record<string, ArangoSearchViewLink>store
Values: "none" | "id" track
List Positions: boolean
-
\ No newline at end of file
diff --git a/devel/types/view.ArangoSearchViewPatchPropertiesOptions.html b/devel/types/view.ArangoSearchViewPatchPropertiesOptions.html
index 56f8c977e..15558548e 100644
--- a/devel/types/view.ArangoSearchViewPatchPropertiesOptions.html
+++ b/devel/types/view.ArangoSearchViewPatchPropertiesOptions.html
@@ -1,85 +1,2 @@
-
-
-
-
-
-Type alias ArangoSearchViewLinkOptions
Arango
    analyzers?: string[];
    cache?: boolean;
    fields?: Record<string, ArangoSearchViewLinkOptions>;
    inBackground?: boolean;
    includeAllFields?: boolean;
    nested?: Record<string, ArangoSearchViewLinkOptions>;
    storeValues?: "none" | "id";
    trackListPositions?: boolean;
}
-Â Â Â Â analyzers?: string[];
    cache?: boolean;
    fields?: Record<string, ArangoSearchViewLinkOptions>;
    inBackground?: boolean;
    includeAllFields?: boolean;
    nested?: Record<string, ArangoSearchViewLinkOptions>;
    storeValues?: "none" | "id";
    trackListPositions?: boolean;
}
A link definition for an ArangoSearch View.
-
-
Type declaration
--
-
-
-
-Optionalanalyzers?: string[]A list of names of Analyzers to apply to values of processed document +
ArangoSearchViewLinkOptions | arangojs --Type alias ArangoSearchViewLinkOptions
ArangoSearch View Link Options: {
    analyzers?: string[];
    cache?: boolean;
    fields?: Record<string, ArangoSearchViewLinkOptions>;
    inBackground?: boolean;
    includeAllFields?: boolean;
    nested?: Record<string, ArangoSearchViewLinkOptions>;
    storeValues?: "none" | "id";
    trackListPositions?: boolean;
}A link definition for an ArangoSearch View.
+Type declaration
Optionalanalyzers?: string[]A list of names of Analyzers to apply to values of processed document attributes.
Default:
-["identity"]
--
-
-Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization + Optionalcache?: boolean(Enterprise Edition only.) If set to
true, then field normalization values will always be cached in memory.Default:
-false
--
-
-Optionalfields?: Record<string, ArangoSearchViewLinkOptions>An object mapping names of attributes to process for each document to -ArangoSearchViewLinkOptions definitions.
-
- -
-
-OptionalinBackground?: boolean If set to
true, then no exclusive lock is used on the source collection + Optionalfields?: Record<string, ArangoSearchViewLinkOptions>An object mapping names of attributes to process for each document to +ArangoSearchViewLinkOptions definitions.
+OptionalinBackground?: boolean If set to
true, then no exclusive lock is used on the source collection during View index creation, so that it remains basically available.Default:
-false
--
-
-OptionalincludeAll Fields?: boolean If set to
true, all document attributes will be processed, otherwise + OptionalincludeAll Fields?: boolean If set to
true, all document attributes will be processed, otherwise only the attributes infieldswill be processed.Default:
-false
--
-
-Optionalnested?: Record<string, ArangoSearchViewLinkOptions>(Enterprise Edition only.) An object mapping attribute names to -ArangoSearchViewLinkOptions definitions to index sub-objects +
Optionalnested?: Record<string, ArangoSearchViewLinkOptions>(Enterprise Edition only.) An object mapping attribute names to +ArangoSearchViewLinkOptions definitions to index sub-objects stored in an array.
-
--
-
-OptionalstoreValues?: "none" | "id" Controls how the view should keep track of the attribute values.
+ OptionalstoreValues?: "none" | "id" Controls how the view should keep track of the attribute values.
Default:
-"none"
--
-
-OptionaltrackList Positions?: boolean If set to
true, the position of values in array values will be tracked, + OptionaltrackList Positions?: boolean If set to
-true, the position of values in array values will be tracked, otherwise all values in an array will be treated as equal alternatives.
-- \ No newline at end of file +Generated using TypeDoc
-
-
-
-
-
-
-
-Type alias ArangoSearchViewPatchPropertiesOptions
Options for partially modifying the properties of an ArangoSearch View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoSearchViewPatchPropertiesOptions
Options for partially modifying the properties of an ArangoSearch View.
+
-
-
-
-
-
-
-Type alias ArangoSearchViewProperties
Arango
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}
-Â Â Â Â cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}
Properties of an ArangoSearch View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ArangoSearchViewProperties
Arango
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}
    cleanupIntervalStep: number;
    commitIntervalMsec: number;
    consolidationIntervalMsec: number;
    consolidationPolicy: TierConsolidationPolicy | BytesAccumConsolidationPolicy;
    links: Record<string, Omit<ArangoSearchViewLink, "nested">>;
    optimizeTopK: string[];
    primaryKeyCache: boolean;
    primarySort: {
        direction: Direction;
        field: string;
    }[];
    primarySortCache: boolean;
    primarySortCompression: Compression;
    storedValues: {
        cache: boolean;
        compression: Compression;
        fields: string[];
    }[];
    writebufferActive: number;
    writebufferIdle: number;
    writebufferSizeMax: number;
}
Properties of an ArangoSearch View.
+Type declaration
cleanup
Interval Step: number commit
Interval Msec: number consolidation
Interval Msec: number consolidation
Policy: TierConsolidationPolicy | BytesAccumConsolidationPolicy links: Record<string, Omit<ArangoSearchViewLink, "nested">>
optimize
TopK: string[] primary
Key Cache: boolean primary
Sort: {
    direction: Direction;
    field: string;
}[]primary
Sort Cache: boolean primary
Sort Compression: Compression stored
Values: {
    cache: boolean;
    compression: Compression;
    fields: string[];
}[]writebuffer
Active: number writebuffer
Idle: number writebuffer
Size Max: number
-
\ No newline at end of file
diff --git a/devel/types/view.BytesAccumConsolidationPolicy.html b/devel/types/view.BytesAccumConsolidationPolicy.html
index 33839fa1b..9926df4e0 100644
--- a/devel/types/view.BytesAccumConsolidationPolicy.html
+++ b/devel/types/view.BytesAccumConsolidationPolicy.html
@@ -1,100 +1,7 @@
-
-
-
-
-
-Type alias ArangoSearchViewPropertiesOptions
Arango
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
}
-Â Â Â Â cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
}
Options for modifying the properties of an ArangoSearch View.
-
-
Type declaration
--
-
-
-
-OptionalcleanupInterval Step?: number How many commits to wait between removing unused files.
+ArangoSearchViewPropertiesOptions | arangojs --Type alias ArangoSearchViewPropertiesOptions
ArangoSearch View Properties Options: {
    cleanupIntervalStep?: number;
    commitIntervalMsec?: number;
    consolidationIntervalMsec?: number;
    consolidationPolicy?: TierConsolidationPolicy;
    links?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>;
}Options for modifying the properties of an ArangoSearch View.
+Type declaration
OptionalcleanupInterval Step?: number How many commits to wait between removing unused files.
Default:
-2
--
-
-OptionalcommitInterval Msec?: number How long to wait between commiting View data store changes and making +
OptionalcommitInterval Msec?: number How long to wait between commiting View data store changes and making documents visible to queries.
Default:
-1000
--
-
-OptionalconsolidationInterval Msec?: number How long to wait between applying the
+consolidationPolicy. OptionalconsolidationInterval Msec?: number How long to wait between applying the
consolidationPolicy.Default:
-10000
--
-
-OptionalconsolidationPolicy?: TierConsolidationPolicy Consolidation policy to apply for selecting which segments should be +
OptionalconsolidationPolicy?: TierConsolidationPolicy Consolidation policy to apply for selecting which segments should be merged.
Default:
-{ type: "tier" }
--
-
-Optionallinks?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>An object mapping names of linked collections to -ArangoSearchViewLinkOptions definitions.
-
-- \ No newline at end of file +Generated using TypeDoc
Optionallinks?: Record<string, Omit<ArangoSearchViewLinkOptions, "nested">>An object mapping names of linked collections to +ArangoSearchViewLinkOptions definitions.
+
-
\ No newline at end of file
diff --git a/devel/types/view.Compression.html b/devel/types/view.Compression.html
index 1fe7de968..4e5c61146 100644
--- a/devel/types/view.Compression.html
+++ b/devel/types/view.Compression.html
@@ -1,85 +1,2 @@
-
-BytesAccumConsolidationPolicy | arangojs
-
-
-Type alias BytesAccumConsolidationPolicy
Bytes
    threshold?: number;
    type: "bytes_accum";
}
-Â Â Â Â threshold?: number;
    type: "bytes_accum";
}
Policy to consolidate based on segment byte size and live document count as +
Type alias BytesAccumConsolidationPolicy
Bytes
    threshold?: number;
    type: "bytes_accum";
}
    threshold?: number;
    type: "bytes_accum";
}
Policy to consolidate based on segment byte size and live document count as dictated by the customization attributes.
- -Deprecated
The bytes_accum consolidation policy was deprecated in
+
Type declaration
Optionalthreshold?: numberMust be in the range of
+0.0to1.0.type: "bytes_accum"
Type of consolidation policy.
+
Deprecated
The bytes_accum consolidation policy was deprecated in
ArangoDB 3.7 and should be replaced with the tier consolidation policy.
-
Type declaration
--
-
-
-
-Optionalthreshold?: numberMust be in the range of
-0.0to1.0.
- -
-
type: "bytes_accum"
-Type of consolidation policy.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
-
-
-
-
-
-
-Type alias Compression
Compression: "lz4" | "none"
-Compression for storing data.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Compression
Compression: "lz4" | "none"
Compression for storing data.
+
-
-
-
-
-
-
-Type alias CreateArangoSearchViewOptions
Create
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}
-Â Â Â Â optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}
Options for creating an ArangoSearch View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateArangoSearchViewOptions
Create
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}
    optimizeTopK?: string[];
    primaryKeyCache?: boolean;
    primarySort?: ({
        direction: Direction;
        field: string;
    } | {
        asc: boolean;
        field: string;
    })[];
    primarySortCache?: boolean;
    primarySortCompression?: Compression;
    storedValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][];
    type: "arangosearch";
    writebufferActive?: number;
    writebufferIdle?: number;
    writebufferSizeMax?: number;
}
Options for creating an ArangoSearch View.
+Type declaration
OptionaloptimizeTopK?: string[] An array of strings defining sort expressions to optimize.
+OptionalprimaryKey Cache?: boolean (Enterprise Edition only.) If set to
+true, then primary key columns +will always be cached in memory.Default:
+falseOptionalprimarySort?: ({
    direction: Direction;
    field: string;
} | {
    asc: boolean;
    field: string;
})[]Attribute path (
+field) for the value of each document that will be +used for sorting.If
+directionis set to"asc"orascis set totrue, +the primary sorting order will be ascending.If
+directionis set to"desc"orascis set tofalse, +the primary sorting order will be descending.OptionalprimarySort Cache?: boolean (Enterprise Edition only.) If set to
+true, then primary sort columns +will always be cached in memory.Default:
+falseOptionalprimarySort Compression?: Compression Compression to use for the primary sort data.
+Default:
+"lz4"OptionalstoredValues?: ArangoSearchViewStoredValueOptions[] | string[] | string[][] Attribute paths for which values should be stored in the view index +in addition to those used for sorting via
+primarySort.type: "arangosearch"
Type of the View.
+OptionalwritebufferActive?: number Maximum number of concurrent active writers that perform a transaction.
+Default:
+0OptionalwritebufferIdle?: number Maximum number of writers cached in the pool.
+Default:
+64OptionalwritebufferSize Max?: number Maximum memory byte size per writer before a writer flush is triggered.
+Default:
+33554432(32 MiB)
-
-
-
-
-
-
-
-Type alias CreateSearchAliasViewOptions
Options for creating a SearchAlias View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateSearchAliasViewOptions
Options for creating a SearchAlias View.
+Type declaration
type: "search-alias"
Type of the View.
+
-
-
-
-
-
-
-
-Type alias CreateViewOptions
Options for creating a View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias CreateViewOptions
Options for creating a View.
+
-
-
-
-
-
-
-Type alias Direction
Direction: "desc" | "asc"
-Sorting direction. Descending or ascending.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias Direction
Direction: "desc" | "asc"
Sorting direction. Descending or ascending.
+
-
-
-
-
-
-
-
-Type alias GenericViewDescription
Generic
    globallyUniqueId: string;
    id: string;
    name: string;
}
-Â Â Â Â globallyUniqueId: string;
    id: string;
    name: string;
}
Generic description of a View.
-
-
Type declaration
--
-
-
-
globally
-Unique Id: string A globally unique identifier for this View.
-
- -
-
id: string
-An identifier for this View.
-
- -
-
name: string
-Name of the View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias GenericViewDescription
Generic
    globallyUniqueId: string;
    id: string;
    name: string;
}
    globallyUniqueId: string;
    id: string;
    name: string;
}
Generic description of a View.
+Type declaration
globally
Unique Id: string A globally unique identifier for this View.
+id: string
An identifier for this View.
+name: string
Name of the View.
+
-
-
-
-
-
-
-Type alias SearchAliasViewDescription
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewDescription
Type declaration
type: "search-alias"
-
-
-
-
-
-
-
-Type alias SearchAliasViewIndexOptions
Search
    collection: string;
    index: string;
}
-Â Â Â Â collection: string;
    index: string;
}
Options defining an index used in a SearchAlias View.
-
-
Type declaration
--
-
-
-
collection: string
-Name of a collection.
-
- -
-
index: string
-Name of an inverted index in the collection.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewIndexOptions
Search
    collection: string;
    index: string;
}
    collection: string;
    index: string;
}
Options defining an index used in a SearchAlias View.
+Type declaration
collection: string
Name of a collection.
+index: string
Name of an inverted index in the collection.
+
-
-
-
-
-
-
-Type alias SearchAliasViewPatchIndexOptions
Search
    operation?: "add" | "del";
}
-Â Â Â Â operation?: "add" | "del";
}
Options defining an index to be modified in a SearchAlias View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewPatchIndexOptions
Search
    operation?: "add" | "del";
}
    operation?: "add" | "del";
}
Options defining an index to be modified in a SearchAlias View.
+Type declaration
Optionaloperation?: "add" | "del"Whether to add or remove the index.
+Default:
+"add"
-
-
-
-
-
-
-
-
-Type alias SearchAliasViewPatchPropertiesOptions
Options for partially modifying the properties of a SearchAlias View.
-
-
Type declaration
--
-
-
-
indexes: SearchAliasViewPatchIndexOptions[]
-An array of inverted indexes to add to the View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewPatchPropertiesOptions
Options for partially modifying the properties of a SearchAlias View.
+Type declaration
indexes: SearchAliasViewPatchIndexOptions[]
An array of inverted indexes to add to the View.
+
-
-
-
-
-
-
-Type alias SearchAliasViewProperties
Search
    indexes: {
        collection: string;
        index: string;
    }[];
}
-Â Â Â Â indexes: {
        collection: string;
        index: string;
    }[];
}
Properties of a SearchAlias View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewProperties
Search
    indexes: {
        collection: string;
        index: string;
    }[];
}
    indexes: {
        collection: string;
        index: string;
    }[];
}
Properties of a SearchAlias View.
+Type declaration
indexes: {
    collection: string;
    index: string;
}[]
-
-
-
-
-
-
-
-
-Type alias SearchAliasViewPropertiesOptions
Options for modifying the properties of a SearchAlias View.
-
-
Type declaration
--
-
-
-
indexes: SearchAliasViewIndexOptions[]
-An array of inverted indexes to add to the View.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias SearchAliasViewPropertiesOptions
Options for modifying the properties of a SearchAlias View.
+Type declaration
indexes: SearchAliasViewIndexOptions[]
An array of inverted indexes to add to the View.
+
-
\ No newline at end of file
diff --git a/devel/types/view.ViewDescription.html b/devel/types/view.ViewDescription.html
index 6a7b39a38..4bf522347 100644
--- a/devel/types/view.ViewDescription.html
+++ b/devel/types/view.ViewDescription.html
@@ -1,83 +1 @@
-
-TierConsolidationPolicy | arangojs
-
-
-Type alias TierConsolidationPolicy
Tier
    minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}
-Â Â Â Â minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}
Policy to consolidate if the sum of all candidate segment byte size is less +
Type alias TierConsolidationPolicy
Tier
    minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}
    minScore?: number;
    segmentsBytesFloor?: number;
    segmentsBytesMax?: number;
    segmentsMax?: number;
    segmentsMin?: number;
    type: "tier";
}
Policy to consolidate if the sum of all candidate segment byte size is less than the total segment byte size multiplied by a given threshold.
-
-
-Type declaration
--
-
-
-
-OptionalminScore?: number Consolidation candidates with a score less than this value will be +
Type declaration
OptionalminScore?: number Consolidation candidates with a score less than this value will be filtered out.
Default:
-0
--
-
-OptionalsegmentsBytes Floor?: number Size below which all segments are treated as equivalent.
+ OptionalsegmentsBytes Floor?: number Size below which all segments are treated as equivalent.
Default:
-2097152(2 MiB)
--
-
-OptionalsegmentsBytes Max?: number Maximum allowed size of all consolidation segments.
+ OptionalsegmentsBytes Max?: number Maximum allowed size of all consolidation segments.
Default:
-5368709120(5 GiB)
--
-
-OptionalsegmentsMax?: number Maximum number of segments that are evaluated as candidates for +
OptionalsegmentsMax?: number Maximum number of segments that are evaluated as candidates for consolidation.
Default:
-10
--
-
-OptionalsegmentsMin?: number Minimum number of segments that are evaluated as candidates for +
OptionalsegmentsMin?: number Minimum number of segments that are evaluated as candidates for consolidation.
Default:
-1
--
-
type: "tier"
-Type of consolidation policy.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
type: "tier"
Type of consolidation policy.
+
-
-
-
-
-
-
-Type alias ViewDescription
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ViewDescription
-
-
-
-
-
-
-Type alias ViewPatchPropertiesOptions
View
-Options for partially modifying a View's properties.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ViewPatchPropertiesOptions
View
Options for partially modifying a View's properties.
+
-
-
-
-
-
-
-Type alias ViewProperties
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ViewProperties
-
-
-
-
-
-
-
-Type alias ViewPropertiesOptions
Options for replacing a View's properties.
-
-
-
\ No newline at end of file
+Generated using TypeDoc
Type alias ViewPropertiesOptions
Options for replacing a View's properties.
+
Represents an Analyzer in a Database.
-