Skip to content

Commit 39d5a33

Browse files
committed
Deprecate load/unload
1 parent 2e46d82 commit 39d5a33

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ This driver uses semantic versioning:
4040
The hash and skiplist index types have been deprecated in ArangoDB 3.9 and
4141
should be replaced with persistent indexes which behave identically.
4242

43+
- Deprecated `collection.load` and `collection.unload` methods
44+
45+
These methods have been deprecated in ArangoDB 3.8 as they no longer have any
46+
effect since the MMFiles storage engine was removed in ArangoDB 3.7.
47+
4348
### Added
4449

4550
- Added support for new ArangoDB 3.9 `CollationAnalyzer` and

src/collection.ts

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1428,7 +1428,7 @@ export interface DocumentCollection<T extends Record<string, any> = any>
14281428
CollectionMetadata & { revision: string; checksum: string }
14291429
>;
14301430
/**
1431-
* Instructs ArangoDB to load the collection into memory.
1431+
* (MMFiles only.) Instructs ArangoDB to load the collection into memory.
14321432
*
14331433
* @param count - Whether the number of documents in the collection should
14341434
* be included in the server response. Disabling this may speed up this
@@ -1441,6 +1441,9 @@ export interface DocumentCollection<T extends Record<string, any> = any>
14411441
* await collection.load();
14421442
* // the collection has now been loaded into memory
14431443
* ```
1444+
*
1445+
* @deprecated This method was deprecated in ArangoDB 3.8 as it no longer has
1446+
* any effect since the MMFiles storage engine was removed in ArangoDB 3.7.
14441447
*/
14451448
load(
14461449
count?: true
@@ -1475,7 +1478,7 @@ export interface DocumentCollection<T extends Record<string, any> = any>
14751478
*/
14761479
loadIndexes(): Promise<boolean>;
14771480
/**
1478-
* Instructs ArangoDB to remove the collection from memory.
1481+
* (MMFiles only.) Instructs ArangoDB to remove the collection from memory.
14791482
*
14801483
* @example
14811484
* ```js
@@ -1484,6 +1487,9 @@ export interface DocumentCollection<T extends Record<string, any> = any>
14841487
* await collection.unload();
14851488
* // the collection has now been unloaded from memory
14861489
* ```
1490+
*
1491+
* @deprecated This method was deprecated in ArangoDB 3.8 as it no longer has
1492+
* any effect since the MMFiles storage engine was removed in ArangoDB 3.7.
14871493
*/
14881494
unload(): Promise<ArangoResponseMetadata & CollectionMetadata>;
14891495
/**

0 commit comments

Comments
 (0)