Connection Properties
The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.
For more information on establishing a connection, see Getting Started.
| Property | Description |
| AuthScheme | Specifies the authentication method to use when connecting to HubSpot. |
| Schema | Specifies which version of the HubSpot API the provider should use. HubSpotV4 is the latest available API version. |
| OAuthOptionalScopes | Specifies a space-separated list of optional OAuth scopes to include in the authorization request. |
| OAuthRequiredScopes | Specifies a space-separated list of required OAuth scopes that the HubSpot app must request during authentication. |
| Property | Description |
| InitiateOAuth | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| OAuthAccessToken | Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange. |
| OAuthSettingsLocation | Specifies the location of the settings file where OAuth values are saved. |
| CallbackURL | Identifies the URL users return to after authenticating to HubSpot via OAuth (Custom OAuth applications only). |
| OAuthVerifier | Specifies a verifier code returned from the OAuthAuthorizationURL . Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set. |
| OAuthRefreshToken | Specifies the OAuth refresh token used to request a new access token after the original has expired. |
| OAuthExpiresIn | Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working. |
| OAuthTokenTimestamp | Displays a Unix epoch timestamp in milliseconds that shows how long ago the current access token was created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| Logfile | Specifes the file path to the log file where the provider records its activities, such as authentication, query execution, and connection details. |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| MaxLogFileSize | Specifies the maximum size of a single log file in bytes. For example, '10 MB'. When the file reaches the limit, the provider creates a new log file with the date and time appended to the name. |
| MaxLogFileCount | Specifies the maximum number of log files the provider retains. When the limit is reached, the oldest log file is deleted to make space for a new one. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| AutoCache | Specifies whether the content of tables targeted by SELECT queries is automatically cached to the specified cache database. |
| CacheProvider | The namespace of an ADO.NET provider. The specified provider is used as the target database for all caching operations. |
| CacheDriver | The driver class of a JDBC driver. The specified driver is used to connect to the target database for all caching operations. |
| CacheConnection | Specifies the connection string for the specified cache database. |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | Notes the tolerance, in seconds, for stale data in the specified cache database. Requires AutoCache to be set to True. |
| Offline | Gets the data from the specified cache database instead of live HubSpot data. |
| CacheMetadata | Determines whether the provider caches table metadata to a file-based cache database. |
| Property | Description |
| Archived | Specifies whether the provider retrieves archived records when querying supported objects. |
| BatchSize | Specifies the maximum number of rows included in each batch submitted during batch operations. To submit the entire batch as a single request, set BatchSize to 0 . |
| CallPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Calls table. |
| ColumnSizes | Specifies a comma-separated list that defines custom column sizes for specific fields. |
| CompanyPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Companies table. |
| ConnectOnOpen | Specifies whether the provider establishes a connection to HubSpot immediately upon opening the connection. Set ConnectOnOpen to True if immediate connectivity verification is necessary. |
| ContactPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Contacts table. |
| DealPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Deals table. |
| DefaultDomain | This property is used for the Oracle Database Gateway for ODBC. |
| EmailPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Emails table. |
| EnableForeignKeyDetection | Whether to detect the foreign keys in ODBC. |
| ExpandAssociations | Specifies whether the provider expands association tables to include one table per object-to-object relationship. |
| FeedbackSubmissionPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the FeedbackSubmissions table. |
| GenerateSchemaFiles | Indicates the user preference as to when schemas should be generated and saved. |
| GoalPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Goals table. |
| IncludeCustomTables | Specifies whether the provider includes custom HubSpot objects in the schema. |
| IncludeDualTable | Set this property to mock the Oracle DUAL table for better compatibility with Oracle database. |
| LeadPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Leads table. |
| LimitKeySize | The maximum length of a primary key column. |
| LineItemPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the LineItems table. |
| MapBigintToVarchar | This property controls whether or not the bigint type maps to SQL_VARCHAR instead of SQL_BIGINT. This property is false by default. |
| MapToInt | This property controls whether or not the long type maps to SQL_INTEGER instead of SQL_BIGINT. This property is false by default. |
| MapToLongVarchar | This property controls whether or not a column is returned as SQL_LONGVARCHAR. |
| MapToWVarchar | This property controls whether or not string types map to SQL_WVARCHAR instead of SQL_VARCHAR. This property is set by default. |
| MaximumColumnSize | The maximum column size. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MeetingPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Meetings table. |
| NotePropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Notes table. |
| NumberColumnMode | Specifies how the provider represents numeric fields detected as number types in HubSpot. |
| OrderPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Orders table. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Pagesize | Specifies the maximum number of records to retrieve per page when querying data from HubSpot. |
| ProductPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Products table. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QuotePropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Quotes table. |
| Readonly | Toggles read-only access to HubSpot from the provider. |
| RTK | Specifies the runtime key for licensing the provider. If unset or invalid, the provider defaults to the standard licensing method. This property is only required in environments where the standard licensing method is unsupported or requires a runtime key. |
| TaskPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Tasks table. |
| TicketPropertiesFile | Specifies a comma-separated list or file path containing the names of fields to retrieve for the Tickets table. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UpperCaseIdentifiers | This property reports all identifiers in uppercase. This is the default for Oracle databases and thus allows better integration with Oracle tools such as the Oracle Database Gateway. |
| UseDisplayNames | Specifies whether to use HubSpot's display names for tables and columns instead of their internal API names. |
| UseDropdownLabels | Specifies whether to return dropdown labels instead of internal values for custom enum fields. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |