Skip to main content

Class: SimpleMongoReader

Read in from MongoDB

Implements​

Constructors​

new SimpleMongoReader()​

new SimpleMongoReader(client): SimpleMongoReader

Parameters​

• client: MongoClient

Returns​

SimpleMongoReader

Source​

packages/core/src/readers/SimpleMongoReader.ts:12

Properties​

client​

private client: MongoClient

Source​

packages/core/src/readers/SimpleMongoReader.ts:10

Methods​

flatten()​

private flatten(texts): string[]

Flattens an array of strings or string arrays into a single-dimensional array of strings.

Parameters​

• texts: (string | string[])[]

The array of strings or string arrays to flatten.

Returns​

string[]

The flattened array of strings.

Source​

packages/core/src/readers/SimpleMongoReader.ts:21

loadData()​

loadData(dbName, collectionName, fieldNames, separator, filterQuery, maxDocs, metadataNames?): Promise <Document <Metadata>[]>

Loads data from MongoDB collection

Parameters​

• dbName: string

The name of the database to load.

• collectionName: string

The name of the collection to load.

• fieldNames: string[]= undefined

An array of field names to retrieve from each document. Defaults to ["text"].

• separator: string= ""

The separator to join multiple field values. Defaults to an empty string.

• filterQuery: Record<string, any>= {}

Specific query, as specified by MongoDB NodeJS documentation.

• maxDocs: number= 0

The maximum number of documents to retrieve. Defaults to 0 (retrieve all documents).

• metadataNames?: string[]

An optional array of metadata field names. If specified extracts this information as metadata.

Returns​

Promise <Document <Metadata>[]>

Implementation of​

BaseReader . loadData

Throws​

If a field specified in fieldNames or metadataNames is not found in a MongoDB document.

Source​

packages/core/src/readers/SimpleMongoReader.ts:41