Help Manual

Azure Maps JDBC Driver

Documentation for Azure Maps drivers found within JDBC Driver Pack

Azure Maps

Building the JDBC URL

After installing the license, access the connection management page by executing the command java -jar kingswaysoft.jdbc.jar. Enter the necessary details, and the program will automatically generate the JDBC connection URL. Users can click Test Connection to test the generated URL and Copy to Clipboard to copy the connection string for use within the application where the JDBC driver is being used.

Note: If the license is not installed, you can still use the connection manager to generate a JDBC URL; however, the 'Test Connection' feature will be disabled.

General Page

The General page allows you to specify connection properties and login credentials for the Azure Maps REST service.

connectionmanage

General Settings
General Settings
Geography

The Geography specifies which Geography service to connect to.

Feature

The Feature refers to the API functionalities that we support in Azure Maps.

API Throttling Rate

The API Throttling Rate will limit the number of requests that can be sent per second. Set this value to 0 to disable API throttling.

Authentication
Authentication Mode

The Authentication Mode option allows you to choose the method used to authenticate with the Azure Maps API. Available options are:

  • OAuth Authorization Code
  • Subscription Key
  • SAS token
  • Client Credentials
  • Certificate

Authentication Methods for Azure Maps

OAuth Authorization Code

A generated access token can be used to establish a connection.

Access Token
The access token can be used to establish a connection.
<dt><strong>Generate Token File</strong></dt>
<dd>
  <p>This button completes the OAuth authentication process in order to generate a new access token.</p>
  <ul>
    <li><strong>Tenant Id:</strong> The Tenant Id option allows you to specify the Tenant Id where the Client App Id is verified to complete the authorization process.</li>
    <li><strong>Client Id:</strong> The Client Id option allows you to specify the unique ID which identifies the application making the request.</li>
    <li><strong>Client Secret:</strong> The Client Secret option allows you to specify the client secret belonging to your app.</li>
    <li><strong>Redirect Url:</strong> The Redirect Url option allows you to specify the Redirect Url to complete the authentication process.</li>
    <li><strong>Scope:</strong> The scope option allows you to select the scopes to be requested when generating a token file. Select from the list of available scopes or add your own in the text field.</li>
    <li><strong>PKCE (Enhanced Security):</strong> The PKCE (Proof Key for Code Exchange) option may be enabled for PKCE App Type. Ensures that the client that initiates the OAuth flow is the same client that completes flow.</li>
  </ul>
</dd>
Subscription Key

Enter Subscription Key and Account Id to establish a connection.

Account Id
The Account Id option allows you to specify the Account Id which identifies the application making the request.
<dt><strong>Subscription Key</strong></dt>
<dd>The Subscription Key option allows you to specify the Subscription Key which identifies the application making the request.</dd>
SAS Token

Enter SAS Token and Account Id to establish a connection.

Account Id
The Account Id option allows you to specify the Account Id which identifies the application making the request.
<dt><strong>SAS Token</strong></dt>
<dd>The SAS Token option allows you to specify the SAS Token which identifies the application making the request.</dd>
Client Credentials

Enter Tenant Id, Client App Id and Client Secret to establish a connection.

Tenant Id
The Tenant Id option allows you to specify the Tenant Id where the Client App Id is verified to complete the authorization process.
<dt><strong>Client Id</strong></dt>
<dd>The Client Id option allows you to specify the unique ID which identifies the application making the request.</dd>

<dt><strong>Client Secret</strong></dt>
<dd>The Client Secret option allows you to specify the client secret belonging to your app.</dd>
Certificate

Choose to use a saved certificate file and certificate password to establish a connection.

Tenant Id
The Tenant Id option allows you to specify the Tenant Id where the Client App Id is verified to complete the authorization process.
<dt><strong>Client Id</strong></dt>
<dd>The Client Id option allows you to specify the unique ID which identifies the application making the request.</dd>

<dt><strong>Path To Certificate</strong></dt>
<dd>The path to an existing certificate file.</dd>

<dt><strong>Certificate Password</strong></dt>
<dd>The password for the specified certificate file.</dd>
Test Connection

After all the connection information has been provided, click the "Test Connection" button to test if the user credentials entered can successfully connect to the selected service.

Advanced Settings Page

The Advanced Settings page allows you to specify advanced settings for the connection.

connectionmanage

