Module

x/mongo/src/types.ts

MongoDB driver for Deno
Extremely Popular
Go to Latest
File
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863
import { Bson } from "../deps.ts";import { WriteConcern } from "./types/read_write_concern.ts";
export type Document = Bson.Document;
export interface Server { host: string; port: number; domainSocket?: string;}
export interface ConnectOptions { compression?: string[]; certFile?: string; keyFile?: string; keyFilePassword?: string; tls?: boolean; safe?: boolean; credential?: Credential; db: string; servers: Server[]; retryWrites?: boolean; appname?: string;}
export interface CountOptions { limit?: number; skip?: number; hint?: Document | string; comment?: Document; readConcern?: Document; collation?: Document;}
export interface FindOptions { findOne?: boolean; skip?: number; limit?: number; projection?: Document; sort?: Document; noCursorTimeout?: boolean;}
export interface ListDatabaseInfo { name: string; sizeOnDisk?: number; empty?: false;}
export interface InsertOptions { /** * Optional. If true, then when an insert of a document fails, return without inserting any remaining documents listed in the inserts array. * If false, then when an insert of a document fails, continue to insert the remaining documents. Defaults to true. */ ordered?: boolean;
/** * Optional. A document that expresses the write concern of the insert command. Omit to use the default write concern. * Do not explicitly set the write concern for the operation if run in a transaction. To use write concern with transactions, see Transactions and Write Concern. */ writeConcern?: Document;
/** * Optional. Enables insert to bypass document validation during the operation. This lets you insert documents that do not meet the validation requirements. */ bypassDocumentValidation?: boolean;
/** * Optional. A user-provided comment to attach to this command. */ comment?: Document;}export interface UpdateOptions { /** * Optional. A document expressing the write concern of the update command. Omit to use the default write concern. */ writeConcern?: Document;
/** * Optional. If true, then when an update statement fails, return without performing the remaining update statements. * If false, then when an update fails, continue with the remaining update statements, if any. Defaults to true. */ ordered?: boolean;
/** * Optional. If true, updates all documents that meet the query criteria. * If false, limit the update to one document that meet the query criteria. Defaults to false. */ multi?: boolean;
/** * optional list of array filters referenced in filtered positional operators */ arrayFilters?: Document[];
/** * Specify collation (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields). */ collation?: Document;
/** * Allow driver to bypass schema validation in MongoDB 3.2 or higher */ bypassDocumentValidation?: boolean;
/** * An optional hint for query optimization. See the update (https://docs.mongodb.com/manual/reference/command/update/#update-command-hint) command reference for more information. */ hint?: Document;
/** * When true, creates a new document if no document matches the query. */ upsert?: boolean;
/** * The write concern timeout. */ wtimeout?: number;
/** * If true, will throw if bson documents start with $ or include a . in any key value */ checkKeys?: boolean;
/** * Serialize functions on any object. */ serializeFunctions?: boolean;
/** * Specify if the BSON serializer should ignore undefined fields. */ ignoreUndefined?: boolean;
/** * Optional. A user-provided comment to attach to this command. */ comment?: Document;
/** * optional session to use for this operation */ // session?: ClientSession}
/** * Options for controlling the collation of strings in a query * * @see https://docs.mongodb.com/manual/reference/collation/ */export interface CollationOptions { locale: string; caseLevel?: boolean; caseFirst?: string; strength?: number; numericOrdering?: boolean; alternate?: string; maxVariable?: string; backwards?: boolean;}
/** * Options for the findAndModify operation * * @see https://docs.mongodb.com/manual/reference/method/db.collection.findAndModify/ */export interface FindAndModifyOptions<T = Document> { /** * Control the order in which documents are found. * findAndModify only modifies the first document found, so controlling the * sort order may ensure, that the right document is first */ sort?: Document; /** * The update to execute on the found document. * * Either update or remove have to be specified */ update?: UpdateFilter<T>; /** * Remove the found document */ remove?: boolean; /** * Return the new state after the update */ new?: boolean; /** * the fields to return. */ fields?: Document; /** * perform an upsert, i.e. update if a document matches, insert otherwise. */ upsert?: boolean; /** * do not validate the document during the operation */ bypassDocumentValidation?: boolean; /** * The write concern to apply to the write operation */ writeConcern?: WriteConcern; /** * The collation options to apply to string handling (e.g. during sort) */ collation?: CollationOptions; /** * Filters determining which elements to modify in an array, when modifying * array values */ arrayFilters?: Document[]; /** * The maximum time of milliseconds the operation is allowed to take */ maxTimeMS?: number;}
export interface DeleteOptions { /** * Optional. If true, then when a delete statement fails, return without performing the remaining delete statements. * If false, then when a delete statement fails, continue with the remaining delete statements, if any. Defaults to true. */ ordered?: boolean;
/** * Optional. A document expressing the write concern of the delete command. Omit to use the default write concern. */ writeConcern?: Document;
/** * Optional. Specifies the collation to use for the operation. * See https://docs.mongodb.com/manual/reference/command/delete/#deletes-array-collation */ collation?: Document;
/** * Optional. A user-provided comment to attach to this command. */ comment?: Document;
/** * The number of matching documents to delete. Specify either a 0 to delete all matching documents or 1 to delete a single document. */ limit?: number;
/** * Optional. A document or string that specifies the index to use to support the query predicate. * The option can take an index specification document or the index name string. * If you specify an index that does not exist, the operation errors. */ hint?: Document | string;}
export interface DropOptions { /** * Optional. A document expressing the write concern of the drop command. Omit to use the default write concern. */ writeConcern?: Document;
/** * Optional. A user-provided comment to attach to this command. */ // deno-lint-ignore no-explicit-any comment?: any;}
export interface DistinctOptions { /** * The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). */ readPreference?: string; /** * Number of milliseconds to wait before aborting the query. */ maxTimeMS?: number; /** * pecify collation settings for operation. See aggregation documentation(https://docs.mongodb.com/manual/reference/command/aggregate). */ collation?: Document; /** * optional session to use for this operation */ // session?:ClientSession;}
export interface AggregateOptions { /** * The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST). */ readPreference?: string; /** * @default 1000 * The number of documents to return per batch. See aggregation documentation(https://docs.mongodb.com/manual/reference/command/aggregate). */ batchSize?: number; /** * @default false * Explain returns the aggregation execution plan (requires mongodb 2.6 >). */ explain?: boolean; /** * @default false * allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >). */ allowDiskUse?: boolean; /** * maxTimeMS specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point. */ maxTimeMS?: number; /** * @default false * Allow driver to bypass schema validation in MongoDB 3.2 or higher. */ bypassDocumentValidation?: boolean; /** * @default false * Return document results as raw BSON buffers. */ raw?: boolean; /** * @default true * Promotes Long values to number if they fit inside the 53 bits resolution. */ promoteLongs?: boolean; /** * @default true * Promotes BSON values to native types where possible, set to false to only receive wrapper types. */ promoteValues?: boolean; /** * @default false * Promotes Binary BSON values to native Node Buffers. */ promoteBuffers?: boolean; /** * Specify collation settings for operation. See aggregation documentation(https://docs.mongodb.com/manual/reference/command/aggregate). */ collation?: Document; /** * Add a comment to an aggregation command */ comment?: string; /** * Add an index selection hint to an aggregation command */ hint?: string | Document; /** * optional session to use for this operation */ // session?:ClientSession;}
export interface CreateUserOptions { /** * The name of the new user. */ username?: string;
/** * The user’s password. The pwd field is not required if you run createUser on the $external database to create users who have credentials stored externally to MongoDB. */ password?: string;
/** * Optional. Any arbitrary information. This field can be used to store any data an admin wishes to associate with this particular user. For example, this could be the user’s full name or employee id. */ customData?: Document;
/** * The roles granted to the user. Can specify an empty array [] to create users without roles. */ roles?: (string | { role: string; db: string; })[];
/** * Optional. Indicates whether the server or the client digests the password. * See https://docs.mongodb.com/manual/reference/command/createUser/#dbcmd.createUser */ digestPassword?: boolean;
/** * Optional. The level of write concern for the creation operation. The writeConcern document takes the same fields as the getLastError command. */ writeConcern?: Document;
/** * Optional. The authentication restrictions the server enforces on the created user. Specifies a list of IP addresses and CIDR ranges from which the user is allowed to connect to the server or from which the server can accept users. */ authenticationRestrictions?: Document[];
/** * Optional. Specify the specific SCRAM mechanism or mechanisms for creating SCRAM user credentials. */ mechanisms?: ("SCRAM-SHA-1" | "SCRAM-SHA-256")[];
/** * Optional. A user-provided comment to attach to this command. */ comment?: Document;}
export interface Credential { /** * The username to authenticate with. This applies to all mechanisms but may be omitted when authenticating via MONGODB-X509. */ username?: string;
/** * The password to authenticate with. This does not apply to all mechanisms. */ password?: string;
/** * The database used to authenticate. This applies to all mechanisms and defaults to "admin" in SCRAM authentication mechanisms and "$external" for GSSAPI, MONGODB-X509 and PLAIN. */ db?: string;
/** * Which authentication mechanism to use. If not provided, one will be negotiated with the server. */ mechanism?: "SCRAM-SHA-1" | "SCRAM-SHA-256" | "MONGODB-X509";}
export interface IndexOptions { /** * Specifies the index’s fields. For each field, specify a key-value pair in which * the key is the name of the field to index and the value is either the index direction * or index type. If specifying direction, specify 1 for ascending or -1 for descending. */ key: Document;
/** * A name that uniquely identifies the index. */ name: string;
/** * Optional. Deprecated in MongoDB 4.2. */ background?: boolean;
/** * Optional. Creates a unique index so that the collection will not accept insertion * or update of documents where the index key value matches an existing value in the index. * Specify true to create a unique index. The default value is false. */ unique?: boolean;
/** * Optional. If specified, the index only references documents that match the filter expression. * See Partial Indexes for more information. */ partialFilterExpression?: Document;
/** * Optional. If true, the index only references documents with the specified field. * These indexes use less space but behave differently in some situations (particularly sorts). * The default value is false. See Sparse Indexes for more information. */ sparse?: boolean;
/** * Optional. Specifies a value, in seconds, as a TTL to control how long MongoDB retains * documents in this collection. See Expire Data from Collections by Setting TTL for * more information on this functionality. This applies only to TTL indexes. */ expireAfterSeconds?: number;
/** * Optional. A flag that determines whether the index is hidden from the query planner. * A hidden index is not evaluated as part of query plan selection. Default is false. */ hidden?: boolean;
/** * Optional. Allows users to configure the storage engine on a per-index basis when creating an index. */ storageEngine?: Document;
/** * Optional. For text indexes, a document that contains field and weight pairs. * The weight is an integer ranging from 1 to 99,999 and denotes the significance * of the field relative to the other indexed fields in terms of the score. * You can specify weights for some or all the indexed fields. * See Control Search Results with Weights to adjust the scores. * The default value is 1. */ weights?: Document;
/** * Optional. For text indexes, the language that determines the list of * stop words and the rules for the stemmer and tokenizer. * See Text Search Languages for the available languages and Specify a Language * for Text Index for more information and examples. The default value is english. */ // deno-lint-ignore camelcase default_language?: string;
/** * Optional. For text indexes, the name of the field, in the collection’s documents, * that contains the override language for the document. The default value is language. * See Use any Field to Specify the Language for a Document for an example. */ // deno-lint-ignore camelcase language_override?: string;
/** * Optional. The text index version number. Users can use this option to override the default version number. */ textIndexVersion?: number;
/** * Optional. The 2dsphere index version number. Users can use this option to override the default version number. */ "2dsphereIndexVersion"?: number;
/** * Optional. For 2d indexes, the number of precision of the stored geohash value of the location data. * The bits value ranges from 1 to 32 inclusive. The default value is 26. */ bits?: number;
/** * Optional. For 2d indexes, the lower inclusive boundary for the longitude and latitude values. The default value is -180.0. */ min?: number;
/** * Optional. For 2d indexes, the upper inclusive boundary for the longitude and latitude values. The default value is 180.0. */ max?: number;
/** * For geoHaystack indexes, specify the number of units within which to group the location values; * i.e. group in the same bucket those location values that are within the specified number * of units to each other. The value must be greater than 0. */ bucketSize?: number;
/** * Optional. Specifies the collation for the index. */ collation?: Document;
/** * Allows users to include or exclude specific field paths from a wildcard index using * the { "$**" : 1} key pattern. This option is only valid if creating a wildcard index * on all document fields. You cannot specify this option if creating a wildcard index * on a specific field path and its subfields, e.g. { "path.to.field.$**" : 1 } */ wildcardProjection?: Document;}
export interface CreateIndexOptions { /** * Specifies the indexes to create. Each document in the array specifies a separate index. */ indexes: IndexOptions[];
/** Optional. A document expressing the write concern. Omit to use the default write concern. */ writeConcern?: Document;
/** * Optional. The minimum number of data-bearing voting replica set members (i.e. commit quorum), * including the primary, that must report a successful index build before the primary marks the indexes as ready. * A “voting” member is any replica set member where members[n].votes is greater than 0. */ commitQuorum?: number | string;
/** Optional. A user-provided comment to attach to this command. Once set */ comment?: Document;}
export interface DropIndexOptions { /** * Specifies the indexes to drop. * To drop all but the _id index from the collection, specify "*". * To drop a single index, specify either the index name, the index specification document (unless the index is a text index), or an array of the index name. * To drop a text index, specify the index names instead of the index specification document. * To drop multiple indexes (Available starting in MongoDB 4.2), specify an array of the index names. * See https://docs.mongodb.com/manual/reference/command/dropIndexes/#mongodb-dbcommand-dbcmd.dropIndexes */ index: string | IndexOptions | string[];
/** Optional. A document expressing the write concern. Omit to use the default write concern. */ writeConcern?: Document;
/** Optional. A user-provided comment to attach to this command. Once set */ comment?: Document;}
type BitwiseType = Bson.Binary | Array<number> | number;
type IntegerType = number | Bson.Int32 | Bson.Long;
type NumericType = IntegerType | Bson.Decimal128 | Bson.Double;
interface RootFilterOperators<T> extends Document { $and?: Filter<T>[]; $nor?: Filter<T>[]; $or?: Filter<T>[]; $text?: { $search: string; $language?: string; $caseSensitive?: boolean; $diacriticSensitive?: boolean; }; $where?: string; $comment?: string | Document;}
/** * Operators for use in the search query. * * @see https://docs.mongodb.com/manual/reference/operator/query/ */interface FilterOperators<TValue> extends Document { $eq?: TValue; $gt?: TValue; $gte?: TValue; $in?: Array<TValue>; $lt?: TValue; $lte?: TValue; $ne?: TValue; $nin?: TValue extends (infer T)[] ? T[] : Array<TValue>; $not?: FilterOperators<TValue>; $exists?: boolean; $expr?: Document; $jsonSchema?: Document; $mod?: TValue extends number ? [number, number] : never; $regex?: string | RegExp | Bson.BSONRegExp; $geoIntersects?: { $geometry: Document }; $geoWithin?: Document; $near?: Document; $nearSphere?: TValue; // deno-lint-ignore no-explicit-any $all?: Array<any>; // deno-lint-ignore no-explicit-any $size?: TValue extends Array<any> ? number : never; $bitsAllClear?: BitwiseType; $bitsAllSet?: BitwiseType; $bitsAnyClear?: BitwiseType; $elemMatch?: Document; $rand?: Record<string, never>;}
/** * Operators for use in the update query. * * @see https://docs.mongodb.com/manual/reference/operator/update/ */interface UpdateOperators<T> extends Document { $currentDate?: DocumentOperator< T, Bson.Timestamp | Date, true | { $type: "date" | "timestamp" } >; $inc?: DocumentOperator<T, NumericType>; $min?: DocumentOperator<T>; $max?: DocumentOperator<T>; $mul?: DocumentOperator<T, NumericType>; $rename?: DocumentOperator<Omit<T, "_id">, string>; $set?: DocumentOperator<T>; $setOnInsert?: DocumentOperator<T>; // deno-lint-ignore no-explicit-any $unset?: DocumentOperator<T, any, "" | true | 1>; // deno-lint-ignore no-explicit-any $pop?: DocumentOperator<T, Array<any>, (1 | -1)>; $pull?: { // deno-lint-ignore no-explicit-any [Key in KeysOfType<T, Array<any>>]?: | Flatten<T[Key]> | FilterOperators<Flatten<T[Key]>>; }; $pullAll?: { // deno-lint-ignore no-explicit-any [Key in KeysOfType<T, Array<any>>]?: T[Key]; }; $push?: { // deno-lint-ignore no-explicit-any [Key in KeysOfType<T, Array<any>>]?: { $each?: T[Key]; $slice?: number; $position?: number; $sort?: 1 | -1; }; }; $bit?: DocumentOperator< T, NumericType, { and: IntegerType } | { or: IntegerType } | { xor: IntegerType } >;}
/** * Operators for use in the aggregation query. * * @see https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/ */type AggregateOperators = | "$addFields" | "$bucket" | "$bucketAuto" | "$collStats" | "$count" | "$currentOp" | "$facet" | "$geoNear" | "$graphLookup" | "$group" | "$indexStats" | "$limit" | "$listLocalSessions" | "$listSessions" | "$lookup" | "$match" | "$merge" | "$out" | "$planCacheStats" | "$project" | "$redact" | "$replaceRoot" | "$replaceWith" | "$sample" | "$search" | "$set" | "$setWindowFields" | "$skip" | "$sort" | "$sortByCount" | "$unset" | "$unwind";
// deno-lint-ignore no-explicit-anytype DocumentOperator<T, OnlyType = any, Value = OnlyType> = IsAny< OnlyType, (Partial<T> & Document), { [key in KeysOfType<T, OnlyType>]?: Value; }>;
// deno-lint-ignore no-explicit-anytype NotImplementedOperators<Operators extends string, Value = any> = { [Key in Operators]?: Value;};
export type Filter<T> = & NotImplementedOperators<"$type"> & RootFilterOperators<T> & { [Key in keyof T]?: T[Key] | FilterOperators<T[Key]>; };
export type UpdateFilter<T> = & NotImplementedOperators<"$addToSet"> & UpdateOperators<T> & Partial<T>;
export type AggregatePipeline<T> = & NotImplementedOperators<AggregateOperators> & Document & { ["$match"]?: Filter<T>; };
type Flatten<T> = T extends Array<infer Item> ? Item : T;
type IsAny<T, Y, N> = 0 extends (1 & T) ? Y : N;
// deno-lint-ignore no-explicit-anyexport type InsertDocument<TDocument extends { _id?: any }> = & Omit<TDocument, "_id"> & { _id?: TDocument["_id"] | Bson.ObjectId; };
type KeysOfType<T, Type> = { [Key in keyof T]: NonNullable<T[Key]> extends Type ? Key : never;}[keyof T];
/** The document returned by the buildInfo command. */export interface BuildInfo { /** * A string that conveys version information about the `mongod` instance. * If you need to present version information to a human, this field is preferable to `versionArray`. * * This string will take the format `<major>.<minor>.<patch>` in the case of a release, * but development builds may contain additional information. */ version: string;
/** The commit identifier that identifies the state of the code used to build the mongod. */ gitVersion: string;
/** * @deprecated since 3.2 * `buildInfo.sysInfo` no longer contains useful information. */ sysInfo: string;
loaderFlags: string;
compilerFlags: string;
/** * The memory allocator that mongod uses. By default this is tcmalloc. */ allocator: string;
/** * An array that conveys version information about the mongod instance. * See version for a more readable version of this string. */ versionArray: number[];
/** * An embedded document describing the version of the TLS/SSL library that mongod * was built with and is currently using. */ openssl: Document;
/** * A string that reports the JavaScript engine used in the mongod instance. * By default, this is mozjs after version 3.2, and previously V8. */ javascriptEngine: string;
/** * A number that reflects the target processor architecture of the mongod binary. */ bits: number;
/** * A boolean. true when built with debugging options. */ debug: boolean;
/** * A number that reports the Maximum BSON Document Size. */ maxBsonObjectSize: number;
/** * A list of storage engines available to the mongod server. */ storageEngines: string[];
ok: number;}
export const enum ReadPreference { Primary = "primary", PrimaryPreferred = "primaryPreferred", Secondary = "secondary", SecondaryPreferred = "secondaryPreferred", Nearest = "nearest",}