Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CollectionsApi

CollectionsApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected basePath

basePath: string

Protected configuration

configuration: Configuration

Protected fetch

fetch: FetchAPI

Methods

createCollection

createPreviewSource

deleteCollection

  • Delete a collection and all its documents from Rockset.

    summary

    Delete Collection

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • Optional options: any

    Returns Promise<DeleteCollectionResponse>

getCollection

  • Get details about a collection.

    summary

    Get Collection

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • Optional options: any

    Returns Promise<GetCollectionResponse>

getSamples

  • getSamples(workspace: string, collection: string, options?: any): Promise<QueryResponse>
  • Get samples for a collection in Rockset.

    summary

    Get Collection Samples

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • Optional options: any

    Returns Promise<QueryResponse>

getSchema

  • getSchema(workspace: string, collection: string, depth?: undefined | number, options?: any): Promise<QueryResponse>
  • Get schema for a collection in Rockset.

    summary

    Get Collection Schema

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • Optional depth: undefined | number
    • Optional options: any

    Returns Promise<QueryResponse>

getSourceConfigs

listAliasesForCollection

  • listAliasesForCollection(workspace: string, collection: string, options?: any): Promise<ListAliasesResponse>
  • Get all Aliases for a specific Rockset Collection.

    summary

    Get Aliases for Collection

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string
    • collection: string
    • Optional options: any

    Returns Promise<ListAliasesResponse>

listCollections

listQueryLambdasInCollection

  • Get all Query Lambdas that hit a specific Rockset Collection.

    summary

    Get Query Lambdas for Collection

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • Optional options: any

    Returns Promise<ListQueryLambdaVersionsResponse>

previewCollection

setCollectionState

  • setCollectionState(workspace: string, collection: string, state: "READY" | "PAUSED", options?: any): Promise<GetCollectionResponse>
  • Update state of a collection.

    summary

    Update state of Collection

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • collection: string

      name of the collection

    • state: "READY" | "PAUSED"

      new state of this collection

    • Optional options: any

    Returns Promise<GetCollectionResponse>

uploadFile

uploadFilePreviewSource

  • Upload a file to a preview source that can be used to generate preview docs

    summary

    Upload File to Preview Source

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • preview_source_id: string

      preview source identifier

    • body: InputStream

      file input stream

    • body2: FormDataContentDisposition

      file metadata

    • Optional body3: undefined | string
    • Optional options: any

    Returns Promise<UploadFileResponse>

workspaceCollections

  • Retrieve all collections in a workspace.

    summary

    List Collections for Workspace

    throws

    {RequiredError}

    memberof

    CollectionsApi

    Parameters

    • workspace: string

      name of the workspace

    • Optional options: any

    Returns Promise<ListCollectionsResponse>

Generated using TypeDoc