HubDB

Last updated:
APPLICABLE PRODUCTS
  • Marketing Hub
    • Enterprise
  • CMS Hub
    • Professional or Enterprise

HubDB is a tool that allows you to create tables to store data in rows, columns, and cells, much like a spreadsheet. You can customize a HubDB table's columns, rows, and other settings based on your needs. For example, you could use a HubDB table to:

  • store feedback from an external mechanism to retrieve at a later time.
  • store structured data that you can use to build dynamic CMS pages (CMS Hub Professional and Enterprise only).

hubdb-table-example0HubDB tables can be accessed both within HubSpot and through the HubDB API, and you can retrieve a table's data in multiple ways, depending on your use case. To get data from a HubDB table, you can: 

  • Query the data externally via the HubDB API. 
  • Use HubSpot’s HubL markup tags to pull data into the CMS as structured content.
  • Use the HubDB API with serverless functions to provide an interactive web app experience.

Please note:

HubDB technical limits

In addition to HubSpot’s general API limits, please note the following HubDB technical limits:

  • 10,000 rows per HubDB table.
  • 1,000 HubDB tables per account.
  • 10,000 characters in each text field.
  • 10 table scans per CMS page. Defined as a single call to hubdb_table_rows().
  • HubDB's with dynamic pages turned on must have lowercase paths so that URLs to these pages can be case insensitive.

Create a HubDB table

You can create HubDB tables either through HubSpot's UI or through the HubDB API.

All new tables created are set with a status of draft. They cannot be used to output data via HubL or API until you publish the table.

Configure your HubDB table settings (CMS Hub Professional and Enterprise only)

You can manage your HubDB tables settings in HubSpot by clicking Actions, then Manage settings. The following settings are available:

  • Allow public API access: by default, the table's data can only be viewed in the app or within authenticated API calls. Turn this setting on to enable unauthenticated API calls to query the table's data. 
  • Enable creation of dynamic pages using row data: turn this setting on to enable the creation of dynamic pages using HubDB data. Upon toggling this option on, you can access the following additional options:
    • Use the dropdown menus to select which columns will populate dynamic pages with meta description, featured image, and canonical URL data. For new tables, you'll need to create new columns to contain this data.
      • Meta description: must be a text type column.
      • Featured image: must be an image type column.
      • Canonical URL: must be a URL type column.
    • To reference other HubDB tables in this table, select the Allow use of child tables checkbox. You can also select the Automatically create listing pages for child tables setting to enable HubSpot to automatically create intermediate listing pages. Learn more about building multilevel dynamic pages using HubDB.

manage-hubdb-table-setting

Please note: a parent table cannot reference a child table that also references the parent table. This will create a loop that results in an error when trying to select the child table within the parent table.

HubDB Architecture

Tables

A table is a 2-dimensional arrangement of rows and columns. When a table is created, it is given a globally unique ID which can be used to identify it. 

Rows

Rows are horizontal slices of a table. All the values in a row are related, usually to a single primary identifier. In a spreadsheet application, rows are represented by numbers, starting with 1. Each table row is given a globally unique ID on creation. 

Columns

Columns are vertical slices of a table. Each column has a type. In a spreadsheet application, they're represented by alphabetic columns like A, B, C, etc. There are two types of table columns:

Each row in a table has a couple of built-in columns:

Use this table to describe parameters / fields
ColumnDescription
hs_id

An automatically assigned, globally unique, numeric ID for this row.

hs_created_at

A timestamp of when this row was created.

hs_path

When used with dynamic pages, this string is the last segment of the URL's path for the page.

hs_name

When used with dynamic pages, this is the title of the page.

Please note: rich text area columns in HubDB are limited to 65,000 characters. For more information, view the changelog announcement.

Tables can have as many custom columns as you'd like. They can be text, rich text, numbers, currency, dates, times, images, videos, selects, or locations (latitude and longitude). 

When a column is created, it is given a numeric ID unique to the table, starting at value 1. Column IDs are increasing, but not necessarily sequential. Column IDs cannot be reused, so if a table has 2 columns, 1 and 2, and the 2nd column is deleted, the next column created will have an ID of 3.

Cells

Cells store the values where a row and column intersect. Cells can be read or updated individually or as part of a row. Setting the value of a cell to null is equivalent to deleting the cell's value.

Access HubDB data using HubL

Using HubL, you can pull HubDB data as to use as structured content on website pages. Below, learn more about how to retrieve table, row, and column data using HubL.

