Class ArangoError
Represents an error returned by ArangoDB.
-Hierarchy
- Error
- ArangoError
Index
Constructors
Class ArangoError
Represents an error returned by ArangoDB.
+Hierarchy
- Error
- ArangoError
Index
Constructors
Properties
Constructors
constructor
- new
Arango Error(data, options?): ArangoError Creates a new
-ArangoErrorfrom an ArangoDB error response.Parameters
- data: Omit<ArangoErrorResponse, "error">
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns ArangoError
Properties
Optional code
HTTP status code included in the server error response object.
-error
ArangoDB error code.
+Parameters
- data: Omit<ArangoErrorResponse, "error">
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns ArangoError
Properties
Optional code
HTTP status code included in the server error response object.
+error
ArangoDB error code.
-name
Static Optional prepare
Optional override for formatting stack traces
+name
Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static 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
- toJSON(): ArangoErrorResponse
Returns ArangoErrorResponse
to
Static capture
Static 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
- toJSON(): ArangoErrorResponse
Returns ArangoErrorResponse
to
Static capture
Class FetchFailedError
Represents an error from a failed fetch request.
+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
Hierarchy (view full)
- NetworkError
- FetchFailedError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Fetch Failed Error(message, request, options?): FetchFailedError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns FetchFailedError
Properties
is
Indicates whether the request that caused this error can be safely retried.
-name
request
Fetch request object.
-Static Optional prepare
Optional override for formatting stack traces
+Constructors
constructor
- new
Fetch Failed Error(message, request, options?): FetchFailedError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns FetchFailedError
Properties
is
Indicates whether the request that caused this error can be safely retried.
+name
request
Fetch request object.
+Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Static capture
Static stack
Methods
toJSON
Static capture
Class HttpError
Represents a plain HTTP error response.
-Hierarchy (view full)
- NetworkError
- HttpError
Index
Properties
Class HttpError
Represents a plain HTTP error response.
+Hierarchy (view full)
- NetworkError
- HttpError
Index
Properties
Properties
code
HTTP status code of the server response.
-is
Indicates whether the request that caused this error can be safely retried.
-name
request
Fetch request object.
-response
Server response object.
-Static Optional prepare
Optional override for formatting stack traces
+is
Indicates whether the request that caused this error can be safely retried.
+name
request
Fetch request object.
+response
Server response object.
+Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
to
Static capture
Static stack
Methods
toJSON
to
Static capture
Class NetworkError
Represents a network error or an error encountered while performing a network request.
-Hierarchy (view full)
- Error
Index
Constructors
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, request, options?): NetworkError Parameters
- message: string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns NetworkError
Properties
is
Indicates whether the request that caused this error can be safely retried.
-name
request
Fetch request object.
-Static Optional prepare
Optional override for formatting stack traces
+Constructors
constructor
- new
Network Error(message, request, options?): NetworkError Parameters
- message: string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns NetworkError
Properties
is
Indicates whether the request that caused this error can be safely retried.
+name
request
Fetch request object.
+Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Static capture
Static stack
Methods
toJSON
Static capture
Class PropagationTimeoutError
Represents an error from a deliberate timeout encountered while waiting +
Class PropagationTimeoutError
Represents an error from a deliberate timeout encountered while waiting for propagation.
-Hierarchy
- Error
- PropagationTimeoutError
Index
Constructors
Hierarchy
- Error
- PropagationTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Propagation Timeout Error(message?, options?): PropagationTimeoutError Parameters
Optionalmessage: string- options: {
cause?: Error;
} = {}Optionalcause?: Error
Returns PropagationTimeoutError
Properties
name
Static Optional prepare
Optional override for formatting stack traces
+Constructors
constructor
- new
Propagation Timeout Error(message?, options?): PropagationTimeoutError Parameters
Optionalmessage: string- options: {
cause?: Error;
} = {}Optionalcause?: Error
Returns PropagationTimeoutError
Properties
name
Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
Static stack
Methods
Static capture
Class RequestAbortedError
Represents an error from a request that was aborted.
-Hierarchy (view full)
- NetworkError
- RequestAbortedError
Index
Constructors
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, request, options?): RequestAbortedError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns RequestAbortedError
Properties
is
Indicates whether the request that caused this error can be safely retried.
-name
request
Fetch request object.
-Static Optional prepare
Optional override for formatting stack traces
+Constructors
constructor
- new
Request Aborted Error(message, request, options?): RequestAbortedError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns RequestAbortedError
Properties
is
Indicates whether the request that caused this error can be safely retried.
+name
request
Fetch request object.
+Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Static capture
Static stack
Methods
toJSON
Static capture
Class ResponseTimeoutError
Represents an error from a deliberate timeout encountered while waiting +
Class ResponseTimeoutError
Represents an error from a deliberate timeout encountered while waiting for a server response.
-Hierarchy (view full)
- NetworkError
- ResponseTimeoutError
Index
Constructors
Hierarchy (view full)
- NetworkError
- ResponseTimeoutError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Response Timeout Error(message, request, options?): ResponseTimeoutError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns ResponseTimeoutError
Properties
is
Indicates whether the request that caused this error can be safely retried.
-name
request
Fetch request object.
-Static Optional prepare
Optional override for formatting stack traces
+Constructors
constructor
- new
Response Timeout Error(message, request, options?): ResponseTimeoutError Parameters
- message: undefined | string
- request: Request
- options: {
cause?: Error;
isSafeToRetry?: null | boolean;
} = {}Optionalcause?: ErrorOptionalisSafe To Retry?: null | boolean
Returns ResponseTimeoutError
Properties
is
Indicates whether the request that caused this error can be safely retried.
+name
request
Fetch request object.
+Static Optional prepare
Optional override for formatting stack traces
Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
Methods
toJSON
Static capture
Static stack
Methods
toJSON
Static capture
Class Graph
Represents a graph in a databases.Database.
- Index
Accessors
Class Graph
Represents a graph in a databases.Database.
+ Index
Accessors
Methods
Accessors
database
is
- get isArangoGraph(): true
Indicates that this object represents an ArangoDB Graph.
-Returns true
name
- get name(): string
Name of the graph.
-Returns string
Methods
add
- add
Edge Definition(edgeDefinition, options?): Promise<GraphDescription> Adds an edge definition to this graph.
+Returns Database
is
- get isArangoGraph(): true
Indicates that this object represents an ArangoDB Graph.
+Returns true
name
- get name(): string
Name of the graph.
+Returns string
Methods
add
- add
Edge Definition(edgeDefinition, options?): Promise<GraphDescription> Adds an edge definition to this graph.
Parameters
- edgeDefinition: EdgeDefinitionOptions
Definition of a relation in this graph.
- options: AddEdgeDefinitionOptions = {}
Returns Promise<GraphDescription>
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
- add
Vertex Collection(collection, options?): Promise<GraphDescription> Adds the given collection to this graph as a vertex collection.
+
add
- add
Vertex Collection(collection, options?): Promise<GraphDescription> 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<GraphDescription>
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<GraphDescription>
Creates a graph with the given
edgeDefinitionsandoptionsfor this +
create
- create(edgeDefinitions, options?): Promise<GraphDescription>
Creates a graph with the given
edgeDefinitionsandoptionsfor this graph's name.Parameters
- edgeDefinitions: EdgeDefinitionOptions[]
Definitions for the relations of the graph.
- options: CreateGraphOptions = {}
Options for creating the graph.
Returns Promise<GraphDescription>
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
drop
- drop(dropCollections?): Promise<boolean>
Deletes the graph from the database.
Parameters
- dropCollections: boolean = false
If set to
true, the collections associated with the graph will also be deleted.
Returns Promise<boolean>
Example
-const db = new Database();
const graph = db.graph("some-graph");
await graph.drop();
// the graph "some-graph" no longer exists- dropCollections: boolean = false
edge
- edge
Collection<T>(collection): GraphEdgeCollection<T, T> Returns a GraphEdgeCollection instance for the given collection +
edge
- edge
Collection<T>(collection): GraphEdgeCollection<T, T> Returns a GraphEdgeCollection instance for the given collection name representing the collection in this graph.
Type Parameters
Parameters
- collection: string | ArangoCollection
Name of the edge collection.
Returns GraphEdgeCollection<T, 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
- edge
Collections(): Promise<GraphEdgeCollection<any, any>[]> Fetches all edge collections of this graph from the database and returns +
edge
- edge
Collections(): Promise<GraphEdgeCollection<any, any>[]> Fetches all edge collections of this graph from the database and returns an array of GraphEdgeCollection instances.
See also Graph#listEdgeCollections.
Returns Promise<GraphEdgeCollection<any, 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
exists
get
- get(): Promise<GraphDescription>
Retrieves general information about the graph.
+
get
- get(): Promise<GraphDescription>
Retrieves general information about the graph.
Returns Promise<GraphDescription>
Example
-const db = new Database();
const graph = db.graph("some-graph");
const data = await graph.get();
// data contains general information about the graph
list
list
- list
Edge Collections(): Promise<string[]> Fetches all edge collections of this graph from the database and returns an array of their names.
See also 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
list
- list
Vertex Collections(): Promise<string[]> Fetches all vertex collections of this graph from the database and returns an array of their names.
See also 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
- remove
Edge Definition(collection, dropCollection?): Promise<GraphDescription> Removes the edge definition for the given edge collection from this graph.
+
remove
- remove
Edge Definition(collection, dropCollection?): Promise<GraphDescription> 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<GraphDescription>
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- collection: string | ArangoCollection
remove
- remove
Vertex Collection(collection, dropCollection?): Promise<GraphDescription> Removes the given collection from this graph as a vertex collection.
+
remove
- remove
Vertex Collection(collection, dropCollection?): Promise<GraphDescription> 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<GraphDescription>
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.- collection: string | ArangoCollection
replace
- replace
Edge Definition(edgeDefinition, options?): Promise<GraphDescription> Replaces an edge definition in this graph. The existing edge definition +
replace
- replace
Edge Definition(edgeDefinition, options?): Promise<GraphDescription> Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.
Parameters
- edgeDefinition: EdgeDefinitionOptions
Definition of a relation in this graph.
Optionaloptions: ReplaceEdgeDefinitionOptions
Returns Promise<GraphDescription>
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<GraphDescription> Replaces an edge definition in this graph. The existing edge definition +
- replace
Edge Definition(collection, edgeDefinition, options?): Promise<GraphDescription> Replaces an edge definition in this graph. The existing edge definition for the given edge collection will be overwritten.
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<GraphDescription>
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
- vertex
Collection<T>(collection): GraphVertexCollection<T, T> Returns a GraphVertexCollection instance for the given collection +
vertex
- vertex
Collection<T>(collection): GraphVertexCollection<T, T> Returns a GraphVertexCollection instance for the given collection name representing the collection in this graph.
Type Parameters
Parameters
- collection: string | ArangoCollection
Name of the vertex collection.
-
Returns GraphVertexCollection<T, T>
- collection: string | ArangoCollection
vertex
- vertex
Collections(): Promise<GraphVertexCollection<any, any>[]> Fetches all vertex collections of this graph from the database and returns +
Returns GraphVertexCollection<T, T>
vertex
- vertex
Collections(): Promise<GraphVertexCollection<any, any>[]> Fetches all vertex collections of this graph from the database and returns an array of GraphVertexCollection instances.
See also Graph#listVertexCollections.
Returns Promise<GraphVertexCollection<any, 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"
}
Class GraphEdgeCollection<EntryResultType, EntryInputType>
Represents a collections.EdgeCollection of edges in a Graph.
+Class GraphEdgeCollection<EntryResultType, EntryInputType>
Represents a collections.EdgeCollection of edges in a Graph.
Type Parameters
- EntryResultType extends Record<string, any> = any
Type to represent edge document contents returned by the server (including computed properties).
- EntryInputType extends Record<string, any> = EntryResultType
Type to represent edge document contents passed when inserting or replacing edge documents (without computed properties).
-
Implements
Index
Accessors
Implements
Accessors
collection
- get collection(): EdgeCollection<EntryResultType, EntryInputType>
A collections.EdgeCollection instance for this edge collection.
-Returns EdgeCollection<EntryResultType, EntryInputType>
database
graph
name
- get name(): string
Name of the collection.
-Returns string
Methods
edge
- edge(selector, options?): Promise<Edge<EntryResultType>>
Retrieves the edge matching the given key or id.
+Returns EdgeCollection<EntryResultType, EntryInputType>
database
graph
name
- get name(): string
Name of the collection.
+Returns string
Methods
edge
- edge(selector, options?): Promise<Edge<EntryResultType>>
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -27,7 +27,7 @@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<EntryResultType>>
Retrieves the edge matching the given key or id.
+- edge(selector, graceful): Promise<Edge<EntryResultType>>
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -38,7 +38,7 @@Example
constExample
-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 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");
}- selector: DocumentSelector
remove
- remove(selector, options?): Promise<DocumentMetadata & {
old?: Edge<EntryResultType>;
}> Removes an existing edge from the collection.
+
remove
- remove(selector, options?): Promise<DocumentMetadata & {
old?: Edge<EntryResultType>;
}> Removes an existing edge from the collection.
Throws an exception when passed a edge or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -54,7 +54,7 @@Example
constOptionaloptions: RemoveGraphDocumentOptionsOptions for removing the edge.
Returns Promise<DocumentMetadata & {
old?: Edge<EntryResultType>;
}>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, newData, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
}> Replaces an existing edge in the collection.
+
replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
}> Replaces an existing edge in the collection.
Throws an exception when passed a edge or
_idfrom a different collection.\ No newline at end of file +Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -63,12 +63,12 @@Example
constOptionaloptions: ReplaceGraphDocumentOptionsOptions for replacing the edge.
Returns Promise<DocumentMetadata & {
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
save
- save(data, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
}> Inserts a new edge with the given
+datainto the collection.
save
- save(data, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
}> Inserts a new edge with the given
datainto the collection.Parameters
- data: EdgeData<EntryInputType>
The contents of the new edge.
Optionaloptions: InsertGraphDocumentOptionsOptions for inserting the edge.
Returns Promise<DocumentMetadata & {
new?: 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>
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
}> Updates an existing edge in the collection.
+
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
}> Updates an existing edge in the collection.
Throws an exception when passed a edge or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -77,4 +77,4 @@Example
constOptionaloptions: ReplaceGraphDocumentOptionsOptions for updating the edge.
Returns Promise<DocumentMetadata & {
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
- selector: DocumentSelector
- selector: DocumentSelector
- selector: DocumentSelector
- selector: DocumentSelector
Class GraphVertexCollection<EntryResultType, EntryInputType>
Represents a collections.DocumentCollection of vertices in a Graph.
+Class GraphVertexCollection<EntryResultType, EntryInputType>
Represents a collections.DocumentCollection of vertices in a Graph.
Type Parameters
- EntryResultType extends Record<string, any> = any
Type to represent vertex document contents returned by the server (including computed properties).
- EntryInputType extends Record<string, any> = EntryResultType
Type to represent vertex document contents passed when inserting or replacing vertex documents (without computed properties).
-
Implements
Index
Accessors
Implements
Index
Accessors
Accessors
collection
- get collection(): DocumentCollection<EntryResultType, EntryInputType>
A collections.DocumentCollection instance for this vertex collection.
-Returns DocumentCollection<EntryResultType, EntryInputType>
database
graph
name
- get name(): string
Name of the collection.
-Returns string
Methods
remove
- remove(selector, options?): Promise<DocumentMetadata & {
old?: Document<EntryResultType>;
}> Removes an existing vertex from the collection.
+Returns DocumentCollection<EntryResultType, EntryInputType>
database
graph
name
- get name(): string
Name of the collection.
+Returns string
Methods
remove
- remove(selector, options?): Promise<DocumentMetadata & {
old?: Document<EntryResultType>;
}> Removes an existing vertex from the collection.
Throws an exception when passed a vertex or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -27,7 +27,7 @@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, newData, options?): Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}> Replaces an existing vertex in the collection.
+
replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}> Replaces an existing vertex in the collection.
Throws an exception when passed a vertex or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -36,12 +36,12 @@Example
constOptionaloptions: ReplaceGraphDocumentOptionsOptions for replacing the vertex.
Returns Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}>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<EntryResultType>;
}> Inserts a new vertex with the given
+datainto the collection.
save
- save(data, options?): Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
}> Inserts a new vertex with the given
datainto the collection.Parameters
- data: DocumentData<EntryInputType>
The contents of the new vertex.
Optionaloptions: InsertGraphDocumentOptionsOptions for inserting the vertex.
Returns Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
}>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<EntryInputType>
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}> Updates an existing vertex in the collection.
+
update
- update(selector, newData, options?): Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}> Updates an existing vertex in the collection.
Throws an exception when passed a vertex or
_idfrom a different collection.\ No newline at end of file +Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -50,7 +50,7 @@Example
constOptionaloptions: ReplaceGraphDocumentOptionsOptions for updating the vertex.
Returns Promise<DocumentMetadata & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}>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<EntryResultType>>
Retrieves the vertex matching the given key or id.
+
vertex
- vertex(selector, options?): Promise<Document<EntryResultType>>
Retrieves the vertex matching the given key or id.
Throws an exception when passed a vertex or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -60,7 +60,7 @@Example
constExample
-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<EntryResultType>>
Retrieves the vertex matching the given key or id.
+- vertex(selector, graceful): Promise<Document<EntryResultType>>
Retrieves the vertex matching the given key or id.
Throws an exception when passed a vertex or
_idfrom a different collection.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -71,7 +71,7 @@Example
constExample
-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 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");
}- selector: DocumentSelector
- selector: DocumentSelector
- selector: DocumentSelector
- selector: DocumentSelector
- selector: DocumentSelector
Class Job<ResultType>
Represents an async job in a databases.Database.
+Class Job<ResultType>
Represents an async job in a databases.Database.
Type Parameters
Index
Accessors
Accessors
database
id
- get id(): string
The job's ID.
-Returns string
is
- get isLoaded(): boolean
Whether the job's results have been loaded. If set to
true, the job's +Returns Database
id
- get id(): string
The job's ID.
+Returns string
is
- 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
- get result(): undefined | ResultType
The job's result if it has been loaded or
-undefinedotherwise.Returns undefined | ResultType
Methods
cancel
result
- get result(): undefined | ResultType
The job's result if it has been loaded or
+undefinedotherwise.Returns undefined | ResultType
Methods
cancel
delete
get
delete
get
- get
Completed(): Promise<boolean> Fetches the job's completion state.
Returns
trueif the job has completed,falseotherwise.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 | ResultType>
Loads the job's result from the database if it is not already loaded.
+
load
- load(): Promise<undefined | ResultType>
Loads the job's result from the database if it is not already loaded.
Returns Promise<undefined | ResultType>
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);
Class Route
Represents an arbitrary route relative to an ArangoDB database.
- Index
Accessors
Class Route
Represents an arbitrary route relative to an ArangoDB database.
+Accessors
database
headers
- get headers(): Headers
Headers of this route.
-Returns Headers
pathname
- get pathname(): string
Path of this route.
-Returns string
Methods
delete
- delete(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a DELETE request against the given path relative to this route +
Returns Database
headers
- get headers(): Headers
Headers of this route.
+Returns Headers
pathname
- get pathname(): string
Path of this route.
+Returns string
Methods
delete
- delete(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a DELETE request against the given path relative to this route and returns the server response.
Parameters
- pathname: 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");- pathname: string
- delete(search?, headers?): Promise<ProcessedResponse<any>>
Performs a DELETE request against the given path relative to this route +
- delete(search?, headers?): Promise<ProcessedResponse<any>>
Performs a DELETE request against the given path relative to this route and returns the server response.
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(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a GET request against the given path relative to this route +
get
- get(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a GET request against the given path relative to this route and returns the server response.
Parameters
- pathname: 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 });- pathname: string
- get(search?, headers?): Promise<ProcessedResponse<any>>
Performs a GET request against the given path relative to this route +
- get(search?, headers?): Promise<ProcessedResponse<any>>
Performs a GET request against the given path relative to this route and returns the server response.
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(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a HEAD request against the given path relative to this route +
head
- head(pathname, search?, headers?): Promise<ProcessedResponse<any>>
Performs a HEAD request against the given path relative to this route and returns the server response.
Parameters
- pathname: 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 });- pathname: string
- head(search?, headers?): Promise<ProcessedResponse<any>>
Performs a HEAD request against the given path relative to this route +
- head(search?, headers?): Promise<ProcessedResponse<any>>
Performs a HEAD request against the given path relative to this route and returns the server response.
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(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PATCH request against the given path relative to this route +
patch
- patch(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PATCH request against the given path relative to this route and returns the server response.
Parameters
- pathname: string
Path relative to this route.
Optionalbody: anyBody of the request object.
@@ -60,7 +60,7 @@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" });- pathname: string
- patch(body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PATCH request against the given path relative to this route +
- 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.Parameters
Optionalbody: anyBody of the request object. Must not be a string.
@@ -68,7 +68,7 @@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(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a POST request against the given path relative to this route +
post
- post(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a POST request against the given path relative to this route and returns the server response.
Parameters
- pathname: string
Path relative to this route.
Optionalbody: anyBody of the request object.
@@ -76,7 +76,7 @@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"
});- pathname: string
- post(body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a POST request against the given path relative to this route +
- 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.Parameters
Optionalbody: anyBody of the request object. Must not be a string.
@@ -84,7 +84,7 @@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(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PUT request against the given path relative to this route +
put
- put(pathname, body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PUT request against the given path relative to this route and returns the server response.
Parameters
- pathname: string
Path relative to this route.
Optionalbody: anyBody of the request object.
@@ -92,7 +92,7 @@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" });- pathname: string
- put(body?, search?, headers?): Promise<ProcessedResponse<any>>
Performs a PUT request against the given path relative to this route +
- 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.Parameters
Optionalbody: anyBody of the request object. Must not be a string.
@@ -100,15 +100,15 @@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 +
request
- request(options?): Promise<ProcessedResponse<any>>
Performs an arbitrary HTTP request relative to this route and returns the server response.
Parameters
- options: RequestOptions = {}
Options 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",
pathname: "/users",
body: {
username: "admin",
password: "hunter2"
}
});- options: RequestOptions = {}
route
- route(pathname, headers?): Route
Creates a new route relative to this route that inherits any of its default +
route
- route(pathname, headers?): Route
Creates a new route relative to this route that inherits any of its default HTTP headers.
Parameters
- pathname: 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");- pathname: string
Class Transaction
Represents a streaming transaction in a databases.Database.
- Index
Accessors
Class Transaction
Represents a streaming transaction in a databases.Database.
+Accessors
database
id
- get id(): string
Unique identifier of this transaction.
+Returns Database
id
- get id(): string
Unique identifier of this transaction.
-Returns string
Methods
abort
- abort(options?): Promise<TransactionInfo>
Attempts to abort the transaction to the databases.
+Returns string
Methods
abort
- abort(options?): Promise<TransactionInfo>
Attempts to abort the transaction to the databases.
Parameters
- options: TransactionAbortOptions = {}
Options for aborting the transaction.
Returns Promise<TransactionInfo>
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<TransactionInfo>
Attempts to commit the transaction to the databases.
+
commit
- commit(options?): Promise<TransactionInfo>
Attempts to commit the transaction to the databases.
Parameters
- options: TransactionCommitOptions = {}
Options for comitting the transaction.
Returns Promise<TransactionInfo>
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
exists
get
- get(): Promise<TransactionInfo>
Retrieves general information about the transaction.
+
get
- get(): Promise<TransactionInfo>
Retrieves general information about the transaction.
Returns Promise<TransactionInfo>
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
- 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 @@ -58,4 +58,4 @@
Example
// BAD! You caExample
-// 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");
- callback: (() => Promise<T>)
Class View
Represents a View in a databases.Database.
- Index
Accessors
Class View
Represents a View in a databases.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.Returns 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 databases.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
drop
exists
exists
get
- get(): Promise<ArangoApiResponse<ViewDescription>>
Retrieves general information about the View.
+
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.
+
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.
rename
- rename(newName): Promise<ArangoApiResponse<ViewDescription>>
Renames the View and updates the instance's
nametonewName.Additionally removes the instance from the databases.Database's internal cache.
Note: Renaming Views may not be supported when ArangoDB is @@ -35,12 +35,12 @@
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!- newName: string
replace
- replace
Properties<Properties>(properties?): Promise<Properties extends ArangoSearchViewPropertiesOptions
? ArangoSearchViewProperties
: Properties extends SearchAliasViewPropertiesOptions
? SearchAliasViewProperties
: ViewProperties> Replaces the properties of the 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 UpdateSearchAliasViewPropertiesOptions
? SearchAliasViewProperties
: ViewProperties> Updates the properties of the View.
+
update
- update
Properties<Properties>(properties?): Promise<Properties extends ArangoSearchViewPropertiesOptions
? ArangoSearchViewProperties
: Properties extends UpdateSearchAliasViewPropertiesOptions
? SearchAliasViewProperties
: ViewProperties> Updates the properties of the View.
Type Parameters
- Properties extends undefined | UpdateViewPropertiesOptions
Parameters
Optionalproperties: PropertiesProperties of the View to update.
Returns Promise<Properties extends ArangoSearchViewPropertiesOptions
? ArangoSearchViewProperties
: Properties extends UpdateSearchAliasViewPropertiesOptions
? 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
Enumeration CollectionStatus
Integer values indicating the collection loading status.
- Index
Enumeration Members
Enumeration Members
DELETED
LOADED
LOADING
NEWBORN
UNLOADED
UNLOADING
Enumeration CollectionType
Integer values indicating the collection type.
- Index
Enumeration Members
Enumeration Members
DOCUMENT_
EDGE_
Function isArangoAnalyzer
Returns analyzer is Analyzer
Function aql
- aql<T>(templateStrings, ...args): AqlQuery<T>
Template string handler (template tag) for AQL queries.
+aql | arangojs \ No newline at end of file +Function aql
- aql<T>(templateStrings, ...args): AqlQuery<T>
Template string handler (template tag) for AQL queries.
The
@@ -20,4 +20,4 @@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.Example
constExample
-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): literal is AqlLiteral Indicates whether the given value is an AqlLiteral.
+isAqlLiteral | arangojs \ No newline at end of file +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
- is
Returns literal is AqlLiteral
Function join
- join(values, sep?): AqlQuery
Constructs AqlQuery objects from an array of arbitrary values.
+join | arangojs \ No newline at end of file +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 @@ -12,4 +12,4 @@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): AqlLiteral
Marks an arbitrary scalar value (i.e. a string, number or boolean) as +
literal | arangojs \ No newline at end of file +Function literal
- literal(value): AqlLiteral
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 @@ -12,4 +12,4 @@Example
// BAD! DO NOTExample
-// 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
`);
Function collectionToString
- collection
To String(collection): string Coerces the given collection name or ArangoCollection object to +
collectionToString | arangojs \ No newline at end of file +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
- collection: string | ArangoCollection
- collection
Returns string
Function isArangoCollection
- is
Arango Collection(collection): collection is ArangoCollection Indicates whether the given value represents an ArangoCollection.
+isArangoCollection | arangojs \ No newline at end of file +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
- is
Returns collection is ArangoCollection
Function isBearerAuth
- is
Bearer Auth(auth): auth is BearerAuthCredentials Determines if the given credentials are for Bearer token authentication.
-Parameters
Returns auth is BearerAuthCredentials
Function isBearerAuth
- is
Bearer Auth(auth): auth is BearerAuthCredentials Determines if the given credentials are for Bearer token authentication.
+Parameters
Returns auth is BearerAuthCredentials
Function getStatusMessage
- get
Status Message(response): string Returns the status message for the given response's status code or the +
getStatusMessage | arangojs \ No newline at end of file +Function getStatusMessage
- get
Status Message(response): string Returns the status message for the given response's status code or the status text of the response.
-Parameters
- response: ProcessedResponse<any>
Returns string
Parameters
- response: ProcessedResponse<any>
Returns string
- get
Function isArangoErrorResponse
- is
Arango Error Response(body): body is ArangoErrorResponse Indicates whether the given value represents an ArangoDB error response.
-Parameters
- body: unknown
Returns body is ArangoErrorResponse
Function isArangoErrorResponse
- is
Arango Error Response(body): body is ArangoErrorResponse Indicates whether the given value represents an ArangoDB error response.
+Parameters
- body: unknown
Returns body is ArangoErrorResponse
Function isArangoDatabase
Returns database is Database
Function isArangoError
- is
Arango Error(error): error is ArangoError Indicates whether the given value represents an ArangoError.
+isArangoError | arangojs \ No newline at end of file +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
- is
Returns error is ArangoError
Function isNetworkError
- is
Network Error(error): error is NetworkError Indicates whether the given value represents a NetworkError.
+isNetworkError | arangojs \ No newline at end of file +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
- is
Returns error is NetworkError
Function arangojs
- arangojs(config?): Database
Creates a new
+Databaseinstance with its own connection pool.arangojs | arangojs \ No newline at end of file +Function arangojs
- arangojs(config?): Database
Creates a new
Databaseinstance with its own connection pool.This is a wrapper function for the :constructor.
Parameters
Optionalconfig: ConfigOptionsAn 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.- arangojs(url, name?): Database
Creates a new
Databaseinstance with its own connection pool.This is a wrapper function for the :constructor.
Parameters
- url: string | string[]
Base URL of the ArangoDB server or list of server URLs. Equivalent to the
urloption in configuration.ConfigOptions. 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): transaction is Transaction Indicates whether the given value represents a Transaction.
+isArangoTransaction | arangojs \ No newline at end of file +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
- is
Returns transaction is Transaction
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.
Interface QueueTimeMetrics
An object providing methods for accessing queue time metrics of the most +
Interface QueueTimeMetrics
An object providing methods for accessing queue time metrics of the most recently received server responses if the server supports this feature.
-getAvg(): number;
getLatest(): undefined | number;
getValues(): [number, number][];
}
Returns [number, number][]
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.
-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
Hierarchy (view full)
- AqlQuery
Properties
Optional [type]
bind
An object mapping AQL bind parameter names to their respective values.
Names of parameters representing collections are prefixed with an at-symbol.
-query
An AQL query string.
-query
An AQL query string.
+Interface GeneratedAqlQuery<T>
Derived type representing AQL query objects generated by the AQL helper +
Interface GeneratedAqlQuery<T>
Derived type representing AQL query objects generated by the AQL helper functions and the AQL template string handler. These objects can be fed back into these helper functions to be inlined or merged in complex queries.
-Type Parameters
Hierarchy (view full)
Properties
Optional [type]
bind
An object mapping AQL bind parameter names to their respective values.
Names of parameters representing collections are prefixed with an at-symbol.
-query
An AQL query string.
-query
An AQL query string.
+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.aql.
-Hierarchy (view full)
- ArangoCollection
Implemented by
Interface DocumentCollection<EntryResultType, EntryInputType>
Represents an document collection in a databases.Database.
+Interface DocumentCollection<EntryResultType, EntryInputType>
Represents an document collection in a databases.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 @@ -9,7 +9,7 @@ server (including computed properties).
Type to represent document contents passed when inserting or replacing documents (without computed properties).
-Hierarchy (view full)
- ArangoCollection
- DocumentCollection
Index
Properties
Hierarchy (view full)
- ArangoCollection
- DocumentCollection
Properties
Readonly database
Database this collection belongs to.
-Readonly name
Name of the collection.
-Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionDescription & {
checksum: string;
revision: string;
}>> Retrieves the collection checksum.
+
Readonly name
Name of the collection.
+Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionDescription & {
checksum: string;
revision: string;
}>> Retrieves the collection checksum.
Parameters
Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
Returns Promise<ArangoApiResponse<CollectionDescription & {
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<CollectionDescription>>
Triggers compaction for a collection.
+
compact
- compact(): Promise<ArangoApiResponse<CollectionDescription>>
Triggers compaction for a collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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<CollectionDescription & CollectionProperties & {
count: number;
}>> Retrieves information about the number of documents in a collection.
+
count
- count(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
count: number;
}>> Retrieves information about the number of documents in a collection.
Returns Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & CollectionProperties>>
Creates a collection with the given
+optionsand the instance's name.
create
- create(options?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Creates a collection with the given
optionsand the instance's name.See also databases.Database#createCollection and databases.Database#createEdgeCollection.
Note: When called on an EdgeCollection instance in TypeScript, @@ -70,7 +70,7 @@
Example
constExample
-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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -80,7 +80,7 @@Example
interfaceExample
-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.
+- 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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -91,7 +91,7 @@Example
constExample
-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
Exists document
Exists - 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
@@ -99,7 +99,7 @@_idfrom a different collection.Example
constOptionaloptions: 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");
}- selector: DocumentSelector
document
Id document
Id - 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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -108,7 +108,7 @@Example
constExample
-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.
+
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.\ No newline at end of file +Parameters
- selectors: (string | ObjectWithDocumentKey)[]
Array of document
_key,_idor objects with either @@ -116,83 +116,83 @@Example
constOptionaloptions: BulkReadDocumentsOptionsOptions 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<{
id: string;
}>> Deletes the collection from the database.
+
drop
- drop(options?): Promise<ArangoApiResponse<{
id: string;
}>> Deletes the collection from the database.
Parameters
Optionaloptions: DropCollectionOptionsOptions for dropping the collection.
Returns Promise<ArangoApiResponse<{
id: string;
}>>Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection
drop
Index - drop
Index(selector): Promise<ArangoApiResponse<{
id: string;
}>> Deletes the index with the given name or
+idfrom the database.
drop
Index - 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
Index - ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
+
ensure
Index - ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
Parameters
- options: EnsurePersistentIndexOptions
Options for creating the persistent index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
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
});- options: EnsurePersistentIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
Parameters
- options: EnsureTtlIndexOptions
Options for creating the TTL index.
Returns Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
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
});- options: EnsureTtlIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
Parameters
- options: EnsureMdiIndexOptions
Options for creating the multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
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"
});
-- options: EnsureMdiIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does +
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
Parameters
- options: EnsureMdiPrefixedIndexOptions
Options for creating the prefixed multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
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-prefixed",
fields: ["x", "y", "z"],
prefixFields: ["x"],
fieldValueTypes: "double"
});
-- options: EnsureMdiPrefixedIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
+- ensure
Index(details): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
Parameters
- details: EnsureMdiPrefixedIndexOptions
Options for creating the prefixed multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
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-prefixed",
fields: ["x", "y", "z"],
prefixFields: ["x"],
fieldValueTypes: "double"
});
-- details: EnsureMdiPrefixedIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
worstIndexedLevel: number;
} & {
isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
worstIndexedLevel: number;
} & {
isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
Parameters
- options: EnsureGeoIndexOptions
Options for creating the geo index.
Returns Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
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
});- options: EnsureGeoIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
writeBufferActive: number;
writeBufferIdle: number;
writeBufferSizeMax: number;
} & {
isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
writeBufferActive: number;
writeBufferIdle: number;
writeBufferSizeMax: number;
} & {
isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
Parameters
- options: EnsureInvertedIndexOptions
Options for creating the inverted index.
Returns Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
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" }]
});- options: EnsureInvertedIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<IndexDescription & {
isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<IndexDescription & {
isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
Parameters
- options: EnsureIndexOptions
Options for creating the index.
Returns Promise<ArangoApiResponse<IndexDescription & {
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
});- options: EnsureIndexOptions
exists
exists
figures
- figures(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
count: number;
figures: Record<string, any>;
}>> Retrieves statistics for a collection.
+
figures
- figures(details?): Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & 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<CollectionDescription>>
Retrieves general information about the collection.
+
get
- get(): Promise<ArangoApiResponse<CollectionDescription>>
Retrieves general information about the collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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 - 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<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.
import
- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
datainto the collection.Parameters
- data: DocumentData<EntryInputType>[]
The data to import, as an array of document data.
Optionaloptions: ImportDocumentsOptionsOptions for importing the data.
Returns Promise<ImportDocumentsResult>
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<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.- import(data, options?): Promise<ImportDocumentsResult>
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: ImportDocumentsOptionsOptions for importing the data.
Returns Promise<ImportDocumentsResult>
Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.import(
[
[ "_key", "password" ],
[ "jcd", "bionicman" ],
[ "jreyes", "amigo" ],
[ "ghermann", "zeitgeist" ]
]
);- data: any[][]
- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
datainto the collection.If
@@ -211,31 +211,31 @@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.Example
constExample
-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<IndexDescription>
Returns an index description by name or
+idif it exists.
index
- index(selector): Promise<IndexDescription>
Returns an index description by name or
idif it exists.Parameters
- selector: IndexSelector
Index name, id or object with either property.
Returns Promise<IndexDescription>
Example
-const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index");- selector: IndexSelector
indexes
indexes
- indexes<IndexType>(options?): Promise<IndexType[]>
Returns a list of all index descriptions for the collection.
Type Parameters
- IndexType extends IndexDescription | HiddenIndexDescription = IndexDescription
Parameters
Optionaloptions: ListIndexesOptionsOptions 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<HiddenIndexDescription>({
withHidden: true
});
load
Indexes load
Indexes - 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<CollectionDescription & CollectionProperties>>
Retrieves the collection's properties.
+
properties
- properties(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Retrieves the collection's properties.
Returns Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & CollectionProperties>>
Replaces the properties of the collection.
+- properties(properties): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Replaces the properties of the collection.
Parameters
- properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionDescription & 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
Count recalculate
Count - 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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -245,7 +245,7 @@Example
constExample
-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
All - remove
All(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
old?: Document<EntryResultType>;
})[]> Removes existing documents from the collection.
+
remove
All - 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.Parameters
- selectors: (string | ObjectWithDocumentKey)[]
Documents
_key,_idor objects with either of those @@ -253,7 +253,7 @@Example
constOptionaloptions: Omit<RemoveDocumentOptions, "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<CollectionDescription>>
Renames the collection and updates the instance's
+nametonewName.
rename
- rename(newName): Promise<ArangoApiResponse<CollectionDescription>>
Renames the collection and updates the instance's
nametonewName.Additionally removes the instance from the databases.Database's internal cache.
Note: Renaming collections may not be supported when ArangoDB is @@ -261,7 +261,7 @@
Example
constParameters
- newName: string
The new name of the collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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!replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
_oldRev?: string;
} & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
}> Replaces an existing document in the collection.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -270,43 +270,43 @@Example
constOptionaloptions: ReplaceDocumentOptionsOptions 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
All - 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 +
replace
All - 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.Parameters
- newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
The documents to replace.
Optionaloptions: Omit<ReplaceDocumentOptions, "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<CollectionDescription & CollectionProperties & {
revision: string;
}>> Retrieves the collection revision ID.
+
revision
- revision(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
revision: string;
}>> Retrieves the collection revision ID.
Returns Promise<ArangoApiResponse<CollectionDescription & 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.
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: InsertDocumentOptionsOptions 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
All - save
All(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
_oldRev?: string;
} & {
new?: Document<EntryResultType>;
old?: Document<EntryResultType>;
})[]> Inserts new documents with the given
+datainto the collection.
save
All - 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: InsertDocumentOptionsOptions 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>[]
shards
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
+
shards
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
Parameters
Optionaldetails: falseIf set to
-true, the response will include the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each +
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- selector: DocumentSelector
- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each shard.
Parameters
- details: true
If set to
-false, the response will only include the shard IDs without the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- details: true
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
+
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- newName: string
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
Parameters
Optionaldetails: falseIf set to
-true, the response will include the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each +
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- selectors: (string | ObjectWithDocumentKey)[]
- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each shard.
Parameters
- details: true
If set to
-false, the response will only include the shard IDs without the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- details: true
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionDescription>>
Deletes all documents in the collection.
+
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- selector: DocumentSelector
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionDescription>>
Deletes all documents in the collection.
Parameters
Optionaloptions: TruncateCollectionOptions
Returns Promise<ArangoApiResponse<CollectionDescription>>
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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -315,10 +315,10 @@Example
constOptionaloptions: UpdateDocumentOptionsOptions 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
All - 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 +
update
All - 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.Parameters
- newData: (Patch<DocumentData<EntryInputType>> & ({
_key: string;
} | {
_id: string;
}))[]The data for updating the documents.
Optionaloptions: Omit<UpdateDocumentOptions, "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- newData: (Patch<DocumentData<EntryInputType>> & ({
- selector: DocumentSelector
- selectors: (string | ObjectWithDocumentKey)[]
- selector: DocumentSelector
- selector: DocumentSelector
Interface EdgeCollection<EntryResultType, EntryInputType>
Represents an edge collection in a databases.Database.
+Interface EdgeCollection<EntryResultType, EntryInputType>
Represents an edge collection in a databases.Database.
See DocumentCollection for a more generic variant of this interface more suited for regular document collections.
See also graphs.GraphEdgeCollection for the type representing an edge @@ -11,7 +11,7 @@ by the server (including computed properties).
Type to represent edge document contents passed when inserting or replacing edge documents (without computed properties).
-Hierarchy (view full)
- DocumentCollection<EntryResultType, EntryInputType>
- EdgeCollection
Index
Properties
Hierarchy (view full)
- DocumentCollection<EntryResultType, EntryInputType>
- EdgeCollection
Properties
Readonly database
Database this collection belongs to.
-Readonly name
Name of the collection.
-Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionDescription & {
checksum: string;
revision: string;
}>> Retrieves the collection checksum.
+
Readonly name
Name of the collection.
+Methods
checksum
- checksum(options?): Promise<ArangoApiResponse<CollectionDescription & {
checksum: string;
revision: string;
}>> Retrieves the collection checksum.
Parameters
Optionaloptions: CollectionChecksumOptionsOptions for retrieving the checksum.
Returns Promise<ArangoApiResponse<CollectionDescription & {
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<CollectionDescription>>
Triggers compaction for a collection.
+
compact
- compact(): Promise<ArangoApiResponse<CollectionDescription>>
Triggers compaction for a collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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<CollectionDescription & CollectionProperties & {
count: number;
}>> Retrieves information about the number of documents in a collection.
+
count
- count(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
count: number;
}>> Retrieves information about the number of documents in a collection.
Returns Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & CollectionProperties>>
Creates a collection with the given
+optionsand the instance's name.
create
- create(options?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Creates a collection with the given
optionsand the instance's name.See also databases.Database#createCollection and databases.Database#createEdgeCollection.
Note: When called on an EdgeCollection instance in TypeScript, @@ -75,7 +75,7 @@
Example
constExample
-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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -85,7 +85,7 @@Example
interfaceExample
-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.
+- 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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -96,7 +96,7 @@Example
constExample
-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
Exists document
Exists - 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
@@ -104,7 +104,7 @@_idfrom a different collection.Example
constOptionaloptions: 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");
}- selector: DocumentSelector
document
Id document
Id - 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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -113,7 +113,7 @@Example
constExample
-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.
+
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.\ No newline at end of file +Parameters
- selectors: (string | ObjectWithDocumentKey)[]
Array of document
_key,_idor objects with either @@ -121,15 +121,15 @@Example
constOptionaloptions: BulkReadDocumentsOptionsOptions 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<{
id: string;
}>> Deletes the collection from the database.
+
drop
- drop(options?): Promise<ArangoApiResponse<{
id: string;
}>> Deletes the collection from the database.
Parameters
Optionaloptions: DropCollectionOptionsOptions for dropping the collection.
Returns Promise<ArangoApiResponse<{
id: string;
}>>Example
-const db = new Database();
const collection = db.collection("some-collection");
await collection.drop();
// The collection "some-collection" is now an ex-collection
drop
Index - drop
Index(selector): Promise<ArangoApiResponse<{
id: string;
}>> Deletes the index with the given name or
+idfrom the database.
drop
Index - 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<DocumentEdgesResult<EntryResultType>>>
Retrieves a list of all edges in this collection of the document matching +
edges
- edges(selector, options?): Promise<ArangoApiResponse<DocumentEdgesResult<EntryResultType>>>
Retrieves a list of all edges in this collection of the document matching the given
selector.Throws an exception when passed a document or
@@ -138,75 +138,75 @@_idfrom a different collection.Example
constOptionaloptions: DocumentEdgesOptionsOptions for retrieving the edges.
Returns Promise<ArangoApiResponse<DocumentEdgesResult<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
Index - ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
+
ensure
Index - ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a persistent index on the collection if it does not already exist.
Parameters
- options: EnsurePersistentIndexOptions
Options for creating the persistent index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "persistent";
unique: boolean;
} & {
cacheEnabled: boolean;
deduplicate: boolean;
estimates: boolean;
selectivityEstimate: number;
storedValues?: string[];
} & {
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
});- options: EnsurePersistentIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
isNewlyCreated: boolean;
}>> Creates a TTL index on the collection if it does not already exist.
Parameters
- options: EnsureTtlIndexOptions
Options for creating the TTL index.
Returns Promise<ArangoApiResponse<{
fields: [string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "ttl";
unique: boolean;
} & {
estimates: boolean;
expireAfter: number;
selectivityEstimate: number;
} & {
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
});- options: EnsureTtlIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a multi-dimensional index on the collection if it does not already exist.
Parameters
- options: EnsureMdiIndexOptions
Options for creating the multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
selectivityEstimate: number;
storedValues?: string[];
} & {
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"
});
-- options: EnsureMdiIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does +
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
Parameters
- options: EnsureMdiPrefixedIndexOptions
Options for creating the prefixed multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
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-prefixed",
fields: ["x", "y", "z"],
prefixFields: ["x"],
fieldValueTypes: "double"
});
-- options: EnsureMdiPrefixedIndexOptions
- ensure
Index(details): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
+- ensure
Index(details): Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
isNewlyCreated: boolean;
}>> Creates a prefixed multi-dimensional index on the collection if it does not already exist.
Parameters
- details: EnsureMdiPrefixedIndexOptions
Options for creating the prefixed multi-dimensional index.
Returns Promise<ArangoApiResponse<{
fields: string[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "mdi-prefixed";
unique: boolean;
} & {
estimates: boolean;
fieldValueTypes: "double";
prefixFields: string[];
selectivityEstimate: number;
storedValues?: string[];
} & {
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-prefixed",
fields: ["x", "y", "z"],
prefixFields: ["x"],
fieldValueTypes: "double"
});
-- details: EnsureMdiPrefixedIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
worstIndexedLevel: number;
} & {
isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
worstIndexedLevel: number;
} & {
isNewlyCreated: boolean;
}>> Creates a geo index on the collection if it does not already exist.
Parameters
- options: EnsureGeoIndexOptions
Options for creating the geo index.
Returns Promise<ArangoApiResponse<{
fields: [string] | [string, string];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "geo";
unique: boolean;
} & {
bestIndexedLevel: number;
geoJson: boolean;
legacyPolygons: boolean;
maxNumCoverCells: number;
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
});- options: EnsureGeoIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
writeBufferActive: number;
writeBufferIdle: number;
writeBufferSizeMax: number;
} & {
isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
writeBufferActive: number;
writeBufferIdle: number;
writeBufferSizeMax: number;
} & {
isNewlyCreated: boolean;
}>> Creates a inverted index on the collection if it does not already exist.
Parameters
- options: EnsureInvertedIndexOptions
Options for creating the inverted index.
Returns Promise<ArangoApiResponse<{
fields: InvertedIndexField[];
figures?: Record<string, any>;
id: string;
name: string;
sparse: boolean;
type: "inverted";
unique: boolean;
} & {
analyzer: string;
cache?: boolean;
cleanupIntervalStep: number;
commitIntervalMsec: number;
consolidationIntervalMsec: number;
consolidationPolicy: Required<TierConsolidationPolicy>;
features: AnalyzerFeature[];
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;
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" }]
});- options: EnsureInvertedIndexOptions
- ensure
Index(options): Promise<ArangoApiResponse<IndexDescription & {
isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
+- ensure
Index(options): Promise<ArangoApiResponse<IndexDescription & {
isNewlyCreated: boolean;
}>> Creates an index on the collection if it does not already exist.
Parameters
- options: EnsureIndexOptions
Options for creating the index.
Returns Promise<ArangoApiResponse<IndexDescription & {
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
});- options: EnsureIndexOptions
exists
exists
figures
- figures(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
count: number;
figures: Record<string, any>;
}>> Retrieves statistics for a collection.
+
figures
- figures(details?): Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & 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<CollectionDescription>>
Retrieves general information about the collection.
+
get
- get(): Promise<ArangoApiResponse<CollectionDescription>>
Retrieves general information about the collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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 - 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<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.
import
- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
datainto the collection.Parameters
- data: EdgeData<EntryInputType>[]
The data to import, as an array of edge data.
Optionaloptions: ImportDocumentsOptionsOptions for importing the data.
Returns Promise<ImportDocumentsResult>
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<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.- import(data, options?): Promise<ImportDocumentsResult>
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: ImportDocumentsOptionsOptions for importing the data.
Returns Promise<ImportDocumentsResult>
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 ]
]
);- data: any[][]
- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
+datainto the collection.- import(data, options?): Promise<ImportDocumentsResult>
Bulk imports the given
datainto the collection.If
@@ -225,7 +225,7 @@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.Example
constExample
-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
Edges - in
Edges(selector, options?): Promise<ArangoApiResponse<DocumentEdgesResult<EntryResultType>>> Retrieves a list of all incoming edges of the document matching the given +
in
Edges - in
Edges(selector, options?): Promise<ArangoApiResponse<DocumentEdgesResult<EntryResultType>>> Retrieves a list of all incoming edges of the document matching the given
selector.Throws an exception when passed a document or
@@ -234,21 +234,21 @@_idfrom a different collection.Example
constOptionaloptions: DocumentEdgesOptionsOptions for retrieving the edges.
Returns Promise<ArangoApiResponse<DocumentEdgesResult<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<IndexDescription>
Returns an index description by name or
+idif it exists.
index
- index(selector): Promise<IndexDescription>
Returns an index description by name or
idif it exists.Parameters
- selector: IndexSelector
Index name, id or object with either property.
Returns Promise<IndexDescription>
Example
-const db = new Database();
const collection = db.collection("some-collection");
const index = await collection.index("some-index");- selector: IndexSelector
indexes
indexes
- indexes<IndexType>(options?): Promise<IndexType[]>
Returns a list of all index descriptions for the collection.
Type Parameters
- IndexType extends IndexDescription | HiddenIndexDescription = IndexDescription
Parameters
Optionaloptions: ListIndexesOptionsOptions 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<HiddenIndexDescription>({
withHidden: true
});
load
Indexes load
Indexes - 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
Edges - out
Edges(selector, options?): Promise<ArangoApiResponse<DocumentEdgesResult<EntryResultType>>> Retrieves a list of all outgoing edges of the document matching the given +
out
Edges - out
Edges(selector, options?): Promise<ArangoApiResponse<DocumentEdgesResult<EntryResultType>>> Retrieves a list of all outgoing edges of the document matching the given
selector.Throws an exception when passed a document or
@@ -257,17 +257,17 @@_idfrom a different collection.Example
constOptionaloptions: DocumentEdgesOptionsOptions for retrieving the edges.
Returns Promise<ArangoApiResponse<DocumentEdgesResult<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<CollectionDescription & CollectionProperties>>
Retrieves the collection's properties.
+
properties
- properties(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Retrieves the collection's properties.
Returns Promise<ArangoApiResponse<CollectionDescription & 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<CollectionDescription & CollectionProperties>>
Replaces the properties of the collection.
+- properties(properties): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties>>
Replaces the properties of the collection.
Parameters
- properties: CollectionPropertiesOptions
Returns Promise<ArangoApiResponse<CollectionDescription & 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
Count recalculate
Count - 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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -275,7 +275,7 @@Example
constOptionaloptions: RemoveDocumentOptionsOptions 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
All - remove
All(selectors, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
old?: Edge<EntryResultType>;
})[]> Removes existing documents from the collection.
+
remove
All - 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.Parameters
- selectors: DocumentSelector[]
Documents
_key,_idor objects with either of those @@ -283,7 +283,7 @@Example
constOptionaloptions: RemoveDocumentOptionsOptions 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<CollectionDescription>>
Renames the collection and updates the instance's
+nametonewName.
rename
- rename(newName): Promise<ArangoApiResponse<CollectionDescription>>
Renames the collection and updates the instance's
nametonewName.Additionally removes the instance from the databases.Database's internal cache.
Note: Renaming collections may not be supported when ArangoDB is @@ -291,7 +291,7 @@
Example
constParameters
- newName: string
The new name of the collection.
Returns Promise<ArangoApiResponse<CollectionDescription>>
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!replace
- replace(selector, newData, options?): Promise<DocumentMetadata & {
_oldRev?: string;
} & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
}> Replaces an existing document in the collection.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -300,43 +300,43 @@Example
constOptionaloptions: ReplaceDocumentOptionsOptions 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
All - 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 +
replace
All - 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.Parameters
- newData: (EntryInputType & Partial<DocumentMetadata> & (Partial<EdgeMetadata> & ({ _key: string; } | { _id: string; })))[]
The documents to replace.
Optionaloptions: ReplaceDocumentOptionsOptions 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<CollectionDescription & CollectionProperties & {
revision: string;
}>> Retrieves the collection revision ID.
+
revision
- revision(): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
revision: string;
}>> Retrieves the collection revision ID.
Returns Promise<ArangoApiResponse<CollectionDescription & 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.
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: InsertDocumentOptionsOptions 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
All - save
All(data, options?): Promise<(DocumentOperationFailure | DocumentMetadata & {
_oldRev?: string;
} & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
})[]> Inserts new documents with the given
+datainto the collection.
save
All - 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: InsertDocumentOptionsOptions 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>[]
shards
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
+
shards
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
Parameters
Optionaldetails: falseIf set to
-true, the response will include the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each +
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- selector: DocumentSelector
- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each shard.
Parameters
- details: true
If set to
-false, the response will only include the shard IDs without the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- details: true
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
+
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- newName: string
- shards(details?): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>> Retrieves the collection's shard IDs.
Parameters
Optionaldetails: falseIf set to
-true, the response will include the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each +
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: string[];
}>>- selectors: DocumentSelector[]
- shards(details): Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>> Retrieves the collection's shard IDs and the responsible servers for each shard.
Parameters
- details: true
If set to
-false, the response will only include the shard IDs without the responsible servers for each shard.
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- details: true
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionDescription>>
Deletes all documents in the collection.
+
Returns Promise<ArangoApiResponse<CollectionDescription & CollectionProperties & {
shards: Record<string, string[]>;
}>>- selector: DocumentSelector
truncate
- truncate(options?): Promise<ArangoApiResponse<CollectionDescription>>
Deletes all documents in the collection.
Parameters
Optionaloptions: TruncateCollectionOptions
Returns Promise<ArangoApiResponse<CollectionDescription>>
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.
+
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.Parameters
- selector: DocumentSelector
Document
_key,_idor object with either of those @@ -345,10 +345,10 @@Example
constOptionaloptions: UpdateDocumentOptionsOptions 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
All - 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 +
update
All - 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: (Patch<DocumentData<EntryInputType>> & ({
_key: string;
} | {
_id: string;
}))[]The data for updating the documents.
Optionaloptions: UpdateDocumentOptionsOptions 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>;
})[]>- newData: (Patch<DocumentData<EntryInputType>> & ({
- selector: DocumentSelector
- selectors: (string | ObjectWithDocumentKey)[]
- selector: DocumentSelector
Returns Promise<(DocumentOperationFailure | DocumentMetadata & {
_oldRev?: string;
} & {
new?: Edge<EntryResultType>;
old?: Edge<EntryResultType>;
})[]>- selector: DocumentSelector
Interface ProcessedResponse<T>
Processed response object.
-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
Interface ProcessedResponse<T>
Processed response object.
+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
Properties
Readonly array
Type declaration
- (): Promise<ArrayBuffer>
Returns Promise<ArrayBuffer>
Readonly blob
Type declaration
- (): Promise<Blob>
Returns Promise<Blob>
Readonly body
Readonly body
Readonly clone
Type declaration
- (): Response
Returns Response
Readonly form
Type declaration
- (): Promise<FormData>
Returns Promise<FormData>
Deprecated
This method is not recommended for parsing multipart/form-data bodies in server environments. +
Properties
Readonly array
Type declaration
- (): Promise<ArrayBuffer>
Returns Promise<ArrayBuffer>
Readonly blob
Type declaration
- (): Promise<Blob>
Returns Promise<Blob>
Readonly body
Readonly body
Readonly clone
Type declaration
- (): Response
Returns Response
Readonly 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
Readonly json
Type declaration
- (): Promise<unknown>
Returns Promise<unknown>
Readonly ok
Optional parsed
Parsed response body.
-Readonly redirected
request
Fetch request object.
-Readonly status
Readonly status
Readonly text
Type declaration
- (): Promise<string>
Returns Promise<string>
Readonly type
Readonly url
Readonly headers
Readonly json
Type declaration
- (): Promise<unknown>
Returns Promise<unknown>
Readonly ok
Optional parsed
Parsed response body.
+Readonly redirected
request
Fetch request object.
+Readonly status
Readonly status
Readonly text
Type declaration
- (): Promise<string>
Returns Promise<string>
Readonly type
Readonly url
Interface BatchCursorItemsView<ItemType>
A low-level interface for consuming the items of a BatchCursor.
-isEmpty: boolean;
more(): Promise<void>;
shift(): undefined | ItemType;
}
Type Parameters
Index
Properties
Properties
Readonly is
Methods
more
shift
Interface CreateArangoSearchViewStoredValueOptions
Options for creating a stored value in an ArangoSearch View.
-cache?: boolean;
compression?: Compression;
fields: string[];
}
Index
Properties
Interface CreateArangoSearchViewStoredValueOptions
Options for creating a stored value in an ArangoSearch View.
+cache?: boolean;
compression?: Compression;
fields: string[];
}
Index
Properties
Properties
Optional cache
(Enterprise Edition only.) If set to true, then stored values will
always be cached in memory.
Default: false
Optional compression
How the attribute values should be compressed.
+Optional compression
How the attribute values should be compressed.
Default: "lz4"
fields
Attribute paths for which values should be stored in the view index +
fields
Attribute paths for which values should be stored in the view index
in addition to those used for sorting via primarySort.
Module administration
import type { VersionInfo } from "arangojs/administration";
+administration | arangojs Module administration
import type { VersionInfo } from "arangojs/administration";
The "administration" module provides types for database administration.
-Index
Interfaces
Index
Interfaces
Type Aliases
Clusteranalyzers | arangojs Module analyzers
import type { Analyzer } from "arangojs/analyzers";
+analyzers | arangojs Module analyzers
import type { Analyzer } from "arangojs/analyzers";
The "analyzers" module provides Analyzer related types and interfaces
for TypeScript.
-Index
Classes
Analyzer
+Index
Classes
Type Aliases
Analyzeraql | arangojs Module aql
import { aql } from "arangojs/aql";
+aql | arangojs Module aql
import { aql } from "arangojs/aql";
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
Index
Interfaces
Type Aliases
Aqlcluster | arangojs Module cluster
import type { ClusterImbalanceInfo } from "arangojs/cluster";
+cluster | arangojs Module cluster
import type { ClusterImbalanceInfo } from "arangojs/cluster";
The "cluster" module provides types for cluster management.
-Index
Type Aliases
Index
Type Aliases
Clustercollections | arangojs Module collections
import type {
DocumentCollection,
EdgeCollection,
} from "arangojs/collections";
+collections | arangojs Module collections
import type {
DocumentCollection,
EdgeCollection,
} from "arangojs/collections";
The "collections" module provides collection related types and interfaces
for TypeScript.
-Index
Enumerations
Index
Enumerations
Interfaces
Arangoconfiguration | arangojs Module configuration
import type { ConfigOptions } from "arangojs/configuration";
+configuration | arangojs Module configuration
import type { ConfigOptions } from "arangojs/configuration";
The "configuration" module provides configuration related types for
TypeScript.
-Index
Type Aliases
Index
Type Aliases
Basicconnection | arangojs Module connection
import type { ArangoApiResponse } from "arangojs/connection";
+connection | arangojs Module connection
import type { ArangoApiResponse } from "arangojs/connection";
The "connection" module provides connection related types for TypeScript.
-Index
Interfaces
Index
Interfaces
Type Aliases
Arangocursors | arangojs Module cursors
import type { Cursor, BatchCursor } from "arangojs/cursors";
+cursors | arangojs Module cursors
import type { Cursor, BatchCursor } from "arangojs/cursors";
The "cursors" module provides cursor-related types and interfaces for
TypeScript.
-Index
Classes
Index
Classes
Interfaces
Type Aliases
Cursordatabases | arangojs Module databases
import { Database } from "arangojs/databases";
+databases | arangojs Module databases
import { Database } from "arangojs/databases";
The "databases" module provides the Database class and associated
types and interfaces for TypeScript.
The Database class is also re-exported by the "index" module.
-Index
Classes
Database
+Index
Classes
Type Aliases
Functions
isdocuments | arangojs Module documents
import type { Document, Edge } from "arangojs/documents";
+documents | arangojs Module documents
import type { Document, Edge } from "arangojs/documents";
The "documents" module provides document/edge related types for TypeScript.
-Index
Type Aliases
Index
Type Aliases
Bulkerrors | arangojs Module errors
import type { ArangoError, HttpError } from "arangojs/errors";
+errors | arangojs Module errors
import type { ArangoError, HttpError } from "arangojs/errors";
The "errors" module provides types and interfaces for TypeScript related
to arangojs error handling.
-Index
Classes
Index
Classes
Arangofoxx-manifest | arangojs Module foxx-manifest
import type { FoxxManifest } from "arangojs/foxx-manifest";
+foxx-manifest | arangojs Module foxx-manifest
import type { FoxxManifest } from "arangojs/foxx-manifest";
The "foxx-manifest" module provides the Foxx manifest type for TypeScript.
Generated from JSON Schema
using json-schema-to-typescript.
-Index
Type Aliases
Index
Type Aliases
Configuration
Dependency
File
Foxxgraphs | arangojs Module graphs
import type {
Graph,
GraphVertexCollection,
GraphEdgeCollection,
} from "arangojs/graphs";
+graphs | arangojs Module graphs
import type {
Graph,
GraphVertexCollection,
GraphEdgeCollection,
} from "arangojs/graphs";
The "graphs" module provides graph related types and interfaces
for TypeScript.
-Index
Classes
Graph
+Index
Classes
Type Aliases
Addhot-backups | arangojs Module hot-backups
import type { HotBackupOptions } from "arangojs/hot-backups";
+hot-backups | arangojs Module hot-backups
import type { HotBackupOptions } from "arangojs/hot-backups";
The "hot-backups" module provides types for managing hot backups.
-Index
Type Aliases
Index
Type Aliases
index | arangojs Module index
import arangojs, { aql, Database } from "arangojs";
+index | 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 databases.Database class for which it is a wrapper.
- Index
References
Database
+ Index
References
Functions
arangojs
diff --git a/devel/modules/indexes.html b/devel/modules/indexes.html
index a657294e3..b4b67ccce 100644
--- a/devel/modules/indexes.html
+++ b/devel/modules/indexes.html
@@ -1,7 +1,7 @@
-indexes | arangojs Module indexes
import type {
FulltextIndex,
GeoIndex,
MdiIndex,
PersistentIndex,
PrimaryIndex,
TtlIndex,
} from "arangojs/indexes";
+indexes | arangojs Module indexes
import type {
FulltextIndex,
GeoIndex,
MdiIndex,
PersistentIndex,
PrimaryIndex,
TtlIndex,
} from "arangojs/indexes";
The "indexes" module provides index-related types for TypeScript.
-Index
Type Aliases
Index
Type Aliases
Arangosearchjobs | arangojs
Represents an Analyzer in a databases.Database.
-