Skip to content

Commit 7d53ae7

Browse files
committed
Mark MMFiles options as deprecated
1 parent 9d84579 commit 7d53ae7

File tree

2 files changed

+23
-4
lines changed

2 files changed

+23
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,9 @@ 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
43+
- Deprecated all MMFiles related options and methods
4444

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.
45+
The MMFiles storage engine was removed in ArangoDB 3.7.
4746

4847
### Added
4948

src/collection.ts

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -274,20 +274,28 @@ export type CollectionProperties = {
274274
shardingStrategy?: ShardingStrategy;
275275
/**
276276
* (MMFiles only.) Whether the collection will be compacted.
277+
*
278+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
277279
*/
278280
doCompact?: boolean;
279281
/**
280282
* (MMFiles only.) Maximum size for each journal or datafile in bytes.
283+
*
284+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
281285
*/
282286
journalSize?: number;
283287
/**
284288
* (MMFiles only.) Number of buckets into which indexes using hash tables are
285289
* split.
290+
*
291+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
286292
*/
287293
indexBuckets?: number;
288294
/**
289295
* (MMFiles only.) If set to `true`, the collection will only be kept
290296
* in-memory and discarded when unloaded, resulting in full data loss.
297+
*
298+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
291299
*/
292300
isVolatile?: boolean;
293301
/**
@@ -344,6 +352,8 @@ export type CollectionPropertiesOptions = {
344352
* (MMFiles only.) Maximum size for each journal or datafile in bytes.
345353
*
346354
* Must be a number greater than or equal to `1048576` (1 MiB).
355+
*
356+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
347357
*/
348358
journalSize?: number;
349359
};
@@ -492,25 +502,33 @@ export type CreateCollectionOptions = {
492502
* Must be a power of 2 and less than or equal to `1024`.
493503
*
494504
* Default: `16`
505+
*
506+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
495507
*/
496508
indexBuckets?: number;
497509
/**
498510
* (MMFiles only.) Whether the collection will be compacted.
499511
*
500512
* Default: `true`
513+
*
514+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
501515
*/
502516
doCompact?: boolean;
503517
/**
504518
* (MMFiles only.) Maximum size for each journal or datafile in bytes.
505519
*
506520
* Must be a number greater than or equal to `1048576` (1 MiB).
521+
*
522+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
507523
*/
508524
journalSize?: number;
509525
/**
510526
* (MMFiles only.) If set to `true`, the collection will only be kept
511527
* in-memory and discarded when unloaded, resulting in full data loss.
512528
*
513529
* Default: `false`
530+
*
531+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
514532
*/
515533
isVolatile?: boolean;
516534
/**
@@ -1524,6 +1542,8 @@ export interface DocumentCollection<T extends Record<string, any> = any>
15241542
* const collection = db.collection("some-collection");
15251543
* const rotated = await collection.rotate();
15261544
* ```
1545+
*
1546+
* @deprecated The MMFiles storage engine was removed in ArangoDB 3.7.
15271547
*/
15281548
rotate(): Promise<boolean>;
15291549
/**
@@ -4059,7 +4079,7 @@ export class Collection<T extends Record<string, any> = any>
40594079
return this._db.request(
40604080
{
40614081
method: "PUT",
4062-
path: `/_api/collection/${this._name}/compact`
4082+
path: `/_api/collection/${this._name}/compact`,
40634083
},
40644084
(res) => res.body
40654085
);

0 commit comments

Comments
 (0)