Class OINODbApi

constructor

• new OINODbApi(db: OINODb, params: OINODbApiParams): OINODbApi

  Constructor of API object. NOTE! OINODb.initDatamodel must be called if created manually instead of the factory.

  Parameters

  • db: OINODb

    database for the API
  • params: OINODbApiParams

    parameters for the API

  Returns OINODbApi

Readonlydatamodel

Readonlydb

Readonlyhashid

Readonlyparams

doApiRequest

• doApiRequest(request: OINODbApiRequest): Promise<OINODbApiResult>

  Parameters

  • request: OINODbApiRequest

  Returns Promise<OINODbApiResult>

doBatchUpdate

• doBatchUpdate(
      method: string,
      rowId: string,
      rowData: OINODbApiData,
      sqlParams?: OINODbSqlParams,
  ): Promise<OINODbApiResult>

  Method for handling a HTTP REST request with batch update using PUT or DELETE methods.

  Parameters

  • method: string

    HTTP method of the REST request
  • rowId: string

    URL id of the REST request
  • rowData: OINODbApiData

    HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
  • OptionalsqlParams: OINODbSqlParams

  Returns Promise<OINODbApiResult>

doHttpRequest

• doHttpRequest(
      request: OINOHttpRequest,
      rowId: string,
      rowData: OINODbApiData,
      sqlParams: OINODbSqlParams,
  ): Promise<OINODbApiResult>

  Method for handling a HTTP REST request with GET, POST, PUT, DELETE corresponding to SQL select, insert, update and delete.

  Parameters

  • request: OINOHttpRequest

    OINO HTTP request object containing all parameters of the REST request
  • rowId: string

    URL id of the REST request
  • rowData: OINODbApiData

    HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
  • sqlParams: OINODbSqlParams

    SQL parameters for the REST request

  Returns Promise<OINODbApiResult>

doRequest

• doRequest(
      method: string,
      rowId: string,
      rowData: OINODbApiData,
      sqlParams: OINODbSqlParams,
      contentType?: OINOContentType,
  ): Promise<OINODbApiResult>

  Method for handling a HTTP REST request with GET, POST, PUT, DELETE corresponding to SQL select, insert, update and delete.

  Parameters

  • method: string

    HTTP method of the REST request
  • rowId: string

    URL id of the REST request
  • rowData: OINODbApiData

    HTTP body data as either serialized string or unserialized JS object or OINODataRow-array or Buffer/Uint8Array binary data
  • sqlParams: OINODbSqlParams

    SQL parameters for the REST request
  • contentType: OINOContentType = OINOContentType.json

    content type of the HTTP body data, default is JSON

  Returns Promise<OINODbApiResult>

isFieldIncluded

• isFieldIncluded(fieldName: string): boolean

  Method to check if a field is included in the API params.

  Parameters

  • fieldName: string

    name of the field

  Returns boolean

runBatchUpdate

• runBatchUpdate(request: OINODbApiRequest): Promise<OINODbApiResult>

  Method for handling a HTTP REST request with batch update using PUT or DELETE methods.

  Parameters

  • request: OINODbApiRequest

    HTTP URL parameters as key-value-pairs

  Returns Promise<OINODbApiResult>

setDebugOnError

• setDebugOnError(debugOnError: boolean): void

  Enable or disable debug output on errors.

  Parameters

  • debugOnError: boolean

    true to enable debug output on errors, false to disable

  Returns void