chris
746868d720
git-subtree-dir: main-site git-subtree-mainline: 4d1daa39101c0a85ca6d916f1c31139faf39632a git-subtree-split: 5cefb4d1618bc54ae0e86830421a8c911900302c
93 lines
3.0 KiB
TypeScript
93 lines
3.0 KiB
TypeScript
import { type Document } from '../bson';
|
|
import { type Connection } from '../cmap/connection';
|
|
import { MongoDBResponse } from '../cmap/wire_protocol/responses';
|
|
import type { Collection } from '../collection';
|
|
import { CommandOperation, type CommandOperationOptions } from './command';
|
|
import { Aspect, defineAspects } from './operation';
|
|
|
|
/** @public */
|
|
export type DistinctOptions = CommandOperationOptions & {
|
|
/**
|
|
* @sinceServerVersion 7.1
|
|
*
|
|
* The index to use. Specify either the index name as a string or the index key pattern.
|
|
* If specified, then the query system will only consider plans using the hinted index.
|
|
*
|
|
* If provided as a string, `hint` must be index name for an index on the collection.
|
|
* If provided as an object, `hint` must be an index description for an index defined on the collection.
|
|
*
|
|
* See https://www.mongodb.com/docs/manual/reference/command/distinct/#command-fields.
|
|
*/
|
|
hint?: Document | string;
|
|
};
|
|
|
|
/**
|
|
* Return a list of distinct values for the given key across a collection.
|
|
* @internal
|
|
*/
|
|
export class DistinctOperation extends CommandOperation<any[] | Document> {
|
|
override SERVER_COMMAND_RESPONSE_TYPE = MongoDBResponse;
|
|
override options: DistinctOptions;
|
|
collection: Collection;
|
|
/** Field of the document to find distinct values for. */
|
|
key: string;
|
|
/** The query for filtering the set of documents to which we apply the distinct filter. */
|
|
query: Document;
|
|
|
|
/**
|
|
* Construct a Distinct operation.
|
|
*
|
|
* @param collection - Collection instance.
|
|
* @param key - Field of the document to find distinct values for.
|
|
* @param query - The query for filtering the set of documents to which we apply the distinct filter.
|
|
* @param options - Optional settings. See Collection.prototype.distinct for a list of options.
|
|
*/
|
|
constructor(collection: Collection, key: string, query: Document, options?: DistinctOptions) {
|
|
super(collection, options);
|
|
|
|
this.options = options ?? {};
|
|
this.collection = collection;
|
|
this.key = key;
|
|
this.query = query;
|
|
}
|
|
|
|
override get commandName() {
|
|
return 'distinct' as const;
|
|
}
|
|
|
|
override buildCommandDocument(_connection: Connection): Document {
|
|
const command: Document = {
|
|
distinct: this.collection.collectionName,
|
|
key: this.key,
|
|
query: this.query
|
|
};
|
|
// we check for undefined specifically here to allow falsy values
|
|
// eslint-disable-next-line no-restricted-syntax
|
|
if (this.options.comment !== undefined) {
|
|
command.comment = this.options.comment;
|
|
}
|
|
|
|
if (this.options.hint != null) {
|
|
command.hint = this.options.hint;
|
|
}
|
|
|
|
return command;
|
|
}
|
|
|
|
override handleOk(
|
|
response: InstanceType<typeof this.SERVER_COMMAND_RESPONSE_TYPE>
|
|
): any[] | Document {
|
|
if (this.explain) {
|
|
return response.toObject(this.bsonOptions);
|
|
}
|
|
return response.toObject(this.bsonOptions).values;
|
|
}
|
|
}
|
|
|
|
defineAspects(DistinctOperation, [
|
|
Aspect.READ_OPERATION,
|
|
Aspect.RETRYABLE,
|
|
Aspect.EXPLAINABLE,
|
|
Aspect.SUPPORTS_RAW_DATA
|
|
]);
|