Expose database instances

Fixes DE-935.
arangodb · Oct 30, 2024 · e634738 · e634738
1 parent bf84655
commit e634738
Show file tree

Hide file tree

Showing 10 changed files with 242 additions and 137 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,6 +14,21 @@ This driver uses semantic versioning:
 - 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.
 
+## [Unreleased]
+
+### Added
+
+- Added `database` property to `Analyzer`, `ArrayCursor`, `BatchedArrayCursor`,
+  `Collection`, `Graph`, `Job`, `Route`, `Transaction` and `View` types (DE-935)
+
+  This property can be used to access the database instance a given object
+  belongs to.
+
+- Added `headers` and `path` properties to `Route` type
+
+  These properties can be used to access the headers and path used when creating
+  the route.
+
 ## [9.1.0] - 2024-09-25
 
 ### Changed

diff --git a/src/analyzer.ts b/src/analyzer.ts
@@ -924,6 +924,13 @@ export class Analyzer {
     this._name = name;
   }
 
+  /**
+   * Database this analyzer belongs to.
+   */
+  get database() {
+    return this._db;
+  }
+
   /**
    * @internal
    *
@@ -1001,40 +1008,40 @@ export class Analyzer {
     options: Options
   ): Promise<
     Options extends CreateIdentityAnalyzerOptions
-      ? IdentityAnalyzerDescription
-      : Options extends CreateDelimiterAnalyzerOptions
-        ? DelimiterAnalyzerDescription
-        : Options extends CreateStemAnalyzerOptions
-          ? StemAnalyzerDescription
-          : Options extends CreateNormAnalyzerOptions
-            ? NormAnalyzerDescription
-            : Options extends CreateNgramAnalyzerOptions
-              ? NgramAnalyzerDescription
-              : Options extends CreateTextAnalyzerOptions
-                ? TextAnalyzerDescription
-                : Options extends CreateSegmentationAnalyzerOptions
-                  ? SegmentationAnalyzerDescription
-                  : Options extends CreateAqlAnalyzerOptions
-                    ? AqlAnalyzerDescription
-                    : Options extends CreatePipelineAnalyzerOptions
-                      ? PipelineAnalyzerDescription
-                      : Options extends CreateStopwordsAnalyzerOptions
-                        ? StopwordsAnalyzerDescription
-                        : Options extends CreateCollationAnalyzerOptions
-                          ? CollationAnalyzerDescription
-                          : Options extends CreateMinHashAnalyzerOptions
-                            ? MinHashAnalyzerDescription
-                            : Options extends CreateClassificationAnalyzerOptions
-                              ? ClassificationAnalyzerDescription
-                              : Options extends CreateNearestNeighborsAnalyzerOptions
-                                ? NearestNeighborsAnalyzerDescription
-                                : Options extends CreateGeoJsonAnalyzerOptions
-                                  ? GeoJsonAnalyzerDescription
-                                  : Options extends CreateGeoPointAnalyzerOptions
-                                    ? GeoPointAnalyzerDescription
-                                    : Options extends CreateGeoS2AnalyzerOptions
-                                      ? GeoS2AnalyzerDescription
-                                      : AnalyzerDescription
+    ? IdentityAnalyzerDescription
+    : Options extends CreateDelimiterAnalyzerOptions
+    ? DelimiterAnalyzerDescription
+    : Options extends CreateStemAnalyzerOptions
+    ? StemAnalyzerDescription
+    : Options extends CreateNormAnalyzerOptions
+    ? NormAnalyzerDescription
+    : Options extends CreateNgramAnalyzerOptions
+    ? NgramAnalyzerDescription
+    : Options extends CreateTextAnalyzerOptions
+    ? TextAnalyzerDescription
+    : Options extends CreateSegmentationAnalyzerOptions
+    ? SegmentationAnalyzerDescription
+    : Options extends CreateAqlAnalyzerOptions
+    ? AqlAnalyzerDescription
+    : Options extends CreatePipelineAnalyzerOptions
+    ? PipelineAnalyzerDescription
+    : Options extends CreateStopwordsAnalyzerOptions
+    ? StopwordsAnalyzerDescription
+    : Options extends CreateCollationAnalyzerOptions
+    ? CollationAnalyzerDescription
+    : Options extends CreateMinHashAnalyzerOptions
+    ? MinHashAnalyzerDescription
+    : Options extends CreateClassificationAnalyzerOptions
+    ? ClassificationAnalyzerDescription
+    : Options extends CreateNearestNeighborsAnalyzerOptions
+    ? NearestNeighborsAnalyzerDescription
+    : Options extends CreateGeoJsonAnalyzerOptions
+    ? GeoJsonAnalyzerDescription
+    : Options extends CreateGeoPointAnalyzerOptions
+    ? GeoPointAnalyzerDescription
+    : Options extends CreateGeoS2AnalyzerOptions
+    ? GeoS2AnalyzerDescription
+    : AnalyzerDescription
   > {
     return this._db.request({
       method: "POST",

diff --git a/src/collection.ts b/src/collection.ts
@@ -1063,6 +1063,10 @@ export interface DocumentCollection<
   EntryResultType extends Record<string, any> = any,
   EntryInputType extends Record<string, any> = EntryResultType,
 > extends ArangoCollection {
+  /**
+   * Database this collection belongs to.
+   */
+  readonly database: Database;
   /**
    * Checks whether the collection exists.
    *
@@ -1215,7 +1219,7 @@ export interface DocumentCollection<
   ): Promise<
     ArangoApiResponse<
       CollectionMetadata &
-        CollectionProperties & { count: number; figures: Record<string, any> }
+      CollectionProperties & { count: number; figures: Record<string, any> }
     >
   >;
   /**
@@ -1550,9 +1554,9 @@ export interface DocumentCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Document<EntryResultType>;
-          old?: Document<EntryResultType>;
-        })
+        new?: Document<EntryResultType>;
+        old?: Document<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -1622,9 +1626,9 @@ export interface DocumentCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Document<EntryResultType>;
-          old?: Document<EntryResultType>;
-        })
+        new?: Document<EntryResultType>;
+        old?: Document<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -1694,9 +1698,9 @@ export interface DocumentCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Document<EntryResultType>;
-          old?: Document<EntryResultType>;
-        })
+        new?: Document<EntryResultType>;
+        old?: Document<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -2255,9 +2259,9 @@ export interface EdgeCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Edge<EntryResultType>;
-          old?: Edge<EntryResultType>;
-        })
+        new?: Edge<EntryResultType>;
+        old?: Edge<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -2351,9 +2355,9 @@ export interface EdgeCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Edge<EntryResultType>;
-          old?: Edge<EntryResultType>;
-        })
+        new?: Edge<EntryResultType>;
+        old?: Edge<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -2445,9 +2449,9 @@ export interface EdgeCollection<
   ): Promise<
     Array<
       | (DocumentOperationMetadata & {
-          new?: Edge<EntryResultType>;
-          old?: Edge<EntryResultType>;
-        })
+        new?: Edge<EntryResultType>;
+        old?: Edge<EntryResultType>;
+      })
       | DocumentOperationFailure
     >
   >;
@@ -2705,13 +2709,12 @@ export interface EdgeCollection<
  * @internal
  */
 export class Collection<
