Class RowsApi

Hierarchy

  • RowsApi

Constructors

constructor

Properties

api

Methods

cloneDraftTableRow createTableRow getDraftTableRowById getTableRow getTableRows purgeDraftTableRow readDraftTableRows replaceDraftTableRow updateDraftTableRow

Constructors

constructor

Properties

Private api

api: ObservableRowsApi

Methods

cloneDraftTableRow

createTableRow

  • Add a new row to a HubDB table. New rows will be added to the draft version of the table. Use publish endpoint to push these changes to published version. Add a new row to a table

    Parameters

    • tableIdOrName: string

      The ID or name of the target table.

    • hubDbTableRowV3Request: HubDbTableRowV3Request

      The row definition JSON, formatted as described above.

    • Optional _options: Configuration

    Returns Promise<HubDbTableRowV3>

getDraftTableRowById

getTableRow

  • Get a single row by ID from a table's published version. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. Get a table row

    Parameters

    • tableIdOrName: string

      The ID or name of the table

    • rowId: string

      The ID of the row

    • Optional _options: Configuration

    Returns Promise<HubDbTableRowV3>

getTableRows

  • Returns a set of rows in the published version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. Get rows for a table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to query.

    • Optional sort: string[]

      Specifies the column names to sort the results by. See the above description for more details.

    • 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 properties: string[]

      Specify the column names to get results containing only the required columns instead of all column details.

    • Optional _options: Configuration

    Returns Promise<CollectionResponseWithTotalHubDbTableRowV3ForwardPaging>

purgeDraftTableRow

  • Permanently deletes a row from a table's draft version. Permanently deletes a row

    Parameters

    • tableIdOrName: string

      The ID or name of the table

    • rowId: string

      The ID of the row

    • Optional _options: Configuration

    Returns Promise<void>

readDraftTableRows

  • Returns rows in the draft version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters column1__gt=5&sort=-column1, API returns the rows with values for column column1 greater than 5 and in the descending order of column1 values. Refer to the overview section for detailed filtering and sorting options. Get rows from draft table

    Parameters

    • tableIdOrName: string

      The ID or name of the table to query.

    • Optional sort: string[]

      Specifies the column names to sort the results by.

    • 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 properties: string[]

      Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times.

    • Optional _options: Configuration

    Returns Promise<CollectionResponseWithTotalHubDbTableRowV3ForwardPaging>

replaceDraftTableRow

  • Replace a single row in the table's draft version. All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the Create a row endpoint for instructions on how to format the JSON row definitions. Replaces an existing row

    Parameters

    • tableIdOrName: string

      The ID or name of the table

    • rowId: string

      The ID of the row

    • hubDbTableRowV3Request: HubDbTableRowV3Request

      The JSON object of the row

    • Optional _options: Configuration

    Returns Promise<HubDbTableRowV3>

updateDraftTableRow

  • Sparse updates a single row in the table's draft version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the Create a row endpoint for instructions on how to format the JSON row definitions. Updates an existing row

    Parameters

    • tableIdOrName: string

      The ID or name of the table

    • rowId: string

      The ID of the row

    • hubDbTableRowV3Request: HubDbTableRowV3Request

      The JSON object of the row with necessary fields that needs to be updated.

    • Optional _options: Configuration

    Returns Promise<HubDbTableRowV3>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc