Skip to content

Latest commit

 

History

History
127 lines (82 loc) · 4.56 KB

mongodb.md

File metadata and controls

127 lines (82 loc) · 4.56 KB
Raw

dbcp / Exports / mongodb

Module: mongodb

Table of contents

Variables

Functions

Variables

batch2

• Const batch2: any

Defined in: mongodb.ts:6

Functions

openMongoDb

▸ openMongoDb(args: { mongodb?: mongoDB.MongoClient ; name?: string ; tables?: string[] ; url?: string }): Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Parameters

Name Type
args object
args.mongodb? mongoDB.MongoClient
args.name? string
args.tables? string[]
args.url? string

Returns: Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Defined in: mongodb.ts:42

openMongoDbInput

▸ openMongoDbInput(args: { inputHost?: string ; inputMongodb?: mongoDB.MongoClient ; inputName?: string ; inputPassword?: string ; inputPort?: number ; inputTable?: string[] ; inputUser?: string }): Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Parameters

Name Type
args object
args.inputHost? string
args.inputMongodb? mongoDB.MongoClient
args.inputName? string
args.inputPassword? string
args.inputPort? number
args.inputTable? string[]
args.inputUser? string

Returns: Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Defined in: mongodb.ts:8

openMongoDbOutput

▸ openMongoDbOutput(args: { outputHost?: string ; outputMongodb?: mongoDB.MongoClient ; outputName?: string ; outputPassword?: string ; outputPort?: number ; outputTable?: string[] ; outputUser?: string }): Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Parameters

Name Type
args object
args.outputHost? string
args.outputMongodb? mongoDB.MongoClient
args.outputName? string
args.outputPassword? string
args.outputPort? number
args.outputTable? string[]
args.outputUser? string

Returns: Promise<{ close: () => Promise<void> ; db: MongoClient ; tables: Record<string, Collection<Document>> } | { close: () => Promise<void> ; db: Db ; tables: Record<string, Collection<Document>> }>

Defined in: mongodb.ts:25

streamFromMongoDb

▸ streamFromMongoDb(collection: mongoDB.Collection, args: { query?: string }): ReadableStreamTree

Parameters

Name Type
collection mongoDB.Collection
args object
args.query? string

Returns: ReadableStreamTree

Defined in: mongodb.ts:71

streamToMongoDb

▸ streamToMongoDb(collection: mongoDB.Collection, options?: { batchSize?: number }): WritableStreamTree

Parameters

Name Type
collection mongoDB.Collection
options? object
options.batchSize? number

Returns: WritableStreamTree

Defined in: mongodb.ts:77