Class Metamodel

This base class provides an lock interface to execute exclusive operations

Hierarchy

Lockable
- Metamodel

Index

Constructors

constructor

new Metamodel(entityManagerFactory: EntityManagerFactory): Metamodel
Constructs a new metamodel instance which represents the complete schema of one baqend app
Parameters
- entityManagerFactory: EntityManagerFactory
Returns Metamodel
Overrides Lockable.constructor
- Defined in lib/metamodel/Metamodel.ts:36

Properties

baseTypes

baseTypes: {
[name: string]: BasicType<any>;
} = {}

Type declaration

[name: string]: BasicType<any>

embeddables

embeddables: {
[name: string]: EmbeddableType<any>;
} = {}

Type declaration

[name: string]: EmbeddableType<any>

enhancer

enhancer: Enhancer = ...

entities

entities: {
[name: string]: EntityType<any>;
} = {}

Type declaration

[name: string]: EntityType<any>

entityManagerFactory

entityManagerFactory: EntityManagerFactory

isInitialized

isInitialized: boolean = false

Defines if the Metamodel has been finalized

Accessors

isReady

get isReady(): boolean
Indicates if there is currently no exclusive operation executed true If no exclusive lock is hold

Returns boolean
Inherited from Lockable.isReady
- Defined in lib/util/Lockable.ts:29

Methods

addType

addType(type: Type<any>): Type<any>
Returns
the added type
Parameters
- type: Type<any>
Returns Type<any>
- Defined in lib/metamodel/Metamodel.ts:133

baseType

baseType(typeConstructor: string | Class<any>): null | BasicType<any>
Return the metamodel basic type representing the native class.

Returns
the metamodel basic type
Parameters
- typeConstructor: string | Class<any>
  
  the type of the represented native class
Returns null | BasicType<any>
- Defined in lib/metamodel/Metamodel.ts:90

createIndex

createIndex(bucket: string, index: DbIndex): Promise<any>
Creates an index

Returns
Parameters
- bucket: string
  
  Name of the Bucket
- index: DbIndex
  
  Will be applied for the given bucket
Returns Promise<any>
- Defined in lib/metamodel/Metamodel.ts:258

dropAllIndexes

dropAllIndexes(bucket: string): Promise<any>
Drops all indexes

Returns
Parameters
- bucket: string
  
  Indexes will be dropped for the given bucket
Returns Promise<any>
- Defined in lib/metamodel/Metamodel.ts:281

dropIndex

dropIndex(bucket: string, index: DbIndex): Promise<any>
Drops an index

Returns
Parameters
- bucket: string
  
  Name of the Bucket
- index: DbIndex
  
  Will be dropped for the given bucket
Returns Promise<any>
- Defined in lib/metamodel/Metamodel.ts:270

embeddable

embeddable(typeConstructor: string | Function | Class<any>): null | EmbeddableType<any>
Return the metamodel embeddable type representing the embeddable class.

Returns
the metamodel embeddable type or null if the class is not a managed embeddable
Parameters
- typeConstructor: string | Function | Class<any>
  
  the type of the represented embeddable class
Returns null | EmbeddableType<any>
- Defined in lib/metamodel/Metamodel.ts:114

entity

entity(typeConstructor: string | Function | Class<any>): null | EntityType<any>
Return the metamodel entity type representing the entity.

Returns
the metamodel entity type or null if the class is not a managed entity
Parameters
- typeConstructor: string | Function | Class<any>
  
  the type of the represented entity
Returns null | EntityType<any>
- Defined in lib/metamodel/Metamodel.ts:80

fromJSON

fromJSON(json: Json): void
Replace the current schema by the provided one in json

Returns
Parameters
- json: Json
  
  The json schema data
Returns void
- Defined in lib/metamodel/Metamodel.ts:240

getIndexes

getIndexes(bucket: string): Promise<DbIndex[]>
Loads all indexes for the given bucket

Returns
Parameters
- bucket: string
  
  Current indexes will be loaded for the given bucket
Returns Promise<DbIndex[]>
- Defined in lib/metamodel/Metamodel.ts:292

getRef

getRef(arg: string | Function | Class<Managed>): null | string
Returns
Parameters
- arg: string | Function | Class<Managed>
Returns null | string
- Defined in lib/metamodel/Metamodel.ts:59

init

init(jsonMetamodel?: JsonMap): void
Prepare the Metamodel for custom schema creation

Returns
Parameters
- Optional jsonMetamodel: JsonMap
  
  initialize the metamodel with the serialized json schema
Returns void
- Defined in lib/metamodel/Metamodel.ts:46

load

load(): Promise<Metamodel>
Load all schema data from the server

Returns

Returns Promise<Metamodel>
- Defined in lib/metamodel/Metamodel.ts:163

