ModelManagerAPI implements the model manager interface and is the concrete implementation of the api end point.

Hierarchy

  • default

Implements

Constructors

Properties

NAME: string = "ModelManager"
VERSION: number = 8
_transport: Transport
NAME: string = "ModelManager"
VERSION: number = 8

Methods

  • CreateModel creates a new model using the account and model config specified in the args.

    Parameters

    Returns Promise<ModelInfo>

  • DestroyModels will try to destroy the specified models. If there is a block on destruction, this method will return an error. From ModelManager v7 onwards, DestroyModels gains 'force' and 'max-wait' parameters.

    Parameters

    Returns Promise<ErrorResults>

  • DumpModels will export the models into the database agnostic representation. The user needs to either be a controller admin, or have admin privileges on the model itself.

    Parameters

    Returns Promise<StringResults>

  • DumpModelsDB will gather all documents from all model collections for the specified model. The map result contains a map of collection names to lists of documents represented as maps.

    Parameters

    Returns Promise<MapResults>

  • ListModelSummaries returns models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

    Parameters

    Returns Promise<ModelSummaryResults>

  • ListModels returns the models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

    Parameters

    Returns Promise<UserModelList>

Generated using TypeDoc