remove index information utility

Author: baileympearson

src/collection.ts

@@ -24,7 +24,6 @@ import type {
 } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import { BulkWriteOperation } from './operations/bulk_write';
-import type { IndexInformationOptions } from './operations/common_functions';
 import { CountOperation, type CountOptions } from './operations/count';
 import { CountDocumentsOperation, type CountDocumentsOptions } from './operations/count_documents';
 import {
@@ -49,15 +48,15 @@ import {
   FindOneAndUpdateOperation,
   type FindOneAndUpdateOptions
 } from './operations/find_and_modify';
-import {
-  CreateIndexesOperation,
-  type CreateIndexesOptions,
-  type DropIndexesOptions,
-  DropIndexOperation,
-  type IndexDescription,
-  type IndexSpecification,
-  type ListIndexesOptions
+import type {
+  CreateIndexesOptions,
+  DropIndexesOptions,
+  IndexDescription,
+  IndexInformationOptions,
+  IndexSpecification,
+  ListIndexesOptions
 } from './operations/indexes';
+import { CreateIndexesOperation, DropIndexOperation } from './operations/indexes';
 import {
   InsertManyOperation,
   type InsertManyResult,

src/db.ts

@@ -11,7 +11,6 @@ import type { MongoClient, PkFactory } from './mongo_client';
 import type { TODO_NODE_3286 } from './mongo_types';
 import type { AggregateOptions } from './operations/aggregate';
 import { CollectionsOperation } from './operations/collections';
-import type { IndexInformationOptions } from './operations/common_functions';
 import {
   CreateCollectionOperation,
   type CreateCollectionOptions
@@ -23,7 +22,11 @@ import {
   type DropDatabaseOptions
 } from './operations/drop';
 import { executeOperation } from './operations/execute_operation';
-import { type CreateIndexesOptions, type IndexSpecification } from './operations/indexes';
+import type {
+  CreateIndexesOptions,
+  IndexInformationOptions,
+  IndexSpecification
+} from './operations/indexes';
 import type { CollectionInfo, ListCollectionsOptions } from './operations/list_collections';
 import { ProfilingLevelOperation, type ProfilingLevelOptions } from './operations/profiling_level';
 import { RemoveUserOperation, type RemoveUserOptions } from './operations/remove_user';

src/index.ts

@@ -447,7 +447,6 @@ export type {
   CommandOperationOptions,
   OperationParent
 } from './operations/command';
-export type { IndexInformationOptions } from './operations/common_functions';
 export type { CountOptions } from './operations/count';
 export type { CountDocumentsOptions } from './operations/count_documents';
 export type {
@@ -466,6 +465,7 @@ export type {
   FindOneAndReplaceOptions,
   FindOneAndUpdateOptions
 } from './operations/find_and_modify';
+export type { IndexInformationOptions } from './operations/indexes';
 export type {
   CreateIndexesOptions,
   DropIndexesOptions,

src/operations/common_functions.ts

@@ -1,47 +1,5 @@
 import type { Document } from '../bson';
 import type { Collection } from '../collection';
-import type { Db } from '../db';
-import type { ReadPreference } from '../read_preference';
-import type { ClientSession } from '../sessions';
-
-/** @public */
-export interface IndexInformationOptions {
-  full?: boolean;
-  readPreference?: ReadPreference;
-  session?: ClientSession;
-}
-/**
- * Retrieves this collections index info.
- *
- * @param db - The Db instance on which to retrieve the index info.
- * @param name - The name of the collection.
- */
-export async function indexInformation(db: Db, name: string): Promise<any>;
-export async function indexInformation(
-  db: Db,
-  name: string,
-  options?: IndexInformationOptions
-): Promise<any>;
-export async function indexInformation(
-  db: Db,
-  name: string,
-  options?: IndexInformationOptions
-): Promise<any> {
-  if (options == null) {
-    options = {};
-  }
-  // If we specified full information
-  const full = options.full == null ? false : options.full;
-  // Get the list of indexes of the specified collection
-  const indexes = await db.collection(name).listIndexes(options).toArray();
-  if (full) return indexes;
-
-  const info: Record<string, Array<[string, unknown]>> = {};
-  for (const index of indexes) {
-    info[index.name] = Object.entries(index.key);
-  }
-  return info;
-}
 
 export function maybeAddIdToDocuments(
   coll: Collection,

src/operations/indexes.ts

@@ -2,6 +2,7 @@ import type { Document } from '../bson';
 import type { Collection } from '../collection';
 import { MongoCompatibilityError } from '../error';
 import { type OneOrMore } from '../mongo_types';
+import { type ReadPreference } from '../read_preference';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
 import { isObject, maxWireVersion, type MongoDBNamespace } from '../utils';
@@ -70,6 +71,13 @@ export type IndexSpecification = OneOrMore<
   | Map<string, IndexDirection>
 >;
 
+/** @public */
+export interface IndexInformationOptions {
+  full?: boolean;
+  readPreference?: ReadPreference;
+  session?: ClientSession;
+}
+
 /** @public */
 export interface IndexDescription
   extends Pick<