Skip to content

EqBroker interface

Defines the broker’s interfaces. Broker is one of the important parts of EasyQuery library which is responsible for the communication with the server-side: getting information about the model, generating SQL (or other type of queries), executing queries, etc.


Executes the current query and processes the result.

▸ buildAndExecute(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the query property which contains a JSON representation of the query.

Returns any


Executes the current query and exports the result to the specified format.

▸ exportResult(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the query property which contains a JSON representation of the query and format property which defines the format of the exported data (e.g. csv).

Returns any


Returns the Promise of the model loading process

▸ getModelPromise(): Promise<DataModel>

Returns Promise<DataModel>


Initializes the broker

▸ init(options?: any): any

  • options: any, Optional -

Returns any


Loads the data model

▸ loadModel(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the modelId property which defines the ID of the model we want to load

Returns any


Loads the query

▸ loadQuery(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the id property which defines the ID of the query we want to load

Returns any


Loads the list of queries available for the current user.

▸ loadQueryList(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the modelId property which defines the ID of the model for which we want to load the list of available queries.

Returns any


Load the list of values for some value editor

▸ loadValueList(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the editoId or listName propertis which define the ID of the value editor or the name of the list we want to get

Returns any


Creates a new query and returns its content back to the client-side.

▸ newQuery(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the modelId property which defines the ID of the model for which we want to create a new query.

Returns any


Removes the current query from some storage on the server-side.

▸ removeQuery(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the id property which defines the ID of the query we would like to remove.

Returns any


Saves the current query to some storage on the server-side.

▸ saveQuery(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the query property which contains a JSON representation of the query to save.

Returns any


Syncs the content of the current query with the server-side.

▸ syncQuery(options?: any): any

  • options: any, Optional - The content of the options parameter depends on broker’s implementation. Usually it contains the query property which contains a JSON representation of the query.

Returns any