Proxy Server Settings
Proxy Server Settings
Proxy Mode

The Proxy Mode option allows you to specify how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Use system configured proxy)
  • Manual
Proxy Server

Using the Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

The Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

The Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Miscellaneous Settings
Miscellaneous Settings
Timeout (secs)

The Timeout (secs) option allows you to specify a timeout value in seconds for the connection. The default value is 120 seconds. Specify 0 for an infinite timeout.

Retry on Intermittent Errors

The retry on intermittent errors determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore those SSL certificate errors when connecting to the target server.

Warning: Enabling the "Ignore Certificate Errors" option is generally NOT recommended, particularly for production instances. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure, this option should be unchecked for best security.

Note: When this option is enabled, it applies to all HTTP-based SSL connections in the same job process.

Concurrent Writing Threads

This option can be used to set the number of threads to be used during write operations. This can improve performance during large-volume write operations.

Using the JDBC Driver

Explore detailed examples in this section that demonstrate the application of JDBC classes such as Connection, Statement, and ResultSet to effectively manage interactions with Azure Maps data. This section covers the use of regular statements and prepared statements for executing complex or frequently executed queries.

Executing Statements

Once you've connected from your code (see Connecting with DriverManager and Connecting with DataSource), you can execute SQL statements using the Statement class. Refer to the Executing Prepared Statements section for information on how to execute parameterized statements.

SELECT

Use the Statement class's generic execute method or the executeQuery method to execute SQL statements that return data. To retrieve the results of a query, you would then call the getResultSet method of the Statement.

String sql = "SELECT * FROM weather/tropical/storms WHERE year = 2025";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

Executing Prepared Statements

Using a PreparedStatement can improve performance when you need to execute a SQL statement multiple times with different parameters. Unlike a Statement object, a PreparedStatement object is provided with a SQL statement when it is created, which can then be executed with different values each time. This special type of statement is derived from the more general class, Statement.

Below are the steps outlining how to execute a prepared statement:

Creating and Executing a Prepared Statement
  1. Create a PreparedStatement
  2. Set Parameters
    • Declare parameters by calling the corresponding setter method of the PreparedStatement.
    • NOTE: The parameter indices start at 1.
  3. Execute the PreparedStatement
    • Use the generic execute or executeUpdate method of the PreparedStatement.
  4. Retrieve Results
    • Call the getResultSet method of the PreparedStatement to obtain the query results, which will be returned as a ResultSet.
  5. Iterate Over the Result Set
    • Use the next method of the ResultSet to iterate through the results. To obtain column information, utilize the ResultSetMetaData class. Instantiate a ResultSetMetaData object by calling the getMetaData method of the ResultSet.

SELECT

Use the PreparedStatement class's generic execute method or the executeQuery method to execute SQL statements that return data.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the retrieved data.

String sql = "SELECT * FROM weather/tropical/storms WHERE year = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setInt(1, 2025);
    boolean ret = ps.execute(sql);
    if (ret) {
        ResultSet rs = ps.getResultSet();
        LOGGER.info(rs.toString());
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

Metadata Discovery

This section provides examples on how to retrieve table and column metadata using the getTables, getColumns, and getPrimaryKeys methods from the DatabaseMetaData interface. These are essential for discovering database structures.

Tables

The getTables method from the DatabaseMetaData interface can be used to retrieve a list of tables.

This method only retrieves tables that are not write-only.

To get a list of tables which include write-only tables, query the table system.tables.

try {
    ResultSet rs = connection.getMetaData().getTables(null, null, null, null);
    LOGGER.info("\r\n" + rs.toString());
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,TABLE_TYPE,REMARKS
null,null,system.columns,Table,null
null,null,system.tables,Table,null
null,null,weather/airQuality/current,Table,null
null,null,weather/airQuality/forecasts/daily,Table,null
null,null,weather/airQuality/forecasts/hourly,Table,null
null,null,weather/currentConditions,Table,null
null,null,weather/forecast/daily,Table,null
null,null,weather/forecast/hourly,Table,null
null,null,weather/forecast/minute,Table,null
null,null,weather/forecast/quarterDay,Table,null
null,null,weather/historical/actuals/daily,Table,null
null,null,weather/historical/normals/daily,Table,null
null,null,weather/historical/records/daily,Table,null
null,null,weather/indices/daily,Table,null
null,null,weather/route,Table,null
null,null,weather/severe/alerts,Table,null
null,null,weather/tropical/storms,Table,null
null,null,weather/tropical/storms/active,Table,null
null,null,weather/tropical/storms/forecasts,Table,null
null,null,weather/tropical/storms/locations,Table,null

The getTables method returns the following metadata columns:

Column Name Data Type Description
TABLE_CAT String The catalog that contains the table.
TABLE_SCHEM String The schema of the table.
TABLE_NAME String The name of the table.
TABLE_TYPE String The type of the table (e.g., TABLE or VIEW).
REMARKS String An optional description of the table.

Columns

Use the getColumns method of the DatabaseMetaData interface to retrieve detailed information about database columns. To narrow the results to a specific table, specify the table name using the parameter table_name.

This method returns columns only for tables that are not write-only.

To get columns for tables which are write-only, query the table system.columns.

try {
    ResultSet rs = connection.getMetaData().getColumns(null, null, "weather/airQuality/current", null);
    LOGGER.info(rs.toString());
} catch (SQLException e) {
    e.printStackTrace();
}

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,DATA_TYPE,TYPE_NAME,COLUMN_SIZE,BUFFER_LENGTH,DECIMAL_DIGITS,NUM_PREC_RADIX,NULLABLE,REMARKS,COLUMN_DEF,SQL_DATA_TYPE,SQL_DATETIME_SUB,CHAR_OCTET_LENGTH,ORDINAL_POSITION,IS_NULLABLE,SCOPE_CATALOG,SCOPE_SCHEMA,SCOPE_TABLE,SOURCE_DATA_TYPE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN,DTS_TYPE
null,null,weather/airQuality/current,category,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,weather/airQuality/current,categoryColor,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,weather/airQuality/current,dateTime,93,TIMESTAMP,null,null,0,0,null,null,null,93,null,null,null,null,null,null,null,null,null,null,DT_DBTIMESTAMP
null,null,weather/airQuality/current,description,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,weather/airQuality/current,dominantPollutant,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,weather/airQuality/current,globalIndex,6,FLOAT,null,null,0,0,null,null,null,6,null,null,null,null,null,null,null,null,null,null,DT_SINGLE
null,null,weather/airQuality/current,index,6,FLOAT,null,null,0,0,null,null,null,6,null,null,null,null,null,null,null,null,null,null,DT_SINGLE
null,null,weather/airQuality/current,pollutants,12,VARCHAR,0,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR

The getColumns method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The database name.
TABLE_SCHEM String The table schema.
TABLE_NAME String The table name.
COLUMN_NAME String The column name.
DATA_TYPE Integer The data type represented by a constant value from java.sql.Types.
TYPE_NAME String The data type name used by the driver.
COLUMN_SIZE Integer The length in characters of the column or the numeric precision.
BUFFER_LENGTH Integer The buffer length.
DECIMAL_DIGITS Integer The column scale or number of digits to the right of the decimal point.
NUM_PREC_RADIX Integer The radix, or base.
NULLABLE Integer Whether the column can contain null as defined by the following JDBC DatabaseMetaData constants: columnNoNulls (0) or columnNullable (1).
REMARKS String The comment or note associated with the object.
COLUMN_DEF String The default value for the column.
SQL_DATA_TYPE Integer Reserved by the specification.
SQL_DATETIME_SUB Integer Reserved by the specification.
CHAR_OCTET_LENGTH Integer The maximum length of binary and character-based columns.
ORDINAL_POSITION Integer The position of the column in the table, starting at 1.
IS_NULLABLE String Whether a null value is allowed: YES or NO.
SCOPE_CATALOG String The catalog of the table referenced by a reference attribute (null if DATA_TYPE is not REF).
SCOPE_SCHEMA String The schema of the table referenced by a reference attribute (null if DATA_TYPE is not REF).
SCOPE_TABLE String The name of the table referenced by a reference attribute (null if DATA_TYPE is not REF).
SOURCE_DATA_TYPE Short The source type of a distinct type or user-defined REF type (null if DATA_TYPE is neither DISTINCT nor a user-defined REF).
IS_AUTOINCREMENT String Whether the column value is assigned by Azure Maps in fixed increments.
IS_GENERATEDCOLUMN String Whether the column is generated: YES or NO.
DTS_TYPE String Object DTS attribute type.

Primary Keys

The getPrimaryKeys method in the DatabaseMetaData interface is used to retrieve metadata about primary keys for a given table in Azure Maps.

try {
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "weather/airQuality/current");
    LOGGER.info("\r\n" + resultSet.toString());
    Assertions.assertNotNull(resultSet);
} catch (SQLException e) {
    LOGGER.severe(e.getMessage());
}

TABLE_NAME,PRIMARY_COLUMN_NAME

NOTE: For Azure Maps, the corresponding tables are read-only, and the API does not specify any field that can serve as a primary key, so we do not return a primary key.

The getPrimaryKeys method returns the following columns:

Column Name Data Type Description
TABLE_CAT String The catalog name.
TABLE_SCHEM String The schema name.
TABLE_NAME String The name of the table that contains the primary key.
COLUMN_NAME String The name of the column that serves as the primary key for the table.
KEY_SEQ Short The sequence number within the primary key.
PK_NAME String The primary key name.

Connection Settings

Connection Setting Type Default Value Description
AccountId String "" The Account Id option allows you to specify the Account Id which identifies the application making the request.
ApiThrottleRate Integer 10 The maximum number of API requests a client can make to the server within a specific time period, defined in requests per second.
AuthenticationMode String "AuthorizationCode" AuthenticationMode specifies the method used to authenticate when connecting to Azure Maps API.
CacheExpirationTime Integer 30 Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword String "" The password used to access the key store file.
ClientId String "" The client ID you have selected or created in Azure Maps.
ClientSecret String "" The client secret you have selected or created in Azure Maps.
ConcurrentWritingThreads Integer 1 The number of threads for executing operations in parallel. A value of 0 will disable multi threading.
ConnectionTimeout Integer 30 ConnectionTimeout is the maximum amount of time the program will wait to set up a connection to the Azure Maps API.
Feature String "" Feature refers to the API functionalities that we support in Azure Maps.
Geography String "" The Geography specifies which Geography service to connect to.
IgnoreCertificateErrors Boolean false Specifies whether to verify the certificate when connecting to Azure Maps. If certificate verification is not required, you can set this value to 'true'.
IgnoreError Boolean false Determines if the program continues executing SQL statements after encountering an error.
InstanceId String "" The InstanceId is required and allows you to specify the instance that should be targeted in requests made to the API.
LogFileSize String "10485760" A string specifying the maximum size in bytes for a log file.
LogLevel String "INFO" The logging level for the JDBC driver.
LogPath String "./jdbcLogs" The directory where log files are stored.
OemKey String "" The OEM license key.
PathToCertificate String "" The file path where the keystore file for connecting to the Azure Maps.
PathToTokenFile String "" PathToTokenFile allows you to specify the path to the token file on the file system.
ProxyMode String NoProxy This setting configures the proxy. Allowed values are "NoProxy", "AutoDetect" and "Manual".
ProxyPassword String "" The password to be used to authenticate to the proxy.
ProxyServer String "" The host of the proxy server.
ProxyServerPort Integer 0 The port of the proxy server.
ProxyUsername String "" The username to be used to authenticate to the proxy.
ReadBatchSize Integer 1 ReadBatchSize is used to set how many records can be read from Azure Maps in a single call.
ResultPath String "" The path where the execution result files are saved.
RetryOnIntermittentErrors Boolean true The RetryOnIntermittentErrors parameter indicates whether to retry the connection when it might occasionally fail due to temporary issues.
SaveResult Boolean false The SaveResult parameter indicates whether to save the execution results to a file.
ServiceName String "" The ServiceName refers to the name of the service API selected by the user.
ServiceTimeout Integer 120 The ServiceTimeout is the timeout to receive the full response from Azure Maps API.
SASToken String "" The SASToken is required to authenticate and authorize API requests to Azure Maps.
Suppress404NotFoundError Boolean true When set to true, if a query results in an HTTP 404 error, a result set will still be created. When set to false, an error is logged instead and no result set is created.
SubscriptionKey String "" The Subscription Key is required to authenticate and authorize API requests to Azure Maps.
TenantId String "" The Azure Tenant ID used to access Azure Maps.
TokenPassword String "" The password used to read the token file.
WriteBatchSize Integer 1 WriteBatchSize is used to set how many records can be written to Azure Maps in a single call.