Changes for 3.7.0

Author: pluma

CHANGELOG.md

@@ -20,6 +20,16 @@ This driver uses semantic versioning:
 
 - Renamed `validation` option to `schema` ([#681](https://github.com/arangodb/arangojs/issues/681))
 
+### Added
+
+- Added support for `isDisjoint` option in Graph API
+
+- Added support for values `"ignore"` and `"conflict"` in `overwriteMode`
+  option when saving documents using the Collection API
+
+- Added support for `primarySortCompression` and `storedValues` options in
+  View API
+
 ## [7.0.0-rc.1] - 2020-07-11
 
 ### Fixed

src/collection.ts

@@ -575,8 +575,10 @@ export type CollectionInsertOptions = {
   /**
    * Defines what should happen if a document with the same `_key` or `_id`
    * already exists, instead of throwing an exception.
+   *
+   * Default: `"conflict"
    */
-  overwriteMode?: "update" | "replace";
+  overwriteMode?: "ignore" | "update" | "replace" | "conflict";
 };
 
 /**

src/graph.ts

@@ -274,6 +274,11 @@ export type GraphInfo = {
    * @deprecated Renamed to `writeConcern` in ArangoDB 3.6.
    */
   minReplicationFactor?: number;
+  /**
+   * (Enterprise Edition cluster only.) If set to `true`, the graph is a
+   * SatelliteGraph.
+   */
+  isSatellite?: boolean;
   /**
    * (Enterprise Edition cluster only.) If set to `true`, the graph has been
    * created as a SmartGraph.
@@ -284,6 +289,11 @@ export type GraphInfo = {
    * value to use for smart sharding.
    */
   smartGraphAttribute?: string;
+  /**
+   * (Enterprise Edition cluster only.) If set to `true`, the graph has been
+   * created as a Disjoint SmartGraph.
+   */
+  isDisjoint?: boolean;
 };
 
 /**
@@ -306,6 +316,8 @@ export type GraphCreateOptions = {
   /**
    * (Cluster only.) Number of shards that is used for every collection
    * within this graph.
+   *
+   * Has no effect when `replicationFactor` is set to `"satellite"`.
    */
   numberOfShards?: number;
   /**
@@ -317,11 +329,15 @@ export type GraphCreateOptions = {
   replicationFactor?: number | "satellite";
   /**
    * (Cluster only.) Write concern for new collections in the graph.
+   *
+   * Has no effect when `replicationFactor` is set to `"satellite"`.
    */
   writeConcern?: number;
   /**
    * (Cluster only.) Write concern for new collections in the graph.
    *
+   * Has no effect when `replicationFactor` is set to `"satellite"`.
+   *
    * @deprecated Renamed to `writeConcern` in ArangoDB 3.6.
    */
   minReplicationFactor?: number;
@@ -341,6 +357,13 @@ export type GraphCreateOptions = {
    * **Note**: `isSmart` must be set to `true`.
    */
   smartGraphAttribute?: string;
+  /**
+   * (Enterprise Edition cluster only.) If set to `true`, the graph will be
+   * created as a Disjoint SmartGraph.
+   *
+   * Default: `false`
+   */
+  isDisjoint?: boolean;
 };
 
 /**
@@ -1250,7 +1273,8 @@ export class Graph {
     edgeDefinitions: EdgeDefinitionOptions[],
     options?: GraphCreateOptions
   ): Promise<GraphInfo> {
-    const { orphanCollections, waitForSync, isSmart, ...opts } = options || {};
+    const { orphanCollections, waitForSync, isSmart, isDisjoint, ...opts } =
+      options || {};
     return this._db.request(
       {
         method: "POST",
@@ -1263,6 +1287,7 @@ export class Graph {
               : [collectionToString(orphanCollections)]),
           edgeDefinitions: edgeDefinitions.map(coerceEdgeDefinition),
           isSmart,
+          isDisjoint,
           name: this._name,
           options: opts,
         },

src/view.ts

@@ -115,6 +115,39 @@ export type ArangoSearchViewProperties = {
    * merged.
    */
   consolidationPolicy: BytesAccumConsolidationPolicy | TierConsolidationPolicy;
+  /**
+   * Attribute path (`field`) for the value of each document that is
+   * used for sorting.
+   */
+  primarySort: {
+    /**
+     * Attribute path for the value of each document used for
+     * sorting.
+     */
+    field: string;
+    /**
+     * If set to `"asc"`, the primary sorting order is ascending.
+     * If set to `"desc"`, the primary sorting order is descending.
+     */
+    direction: "desc" | "asc";
+  }[];
+  /**
+   * Compression to use for the primary sort data.
+   *
+   * Default: `"lz4"`
+   */
+  primarySortCompression: PrimarySortCompression;
+  /**
+   * Attribute paths for which values should be stored in the view index
+   * in addition to those used for sorting via `primarySort`.
+   */
+  storedValues: {
+    /**
+     * Attribute paths for which values should be stored in the view index
+     * in addition to those used for sorting via `primarySort`.
+     */
+    fields: string[];
+  }[];
   /**
    * An object mapping names of linked collections to
    * {@link ArangoSearchViewLink} definitions.
@@ -179,6 +212,13 @@ export type TierConsolidationPolicy = {
   minScore?: number;
 };
 
+/**
+ * Compression to use for primary sort data of a View.
+ *
+ * Default: `"lz4"`
+ */
+export type PrimarySortCompression = "lz4" | "none";
+
 /**
  * Properties of an ArangoSearch View.
  */
@@ -261,6 +301,23 @@ export type ArangoSearchViewPropertiesOptions = {
         asc: boolean;
       }
   )[];
+  /**
+   * Compression to use for the primary sort data.
+   *
+   * Default: `"lz4"`
+   */
+  primarySortCompression?: PrimarySortCompression;
+  /**
+   * Attribute paths for which values should be stored in the view index
+   * in addition to those used for sorting via `primarySort`.
+   */
+  storedValues?: {
+    /**
+     * Attribute paths for which values should be stored in the view index
+     * in addition to those used for sorting via `primarySort`.
+     */
+    fields: string[];
+  }[];
   /**
    * An object mapping names of linked collections to
    * {@link ArangoSearchViewLink} definitions.