Programmers reference for HubSpot Reader

Auth Mode

Select list

Client ID

String

Required for authentication with OAuth.

Client secret

Password

Required for authentication with OAuth.

Connection pool size

Integer

20

Specifies the number of connections in use.

Connection profile name

String

Used when Use connection profile is True. Select the name of the HubSpot Reader connection from the list.

Some HubSpot objects cannot be read when HubSpot Reader uses a connection profile. See Objects not supported when using a connection profile.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

Value of the Last_Modified_Date field.

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target.

Mode

Select list

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

String

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). HubSpot Reader polls the HubSpot instance at the specified interval.

Private app token

Password

Required for authentication with a private app token.

Refresh token

Password

Required for authentication with OAuth.

Start position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Use connection profile

Boolean

Set to True to use a connection profile instead of specifying the connection properties here.

Tables

String

A semicolon-delimited (;) list of objects to read from the HubSpot instance. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool counter

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.

The ThreadPoolCount value must be less than the number of available processors. For example, if the system has eight processors, set ThreadPoolCount to 7 or lower.