Reference

RestBI SDK Reference Guide

The RestBI SDK provides a simple and efficient way to interact with the RestBI server API. This SDK allows you to perform operations such as retrieving metadata, validating models, and executing queries by making calls to the backend API. Below is a reference guide for using the SDK.

RestBIClient Class

• Constructor:

  • new RestBIClient(serverURL: string)

• Methods:

  • getMetadata(connection: Connection): Promise<Table[]>

  • validateModel(model: Model): Promise<ValidationResult>

  • executeQuery(query: Query, model: Model): Promise<SQLResult>

Error Handling:

SQLError Returned when when a database operation fails, providing a message that describes the issue and the context for the query that caused it.