Getting rows

To list rows of a table, use the hubdb_table_rows() HubL function. You can either access a table by its ID or name. It is recommended to reference a HubDB table by name, as this can help with code portability across HubSpot accounts. The immutable table name is set when creating a new table and can be found at any time by selecting Actions > Manage Settings within the table editor. A table's ID can be found in the address bar of the table editor or in the HubDB tables dashboard under the ID column. 

Screenshot of create table modal

Below is an example of using hubdb_table_rows() to fetch data.

{% for row in hubdb_table_rows(<tableId or name>, <filterQuery>) %} the value for row {{ row.hs_id }} is {{ row.<column name> }} {% endfor %}

<filterQuery> uses the same syntax as the HTTP API. For example,  hubdb_table_rows(123, "employees__gt=10&orderBy=count") would return a list of rows where the "employees" column is greater than 10, ordered by the "count" column. A complete list of optional <filterQuery> parameters can be found here.

Instead of using multiple row queries with different <filterQuery>  parameters, you should make one query and use the selectattr()  or rejectattr()  filters to filter your rows:

{% set all_cars = hubdb_table_rows(<tableId or name>) %} {% set cars_with_windows = all_cars|selectattr('windows') %} {% set teslas = all_cars|selectattr('make','equalto','tesla') %}

To get a single row, use the hubdb_table_row() HubL function.

{% set row = hubdb_table_row(<tableId or name>, <rowId>) %} the value for {{ row.hs_id }} is {{ row.<column name> }}

Built-in and custom column names are case insensitive. HS_ID will work the same as hs_id.

Row attributes

Use this table to describe parameters / fields
AttributeDescription
row.hs_id

The globally unique id for this row.

row.hs_path

When using dynamic pages, this string is the Page Path column value and the last segment of the url's path.

row.hs_name

When using dynamic pages, this string is the Page Title column value for the row.

row.hs_created_at

Unix timestamp for when the row was created.

row.hs_child_table_id

When using dynamic pages, this is the ID of the other table that is populating data for the row.

row.column_name

Get the value of the custom column by the name of the column.

row["column name"]

Get the value of the custom column by the name of the column.

Getting table metadata

To get a table's metadata, including its name, columns, last updated, etc, use the hubdb_table() function.

{% set table_info = hubdb_table(<tableId or name>) %}

Table attributes

The attributes listed below are in reference to the variable that hubdb_table() was assigned to in the above code. Your variable may differ.
Note: It is recommended assigning this to a variable for easier use. If you don't want to do that, you can use
{{ hubdb_table(<tableId>).attribute }}

Use this table to describe parameters / fields
AttributeDescription
table_info.id

The id of the table.

table_info.name

The name of the table.

table_info.columns

List of column information. You can use a for loop to iterate through the information available in this attribute.

table_info.created_at

Timestamp of when the table was first created.

table_info.published_at

Timestamp of when this table was published.

table_info.updated_at

Timestamp of when this table was last updated.

table_info.row_count

Number of rows in the table.

Getting column metadata

{% set table_info = hubdb_table_column(<tableId or name>, <columnId or column name>) %}

To get information on a column in table such as its label, type and options, use the hubdb_table_column() function

Column attributes

The attributes listed below are in reference to the variable that hubdb_table_column() was assigned to in the above code. Your variable may differ.
Note: It is recommended assigning this to a variable for easier use. If you don't want to do that, you can use
{{ hubdb_table_column(<tableId>,<columnId or column name>).attribute }}

Use this table to describe parameters / fields
AttributeDescription
table_info.id

The ID of the column.

table_info.name

The name of the column.

table_info.label

The label to be used for the column.

table_info.type

Type of this column.

table_info.options

For select column type, this is a map of optionId to option information.

table_info.foreignIds

For foreignId column types, a list of foreignIds (with id and name properties).

Column methods

Use this table to describe parameters / fields
MethodDescription
getOptionByName("<option name")

For select column types, get option information by the options name.

Rich Text columns

The richtext column type functions similar to the rich text field you see for modules.

The data is stored as HTML, and the HubDB UI provides a text editing interface. However, when editing a HubDB table through HubSpot's UI, you cannot edit source code directly. This prevents situations where a non-technical user may input invalid HTML, preventing unintended issues with the appearance or functionality of your site. For situations where you need an embed code or more custom HTML you can use the embed feature in the rich text editor to place your custom code. 


Was this article helpful?
This form is used for documentation feedback only. Learn how to get help with HubSpot.