managedType

managedType(typeConstructor: string | Function | Class<any>): null | ManagedType<any>
Return the metamodel managed type representing the entity, mapped superclass, or embeddable class.

Returns
the metamodel managed type
Parameters
- typeConstructor: string | Function | Class<any>
  
  the type of the represented managed class
Returns null | ManagedType<any>
- Defined in lib/metamodel/Metamodel.ts:125

ready

ready(doneCallback?: ((this: Metamodel) => any), failCallback?: ((error: Error) => any)): Promise<Metamodel>
Waits on the previously requested operation and calls the doneCallback if the operation is fulfilled

Returns
A promise which completes successfully, when the previously requested operation completes
Parameters
- Optional doneCallback: ((this: Metamodel) => any)
  
  The callback which will be invoked when the previously operations on this object is completed.
  - - (this: Metamodel): any
    - Parameters
      
      this: Metamodel
      
      Returns any
- Optional failCallback: ((error: Error) => any)
  
  When the lock can't be released caused by a none recoverable error
  - - (error: Error): any
    - Parameters
      
      error: Error
      
      Returns any
Returns Promise<Metamodel>
Inherited from Lockable.ready
- Defined in lib/util/Lockable.ts:42

save

save(managedType?: ManagedType<any>): Promise<Metamodel>
Store all local schema data on the server, or the provided one

Note: The schema must be initialized, by init or load

Returns
Parameters
- Optional managedType: ManagedType<any>
  
  The specific type to persist, if omitted the complete schema will be updated
Returns Promise<Metamodel>
- Defined in lib/metamodel/Metamodel.ts:187

`Private` sendUpdate

sendUpdate(data: JsonArray | JsonMap | ManagedType<any>): Promise<Response>
Parameters
- data: JsonArray | JsonMap | ManagedType<any>
Returns Promise<Response>
- Defined in lib/metamodel/Metamodel.ts:207

toJSON

toJSON(): JsonArray
Get the current schema types as json

Returns
the json data

Returns JsonArray
- Defined in lib/metamodel/Metamodel.ts:224

update

update(data: JsonArray | JsonMap): Promise<Metamodel>
Update the metamodel with the schema

The provided data object will be forwarded to the UpdateAllSchemas resource. The underlying schema of this Metamodel object will be replaced by the result.

Returns
Parameters
- data: JsonArray | JsonMap
  
  The JSON which will be send to the UpdateAllSchemas resource.
Returns Promise<Metamodel>
- Defined in lib/metamodel/Metamodel.ts:200

`Protected` withLock

withLock<T>(callback: (() => Promise<T>), critical??: boolean): Promise<T>
Protected
Try to aquire an exclusive lock and executes the given callback.

Returns
A promise

Throws
If the lock can't be aquired
Type Parameters
- T
Parameters
- callback: (() => Promise<T>)
  
  The exclusive operation to execute
  - - (): Promise<T>
    - Returns Promise<T>
- Optional critical: boolean = false
  
  Indicates if the operation is critical. If the operation is critical and the operation fails, then the lock will not be released
Returns Promise<T>
Inherited from Lockable.withLock
- Defined in lib/util/Lockable.ts:55

Class Metamodel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entityManagerFactory: EntityManagerFactory

Returns Metamodel

Properties

baseTypes

Type declaration

[name: string]: BasicType<any>

embeddables

Type declaration

[name: string]: EmbeddableType<any>

enhancer

entities

Type declaration

[name: string]: EntityType<any>

entityManagerFactory

isInitialized

Accessors

isReady

Returns boolean

Methods

addType

Returns

Parameters

type: Type<any>

Returns Type<any>

baseType

Returns

Parameters

typeConstructor: string | Class<any>

Returns null | BasicType<any>

createIndex

Returns

Parameters

bucket: string

index: DbIndex

Returns Promise<any>

dropAllIndexes

Returns

Parameters

bucket: string

Returns Promise<any>

dropIndex

Returns

Parameters

bucket: string

index: DbIndex

Returns Promise<any>

embeddable

Returns

Parameters

typeConstructor: string | Function | Class<any>

Returns null | EmbeddableType<any>

entity

Returns

Parameters

typeConstructor: string | Function | Class<any>

Returns null | EntityType<any>

fromJSON

Returns

Parameters

json: Json

Returns void

getIndexes

Returns

Parameters

bucket: string

Returns Promise<DbIndex[]>

getRef

Returns

Parameters

arg: string | Function | Class<Managed>

`Optional` jsonMetamodel: JsonMap

`Optional` doneCallback: ((this: Metamodel) => any)

`Optional` failCallback: ((error: Error) => any)

`Optional` managedType: ManagedType<any>

`Private` sendUpdate

`Protected` withLock

`Optional` critical: boolean = false