Interface MongoConnector

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

interface MongoConnector {
    database?: string;
    engine: "mongodb";
    id: string;
    name: string;
    aggregate(
        collection: string,
        pipeline: unknown[],
        opts?: ExecuteOptions,
    ): Promise<ResultSet>;
    close(): Promise<void>;
    connect(): Promise<void>;
    introspect(): Promise<SchemaCatalog>;
}

Implemented by

MongodbConnector

Index

Properties

database? engine id name

Methods

aggregate close connect introspect

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>
- Defined in packages/core/src/mongo/engine.ts:79

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/mongo/engine.ts:77

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/mongo/engine.ts:76

introspect

introspect(): Promise<SchemaCatalog>
Returns Promise<SchemaCatalog>
- Defined in packages/core/src/mongo/engine.ts:78