Skip to main content

@webda/postgres • Readme | API

Class: PostgresParameters

Extends​

Constructors​

new PostgresParameters(params, store)​

new PostgresParameters(params, store): PostgresParameters

Parameters​

• params: any

• store: PostgresStore<CoreModel, PostgresParameters>

Returns​

PostgresParameters

Overrides​

SQLStoreParameters.constructor

Source​

postgres/src/postgresstore.ts:45

Properties​

additionalModels?​

additionalModels?: string[]

Additional models

Allow this store to manage other models

Default​

[]

Inherited from​

SQLStoreParameters.additionalModels

Source​

core/lib/stores/store.d.ts:388

asyncDelete​

asyncDelete: boolean

async delete

Inherited from​

SQLStoreParameters.asyncDelete

Source​

core/lib/stores/store.d.ts:392

autoCreateTable?​

autoCreateTable?: boolean

Auto create table if not exists

Default​

true

Source​

postgres/src/postgresstore.ts:33

database​

database: SQLDatabase

Inherited from​

SQLStoreParameters.database

Source​

postgres/src/sqlstore.ts:17

defaultModel?​

defaultModel?: boolean

When __type model not found, use the model If strict is setup this parameter is not used

Default​

true

Inherited from​

SQLStoreParameters.defaultModel

Source​

core/lib/stores/store.d.ts:414

expose?​

expose?: StoreExposeParameters

Expose the service to an urls

Deprecated​

will probably be removed in 4.0 in favor of Expose annotation

Inherited from​

SQLStoreParameters.expose

Source​

core/lib/stores/store.d.ts:398

forceModel?​

forceModel?: boolean

If set, Store will ignore the __type

Default​

false

Inherited from​

SQLStoreParameters.forceModel

Source​

core/lib/stores/store.d.ts:420

model?​

model?: string

Webda model to use within the Store

Default​

"Webda/CoreModel"

Inherited from​

SQLStoreParameters.model

Source​

core/lib/stores/store.d.ts:380

modelAliases?​

modelAliases?: Object

Model Aliases to allow easier rename of Model

Index signature​

[key: string]: string

Inherited from​

SQLStoreParameters.modelAliases

Source​

core/lib/stores/store.d.ts:430

noCache?​

noCache?: boolean

Disable default memory cache

Inherited from​

SQLStoreParameters.noCache

Source​

core/lib/stores/store.d.ts:436

openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

SQLStoreParameters.openapi

Source​

core/lib/services/service.d.ts:104

postgresqlServer?​

postgresqlServer?: ClientConfig | PoolConfig

By default use environment variables

Source​

postgres/src/postgresstore.ts:28

slowQueryThreshold​

slowQueryThreshold: number

Slow query threshold

Default​

30000

Inherited from​

SQLStoreParameters.slowQueryThreshold

Source​

core/lib/stores/store.d.ts:426

strict?​

strict?: boolean

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​

SQLStoreParameters.strict

Source​

core/lib/stores/store.d.ts:407

table​

table: string

Inherited from​

SQLStoreParameters.table

Source​

postgres/src/sqlstore.ts:16

type​

type: string

Type of the service

Inherited from​

SQLStoreParameters.type

Source​

core/lib/services/service.d.ts:95

url?​

url?: string

URL on which to serve the content

Inherited from​

SQLStoreParameters.url

Source​

core/lib/services/service.d.ts:99

usePool?​

usePool?: boolean

Default​

true

Source​

postgres/src/postgresstore.ts:24

viewPrefix?​

viewPrefix?: string

View name prefix

Source​

postgres/src/postgresstore.ts:37

views?​

views?: string[]

Regexp of models to include

Default​

[".*"]

Source​

postgres/src/postgresstore.ts:43