@mongosh/service-provider-core - npm Package Compare versions

Comparing version 1.9.1 to 1.10.0

lib/admin.d.ts

@@ -13,2 +13,8 @@ import ShellAuthOptions from './shell-auth-options';
 }
+export interface CheckMetadataConsistencyOptions {
+    cursor?: {
+        batchSize: number;
+    };
+    checkIndexes?: 1;
+}
 export default interface Admin {
@@ -15,0 +21,0 @@ platform: ReplPlatform;

lib/all-transport-types.d.ts

@@ -1,1 +0,1 @@
-export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, Batch, BulkWriteOptions, BulkWriteResult, ChangeStream, ChangeStreamOptions, ClientSession, CloseOptions, CollationOptions, CollStatsOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyDescription, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient } from 'mongodb';
+export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, Batch, BulkWriteOptions, BulkWriteResult, ChangeStream, ChangeStreamOptions, ClientSession, CloseOptions, CollationOptions, CollStatsOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, RunCommandCursor, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyDescription, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient } from 'mongodb';

lib/index.d.ts

@@ -12,3 +12,3 @@ import './textencoder-polyfill';
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
-export { CreateEncryptedCollectionOptions } from './admin';
+export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions } from './admin';
 declare const bson: {
@@ -15,0 +15,0 @@ ObjectId: typeof ObjectId;

lib/readable.d.ts

@@ -16,2 +16,3 @@ import type { Document, AggregateOptions, CountOptions, CountDocumentsOptions, DistinctOptions, EstimatedDocumentCountOptions, FindOptions, ListCollectionsOptions, ListIndexesOptions, AggregationCursor, FindCursor, DbOptions, ReadPreferenceFromOptions, ReadPreferenceLike } from './all-transport-types';
     watch(pipeline: Document[], options: ChangeStreamOptions, dbOptions?: DbOptions, db?: string, coll?: string): ChangeStream<Document>;
+    getSearchIndexes(database: string, collection: string, indexName?: string, options?: Document, dbOptions?: DbOptions): Promise<Document[]>;
 }

lib/writable.d.ts

