Skip to main content
This component is deprecated for Snowflake projects. For Snowflake, use the HubSpot Load component instead, which supersedes this component and is no longer available for new Snowflake pipelines.Existing pipelines with the HubSpot Query component will continue to work as expected.Databricks and Amazon Redshift projects should continue to use this component.
The HubSpot Query component uses the Connect and Configure parameters to create a table of HubSpot data, which is then stored in your preferred storage location (Databricks or Amazon Redshift). You do not need to use the Create Table component when using this connector, as the HubSpot Query component will create a new table or replace an existing table for you using the Destination parameters you define. If the component requires access to a cloud provider (AWS, Azure, or GCP), it will use credentials as follows:
  • If using Matillion Full SaaS: The component will use the cloud credentials associated with your environment to access resources.
  • If using Hybrid SaaS: By default the component will inherit the agent’s execution role (service account role). However, if there are cloud credentials associated to your environment, these will overwrite the role.
This component is potentially destructive. If the target table undergoes a change in structure, it will be recreated. Otherwise, the target table is truncated. Setting the load option Recreate Target Table to Off will prevent both recreation and truncation. Do not modify the target table structure manually.

​
Properties

Reference material is provided below for the Connect, Configure, Destination, and Advanced Settings properties.
​
Name
string
required
A human-readable name for the component.

​
Connect

​
Authentication Method
drop-down
required
Choose between OAuth and Private App Token for authenticating this component.
​
Authentication
drop-down
required
Choose your OAuth connection from the drop-down menu.Click Manage to navigate to the OAuth connections list to review OAuth connections and to add new connections. Read OAuth to learn how to create an OAuth connection.
​
Private App Token
drop-down
required
This parameter is only available when you choose API Key as the authentication method.Choose the secret definition that represents your credentials for this connector.If you have not already saved your credentials for this connector as a secret definition, click Add secret to create a secret definition representing these credentials. Read Secrets and secret definitions for details about creating a secret definition.Read HubSpot authentication guide to learn how to obtain a Private App token.
Connection Options = column editor
  • Parameter: A JDBC parameter supported by the database driver. The available parameters are explained in data model. Manual setup is not usually required, since sensible defaults are assumed.
  • Value: A value for the given parameter.
Click the Text Mode toggle at the bottom of the Connection Options dialog to open a multi-line editor that lets you add items in a single block. For more information, read Text mode. To use grid variables, select the Use Grid Variable checkbox at the bottom of the Connection Options dialog.
  • For more information about configuring the connection options, read the section Data model.
  • To make sure you’re using the latest API supported by HubSpot, set the “Schema” connection option to “HubSpotV4”. By default, the component uses “Schema=HubSpot”, which references the older, V2 API. HubSpot recommends the CRM V4 API for improved performance.

​
Configure

​
Mode
drop-down
required
  • Basic: Configure data selection using the Data Source, Data Selection, Data Source Filter, Combine Filters, and Limit properties.
  • Advanced: Write your own SQL query using the SQL Query property.
​
SQL Query
code editor
Write an SQL query to retrieve your data when Mode is set to Advanced.
​
Data Source
drop-down
required
Select the data source to query from. Available when Mode is set to Basic.
​
Data Selection
dual listbox
required
Select the columns to include from the data source. Available when Mode is set to Basic.
​
Data Source Filter
grid
Filter the rows returned from the data source. Available when Mode is set to Basic.
​
Combine Filters
drop-down
required
Choose how to combine multiple filters. Select AND to return rows matching all filters, or OR to return rows matching any filter. Available when Mode is set to Basic.
​
Limit
integer
The maximum number of rows to return from the data source. Leave blank to return all rows. Available when Mode is set to Basic.

​
Destination

Select your cloud data warehouse.
​
Type
drop-down
required
  • Standard: The data will be staged in your storage location before being loaded into a table. This is the only setting currently available.
​
Warehouse
drop-down
required
The Snowflake warehouse used to run the queries. The special value [Environment Default] uses the warehouse defined in the environment. Read Overview of Warehouses to learn more.
​
Database
drop-down
required
The Snowflake database. The special value [Environment Default] uses the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
​
Schema
drop-down
required
The Snowflake schema. The special value [Environment Default] uses the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
​
Target Table
string
required
The name of the table to be created in your Snowflake database. This table will be recreated and will drop any existing table of the same name.You can use a Table Input component in a transformation pipeline to access and transform this data after it has been loaded.
​
Primary Keys
dual listbox
Select one or more columns to be designated as the table’s primary key.
​
Stage
drop-down
required
Select a managed stage. The special value, [Custom], will create a stage “on the fly” for use solely within this component.
​
Stage Platform
drop-down
required
Choose where the data is staged before being loaded into your Snowflake table using the drop-down menu.
  • Existing Amazon S3 Location: Activates the S3 Staging Area property, allowing users to specify a custom staging area on Amazon S3. The Stage Authentication property is also activated, letting users select a method of authenticating the data staging.
  • Existing Azure Blob Storage Location: Activates the Storage Account and Blob Container properties, allowing users to specify a custom staging location on Azure. The Stage Authentication property is also activated, letting users select a method of authenticating the data staging.
  • Existing Google Cloud Storage Location: Activates the Storage Integration and GCS Staging Area properties, allowing users to specify a custom staging area within Google Cloud Storage.
  • Snowflake Managed: Create and use a temporary internal stage on Snowflake for staging the data. This stage, along with the staged data, will cease to exist after loading is complete. This is the default setting.
​
Stage Authentication
drop-down
required
Select an authentication method for data staging. Only available when Stage Platform is set to either Existing Amazon S3 Location or Existing Azure Blob Storage Location.
  • Credentials: Uses the credentials configured in the environment. If no credentials have been configured, an error will occur.
  • Storage Integration: Use a Snowflake storage integration to authentication data staging.
​
Storage Integration
drop-down
required
Select a Snowflake storage integration from the drop-down list. Storage integrations are required to permit Snowflake to read data from and write to your cloud storage location and must be set up in advance of selection.
​
S3 Staging Area
drop-down
required
Select an S3 bucket for temporary storage. Ensure your access credentials have S3 access and permission to write to the bucket. The temporary objects created in this bucket will be removed again after the load completes.
​
Storage Account
drop-down
required
Select a storage account with your desired blob container to be used for staging the data. For more information, read Storage account overview.
​
Blob Container
drop-down
required
Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.
​
GCS Staging Area
drop-down
required
The URL and path of the target Google Cloud Storage bucket to be used for staging the queried data.

​
Advanced Settings

​
Load Options
multiple drop-downs
required
  • Clean Staged Files: Destroy staged files after loading data. Default is On.
  • String Null is Null: Converts any strings equal to null into a null value. This is case-sensitive and only works with entirely lower-case strings. Default is Off.
  • Recreate Target Table: Choose whether the component recreates its target table before the data load. If Off, the existing table will be used. Default is On.
  • File Prefix: Give staged file names a prefix of your choice. Default is empty (no prefix).
  • Trim String Columns: Remove leading and trailing characters from a string column. Default is On.
  • Compression Type: Set the compression type to either gzip (default) or None.
​
Encryption
drop-down
required
Decide how the files are encrypted inside the S3 bucket. This property is available when using an existing Amazon S3 location for staging.
​
KMS Key ID
drop-down
required
The ID of the KMS encryption key you have chosen to use in the Encryption property.
​
Auto Debug
drop-down
required
Choose whether to automatically log debug information about your load. These logs can be found in the task history and should be included in support requests concerning the component. Turning this on will override any debugging connection options.
​
Debug Level
drop-down
required
The level of verbosity with which your debug information is logged. Levels above 1 can log huge amounts of data and result in slower execution. These logs can be found in the Message field of the task details after pipeline execution and should be included in support requests concerning the component.
  1. Will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors.
  2. Will log everything included in Level 1, plus cache queries and additional information about the request, if applicable.
  3. Will additionally log the body of the request and the response.
  4. Will additionally log transport-level communication with the data source. This includes SSL negotiation.
  5. Will additionally log communication with the data source, as well as additional details that may be helpful in troubleshooting problems. This includes interface commands.

​
Data model

The JDBC driver for this component models HubSpot APIs as relational tables, views, and stored procedures, which are documented in the data model. You’ll also find API limitations and requirements. The connection option SupportEnhancedSQL is set to true by default and typically circumvents most API limitations. This connector also allows you to query system tables in Advanced mode. To see the available system tables in the data model, read the System Tables section of the data model. For more information about using system tables, read our System tables guide.

​
Video