Class CollectionsClient

SDK for interacting with collections in AppDB.

Example Usage

 
import { AppDBClient } from '@domoinc/toolkit';

const collections = await (new AppDBClient.CollectionsClient()).getCollections();
// do something with the collections
console.table(collections);

Hierarchy

  • CollectionsClient

Constructors

constructor

Properties

reCaptchaHeader transportClient

Methods

createCollection deleteCollection getCollections syncWithDomo updateCollection

Constructors

constructor

  • Parameters

    • Optional reCaptchaToken: string

    Returns CollectionsClient

Properties

Private reCaptchaHeader

reCaptchaHeader: {
    X-DOMO-Ryuu-Recaptcha?: string;
}

Type declaration

  • Optional X-DOMO-Ryuu-Recaptcha?: string

transportClient

transportClient: TransportClientClass

Methods

createCollection

  • A helper method for creating a new collection.

    Parameters

    • newCollection: AppDBCollectionDefinition

      Properties for new collection

      Example Usage

       
      collectionsClient.createCollection({
        name: 'newCollection',
        schema: [
          {
            name: 'name',
            type: 'STRING'
          },
          {
            name: 'age',
            type: 'LONG'
          },
        ],
        syncEnabled: true,
      });

    Returns Promise<Response<AppDBCollection>>

deleteCollection

  • A helper method for deleting a collection.

    Parameters

    • collectionId: string

      ID of target collection to delete

      Example Usage

       
      collectionsClient.deleteCollection('753e53a0-f054-11e9-81b4-2a2ae2dbcce4');

    Returns Promise<Response<void>>

getCollections

  • A helper method for retrieving a full list of collections.

    Returns Promise<Response<AppDBCollection[]>>

syncWithDomo

  • A helper method for forcing the collections to be sync'd with their respective datasets in Domo.

    Returns Promise<Response>

updateCollection

  • A helper method for updating a collection.

    Parameters

    • collectionId: string

      ID of target collection to update

    • updatedConfig: AppDBCollectionDefinition

      Partial object representing the new values of the collection

      Example Usage

       
      collectionsClient.updateCollection(
        '753e53a0-f054-11e9-81b4-2a2ae2dbcce4',
        {
         schema: [
           {
             name: 'name',
             type: 'STRING'
           },
           {
             name: 'created',
             type: 'DATETIME'
           },
         ],
        }
      );

    Returns Promise<Response<AppDBCollection>>

Settings

Member Visibility

Theme

Generated using TypeDoc