Skip to main content

CosmosStoreParameters

@webda/azure

Class: CosmosStoreParameters

Defined in: azure/src/services/cosmos.service.ts:22

Cosmos DB NoSQL settings. All models in the store share a typed container.

Extends​

  • StoreParameters

Implements​

Constructors​

Constructor​

new CosmosStoreParameters(): CosmosStoreParameters

Returns​

CosmosStoreParameters

Inherited from​

StoreParameters.constructor

Properties​

aggregationFallback?​

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

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

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

clientId?​

optional clientId?: string

Defined in: azure/src/services/cosmos.service.ts:58

Client ID

Implementation of​

AzureServiceParameters.clientId

clientSecret?​

optional clientSecret?: string | SecretString

Defined in: azure/src/services/cosmos.service.ts:62

Client secret

Implementation of​

AzureServiceParameters.clientSecret

container​

container: string

Defined in: azure/src/services/cosmos.service.ts:38

Container

createIfNotExists​

createIfNotExists: boolean = false

Defined in: azure/src/services/cosmos.service.ts:46

Create if not exists

database​

database: string

Defined in: azure/src/services/cosmos.service.ts:34

Database

endpoint​

endpoint: string

Defined in: azure/src/services/cosmos.service.ts:26

Endpoint

Implementation of​

AzureServiceParameters.endpoint

key?​

optional key?: string | SecretString

Defined in: azure/src/services/cosmos.service.ts:30

Key

maxGroups?​

optional maxGroups?: number

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

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:246

Models managed by this Store.

Default​

["Webda/RegistryEntry"]

Inherited from​

StoreParameters.models

noCache?​

optional noCache?: boolean

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

Disable default memory cache

Inherited from​

StoreParameters.noCache

partitionKey​

partitionKey: string = "/id"

Defined in: azure/src/services/cosmos.service.ts:42

Partition key

slowQueryLogLevel?​

optional slowQueryLogLevel?: WorkerLogLevel

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

Log level used for slow queries

Default​

"WARN"

Inherited from​

StoreParameters.slowQueryLogLevel

slowQueryMaxLength?​

optional slowQueryMaxLength?: number

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

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:262

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:255

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

subscriptionId?​

optional subscriptionId?: string

Defined in: azure/src/services/cosmos.service.ts:66

Subscription ID

Implementation of​

AzureServiceParameters.subscriptionId

tenantId?​

optional tenantId?: string

Defined in: azure/src/services/cosmos.service.ts:54

Tenant ID

Implementation of​

AzureServiceParameters.tenantId

throughput?​

optional throughput?: number

Defined in: azure/src/services/cosmos.service.ts:50

Throughput

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:292

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

enabled?​

optional enabled?: boolean

Whether enabled is enabled

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: azure/src/services/cosmos.service.ts:72

Perform load.

Parameters​

params?​

any = {}

Returns​

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