@@ -0,1 +1,2 @@
+import { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
 import type { Document, InsertOneOptions, InsertOneResult, Collection, RenameOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, BulkWriteOptions, AnyBulkWriteOperation, DeleteOptions, DeleteResult, InsertManyResult, ReplaceOptions, UpdateResult, UpdateOptions, DropDatabaseOptions, CreateIndexesOptions, DropCollectionOptions, BulkWriteResult, RunCommandOptions, DbOptions, OrderedBulkOperation, UnorderedBulkOperation } from './all-transport-types';
@@ -5,2 +6,3 @@ export default interface Writable {
     runCommandWithCheck(db: string, spec: Document, options: RunCommandOptions, dbOptions?: DbOptions): Promise<Document>;
+    runCursorCommand(db: string, spec: Document, options: RunCursorCommandOptions, dbOptions?: DbOptions): RunCommandCursor;
     dropDatabase(database: string, options: DropDatabaseOptions, dbOptions?: DbOptions): Promise<Document>;
@@ -22,2 +24,8 @@ bulkWrite(database: string, collection: string, requests: AnyBulkWriteOperation[], options: BulkWriteOptions, dbOptions?: DbOptions): Promise<BulkWriteResult>;
     initializeBulkOp(dbName: string, collName: string, ordered: boolean, options?: BulkWriteOptions, dbOptions?: DbOptions): Promise<OrderedBulkOperation | UnorderedBulkOperation>;
+    createSearchIndexes(database: string, collection: string, specs: {
+        name: string;
+        definition: Document;
+    }[], dbOptions?: DbOptions): Promise<string[]>;
+    dropSearchIndex(database: string, collection: string, index: string, dbOptions?: DbOptions): Promise<void>;
+    updateSearchIndex(database: string, collection: string, index: string, definition: Document, dbOptions?: DbOptions): Promise<void>;
 }

package.json

 {
   "name": "@mongosh/service-provider-core",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "description": "MongoDB Shell Core Service Provider Package",
@@ -40,6 +40,6 @@ "main": "lib/index.js",
   "dependencies": {
-    "@aws-sdk/credential-providers": "^3.262.0",
-    "@mongosh/errors": "1.9.1",
+    "@aws-sdk/credential-providers": "^3.347.1",
+    "@mongosh/errors": "1.10.0",
     "bson": "^5.2.0",
-    "mongodb": "^5.5.0",
+    "mongodb": "^5.6.0",
     "mongodb-build-info": "^1.5.0",
@@ -62,3 +62,3 @@ "mongodb-client-encryption": "^2.8.0"
   },
-  "gitHead": "c9140a8ad23bd670fb66aff4fc8753306156856b"
+  "gitHead": "6a6f97712a596a21c61408dfb925e729306030f8"
 }

src/admin.ts

@@ -33,2 +33,9 @@ import ShellAuthOptions from './shell-auth-options';
 
+export interface CheckMetadataConsistencyOptions {
+  cursor?: {
+      batchSize: number
+  },
+  checkIndexes?: 1
+}
+
 export default interface Admin {
@@ -35,0 +42,0 @@ /**

src/all-transport-types.ts

@@ -24,2 +24,3 @@ export type {
   CursorFlag,
+  RunCommandCursor,
   Db,
@@ -26,0 +27,0 @@ DbOptions,

src/index.ts

@@ -30,3 +30,3 @@ import './textencoder-polyfill'; // for mongodb-connection-string-url in the java-shell
 
-export { CreateEncryptedCollectionOptions } from './admin';
+export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions } from './admin';
 
@@ -33,0 +33,0 @@ const bson = {

src/readable.ts

@@ -15,3 +15,3 @@ import type {
   ReadPreferenceFromOptions,
-  ReadPreferenceLike
+  ReadPreferenceLike,
 } from './all-transport-types';
@@ -210,3 +210,22 @@ import { ChangeStream, ChangeStreamOptions } from './all-transport-types';
   ): ChangeStream<Document>;
+
+  /**
+   * Returns an array of documents that identify and describe the existing
+   * search indexes on the collection.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {Document} options - The command options.
+   * @param {DbOptions} dbOptions - The database options
+   *
+   * @return {Promise}
+   */
+  getSearchIndexes(
+    database: string,
+    collection: string,
+    indexName?: string,
+    // TODO(MONGOSH-1471): use ListSearchIndexesOptions once available
+    options?: Document,
+    dbOptions?: DbOptions): Promise<Document[]>;
 }
 

src/writable.ts

@@ -0,1 +1,2 @@
+import { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
 import type {
@@ -62,2 +63,16 @@ Document,
   /**
+   * @param {String} db - the db name
+   * @param spec
+   * @param options
+   * @param {DbOptions} dbOptions - The database options
+   * @return {Promise<Document>}
+   */
+  runCursorCommand(
+    db: string,
+    spec: Document,
+    options: RunCursorCommandOptions,
+    dbOptions?: DbOptions
+  ): RunCommandCursor;
+
+  /**
    * Drop a database
@@ -349,3 +364,52 @@ *
   ): Promise<OrderedBulkOperation | UnorderedBulkOperation>;
+
+  /**
+   * Adds new search indexes to a collection.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {Object[]} descriptions - The specs of the indexes to be created.
+   * @param {DbOptions} dbOptions - The database options
+  */
+  createSearchIndexes(
+    database: string,
+    collection: string,
+    // TODO(MONGOSH-1471): use SearchIndexDescription[] once available
+    specs: {name: string, definition: Document}[],
+    dbOptions?: DbOptions
+  ): Promise<string[]>
+
+  /**
+   * Drops a search index.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {String} indexName - The index name
+   * @param {DbOptions} dbOptions - The database options
+  */
+  dropSearchIndex(
+    database: string,
+    collection: string,
+    index: string,
+    dbOptions?: DbOptions
+  ): Promise<void>
+
+  /**
+   * Update a search index.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {String} indexName - The index name.
+   * @param {Object} description - The update.
+   * @param {DbOptions} dbOptions - The database options
+  */
+  updateSearchIndex(
+    database: string,
+    collection: string,
+    index: string,
+    // TODO(MONGOSH-1471): use SearchIndexDescription once available
+    definition: Document,
+    dbOptions?: DbOptions
+  ): Promise<void>
 }
 

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

86468

increased by4.27%

Lines of code

1824

increased by5.8%

Dependency changes

• + Added@mongosh/errors@1.10.0(transitive)

• - Removed@mongosh/errors@1.9.1(transitive)

• Updated@aws-sdk/credential-providers@^3.347.1

• Updated@mongosh/errors@1.10.0

• Updatedmongodb@^5.6.0