Class MongodbConnector

A MongoDB data source: results come from a (collection, pipeline) pair, and introspection is sampling-based.

Implements

MongoConnector

Index

Constructors

Properties

database? engine id name

Methods

aggregate close connect introspect

Constructors

constructor

new MongodbConnector(config: MongodbConnectorConfig): MongodbConnector
Parameters
- config: MongodbConnectorConfig
Returns MongodbConnector
- Defined in index.ts:38

Properties

`Optional` `Readonly`database

database?: string

`Readonly`engine

engine: "mongodb" = ...

`Readonly`id

id: string

`Readonly`name

name: string

Methods

aggregate

aggregate(
    collection: string,
    pipeline: unknown[],
    opts?: ExecuteOptions,
): Promise<ResultSet>
Parameters
- collection: string
- pipeline: unknown[]
- Optionalopts: ExecuteOptions
Returns Promise<ResultSet>
Implementation of MongoConnector.aggregate
- Defined in index.ts:133

close

close(): Promise<void>
Returns Promise<void>
Implementation of MongoConnector.close
- Defined in index.ts:108

connect

connect(): Promise<void>
Returns Promise<void>
Implementation of MongoConnector.connect
- Defined in index.ts:82

introspect

introspect(): Promise<SchemaCatalog>
Returns Promise<SchemaCatalog>
Implementation of MongoConnector.introspect
- Defined in index.ts:121