@zcatalyst/zcql

ZOHO CATALYST SDK for JavaScript zcql for Node.js and Browser.

Installing

To install this package, simply type add or install @zcatalyst/zcql using your favorite package manager:

• npm install @zcatalyst/zcql
• yarn add @zcatalyst/zcql
• pnpm add @zcatalyst/zcql

Getting Started

Import

The Catalyst SDK is modulized by Components. To send a request, you only need to import the zcql:

// ES5 example
const { zcql } = require("@zcatalyst/zcql");

// ES6+ example
import { zcql } from "@zcatalyst/zcql";

Usage

To send a request, you:

• Create a zcql Instance.
• Call the zcql operation with input parameters.

const zcql = new zcql();

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await zcql.executeZCQLQuery("select * from sample");
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

zcql.executeZCQLQuery("select * from sample").then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

zcql
  .executeZCQLQuery("select * from sample")
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await zcql.executeZCQLQuery("select * from sample");
  // process data.
} catch (error) {
  const message = error.message;
  const status = error.statusCode;
  console.log({ message, status });
}

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

License

This SDK is distributed under the Apache License 2.0. See LICENSE file for more information.

ZCQL operations