Interface Backend

Hierarchy

Backend

Properties

cache

cache: Cache

connection

connection: any

errors

errors: CoreErrors

Methods

connect

connect(context: Context): Promise<boolean>

- Defined in lib/core/backend.ts:81
Parameters
- context: Context
Returns Promise<boolean>

createFullTextSearchIndex

createFullTextSearchIndex(context: Context, type: string, fields: string[]): Promise<void>

- Defined in lib/core/backend.ts:141
Parameters
- context: Context
- type: string
- fields: string[]
Returns Promise<void>

createTypeIndex

createTypeIndex(context: Context, fields: string[], type: string): Promise<void>

- Defined in lib/core/backend.ts:136
Parameters
- context: Context
- fields: string[]
- type: string
Returns Promise<void>

disconnect

disconnect(context: Context): Promise<void>

- Defined in lib/core/backend.ts:82
Parameters
- context: Context
Returns Promise<void>

drop

drop(context: Context): Promise<void>

- Defined in lib/core/backend.ts:83
Parameters
- context: Context
Returns Promise<void>

getElementById

getElementById<TContract>(context: Context, id: string): Promise<TContract>

- Defined in lib/core/backend.ts:103
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- id: string
Returns Promise<TContract>

getElementBySlug

getElementBySlug<TContract>(context: Context, slug: string, options: BackendOptions): Promise<TContract>

- Defined in lib/core/backend.ts:107
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- slug: string
- options: BackendOptions
Returns Promise<TContract>

getElementsById

getElementsById<TContract>(context: Context, ids: string[]): Promise<TContract[]>

- Defined in lib/core/backend.ts:112
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- ids: string[]
Returns Promise<TContract[]>

getStatus

getStatus(): Promise<BackendStatus>

- Defined in lib/core/backend.ts:135
Returns Promise<BackendStatus>

insertElement

insertElement<TContract>(context: Context, object: ContractDefinition<ContractData>): Promise<TContract>

- Defined in lib/core/backend.ts:85
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- object: ContractDefinition<ContractData>
Returns Promise<TContract>

prepareQueryForStream

prepareQueryForStream<TContract>(context: string, name: string, select: QuerySelect, schema: JsonSchema, options: QueryOptions): StreamQuery<TContract>

- Defined in lib/core/backend.ts:122
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: string
- name: string
- select: QuerySelect
- schema: JsonSchema
- options: QueryOptions
Returns StreamQuery<TContract>

query

query<TContract>(context: Context, select: QuerySelect, schema: JsonSchema, options: QueryOptions): Promise<TContract[]>

- Defined in lib/core/backend.ts:116
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- select: QuerySelect
- schema: JsonSchema
- options: QueryOptions
Returns Promise<TContract[]>

reset

reset(context: Context): Promise<void>

- Defined in lib/core/backend.ts:84
Parameters
- context: Context
Returns Promise<void>

stream

stream(context: Context, select: QuerySelect, schema: JsonSchema, options: QueryOptions): Promise<Stream>

- Defined in lib/core/backend.ts:129
Parameters
- context: Context
- select: QuerySelect
- schema: JsonSchema
- options: QueryOptions
Returns Promise<Stream>

upsertElement

upsertElement<TContract>(context: Context, object: ContractDefinition<ContractData>, options?: BackendOptions): Promise<TContract>

- Defined in lib/core/backend.ts:89
Type parameters
- TContract: Contract<ContractData, {}, TContract>
Parameters
- context: Context
- object: ContractDefinition<ContractData>
- Optional options: BackendOptions
Returns Promise<TContract>

withSerializableTransaction

withSerializableTransaction<TResult>(context: Context, callback: (transaction: any) => Promise<TResult>, options: TransactionOptions): Promise<TResult>

- Defined in lib/core/backend.ts:98
Type parameters
- TResult
Parameters
- context: Context
- callback: (transaction: any) => Promise<TResult>
  - - (transaction: any): Promise<TResult>
    - Parameters
      - transaction: any
      Returns Promise<TResult>
- options: TransactionOptions
Returns Promise<TResult>

withTransaction

withTransaction<TResult>(callback: (transaction: any) => Promise<TResult>, options: TransactionOptions): Promise<TResult>

- Defined in lib/core/backend.ts:94
Type parameters
- TResult
Parameters
- callback: (transaction: any) => Promise<TResult>
  - - (transaction: any): Promise<TResult>
    - Parameters
      - transaction: any
      Returns Promise<TResult>
- options: TransactionOptions
Returns Promise<TResult>

Generated using TypeDoc