arangojs

When upgrading to version 9, note the following breaking changes:

Default URL Change

• The default URL changed from http://localhost:8529 to http://127.0.0.1:8529. If you require localhost resolution (e.g., for IPv6 support), specify the URL explicitly in the Database constructor.

Database Instance Management

• The db.useDatabase method is deprecated. To interact with a different database, use db.database(name) to create a new Database instance.

Queries and Users

• aql.literal and aql.join must be imported separately from arangojs/aql rather than accessed via the aql template handler.
• db.getUserDatabases and db.getUserAccessLevel return values have changed; they no longer wrap results in a .result object.

 import { Database } from "arangojs";

 const db = new Database({
+  url: "http://localhost:8529"
 });

 // Instead of db.useDatabase("database2")
+const db2 = db.database("database2");

When upgrading to version 10, note the following breaking changes:

Module name changes

• The Dict<T> type from arangojs/connection is removed. Use the built-in TypeScript Record<string, T> instead.
• The GraphCreateOptions type has been renamed to CreateGraphOptions in arangojs/graph.
• Enums CollectionStatus and CollectionType must now be imported from arangojs/collection instead of the main arangojs module.
• The ViewType enum has been removed; use the string literal "arangosearch" for ArangoSearch views.

AQL and Queries

• aql.join is no longer a method on the aql template handler. Import join separately from arangojs/aql.

User Management

• db.getUserDatabases and db.getUserAccessLevel no longer return a .result property. They now return the result directly.

 import { Database } from "arangojs";
-import type { Dict } from "arangojs/connection";

 const db = new Database();
-let deps: Dict<string | string[] | undefined>;
+let deps: Record<string, string | string[] | undefined>;
 deps = await db.getServiceDependencies("/my-foxx-service", true);

When upgrading to version 7, note the following breaking changes:

Configuration and Connections

• db.useDatabase is deprecated. Specify the database name using the databaseName option in the Database configuration.
• You can now share a connection pool by creating multiple Database objects from the same instance using db.database(name).

Collections and Indexes

• Specific index helper methods (e.g., createHashIndex) are removed. Use the generic ensureIndex method with a type option.
• db.edgeCollection is removed. Use db.collection for all collection types. In TypeScript, you can cast to EdgeCollection<T> or DocumentCollection<T> if needed.
• db.edge(id) is removed; use db.collection(name).document(id) instead.
• For Graph collections, use the .vertex() or .edge() methods for high-level access, or access the low-level API via the .collection property.

Data Operations

• save for edges no longer accepts positional _from and _to arguments. These must be included in the document object.
• bulkUpdate is removed. Use saveAll, updateAll, replaceAll, or removeAll for bulk operations.
• db.truncate() is removed. To truncate all collections, iterate through db.collections() and call .truncate() on each.

Cursors and Queries

• cursor.each is renamed to cursor.forEach.
• cursor.hasNext() is replaced by the hasNext getter.
• cursor.some() and cursor.every() are removed. Emulate them using forEach or, preferably, more efficient AQL queries.
• Batch API: cursor.hasMore() and cursor.nextBatch() are replaced by cursor.batches.hasMore (getter) and cursor.batches.next().
• db.query options are now flattened. Nested options properties are no longer used.

Other Changes

• ArangoSearch: db.arangoSearchView and db.createArangoSearchView are renamed to db.view and db.createView.
• Transactions: db.transaction is no longer an alias for db.executeTransaction. Use db.executeTransaction explicitly.
• Graph Creation: db.createGraph and graph.create now take an array of edge definitions as the first argument.

 // Instead of db.useDatabase("database1")
+const db1 = new Database({ databaseName: "database1" });
+const db2 = db1.database("database2");

 // Instead of collection.createGeoIndex(["lat", "lng"])
+await collection.ensureIndex({ type: "geo", fields: ["lat", "lng"] });

 // Instead of edges.save("v1", "v2", { color: "red" })
+await edges.save({ _from: "v1", _to: "v2", color: "red" });

Version 9 transitioned to using the native fetch API in all environments. Consequently, agentOptions and agent configuration options have been removed. These have been replaced by properties within the main configuration object:

• maxSockets is now poolSize
• keepAlive is now keepalive
• before is now beforeRequest
• after is now afterResponse

If you need to customize the underlying Node.js agent beyond these options, you must use the undici module to set a global dispatcher.

  const db = new Database({
    url: "http://localhost:8529",
-   agentOptions: {
-     maxSockets: 10,
-     keepAlive: true,
-     before: (req) => console.log(String(new Date()), 'requesting', req.url),
-     after: (res) => console.log(String(new Date()), 'received', res.request.url)
-   }
+   poolSize: 10,
+   keepalive: true,
+   beforeRequest: (req) => console.log(String(new Date()), 'requesting', req.url),
+   afterResponse: (res) => console.log(String(new Date()), 'received', res.request.url)
  });

To use a custom agent in Node.js:

const { Agent, setGlobalDispatcher } = require("undici");

setGlobalDispatcher(
  new Agent({
    // your agent options here
  })
);