odatafy-mongodb
Version:
convert oData requests through odatafy to MongoDB queries
25 lines (24 loc) • 937 B
TypeScript
import { CollectionMap } from "./lookupGenerator";
import { oDataParameters } from "odatafy-parser";
import { Document } from "mongodb";
export type MongoDBODatafyOpts = {
expandMapping?: CollectionMap;
returnEmptyPipeline?: boolean;
regexSearchFields?: string[];
returnDataCountQuery?: boolean;
returnCountOnly?: boolean;
};
/**
* Get MongoDB aggregation query from a given url can be obtained by nodes req.url
* @param oDataUrl - the url format ?param=value
* @param opts options for getting the url
* @returns MongoDB aggregation query
*/
export declare function getQueryFromUrl(oDataUrl: string, opts?: MongoDBODatafyOpts): Document[];
/**
* Get a MongoDB based on oData url paramaters
* @param parameters parameters
* @param opts options for getting the url
* @returns MongoDB aggregaion pipeline
*/
export declare function getQuery(parameters: oDataParameters, opts?: MongoDBODatafyOpts): Document[];