Class SzGrpcConfigManager

SzGrpcConfigManager Access the Senzing ConfigManager module via gRPC

Hierarchy

  • SzGrpcBase
    • SzGrpcConfigManager

Implements

  • SzConfigManager

Properties

grpcConnectionReadyTimeOut productId

Methods

createConfig getConfigRegistry getDeadlineFromNow getDefaultConfigId getTemplateConfig registerConfig replaceDefaultConfigId setDefaultConfig setDefaultConfigId waitForReady

Accessors

szConfigGrpcOptions

Properties

grpcConnectionReadyTimeOut

grpcConnectionReadyTimeOut: number = DEFAULT_CONNECTION_READY_TIMEOUT

productId

productId: string = "5051"

See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md

Methods

InternalcreateConfig

getConfigRegistry

  • getConfigRegistry(): Promise<string>

  • Gets the list of saved configuration ID's with their comments and timestamps and return the JSON describing them.

    Returns Promise<string>

    JSON document describing the configurations registered in the entity repository with their identifiers, timestamps and comments.

ProtectedgetDeadlineFromNow

  • getDeadlineFromNow(secondsFromNow?: number): Date

  • Parameters

    • OptionalsecondsFromNow: number

    Returns Date

getDefaultConfigId

  • getDefaultConfigId(): Promise<number>

  • Gets the configuration ID of the default configuration for the repository and returns it. If the entity repository is in the initial state and the default configuration ID has not yet been set, then zero (0) is returned.

    Returns Promise<number>

    identifier which identifies the current configuration in use.

getTemplateConfig

  • getTemplateConfig(): Promise<string>

  • Get the Configuration Document for the default configuration template.

    Returns Promise<string>

    the configuration document

registerConfig

  • registerConfig(configDefinition: string, comment?: string): Promise<number>

  • Registers the configuration described by the specified configuration definition in the repository with the specified comment. If a comment has not been provided an autogenerated one will be used.

    Parameters

    • configDefinition: string

      The configuration definition to register.

    • Optionalcomment: string

      The comments for the configuration.

    Returns Promise<number>

    The identifier for referencing the config in the entity repository.

    Throws

    SzException If a failure occurs.

replaceDefaultConfigId

  • replaceDefaultConfigId(
        currentDefaultConfigId: number,
        newDefaultConfigId: number,
    ): Promise<string>

  • Replaces the old configuration identifier with a new configuration identifier in the Senzing database. It is like a “compare-and-swap” instruction to serialize concurrent editing of configuration. If {@param currentDefaultConfigId} is no longer the “current configuration identifier”, the operation will fail. To simply set the default configuration ID, use setDefaultConfigId.

    Parameters

    • currentDefaultConfigId: number

      The configuration identifier to replace.

    • newDefaultConfigId: number

      The configuration identifier to use as the default.

    Returns Promise<string>

    for async flow control

InternalsetDefaultConfig

  • setDefaultConfig(configDefinition: string): Promise<number>

  • Registers the specified config definition with an autogenerated comment and then sets the default configuration ID for the repository to the configuration ID that is the result of that registration, returning the config ID under which the configuration was registered.

    Parameters

    • configDefinition: string

      The configuration definition to register as the default.

    Returns Promise<number>

    The configuration ID under which the configuration was registered.

  • setDefaultConfig(configDefinition: string, comment: string): Promise<number>

  • Registers the specified config definition with the specified comment and then sets the default configuration ID for the repository to the configuration ID that is the result of that registration, returning the config ID under which the configuration was registered.

    Parameters

    • configDefinition: string

      The configuration definition to register as the default.

    • comment: string

    Returns Promise<number>

    The configuration ID under which the configuration was registered.

setDefaultConfigId

  • setDefaultConfigId(configId: number): undefined | Promise<number | SzError>

  • Sets the default configuration for the repository to the specified configuration ID.

    Parameters

    • configId: number

      The configuration identifier of the Senzing Engine configuration to use as the default.

    Returns undefined | Promise<number | SzError>

    for async flow control

    See

    replaceDefaultConfigId

waitForReady

  • waitForReady(deadline: Date, cb: (error: null | Error) => void): any

  • Wait for the client to be ready. The callback will be called when the client has successfully connected to the server, and it will be called with an error if the attempt to connect to the server has unrecoverablly failed or if the deadline expires. This function will make the channel start connecting if it has not already done so.

    Parameters

    • deadline: Date
    • cb: (error: null | Error) => void

    Returns any

Accessors

szConfigGrpcOptions

Settings

Member Visibility

On This Page

Properties
Methods
Accessors