Skip to main content

MongoParameters

@webda/mongo

Class: MongoParameters

Defined in: mongodb/src/mongodb.service.ts:19

MongoDB store parameters

Extends​

  • StoreParameters

Constructors​

Constructor​

new MongoParameters(): MongoParameters

Returns​

MongoParameters

Inherited from​

StoreParameters.constructor

Properties​

aggregationFallback?​

optional aggregationFallback?: "allow" | "warn" | "deny"

Defined in: core/lib/stores/store.d.ts:239

What to do when an aggregation on this store cannot run natively and must stream every matching object through memory

Default​

"warn"

Inherited from​

StoreParameters.aggregationFallback

collection​

collection: string

Defined in: mongodb/src/mongodb.service.ts:44

Which collection to use

All the models managed by the store share this collection, the __type field is used to differentiate them

database?​

optional database?: string

Defined in: mongodb/src/mongodb.service.ts:48

Database to use, default to the one defined in the URL

databaseOptions?​

optional databaseOptions?: DbOptions

Defined in: mongodb/src/mongodb.service.ts:54

Mongo Database Options

See​

https://www.npmjs.com/package/mongodb

maxGroups?​

optional maxGroups?: number

Defined in: core/lib/stores/store.d.ts:246

Maximum number of groups an aggregation may produce without LIMIT (or in memory)

Minimum​

1

Default​

10000

Inherited from​

StoreParameters.maxGroups

models?​

optional models?: string[]

Defined in: core/lib/stores/store.d.ts:204

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

Inherited from​

StoreParameters.models

mongoUrl?​

optional mongoUrl?: string | SecretString

Defined in: mongodb/src/mongodb.service.ts:27

Contains the URL to Mongo Server

Will try to use WEBDA_MONGO_URL environment variable if not defined

Can be encrypted with webda config encrypt

noCache?​

optional noCache?: boolean

Defined in: core/lib/stores/store.d.ts:265

Disable default memory cache

Inherited from​

StoreParameters.noCache

options?​

optional options?: any

Defined in: mongodb/src/mongodb.service.ts:37

Additional options for Mongo connetion

Should be typed with MongoClientOptions but not available due to bug in ts-json-schema-generator https://docs.mongodb.com/manual/reference/connection-string

Can be encrypted with webda config encrypt

Secret​

auth.password,tlsCertificateKeyFilePassword

slowQueryLogLevel?​

optional slowQueryLogLevel?: WorkerLogLevel

Defined in: core/lib/stores/store.d.ts:226

Log level used for slow queries

Default​

"WARN"

Inherited from​

StoreParameters.slowQueryLogLevel

slowQueryMaxLength?​

optional slowQueryMaxLength?: number

Defined in: core/lib/stores/store.d.ts:232

Maximum length of the query string written to logs / events (longer queries are truncated)

Default​

1024

Inherited from​

StoreParameters.slowQueryMaxLength

slowQueryThreshold?​

optional slowQueryThreshold?: number

Defined in: core/lib/stores/store.d.ts:220

Duration in ms above which a query is considered slow. Set to 0 to disable slow query detection.

Default​

30000

Inherited from​

StoreParameters.slowQueryThreshold

strict?​

optional strict?: boolean

Defined in: core/lib/stores/store.d.ts:213

Allow to load object that does not have the type data

If set to true, then the Store will only managed the defined _model and no model extending this one

Default​

false

Inherited from​

StoreParameters.strict

type​

type: string

Defined in: core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

StoreParameters.type

typeCheck?​

optional typeCheck?: object

Defined in: core/lib/stores/store.d.ts:250

Startup check of the stored types: one WARN listing the legacy, untyped and unknown types found

enabled?​

optional enabled?: boolean

Default​
true

maxRows?​

optional maxRows?: number

Rows scanned at most by stores without a native count; beyond, the counts are "at least"

Default​
10000

Inherited from​

StoreParameters.typeCheck

Methods​

load()​

load(params?): this

Defined in: mongodb/src/mongodb.service.ts:61

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

StoreParameters.load

update()​

update(params, delta): this

Defined in: core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

StoreParameters.update

with()​

with(callback): this

Defined in: core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

StoreParameters.with