-    EntryResultType extends Record<string, any> = any,
-    EntryInputType extends Record<string, any> = EntryResultType,
-  >
+  EntryResultType extends Record<string, any> = any,
+  EntryInputType extends Record<string, any> = EntryResultType,
+>
   implements
-    EdgeCollection<EntryResultType, EntryInputType>,
-    DocumentCollection<EntryResultType, EntryInputType>
-{
+  EdgeCollection<EntryResultType, EntryInputType>,
+  DocumentCollection<EntryResultType, EntryInputType> {
   //#region attributes
   protected _name: string;
   protected _db: Database;
@@ -2730,6 +2733,10 @@ export class Collection<
     return true;
   }
 
+  get database() {
+    return this._db;
+  }
+
   get name() {
     return this._name;
   }
@@ -2838,9 +2845,9 @@ export class Collection<
     details = false
   ): Promise<
     CollectionMetadata &
-      ArangoApiResponse<
-        CollectionProperties & { count: number; figures: Record<string, any> }
-      >
+    ArangoApiResponse<
+      CollectionProperties & { count: number; figures: Record<string, any> }
+    >
   > {
     return this._db.request({
       path: `/_api/collection/${encodeURIComponent(this._name)}/figures`,

diff --git a/src/cursor.ts b/src/cursor.ts
@@ -226,6 +226,13 @@ export class BatchedArrayCursor<T = any> {
     this._nextBatchId = body.nextBatchId;
   }
 
+  /**
+   * Database this cursor belongs to.
+   */
+  get database() {
+    return this._db;
+  }
+
   /**
    * An {@link ArrayCursor} providing item-wise access to the cursor result set.
    *
@@ -769,6 +776,13 @@ export class ArrayCursor<T = any> {
     this._view = view;
   }
 
+  /**
+   * Database this cursor belongs to.
+   */
+  get database() {
+    return this._batches.database;
+  }
+
   /**
    * A {@link BatchedArrayCursor} providing batch-wise access to the cursor
    * result set.