arangojs
Version:
The official ArangoDB JavaScript driver.
1,458 lines (906 loc) • 67.7 kB
Markdown
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
This driver uses semantic versioning:
- A change in the bugfix version (e.g. X.Y.0 -> X.Y.1) indicates internal
changes and should always be safe to upgrade.
- A change in the minor version (e.g. X.1.Z -> X.2.0) indicates additions and
backwards-compatible changes that should not affect your code.
- A change in the major version (e.g. 1.Y.Z -> 2.0.0) indicates _breaking_
changes that require changes in your code to upgrade.
## [9.0.0] - 2024-07-31
This is a major release and breaks backwards compatibility.
See [the migration guide](./MIGRATING.md#v8-to-v9) for detailed instructions
for upgrading your code to arangojs v9.
### Removed
- Removed Node.js 14 and Node.js 16 support
With Node.js 14 and 16 having reached their end of life, arangojs will no
longer support these versions of Node.js going forward.
For more information, see [the Node.js release schedule](https://nodejs.dev/en/about/releases/).
- Removed `Params` and `Headers` types
These can mostly be replaced with the native `URLSearchParams` and `Headers`
types but most public methods still accept the equivalent `Record` types for
convenience.
- Removed deprecated `FulltextIndex` and related types
Fulltext indexes have been deprecated in ArangoDB 3.10 and should be replaced
with ArangoSearch.
- Removed browser build
The browser build has been removed from the repository and will no longer be
published to npm. The npm package can still be used in the browser by using
common frontend tooling like webpack or rollup.
- Removed `Collection` methods for simple queries: `list`, `all`, `any`,
`byExample`, `firstExample`, `removeByExample`, `replaceByExample`,
`updateByExample`, `lookupByKeys`, `removeByKeys`, `fulltext`
Simple queries were deprecated in ArangoDB 3.4 and can be replicated with AQL.
### Changed
- Replaced request logic with native `fetch` API ([#788](https://github.com/arangodb/arangojs/issues/788), DE-578, DE-758)
The node-specific request logic using the `http` and `https` modules has been
replaced with all-new logic using the web standard `fetch` API, which should
work in Node.js, browsers and other conformant environments.
- Unicode names are now **no longer** automatically NFC normalized (DE-65)
This change affects all database, collection, graph, view and analyzer names
using unicode characters. Starting with arangojs v7.7.0 these names were
automatically NFC normalized. This behavior has now been reverted to match
the behavior of other ArangoDB drivers and help detect normalization issues
in user code.
- Changed return type of `aql` and the AQL `join` helper function to `AqlQuery`
Previously the internal `GeneratedAqlQuery` type was exposed as the return
type of these functions, leading to complexity when handling generic type
arguments.
- Removed dependency on Node `path` module or its browserify equivalent
This change should be backwards-compatible but may produce different results
when using non-normalized paths and base-paths in custom `routes`. This
should help support more environments and reduce the size of the browser
bundle.
- Inlined `x3-linkedlist` dependency
Inlining this dependency should help make arangojs more portable.
- Split the Collection type parameter into result and input types ([#807](https://github.com/arangodb/arangojs/issues/807))
It is now possible to specify a separate type for the data passed when
creating or modifying documents in addition to the type of the data returned
when fetching documents. This allows excluding computed properties from
the input type while still including them in the result type.
### Added
- Added ESM support (DE-236)
The driver now supports being imported as an ES module or CommonJS module
and provides exports for both types of environments. This change should be
backwards-compatible.
- Added support for `withHidden` option in `collection.indexes`
This option was introduced in ArangoDB 3.10.13 and 3.11.7 and allows
fetching the progress information of indexes that are in the building phase.
- Added support for `withStats` option in `collection.indexes`
This method now takes an object with `withStats` and `withHidden` options
instead of a boolean flag.
- Added readonly `Job#id` property
This property was not previously exposed.
- Added `skipFastLockRound` option for streaming transactions
This option was introduced in 3.12.1 and allows skipping the fast lock round.
- Added non-specific `EnsureIndexOptions` type and `ensureIndex` method
signature ([#778](https://github.com/arangodb/arangojs/issues/778))
This allows creating indexes without narrowing the index type.
## [8.8.1] - 2024-03-20
### Added
- Added the `versionAttribute` option to the document operation options types (DE-783)
## [8.8.0] - 2024-03-12
### Changed
- Renamed ZKD index type to MDI (DE-744)
The ZKD index type was previously marked as experimental and has now been
finalized and renamed to MDI in ArangoDB 3.12.
- Added `DocumentOperationMetadata` and `DocumentOperationFailure` types (DE-693)
The return types of document and edge operations on collections have been
modified to correctly represent the return values of bulk operations and
single document/edge operations using the `overwriteMode` option.
### Deprecated
- Deprecated active failover support (DE-746)
Active failover is no longer be supported in ArangoDB 3.12 and later. This
functionality will be removed from the driver in a future release.
### Added
- Added support for `multi_delimiter` analyzer type (DE-753)
- Added support for `wildcard` analyzer type (DE-750)
## [8.7.0] - 2024-02-14
### Changed
- Made `options` argument in `collection.edges`, `inEdges` and `outEdges` optional ([#802](https://github.com/arangodb/arangojs/issues/802))
### Deprecated
- Deprecated `db.getLogMessages`
This API was deprecated in ArangoDB 3.8 and should no longer be used.
Use `db.getLogEntries` instead.
### Fixed
- Fixed `db.getLogEntries` using the wrong API endpoint
## [8.6.0] - 2023-10-24
### Added
- Added `db.createJob` method to convert arbitrary requests into async jobs (DE-610)
This method can be used to set the `x-arango-async: store` header on any
request, which will cause the server to store the request in an async job:
```js
const collectionsJob = await db.createJob(() => db.collections());
// once loaded, collectionsJob.result will be an array of Collection instances
const numbersJob = await db.createJob(() =>
db.query(aql`FOR i IN 1..1000 RETURN i`)
);
// once loaded, numbersJob.result will be an ArrayCursor of numbers
```
## [8.5.0] - 2023-10-09
### Added
- Implemented hot backup API (DE-576)
- Implemented logging API (DE-144, DE-145, DE-146, DE-147)
- Implemented async jobs management (DE-339)
- Added `db.shutdown` to initiate a clean shutdown of the server
- Added `db.time` method to retrieve the server's system time
## [8.4.1] - 2023-09-15
### Fixed
- Fixed default return type of AQL queries being `undefined` instead of `any` ([#797](https://github.com/arangodb/arangojs/issues/797))
## [8.4.0] - 2023-07-10
### Changed
- Fetching additional cursor results now uses `POST` instead of `PUT` (DE-605)
The `PUT` route was deprecated and the `POST` route is supported in all
actively maintained versions of ArangoDB.
- User management methods now use database-relative URLs (DE-606)
Previously these methods would make requests without a database prefix,
implicitly using the `_system` database.
- `aql` template strings now take a generic type argument
This allows explictly setting the item type of the `ArrayCursor` returned by
`db.query` when using `aql` template strings. Note that like when setting
the type on `db.query` directly, arangojs can make no guarantees that the
type matches the actual data returned by the query.
```ts
const numbers = await db.query(aql<{ index: number; squared: number }>`
FOR i IN 1..1000
RETURN {
index: i,
squared: i * i
}
`);
const first = await numbers.next(); // { index: number; squared: number; }
console.log(first.index, first.squared); // 1 1
```
### Fixed
- Fixed `listUsers` behavior ([#782](https://github.com/arangodb/arangojs/issues/782))
- Fixed `graph.create` not correctly handling `isDisjoint` option
### Added
- Added missing attributes to `QueryInfo` and `MultiExplainResult.stats` types (DE-607)
- Added cluster rebalancing methods to `Database` (DE-583)
- Added `db.withTransaction` helper method for streaming transactions ([#786](https://github.com/arangodb/arangojs/discussions/786))
This method allows using streaming transactions without having to manually
begin and commit or abort the transaction.
```ts
const vertices = db.collection("vertices");
const edges = db.collection("edges");
const info = await db.withTransaction([vertices, edges], async (step) => {
const start = await step(() => vertices.document("a"));
const end = await step(() => vertices.document("b"));
return await step(() => edges.save({ _from: start._id, _to: end._id }));
});
```
## [8.3.1] - 2023-06-05
### Changed
- Added note that Simple Queries traversals are removed in ArangoDB 3.12.
## [8.3.0] - 2023-05-11
### Fixed
- Fixed `updateUser` and `replaceUser` behavior ([#783](https://github.com/arangodb/arangojs/issues/783))
### Added
- Added `renewAuthToken` method to `Database` ([#784](https://github.com/arangodb/arangojs/issues/784))
This method allows refreshing the authentication token passed to the
`useBearerAuth` method or used by the `login` method. Note that ArangoDB
will currently only return a new token if the token is going to expire
in the next 150 seconds.
- Added `returnOld` and `mergeObjects` to `CollectionInsertOptions` type
These options are only available when using `overwriteMode`.
- Added caching options to `InvertedIndex` and `ArangoSearchView` types
These options were added in ArangoDB 3.10.2.
- Added support for `ArangoSearchView` type `storedValues` shorthand notation
Instead of using an object, attributes can also be defined as arrays of
strings and arrays of arrays of strings. This was added in ArangoDB 3.10.3.
- Added `peakMemoryUsage` and `executionTime` to `SingleExplainResult.stats` type
These attributes were added in ArangoDB 3.10.4.
- Added `geo_s2` Analyzer types
This Analyzer was added in ArangoDB 3.10.5.
- Added `refillIndexCaches` option to document operation options types
This option was added in ArangoDB 3.11.
- Added `optimizeTopK` to `ArangoSearchView` and `InvertedIndex` types
This option was added in ArangoDB 3.11.
- Added support for `allowRetry` option in `db.query`
This feature was added in ArangoDB 3.11.
- Added `x-arango-driver` header
The arangojs driver now correctly identifies itself to ArangoDB, allowing the
ArangoGraph Insights Platform to take advantage of the driver's support for
cloud-optimized behaviors.
## [8.2.1] - 2023-04-05
### Fixed
- Fixed a bug in search parameter handling in the browser version
Previously the browser version would incorrectly handle search parameters,
which could result in invalid request URLs in many cases.
## [8.2.0] - 2023-03-29
### Changed
- Index names are now automatically NFC-normalized (DE-506)
This change affects all index names using unicode characters. **The change
has no effect when using non-unicode (ASCII) names.**
Any names used when creating/ensuring indexes or passed to any methods that
expect an `IndexSelector` will automatically be NFC normalized.
- Internal querystring handling logic now uses `URLSearchParams` instead of
node `querystring` module
This change should be backwards compatible but may produce different results
when relying on undefined behavior in custom (e.g. Foxx) routes.
## [8.1.0] - 2022-12-19
### Added
- Added support for new ArangoDB 3.9.5 `cache` field in ArangoSearch types
## [8.0.0] - 2022-10-25
This is a major release and breaks backwards compatibility.
See [the migration guide](./MIGRATING.md#v7-to-v8) for detailed instructions
for upgrading your code to arangojs v8.
### Removed
- Removed Node.js 10 and Node.js 12 support
With Node.js 10 and 12 having reached their end of life, arangojs will no
longer support these versions of Node.js going forward.
- Removed Internet Explorer and older browser support
As of version 8 arangojs uses the [Browserlist `defaults`](https://browsersl.ist/#q=defaults)
list to generate the pre-built browser bundle, which excludes older browsers
and specifically all versions of Internet Explorer.
You may still be able to use arangojs in some of the excluded browsers when
bundling arangojs yourself but this may require polyfills and additional
transformations.
- Removed `Dict` type from `connection` module
The `Dict<T>` type was identical to `Record<string, T>` and has been replaced
with this built-in type across arangojs.
- Removed workaround for ArangoDB pre-3.2.8 Foxx HTTP API responses
When fetching or modifying the configuration or dependencies of a Foxx
service using ArangoDB 3.2.7 and earlier, arangojs would perform additional
operations to convert the server response to a compatible format. All
affected versions of ArangoDB have reached End of Life since December 2018.
- Removed deprecated `db.useDatabase` method
The method was previously deprecated and can be replaced with `db.database`,
which returns a new `Database` object instead of modifying the existing one.
- Removed deprecated MMFiles methods and types
The MMFiles storage engine was removed in ArangoDB 3.7.
- Removed deprecated `minReplicationFactor` option from collection and
database related types
This option was renamed to `writeConcern` in ArangoDB 3.6.
- Removed deprecated `overwrite` option from `CollectionInsertOptions` type
This option was deprecated in ArangoDB 3.7 and should be replaced with the
`overwriteMode` option.
- Removed internal `request.host` attribute
This attribute has been replaced with `request.hostUrl`.
- Removed internal `response.arangojsHostId` attribute
This attribute has been replaced with `response.arangojsHostUrl`.
- Removed `CollectionStatus` and `CollectionType` enum re-exports
Previously these would be re-exported by the arangojs module for backwards
compatibility. If you still need to access these enums, you can import them
from the `collection` sub-module instead. Note that the `ViewType` enum
has been removed completely.
### Changed
- Changed default URL to `http://127.0.0.1:8529` to match ArangoDB default
Previously arangojs would use `localhost` which on some systems resolves to
the IPv6 address `::1` instead, resulting in confusing connection errors.
- Changed TypeScript compilation target to ES2020
Since all evergreen browsers including Firefox ESR and all active Node.js LTS
releases fully support ES2020, the compilation target for the browser bundle
and Node.js has been moved from ES2016 and ES2018 respectively to ES2020.
- Updated TypeScript to version 4.8
This may result in type signatures that are incompatible with TypeScript 3
being added in future releases (including patch releases).
- Changed default behavior of _internal_ `db.request` method
Previously this method would always return the full response object if no
`transform` callback was provided. The method now defaults to a `transform`
callback that extracts the response body instead. The previous behavior can
still be forced by passing `false` instead of a callback function.
This change has no effect on other methods like `route.request`.
- Replaced node core module polyfills with native APIs in browser build
As part of upgrading to webpack 5, arangojs now no longer requires node core
modules to be polyfilled to work in the browser. This also drastically
reduces the file size of the pre-built browser bundle `arangojs/web`.
- `db.query` now supports a generic return type ([#764](https://github.com/arangodb/arangojs/issues/764))
This allows explictly setting the item type of the `ArrayCursor` returned by
the query without using a type assertion on the promise result. Note that
arangojs can make no guarantees that the type matches the actual data
returned by the query.
```ts
const numbers = await db.query<{ index: number; squared: number }>(aql`
FOR i IN 1..1000
RETURN {
index: i,
squared: i * i
}
`);
const first = await numbers.next(); // { index: number; squared: number; }
console.log(first.index, first.squared); // 1 1
```
- Moved `aql.literal` and `aql.join` into `aql` module
Previously these were available as methods on the `aql` function. Now they
need to be imported from the `aql` module.
- Changed return values of `db.getUserAccessLevel` and `db.getUserDatabases`
to match documented return types
- Retry requests resulting in status 503 `ArangoError` ([#710](https://github.com/arangodb/arangojs/issues/710))
Unless retries are explicitly disabled by setting `config.maxRetries` to
`false`, requests will now also be retried if the server responded with a
503 `ArangoError`, which ArangoDB uses to indicate the server is running in
maintenance mode. Previously this would always result in an error.
- Extended `CursorExtras` type in TypeScript
The types of the attributes `plan`, `profile`, and `stats` are now defined
more explicitly.
- Changed behavior of `collection.removeAll` for non-string arrays
Previously `collection.removeAll` would always convert its argument into an
array of document IDs and fail with an error if passed any documents had an
ID not matching the collection name. Now the selector argument is passed
as-is, bypassing this validation but allowing `ignoreRevs` to be respected
by the server.
- Extracted type `ArangoSearchViewLinkOptions` from `ArangoSearchViewLink`
Note that `ArangoSearchViewLink` now represents the type of the value
returned by the server, marking several properties as required.
- Extracted type `CreateArangoSearchView` from
`ArangoSearchViewPropertiesOptions`
Note that `ArangoSearchViewPropertiesOptions` now includes only those options
that can be updated/replaced whereas `CreateArangoSearchView` also includes
options that can only be set during creation of a view.
- Renamed type `GraphCreateOptions` to `CreateGraphOptions`
- Renamed type `PrimarySortCompression` to `Compression`
- Replaced type `AnalyzerInfo` and all its constituent types
Previously each type of Analyzer was represented by an `AnalyzerInfo` type
and (where relevant) an `AnalyzerProperties` type, which were used for both
creating and fetching Analyzers. The new types more closely follow the
pattern already used for index types, providing pairs of
`CreateAnalyzerOptions` and `AnalyzerDescription` types.
- Removed enum `ViewType`, type `ArangoSearchView` and changed `View` class to
be non-generic
The `View` class now behaves analogous to the `Analyzer` class. The various
types related to different view types have been restructured to more closely
follow the pattern used for indexes and analyzers.
### Deprecated
- Deprecated `EnsureFulltextIndexOptions` and `FulltextIndex` types
Fulltext indexes have been deprecated in ArangoDB 3.10 and should be replaced
with ArangoSearch.
- Deprecated `BytesAccumConsolidationPolicy` type
The `bytes_accum` consolidation policy for views was deprecated in
ArangoDB 3.7 and should be replaced with the `tier` consolidation policy.
The type is also no longer supported in `ArangoSearchViewPropertiesOptions`.
### Added
- Added `toJSON` method to system errors
ArangoJS already adds the `request` object to system errors encountered
while attempting to make network requests. This change makes it easier
to serialize these error objects to JSON the same way `ArangoError` and
`HttpError` objects can already be serialized.
- Added `allowDirtyRead` option to `db.beginTransaction`, `trx.commit`,
`trx.abort`, `collection.edges`, `collection.inEdges`, `collection.outEdges`
The option is only respected by read-only requests.
- Added support for `ifMatch` and `ifNoneMatch` options ([#707](https://github.com/arangodb/arangojs/issues/707))
- Added `overwrite` option to `db.acquireHostList` ([#711](https://github.com/arangodb/arangojs/issues/711))
Setting this option to `true` will replace the current host list, removing any
hosts no longer present in the cluster.
- Added new ArangoDB 3.10 `legacyPolygons` option to `EnsureGeoIndexOptions`
and `GeoIndex` types
Geo indexes created in ArangoDB pre-3.10 will implicitly default this option
to `true`. ArangoDB 3.10 and later will default to `false` and use the new
parsing rules for geo indexes.
- Added support for new ArangoDB 3.10 `cacheEnabled` and `storedValues` options
in persistent indexes
- Added support for new ArangoDB 3.10 computed values in collections
- Added support for new ArangoDB 3.10 `InvertedIndex` type
- Added support for new ArangoDB 3.10 `offset` Analyzer feature
- Added support for new ArangoDB 3.10 `minhash`, `classification` and
`nearest_neighbors` Analyzer types
- Added missing `replicationFactor` and `writeConcern` options to
`CollectionPropertiesOptions` type
- Added missing `commitIntervalMsec` option to `ArangoSearchViewProperties`
type
- Added missing `deduplicate` option to `EnsurePersistentIndexOptions` type
([#771](https://github.com/arangodb/arangojs/issues/771))
- Added missing `unique` option to `EnsureZkdIndexOptions` type
- Added missing `deduplicate` and `estimates` fields to `PersistentIndex` type
- Added new ArangoDB 3.10 `db.queryRules` method
- Added support for `Analyzer` in `aql` templates
`Analyzer` objects can now be passed into `aql` templates like `View` and
`ArangoCollection` objects.
- Added `retryOnConflict` option to `Config`
If set to any number, this value will be used as the default value for all
requests unless explicitly overridden when using `db.query` or
`route.request`.
## [7.8.0] - 2022-05-19
### Added
- Added `retryOnConflict` option to `db.query` and `route.request`
This option allows specifying the number of times the request will be retried
if it results in a write-write conflict.
## [7.7.0] - 2022-01-26
### Changed
- Unicode names are now automatically NFC normalized
This change affects all database, collection, graph, view and analyzer names
using unicode characters. **The change has no effect when using non-unicode
(ASCII) names.** At this time, ArangoDB does not support unicode characters
in any of these names but experimental support for unicode database names is
available in ArangoDB 3.9 using the `--database.extended-names-databases`
startup option.
Any names used to create `Database`, `Collection`, etc instances or passed to
methods will automatically be NFC normalized. Additionally the collection
name part of any value passed as a `DocumentSelector` and the collection name
part of values returned by `collection.documentId` will automatically be NFC
normalized.
### Deprecated
- Deprecated `EnsureHashIndexOptions` and `EnsureSkiplistIndexOptions` types
The hash and skiplist index types have been deprecated in ArangoDB 3.9 and
should be replaced with persistent indexes which behave identically.
- Deprecated all MMFiles related options and methods
The MMFiles storage engine was removed in ArangoDB 3.7.
### Added
- Added support for new ArangoDB 3.9 `CollationAnalyzer` and
`SegmentationAnalyzer` types
- Added support for new ArangoDB 3.9 (multi-dimensional) `ZkdIndex` type
- Added support for new ArangoDB 3.9 Hybrid SmartGraphs graph options
- Added support for new ArangoDB 3.9 response queue time reporting
This adds the `db.queueTime` property, which provides methods for accessing
queue time metrics reported by the most recently received server responses if
the server supports this feature.
- Added `ArangoSearchViewLink#inBackground` ([#759](https://github.com/arangodb/arangojs/issues/759))
- Added `collection.compact` ([#630](https://github.com/arangodb/arangojs/issues/630))
## [7.6.1] - 2021-10-26
### Fixed
- Changed all uses of `Record<string, unknown>` to `Record<string, any>` ([#750](https://github.com/arangodb/arangojs/issues/750))
This should allow using more specific types without having to implement
index signatures.
## [7.6.0] - 2021-10-20
### Added
- Added `collection.documents` for fetching multiple documents
- Added support for `fillBlockCache` query option
- Added support for passing `Graph` objects in AQL queries ([#740](https://github.com/arangodb/arangojs/issues/740))
This also adds the `isArangoGraph` helper function for type checking.
- Added User Management API ([#664](https://github.com/arangodb/arangojs/issues/664))
This implements the endpoints of the
[HTTP Interface for User Management](https://www.arangodb.com/docs/stable/http/user-management.html)
### Fixed
- Added missing `hex` option to `StopwordsAnalyzer` type ([#732](https://github.com/arangodb/arangojs/issues/732))
- Added missing `details` option to `collection.figures` ([#728](https://github.com/arangodb/arangojs/issues/728))
- Added missing `inBackground` option to index options ([#734](https://github.com/arangodb/arangojs/issues/734))
## [7.5.0] - 2021-04-22
### Added
- Added support for new ArangoDB 3.8 Analyzer types
This adds the `PipelineAnalyzer`, `AqlAnalyzer`, `GeoJsonAnalyzer`,
`GeoPointAnalyzer` and `StopwordsAnalyzer` types in TypeScript, as well as
the Analyzer-specific properties types.
- Added support for new ArangoDB 3.8 `estimates` option for indexes
This affects the `PersistentIndex`, `HashIndex` and `SkiplistIndex` types
in TypeScript.
## [7.4.0] - 2021-04-09
### Added
- Implemented `toJSON` methods for `ArangoError` and `HttpError` ([#632](https://github.com/arangodb/arangojs/issues/632))
This prevents an error where `JSON.stringify` would reliably throw if passed
an instance of either of these error types generated by arangojs. Note that
you may still want to implement your own JSON representation logic as system
errors (e.g. `ECONNREFUSED`) are not wrapped by arangojs and thrown as-is.
### Fixed
- Stack traces are now improved for most errors when using `precaptureStackTraces` ([#722](https://github.com/arangodb/arangojs/issues/722))
Previously this option would only affect network errors, making it far less
useful than intended. Now parsing errors, `ArangoError` instances and HTTP
errors also receive improved error stack traces when this option is enabled.
- Improved performance for `precaptureStackTraces` when no errors occur
The generated stack is now only accessed on demand, allowing the runtime to
delay generation of the stack trace string. Previously the stack would always
be accessed prior to the request being sent, causing a noticeable delay even
when no error occurs.
- Fixed document selector validation in `collection.edges` and its variants ([#704](https://github.com/arangodb/arangojs/issues/704))
These methods previously only permitted start vertices that are documents
within the edge collection itself. This behavior has now been corrected to
permit start vertices outside the collection, as expected.
## [7.3.0] - 2021-03-08
### Changed
- Changed the default for `agentOptions.scheduling` to `"lifo"`
This is already the default in Node v15.6 but can reduce latency caused by
sockets expiring, especially with larger connection pools and infrequent
requests.
- Removed `keepAlive`-specific throughput optimization
Previously arangojs would allow `agentOptions.maxSockets * 2` concurrent
requests, to optimize socket reuse by avoiding idle time. This behavior
could trigger deadlocks when attempting to perform multiple transactions
in parallel and only marginally improved throughput in some high-load
scenarios. The connection pool size now always reflects the value set in
`agentOptions.maxSockets` regardless of whether `keepAlive` is enabled.
- Changed `agentOptions.maxSockets` default value when using `ROUND_ROBIN`
As the connection pool is shared across all server connections when using
`ROUND_ROBIN` load balancing, the default value of `3` is too limiting for
most scenarios involving multiple coordinators. When passing multiple URLs
via the `url` option and specifying `ROUND_ROBIN` load balancing, arangojs
will now default this value to `url.length * 3` instead.
## [7.2.0] - 2020-12-02
### Added
- Added `db.waitForPropagation` method
This method helps with setting up databases in a cluster scenario by waiting
for a request to succeed on every known coordinator.
## [7.1.1] - 2020-11-30
This is a maintenance release and contains no bugfixes or features.
## [7.1.0] - 2020-10-16
### Changed
- Killing a cursor now also drains it locally
### Fixed
- Fixed a potential memory leak in cursor batch handling
## [7.0.2] - 2020-09-25
### Fixed
- Fixed incorrect HTTP method call in `patch` method ([#687](https://github.com/arangodb/arangojs/pull/687))
- Fixed empty query results containing `[undefined]` ([#683](https://github.com/arangodb/arangojs/issues/683))
- Fixed `updateByExample` and `replaceByExample` new value parameter name
Note that these methods are still deprecated. Previously the `newValue`
parameter was incorrectly called `newData`, which prevented the methods from
working at all.
## [7.0.1] - 2020-08-21
This is a maintenance release because the initial v7 release did not include
a README file.
## [7.0.0] - 2020-08-21
This is a major release and breaks backwards compatibility.
See [the migration guide](./MIGRATING.md#v6-to-v7) for detailed instructions
for upgrading your code to arangojs v7.
For a detailed list of changes between pre-release versions of v7 see the
[Changelog of the final v7 release candidate](https://github.com/arangodb/arangojs/blob/v7.0.0-rc.2/CHANGELOG.md).
### Removed
#### General
- Removed ArangoDB 2.8 support
ArangoDB 2.8 has reached End of Life since mid 2018. Version 7 and above
of arangojs will no longer support ArangoDB 2.8 and earlier.
- Removed Node.js 6/8 support
As of version 7 arangojs now requires language support for async/await.
This means arangojs requires Node.js 10 (LTS) or newer to function correctly.
- Removed support for absolute endpoint URLs
This removes the `isAbsolute` option from the arangojs configuration.
- Removed `ArangoError` re-export
The type can still be imported directly from the `error` module.
- Removed `statusCode` properties of `ArangoError` and `HttpError`
Both of these error types still expose the HTTP status code as the `code`
property. For `ArangoError` the true HTTP status code may be different and
can still be accessed using the `response.statusCode` property.
#### Database API
- Removed `db.edgeCollection` method
As arangojs 7 uses the same implementation for document and edge collections,
this method is no longer necessary. Generic collection objects can still be
cast to `DocumentCollection` or `EdgeCollection` types in TypeScript.
- Removed `db.truncate` convenience method
This was a wrapper around `db.listCollections` and `collection.truncate`.
The behavior of `db.truncate` can still be emulated by calling these methods
directly.
#### Collection API
- Removed collection `createCapConstraint`, `createHashIndex`,
`createSkipList`, `createPersistentIndex`, `createGeoIndex` and
`createFulltextIndex` methods
These methods are no longer part of the official ArangoDB API and can be
replaced by using the `collection.ensureIndex` method.
- Removed `save(fromId, toId, edgeData)` method variants
Methods for creating edges now require the `_to` and `_from` attributes to
be specified in the edge (document) data and no longer accept these values
as positional arguments.
- Removed `collection.bulkUpdate` method
The new method `collection.updateAll` now provides this functionality.
- Removed `collection.edge` method
This method was previously an alias for `collection.document`.
The method `graphEdgeCollection.edge` is unaffected by this change.
- Removed `graphName` option for `edgeCollection.traversal`
Graph traversals can still be performed via `graph.traversal`.
#### Graph API
- Removed generic collection methods from `GraphVertexCollection`
All methods that are not part of the graph API have been removed.
The underlying collection can still be accessed from the `collection`
property.
- Removed generic collection methods from `GraphEdgeCollection`
All methods that are not part of the graph API have been removed.
The underlying collection can still be accessed from the `collection`
property.
#### Cursor API
- Removed `cursor.some` and `cursor.every` methods
These methods encouraged overfetching and should be replaced with more
efficient AQL queries.
The behavior can still be implemented by using the `next` method directly
or iterating over the cursor using the `forEach` method or the `for await`
syntax.
#### View API
- Removed `ViewResponse` type
The type `ViewDescription` represents the same structure.
- Removed `ArangoSearchViewPropertiesResponse` type
The type `ArangoSearchViewProperties & ViewDescription` can be used
to represent the same structure.
### Deprecated
#### Database API
- Deprecated `db.useDatabase` method
Using this method will affect `Collection`, `Graph` and other objects
already created for the given database and change which database these
refer to, which may cause unexpected behavior.
As of arangojs 7 the `db.database` method can be used instead to create a
new, separate `Database` object using the same connection pool.
#### Collection API
- Deprecated `Collection` methods for simple queries: `list`, `all`, `any`,
`byExample`, `firstExample`, `removeByExample`, `replaceByExample`,
`updateByExample`, `lookupByKeys`, `removeByKeys`, `fulltext`
These methods were deprecated in ArangoDB 3.4 and should no longer be used.
They will still behave correctly with versions of ArangoDB supporting these
methods but may be removed in a future ArangoDB release.
Their behavior can be emulated using AQL queries.
#### Graph API
- Deprecated `graph.traversal` and `collection.traversal`
These methods were deprecated in ArangoDB 3.4 and should no longer be used.
They will still behave correctly with versions of ArangoDB supporting these
methods but may be removed in a future ArangoDB release.
Their behavior can be emulated using AQL graph traversal.
### Changed
#### General
- Multiple `Database` objects can now share a single `Connection`
All arangojs objects now reference a `Database` object rather than accessing
the underlying `Connection` directly. This allows multiple `Database` objects
to be created by using the `db.database` method while still allowing the
creation of separate database objects with separate connection pools if
desired.
- Memoized `Database`, `Collection`, `Graph`, `View` and `Analyzer`
Database objects are now memoized per-connection and the other object types
are memoized per-database. Using `useDatabase` de-memoizes the database
object to prevent unexpected behavior.
- Added support for `View` in `aql` templates ([#667](https://github.com/arangodb/arangojs/issues/667))
`View` (or `ArangoSearchView`) objects can now be passed into `aql` templates
like `ArangoCollection` objects.
- Moved `collectionToString` helper into `collection` module
- Moved `Dict` type into `connection` module
- Moved `Patch` type into `documents` module
- Removed `Errback` type from public API
- Renamed `util/foxx-manifest` module to `foxx-manifest`
#### Database API
- Renamed method `db.arangoSearchView` to `db.view`
- Renamed method `db.createArangoSearchView` to `db.createView`
- Replaced methods `db.enableServiceDevelopmentMode` and
`db.disableServiceDevelopmentMode` with `db.setServiceDevelopmentMode`
- Flattened database `query` method `options` argument
The optional `options` argument previously contained an additional `options`
object with additional query options. These options are now specified on the
`options` argument itself directly.
Before:
```js
db.query(aql`FOR doc IN ${collection} RETURN doc`, {
cache: false,
options: { fullCount: true },
});
```
After:
```js
db.query(aql`FOR doc IN ${collection} RETURN doc`, {
cache: false,
fullCount: true,
});
```
- Changed `db.listServices` option `excludeSystem` default to `true`
To be more consistent with the equivalent options in other methods,
the default value has been changed from `false` to `true`.
- Changed `db.createDatabase` return type to `Database`
- Renamed `database.setQueryTracking` to `database.queryTracking`
The method will now return the existing query tracking properties or set the
new query tracking properties depending on whether an argument is provided.
- Method `db.transaction` no longer acts as an alias for `executeTransaction`
The method now only allows looking up transactions by ID. Previously it would
wrap `executeTransaction` if passed the arguments expected by that method.
#### Collection API
- Merged `DocumentCollection` and `EdgeCollection` APIs
All collections are now implemented as generic `Collection` objects.
In TypeScript the generic collection object can still be explicitly cast to
`DocumentCollection` or `EdgeCollection` for stricter type safety.
- Renamed `collection.setProperties` to `collection.properties`
The method will now return the existing properties or set the properties
depending on whether an argument is provided.
- Removed `CollectionMetadata` fields from `CollectionProperties` type
Methods that previously returned `CollectionProperties` now return
`CollectionMetadata & CollectionProperties`.
- Collection methods `save`, `update`, `replace` and `remove` no longer take
arrays as input
The array versions have been renamed to `saveAll`, `updateAll`, `replaceAll`
and `removeAll` to reduce the likelihood of mistakes and provide more helpful
type signatures.
- Collection methods will now throw errors when passed documents or document
IDs from different collections where a document key or ID for a document in
the same collection is expected
For example the following code will now result in an error rather than the
document from a different collection being returned:
```js
const aliceId = "alice/123"; // Document from collection "alice"
const bobCol = db.collection("bob"); // Collection "bob"
const doc = await bobCol.document(aliceId); // THROWS
```
- Changed `collection.import` option `type` behavior
Previously this option would always default to `"auto"`.
When passing a `string`, `Buffer` or `Blob` as data, the option now defaults
to `undefined`. This matches the behavior in previous versions of setting
the option explicitly to `null`.
Additionally, the value `"array"` has been replaced with `"list"`.
When passing an array as data, the option is now no longer supported as the
corresponding value will be inferred from the array's contents:
If the array's first item is also an array, it will match the behavior in
previous versions of setting the option explicitly to `null`.
Otherwise it will match the behavior in previous versions of setting the
option explicitly to `"documents"` or `"auto"`, or omitting it entirely.
- Changed `collection.list` return type to `ArrayCursor`
#### Graph API
- Graph methods now also accept `ArangoCollection` instances instead of names
This brings these methods behavior in line with that of the `beginTransaction`
and `executeTransaction` methods of `Database` objects.
- Graph `create` method (and `db.createGraph`) signature changed
The `graph.create` method now takes an array of edge definitions as the
first argument and any additional options (not just the `waitForSync`
option) as the second argument.
Before:
```js
await graph.create(
{
edgeDefinitions: [{ collection: "edges", from: ["a"], to: ["b"] }],
isSmart: true,
},
{ waitForSync: true }
);
```
After:
```js
await graph.create([{ collection: "edges", from: ["a"], to: ["b"] }], {
isSmart: true,
waitForSync: true,
});
```
- First argument to `graph.replaceEdgeDefinition` is now optional
Since the new edge definition already includes the edge collection name
that identifies the edge definition, it is now possible to specify only the
new edge definition object without additionally specifying the collection
name as the first argument.
Before:
```js
await graph.replaceEdgeDefinition("edges", {
collection: "edges", // This is a bit redundant
from: ["a"],
to: ["b"],
});
```
After:
```js
await graph.replaceEdgeDefinition({
collection: "edges",
from: ["a"],
to: ["b"],
});
```
- Graph collection return values now contain `old` and `new` properties when
`returnOld` or `returnNew` options are used
This behavior represents a compromise between remaining consistent with the
behavior of the regular collection method equivalents and remaining
compatible with the ArangoDB HTTP API response object quirks.
#### Cursor API
- Replaced `ArrayCursor` methods `hasNext` and `hasMore` with getters
- Renamed `ArrayCursor` method `each` to `forEach`
- Renamed `cursor.nextBatch` to `cursor.batches.next`
- Renamed `cursor.hasMore` to `cursor.batches.hasMore`
- In TypeScript `ArrayCursor` is now a generic type
TypeScript users can now cast cursor instances to use a specific type for
its values rather than `any` to aid type safety.
#### View API
- Renamed `view.setProperties` to `view.updateProperties`
- Renamed type `ArangoView` to `View`
#### Analyzer API
- Renamed type `ArangoAnalyzer` to `Analyzer`
#### Transaction API
- Renamed type `ArangoTransaction` to `Transaction`
- Renamed `transaction.run` to `transaction.step`
This should hopefully make it more obvious that sequential calls to arangojs
methods should be split into separate calls of this method.
### Added
#### General
- Added `databaseName` configuration option
Setting this option to a database name will result in the initial `Database`
object using this database instead of the default `_system` database.
- Added `auth` configuration option
It is now possible to pass authentication credentials using the `auth`
option in addition to calling `db.useBasicAuth` or `db.useBearerAuth`.
- Added `precaptureStackTraces` configuration option ([#599](https://github.com/arangodb/arangojs/issues/599))
This option can be used to get more useful stack traces but results in a
performance hit on every request.
- Added `before` and `after` to the `agentOptions` configuration option ([#585](https://github.com/arangodb/arangojs/issues/585))
These methods can be used to track performance metrics for outgoing requests.
- Improved type signatures for TypeScript and inline documentation
Most methods should now provide full type signatures for options and response
objects and provide inline documentation in IDEs and editors that support
this feature in TypeScript and JavaScript.
#### Database API
- Added `db.database` method
This method replaces the use case for the deprecated `db.useDatabase`
method.
- Added support for extended options in `db.createDatabase`
This method now supports passing an extended options object instead of
passing the users array directly.
- Added `db.createCollection` and `db.createEdgeCollection` methods
These are convenience methods wrapping `collection.create`. In TypeScript
`createEdgeCollection` will return a collection cast to the `EdgeCollection`
type.
- Added `db.createGraph` method
This is a convenience method wrapping `graph.create`.
- Added `db.createArangoSearchView` method
This is a convenience method wrapping `view.create`.
- Added `db.createAnalyzer` method
This is a convenience method wrapping `analyzer.create`.
- Added support for `db.createFunction` option `isDeterministic`
- Added support for `db.listServices` option `excludeSystem`
#### Collection API
- Added collection `saveAll`, `updateAll`, `replaceAll` and `removeAll` methods
These methods replace the respective array versions of the collection
methods `save`, `update`, `replace` and `remove`, which no longer accept
arrays as inputs.
- Added `collection.documentId` method
The method takes a document or a document key and returns a fully qualified
document ID string for the document in the current collection.
- Added support for values `"ignore"` and `"conflict"` in `overwriteMode`
option when saving documents using the Collection API
#### Graph API
- Added `graphVertexCollection.vertexExists` and
`graphEdgeCollection.edgeExists` methods
These mimic the behavior of the `collection.documentExists` method but using
the Graph API.
- Added `graphVertexCollection.collection` and `graphEdgeCollection.collection`
These properties now provide access to regular (non-graph) collection
objects for these graph collections. These objects can be used to perform
operations not available within the context of a graph (e.g. bulk imports
or modifying the collection itself).
- Added support for `isDisjoint` option in Graph API
#### Cursor API
- Added `cursor.flatMap` method
This method behaves similarly to the `Array` method `flatMap` but operates
on the cursor directly like `cursor.map` does.
- Added `cursor.batches` to provide a batch-wise cursor API
- Added support for `for await` in `ArrayCursor` ([#616](https://github.com/arangodb/arangojs/pull/616))
It is now possible to use `for await` to iterate over each item in a cursor
asynchronously.
#### View API
- Added support for `primarySortCompression` and `storedValues` options in
View API
### Fixed
#### General
- Removed TypeScript dependency on `dom` library
If you are using arangojs in Node.js, you no longer need to add the `dom`
library to your `tsconfig.json` configuration.
#### Database API
- Fixed `db.dropFunction` option `group` being ignored
- Fixed documentation of `db.runServiceTests`
Previously the documentation incorrectly indicated that the default value
of the `idiomatic` option is `true`. The correct default value is `false`.
## [6.14.1] - 2020-05-01
### Fixed
- Added `uuid` and `padded` to legal `KeyGeneratorType` values in TypeScript ([#656](https://github.com/arangodb/arangojs/issues/656))
- Added `overwrite` to `InsertOptions` type in TypeScript ([#657](https://github.com/arangodb/arangojs/issues/657))
## [6.14.0] - 2020-03-18
### Added
- Added `db.listTransactions` and `db.transactions` methods
## [6.13.0] - 2020-01-24
### Changed
- Empty querystring parameters are now omitted
In some cases ArangoDB would be unable to correctly handle querystring
parameters without values. Any paremeters set to `undefined` will now
no longer be added to the querystring.
This does not affect parameters set to empty string values.
### Added
- Added `maxRuntime` option to `db.query` method
### Fixed
- Replaced `linkedlist` dependency with `x3-linkedlist` ([#601](https://github.com/arangodb/arangojs/issues/601))
The `linkedlist` dependency had a memory leak and was no longer maintained.
The replacement should fix this issue.
## [6.12.0] - 2019-10-16
### Added
- Added `cursor.kill` method
Cursors that have not yet been fully depleted can now be killed using the
`cursor.kill` method. Note that this method has no effect if the cursor
is already depleted.
- Added `cursor.nextBatch` method
Cursors normally fetch additional batches as necessary while iterating
over the individual results, this method allows consuming an entire batch
at a time.
## [6.11.1] - 2019-08-30
### Fixed
- Fixed View properties not being passed correctly when creating Views ([#621](https://github.com/arangodb/arangojs/issues/621))
- Renamed internal `response.host` attribute to `response.arangojsHostId` ([#604](https://github.com/arangodb/arangojs/pull/604))
In some environments the `host` attribute is already present and read-only.
This should avoid a `TypeError` being thrown when a value is assigned by
arangojs.
## [6.11.0] - 2019-08-16
### Changed
- Renamed `db.transaction` to `db.executeTransaction`
The method for executing server-side transactions is now called
`executeTransaction` and the `params` argument now must be passed via the
`options` object.
For backwards-compatibility the new `db.transaction` method will continue to
behave like before when passed an `action` string as the second argument.
Note that this behavior is deprecated and will be removed in arangojs 7.
### Added
- Added support for ArangoDB 3.5 streaming transactions
New streaming transactions can be created using `db.beginTransaction` and
existing streaming transactions can be accessed by passing the transaction ID
to `db.transaction`.
See the documentation of the `transaction.run` method for examples of using
streaming transactions with arangojs.
- Added support for ArangoDB 3.5 Analyzers API
See the documentation of the `da