Class TablesApi

Hierarchy

  • TablesApi

Constructors

constructor

Properties

api

Methods

archiveTable cloneDraftTable createTable exportDraftTable exportTable getAllDraftTables getAllTables getDraftTableDetailsById getTableDetails importDraftTable publishDraftTable resetDraftTable unpublishTable updateDraftTable

Constructors

constructor

Properties

Private api

api: ObservableTablesApi

Methods

archiveTable

  • Archive (soft delete) an existing HubDB table. This archives both the published and draft versions. Archive a table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to archive.

    • Optional _options: Configuration

    Returns Promise<void>

cloneDraftTable

  • Clone an existing HubDB table. The newName and newLabel of the new table can be sent as JSON in the body parameter. This will create the cloned table as a draft. Clone a table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to clone.

    • hubDbTableCloneRequest: HubDbTableCloneRequest

      JSON object with the properties newName and newLabel. You can set copyRows to false to clone the table with copying rows and default is true.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

createTable

exportDraftTable

  • Exports the draft version of a table to CSV / EXCEL format. Export a draft table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to export.

    • Optional format: string

      The file format to export. Possible values include `CSV`, `XLSX`, and `XLS`.

    • Optional _options: Configuration

    Returns Promise<HttpFile>

exportTable

  • Exports the published version of a table to CSV / EXCEL format. Export a published version of a table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to export.

    • Optional format: string

      The file format to export. Possible values include `CSV`, `XLSX`, and `XLS`.

    • Optional _options: Configuration

    Returns Promise<HttpFile>

getAllDraftTables

  • Returns the details for each draft table defined in the specified account, including column definitions. Return all draft tables

    Parameters

    • Optional sort: string[]

      Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.

    • Optional after: string

      The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.

    • Optional limit: number

      The maximum number of results to return. Default is 1000.

    • Optional createdAt: Date

      Only return tables created at exactly the specified time.

    • Optional createdAfter: Date

      Only return tables created after the specified time.

    • Optional createdBefore: Date

      Only return tables created before the specified time.

    • Optional updatedAt: Date

      Only return tables last updated at exactly the specified time.

    • Optional updatedAfter: Date

      Only return tables last updated after the specified time.

    • Optional updatedBefore: Date

      Only return tables last updated before the specified time.

    • Optional archived: boolean

      Specifies whether to return archived tables. Defaults to `false`.

    • Optional _options: Configuration

    Returns Promise<CollectionResponseWithTotalHubDbTableV3ForwardPaging>

getAllTables

  • Returns the details for the published version of each table defined in an account, including column definitions. Get all published tables

    Parameters

    • Optional sort: string[]

      Specifies which fields to use for sorting results. Valid fields are `name`, `createdAt`, `updatedAt`, `createdBy`, `updatedBy`. `createdAt` will be used by default.

    • Optional after: string

      The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results.

    • Optional limit: number

      The maximum number of results to return. Default is 1000.

    • Optional createdAt: Date

      Only return tables created at exactly the specified time.

    • Optional createdAfter: Date

      Only return tables created after the specified time.

    • Optional createdBefore: Date

      Only return tables created before the specified time.

    • Optional updatedAt: Date

      Only return tables last updated at exactly the specified time.

    • Optional updatedAfter: Date

      Only return tables last updated after the specified time.

    • Optional updatedBefore: Date

      Only return tables last updated before the specified time.

    • Optional archived: boolean

      Specifies whether to return archived tables. Defaults to `false`.

    • Optional _options: Configuration

    Returns Promise<CollectionResponseWithTotalHubDbTableV3ForwardPaging>

getDraftTableDetailsById

  • Get the details for the draft version of a specific HubDB table. This will include the definitions for the columns in the table and the number of rows in the table. Get details for a draft table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to return.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the result.

    • Optional archived: boolean

      Set this to `true` to return an archived table. Defaults to `false`.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

getTableDetails

  • Returns the details for the published version of the specified table. This will include the definitions for the columns in the table and the number of rows in the table. Note: This endpoint can be accessed without any authentication if the table is set to be allowed for public access. Get details for a published table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to return.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the result.

    • Optional archived: boolean

      Set this to `true` to return details for an archived table. Defaults to `false`.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

importDraftTable

  • Import the contents of a CSV file into an existing HubDB table. The data will always be imported into the draft version of the table. Use /publish endpoint to push these changes to published version. This endpoint takes a multi-part POST request. The first part will be a set of JSON-formatted options for the import and you can specify this with the name as config. The second part will be the CSV file you want to import and you can specify this with the name as file. Refer the overview section to check the details and format of the JSON-formatted options for the import. Import data into draft table

    Parameters

    • tableIdOrName: string

      The ID of the destination table where data will be imported.

    • Optional config: string

      Configuration for the import in JSON format as described above.

    • Optional file: HttpFile

      The source CSV file to be imported.

    • Optional _options: Configuration

    Returns Promise<ImportResult>

publishDraftTable

  • Publishes the table by copying the data and table schema changes from draft version to the published version, meaning any website pages using data from the table will be updated. Publish a table from draft

    Parameters

    • tableIdOrName: string

      The ID or name of the table to publish.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the response.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

resetDraftTable

  • Replaces the data in the draft version of the table with values from the published version. Any unpublished changes in the draft will be lost after this call is made. Reset a draft table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to reset.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the response.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

unpublishTable

  • Unpublishes the table, meaning any website pages using data from the table will not render any data. Unpublish a table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to publish.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the response.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

updateDraftTable

  • Update an existing HubDB table. You can use this endpoint to add or remove columns to the table as well as restore an archived table. Tables updated using the endpoint will only modify the draft verion of the table. Use publish endpoint to push all the changes to the published version. To restore a table, include the query parameter archived=true and \"archived\": false in the json body. Note: You need to include all the columns in the input when you are adding/removing/updating a column. If you do not include an already existing column in the request, it will be deleted. Update an existing table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to update.

    • hubDbTableV3Request: HubDbTableV3Request

      The JSON schema for the table being updated.

    • Optional includeForeignIds: boolean

      Set this to `true` to populate foreign ID values in the result.

    • Optional archived: boolean

      Specifies whether to return archived tables. Defaults to `false`.

    • Optional _options: Configuration

    Returns Promise<HubDbTableV3>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc