odatafy-mongodb

Index

Type Aliases

MongoDBODatafyOpts

Functions

Type Aliases

MongoDBODatafyOpts

MongoDBODatafyOpts: { expandMapping?: CollectionMap; regexSearchFields?: string[]; returnCountOnly?: boolean; returnDataCountQuery?: boolean; returnEmptyPipeline?: boolean }

Type declaration

Optional expandMapping?: CollectionMap
Optional regexSearchFields?: string[]
Optional returnCountOnly?: boolean
Optional returnDataCountQuery?: boolean
Optional returnEmptyPipeline?: boolean

Functions

getQuery

getQuery(parameters: oDataParameters, opts?: MongoDBODatafyOpts): Document[]

- Defined in src/mongodbGenerator.ts:72
Get a MongoDB based on oData url paramaters

Parameters
- parameters: oDataParameters
  
  parameters
- Optional opts: MongoDBODatafyOpts
  
  options for getting the url
Returns Document[]
MongoDB aggregaion pipeline

getQueryFromUrl

getQueryFromUrl(oDataUrl: string, opts?: MongoDBODatafyOpts): Document[]

- Defined in src/mongodbGenerator.ts:29
Get MongoDB aggregation query from a given url can be obtained by nodes req.url

Parameters
- oDataUrl: string
  
  the url format ?param=value
- Optional opts: MongoDBODatafyOpts
  
  options for getting the url
Returns Document[]
MongoDB aggregation query

Generated using TypeDoc