Skip to main content

Datometry Documentation

Understanding the Hyper-Q Configuration File

Hyper-Q VM reads its initial configuration from the file /opt/datometry/config/dtm.ini. The dtm.ini file is a text-based file that records configuration options as key-value pairs for properties, and sections that organize those properties.

.INI File Format

The format of .ini files is as follows:

property

The basic element contained in an .ini file is a property. Each property includes a name and a value that are delimited using an equals sign (=). This is represented in the format: keyname=value

section

Properties can be arranged into arbitrarily named sections in the file. Every section begins with a section header containing a section name in square brackets. For example: [section_name].

comment

Semicolons (;) used at the start of the line represent a comment.

Sections of the Hyper-Q Configuration File

Defined sections of the dtm.ini file specify configuration parameters for specific Hyper-Q subsystems. The sections of the file are:

Table 4. Sections of the Hyper-Q Configuration File

Section

Description

version

The version of the Hyper-Q software you have installed in your environment. The version section must always be the first section of the dtm.ini file

[endpoint]

The [endpoint] defines the Hyper-Q service endpoint. SQL clients connect to the endpoint to gain access to the Hyper-Q VM. The endpoint consists of the IP address and the port number at which the Hyper-Q service is available.

[gateway]

The [gateway] defines the connection to the target data warehouse. For example, Azure Synapse Analytics of Google BigQuery.

[metadata_stores]

The Metadata Store (MD Store) is where Hyper-Q persistently stores metadata information for its operation. This includes information about the database objects that cannot be natively stored in the target database's schema. For example, custom FORMAT strings, default column values, and SET and MULTISET semantics of a Teradata database table.

The metadata is stored in a pre-configured table, and is accessed at runtime when retrieving and updating object metadata. The metadata information is stored in the table mdstore_schema.MDSTORE_TBL for each database that the user sessions connect.

[pools]

The [pool] defines a collection of gateways. Typically, Hyper-Q has one gateway per pool.

[policies]

The [policies] section defines rules for connection routing. Incoming connections are routed to a specific pool based on policy matching. A policy matches incoming connections on the target database, user, IP and protocol. Policies are order dependent.

Note

Due to the origins of Hyper-Q using PostgreSQL clients, which provide a database name when connecting, the database name is part of the information on which policies match. For Teradata clients, which do not send a database name (not to be confused with Teradata database = schema on most target systems), the database name is configured in the [endpoint] section

[general_settings]

Specifies basic configuration settings for the Hyper-Q deployment.



Hyper-Q Configuration File Syntax

Configuration options in the dtm.ini file use the form "identifier".property_name = property_value, where:

Table 5. Hyper-Q Configuration File Format

Parameter Format

Description

identifier

Identifies the section the parameter belongs to.

property_name

Name of the property.

property_value

The configuration value to assign to the property.



The parameter format contains two parts divided by the equal sign (=), the parameter name on the left side, and the parameter value on the right side. All parameter names are case-sensitive, and can accept a value of one of the following types: Boolean, integer, or string.

; This is a comment on its own line
[sectionidentifier".property_name = property_value ; This is an inline comment