To create a data access service connector and define the properties, perform the following steps:
In
Application Integration
, click
New
Service Connectors
Data Access Service Connector using Form
Create
.
The data access service connector editor appears.
The following image shows the data access service connector editor:
On the
Definition
tab, define the following basic properties for the data access service connector:
Name
: The name by which the data access service connector is made available for processes. The name must start with a letter or number, and can contain only alphanumeric characters, multibyte characters, underscores (_), and hyphens (-). The name must not exceed 128 characters. This is a required field.
Location
: Specify the project or folder to save the data access service connector. This is a required field.
Description
: Optionally, enter a description for the data access service connector.
Agent Only
: Selected by default because a data access service connector can only run on a Secure Agent.
Use OData
: Select this option to access data from a web service that uses OData. After you enable the
Use OData
option in a data access service connector, you can enable OData and specify the allowed users and groups for OData in the app connection that uses the data access service connections.
For more information about properties related to app connections, see
Design
After you publish the app connection, you can view the OData Service URL and OData Swagger URL in the
Properties Detail
page of the app connection.
In the
Connection Properties
section, define the following general properties to connect to an external database:
JDBC Driver
: The fully qualified Java class name of the JDBC driver.
Based on the database, you can specify one of the following driver class names:
Databricks
: com.databricks.client.jdbc.Driver
IBM DB2
: com.ibm.db2.jcc.DB2Driver
Microsoft SQL Server
: com.microsoft.sqlserver.jdbc.SQLServerDriver
MySQL
: com.mysql.jdbc.Driver
Oracle
: oracle.jdbc.OracleDriver
PostgreSQL
: org.postgresql.Driver
This is a required field.
JDBC URL
: The connection URL to connect to an external database. This is a required field.
Based on the database, you can specify one of the following URLs:
You can only use a personal access token (PAT) authentication method to connect to the Databricks database.
User Name
: The user name to connect to the database. This is a required field.
Password
: The password to connect to the database. This is a required field. The value entered in this field is encrypted by default. In the Developer Console, the password that you enter is visible when you save the connector. After you save, close, and reopen the connector, the password appears encrypted.
When you connect to the Databricks database, enter
token
in the
User Name
field and the PAT value in the
Password
field.
Schema
: Enter the name of the schema that contains the tables that you want to include or exclude in the metadata. To view the appropriate results, you must also enter a schema name in the app connection that uses the data access service connector.
Include Tables
: Enter the names of the tables that you want to include in the metadata. To include a list of tables, use a comma to separate multiple table names. You can also use '.*' for pattern matching. To view the appropriate results, you must also mention the included table names in the app connection that uses the data access service connector.
Exclude Tables
: Enter the names of the tables that you want to exclude from the metadata. To exclude a list of tables, use a comma to separate multiple table names. You can also use '.*' for pattern matching. To view the appropriate results, you must also mention the excluded table names in the app connection that uses the data access service connector.
Optionally, in the
Connection Properties
section, define the following advanced properties :
Check SQL Injection
: Set this field to
Yes
to prevent or mitigate an SQL injection attack that can happen through malicious input parameters. Default is
No
. You must also configure this field in the app connection that uses the data access service connector.
Although you can use this option to prevent SQL injection attacks, it might not apply to all conditions.
Initial Connection Pool Size
: The initial number of connections created when the pool is started. Default is 5.
Max Active
: The maximum number of active connections that can be allocated from the pool simultaneously. If the value is negative, there is no limit. Default is 10.
Min Idle
: The minimum number of connections that can remain idle in the pool without additional connections being created. A value of 0 means that none will be created. Default is 1.
Max Idle
: The maximum number of connections that can remain idle in the pool without additional connections being released. If the value is negative, there is no limit. Default is 5.
Max Wait
: The maximum number of milliseconds that the pool waits for a connection if there are none available. A value of -1 means to wait indefinitely.
Transaction Isolation Level
: The default state of connections created by the pool, which is one of the following states:
0 - None
1 - Read Uncommitted
2 - Read Committed
4 - Repeatable Read
8 - Serializable
Min Evictable Idle Time
: The minimum amount of time an object may sit idle in the pool before it is evicted (if an evictor exists).
Num Tests per Eviction Run
: The number of objects to test during each run of the idle object evictor thread (if an evictor exists).
Test on Borrow
: When selected, objects are validated before being borrowed from the pool. If the object cannot be validated, it is dropped from the pool, and an attempt is made to borrow another. Default is false.
Test on Return
: When selected, the borrowed objects are validated before being returned to the pool. Default is false.
Test while Idle
: When selected, the borrowed objects are validated by the idle object evictor (if one exists). If the object cannot be validated, it is dropped from the pool. Default is false.
Validation Query
: The SQL query that validates connections from the pool before returning them to the caller. If specified, the query must be an SQL SELECT statement that returns at least one row.