Elasticsearch

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 Elasticsearch REST service.

connectionmanage

General Settings

General Settings

Base Url: The Base URL specifies the URL of the API endpoint for your Elasticsearch instance.
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.
Scroll API: By enabling Scroll API, requests will be sent to the Elasticsearch Scroll API instead of the Search API. Once enabled, you will be able to enter the value for the scroll parameter, including both the unit of time and the amount of time.

Authentication

Authentication Mode

The Authentication Mode option allows you to specify how to authenticate with the Elasticsearch server. Available options are:

None
API Key
Basic
Client Credentials
OpenID Connect
Delegate PKI
Password
AWS Signature

Authentication Methods for Elasticsearch

None

Use this option when your request does not require authorization.

API Key

A pre-existing API Key can be used to establish a connection. If the API Key is base64 encoded, it can be provided in the API Key field with the Encoded API Token checkbox selected. If you wish to generate a new API Key, click Generate API Key to go through the API Key creation process. You can use the created API Key to connect.

Authentication

API Key ID: ID of the API Key that you would like to use. If you do not have an API key you can generate one by clicking the Generate API Key button.
API Key: API Key that you would like to use, enter it in the authentication field, and check the 'Encoded API Token' if it is base64 encoded.
Generate API Key: If you click the Generate API Key button the 'Generate API Key' dialog will appear. You can enter credentials for an Elasticsearch user, and then generate an API Key. The generated token will automatically populate the 'API Key ID' and 'API Key' field. Credentials entered in this dialog are not saved, they are just used to generate a token and then discarded.
Encoded API Token: When the Encoded API Token checkbox is enabled, authentication will be performed using only the base64 encoded API Key value provided.

Basic

Users can choose to use their instance url along with their username and password to establish a connection.

Authentication

Username: The Username of the account you wish to use to connect to your Elasticsearch instance.
Password: The Password of the account you wish to use to connect to your Elasticsearch instance.

Client Credentials

Client Credentials can be used to authenticate and connect to Elasticsearch. Provide the Client ID and Client Secret.

Authentication

Username: The Username option allows you to specify the Username used to authenticate with the API.
Password: The Password option allows you to specify the Password used to authenticate with the API.

OpenID Connect

Uses an identity provider to authenticate users and provide identity information via tokens.

Authentication

Username: The Username of the account you wish to use to connect to your Elasticsearch OID instance.
Password: The Password of the account you wish to use to connect to your Elasticsearch OID instance.
Realm: The Realm of the account you wish to use to connect to your Elasticsearch OID instance.
Iss: The Issuer of the account you wish to use to connect to your Elasticsearch OID instance.

Delegate PKI

Allows certificate management to be delegated to trusted entities while maintaining central CA trust.

Authentication

Username: The Username of the account you wish to use to connect to your Elasticsearch OID instance.
Password: The Password of the account you wish to use to connect to your Elasticsearch OID instance.
Certificate Path: The path to an existing certificate file.
Certificate Password: The password for the specified certificate file.

Password

Users can choose to use their instance url along with their username and password to establish a connection.

Authentication

Username: The Username of the account you wish to use to connect to your Elasticsearch instance.
Password: The Password of the account you wish to use to connect to your Elasticsearch instance.

AWS Signature

Provide an Access Key, Access Secret, Session Token, Service Name, and select an AWS region to establish a connection.

AWS Signature Settings

Access Key: The Access key to be used for authentication.
Access Secret: Provide the Access secret to be used for authentication.
AWS Region: The AWS Region for the web service endpoint.
Session Token: The Session Token option allows you to specify a temporary security token, known as temporary security credentials. Note this property is optional.

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.

Max Rows to Scan for Field Discovery

This allows you to set how many rows will be scanned when the JDBC driver populates table metadata.

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 Elasticsearch 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.

To improve performance when executing multiple write queries, utilize the batch feature. For more information, review Batch Writing with PreparedStatement.

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 account_1";
try {
    ResultSet resultSet = statement.executeQuery(sql);
    LOGGER.info(resultSet.toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the Statement class to execute an INSERT operation.

In Elasticsearch, when writing multiple values to a field, you can provide the values with a comma delimited format. However, when writing multiple string values the delimiter character should be \, instead of just ,

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the inserted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "INSERT INTO account_1 (_id, FirstName) VALUES ('5f3d5d62', 'firstName')";

try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,{"FirstName":"firstName"},false

String sql = "INSERT INTO employee (_id,firstname,lastname,dob,gender,isActive,salary,joinDate,department,hobby,company) " +
             "VALUES ('1','John','Doe','2001-10-09T11:55:09.246286700-04:00','Male',true,80000.00,'2024-10-09T11:55:09.246286700-04:00'," +
             "'Marketing\\,Sales\\,Purchasing','hiking\\,swimming','test')";

try {
    int result = statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"firstname":"John","lastname":"Doe","dob":"2001-10-09","gender":"Male","isActive":true,"salary":80000.0,"joinDate":"2024-10-09 15:55:09","department":["Marketing","Sales","Purchasing"],"hobby":["hiking","swimming"],"company":"test"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the Statement class to execute an UPDATE operation.

In Elasticsearch, you can also utilize the Update by Query API. This allows you to update documents within an index or data stream that match a specified query. This allows you to perform powerful update queries more effectively while also reducing network overhead. An example is shown below.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the updated data's ID, exceptions raised during execution, and details of the affected data.

String sql = "UPDATE account_1 SET LastName = 'lastName' WHERE _id = '5f3d5d62'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,{"doc":{"LastName":"lastName"}},false

String sql = "UPDATE employee " + 
             "SET script = '{\"source\": \"ctx._source.isActive= false\",\"lang\": \"painless\"}', conflicts='proceed' " +
             "WHERE query = '{\"match\":{\"company\":\"test\"}}'";
  
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{"script":{"source":"ctx._source.isActive= false","lang":"painless"},"query":{"match":{"company":"test"}}},false

DELETE

Use either the generic execute method or the executeUpdate method of the Statement class to execute a DELETE operation.

In Elasticsearch, you can also utilize the Delete by Query API. This allows you to delete documents within an index or data stream that match a specified query. This allows you to perform powerful delete queries more effectively while also reducing network overhead. An example is shown below.

The results of SQL queries are saved in a ResultSet. You can retrieve the ResultSet after execution to view the deleted data's ID, exceptions raised during execution, and details of the affected data.

String sql = "DELETE FROM account_1 WHERE _id = '5f3d5d62'";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,null,false

String sql = "DELETE FROM employee WHERE query = '{\"match\":{\"company\":\"test\"}}' AND conflicts = 'proceed'";
  
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{"query":{"match":{"company":"test"}}},false

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

Create a PreparedStatement

Use the prepareStatement method of the Connection class to instantiate a PreparedStatement.

Refer to Connecting with DriverManager or Connecting with DataSource for information related to establishing connections.

Set Parameters

Declare parameters by calling the corresponding setter method of the PreparedStatement.
NOTE: The parameter indices start at 1.

Execute the PreparedStatement

Use the generic execute or executeUpdate method of the PreparedStatement.

Retrieve Results

Call the getResultSet method of the PreparedStatement to obtain the query results, which will be returned as a ResultSet.

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 account_1";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    boolean ret = ps.execute(sql);
    if (ret) {
        ResultSet rs = ps.getResultSet();
        LOGGER.info(rs.toString());
    }
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

INSERT

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute an INSERT operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of inserted data, exceptions raised during execution, and the data affected by the insertion.

String sql = "INSERT INTO account_1 (_id, FirstName) VALUES (?, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "5f3d5d62");
    ps.setString(2, "firstName");
    ps.executeUpdate();

    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,{"FirstName":"firstName"},false

String sql = "INSERT INTO employee (_id,firstname,lastname,dob,gender,isActive,salary,joinDate,department,hobby,company) " +
             "VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)";

try (PreparedStatement ps = connection.prepareStatement(sql)){
    ps.setString(1, "1");
    ps.setString(2, "John");
    ps.setString(3, "Doe");
    ps.setString(4, "2001-10-09T11:55:09.246286700-04:00");
    ps.setString(5, "Male");
    ps.setBoolean(6, "true");
    ps.setDouble(7, 80000.00);
    ps.setString(8, "2024-10-09T11:55:09.246286700-04:00");
    ps.setString(9, "Marketing\\,Sales\\,Purchasing");
    ps.setString(10, "hiking\\,swimming");
    ps.setString(11, "test");
    int result = ps.executeUpdate(sql);
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
1,null,null,{"firstname":"John","lastname":"Doe","dob":"2001-10-09","gender":"Male","isActive":true,"salary":80000.0,"joinDate":"2024-10-09 15:55:09","department":["Marketing","Sales","Purchasing"],"hobby":["hiking","swimming"],"company":"test"},false

UPDATE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute an UPDATE operation.

The results of SQL queries are saved in a ResultSet. Users can retrieve the ResultSet after execution to view the ID of updated data, exceptions raised during execution, and the data affected by the update.

String sql = "UPDATE account_1 SET LastName = ? WHERE _id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "lastName");
    ps.setString(2, "5f3d5d62");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,{"doc":{"LastName":"lastName"}},false

String sql = "UPDATE employee " + 
             "SET script = ? " +
             "WHERE query = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "{\"source\": \"ctx._source.isActive= false\",\"lang\": \"painless\"}");
    ps.setString(2, "{\"match\":{\"company\":\"test\"}}");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{"script":{"source":"ctx._source.isActive= false","lang":"painless"},"query":{"match":{"company":"test"}}},false

DELETE

Use either the generic execute method or the executeUpdate method of the PreparedStatement class to execute a DELETE operation.

String sql = "DELETE FROM account_1 WHERE _id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "5f3d5d62");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata,haserrors
5f3d5d62,null,null,null,false

String sql = "DELETE FROM employee WHERE query = ? AND conflicts = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "{\"match\":{\"company\":\"test\"}}");
    ps.setString(2, "proceed");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata,haserrors
null,null,null,{"query":{"match":{"company":"test"}}},false

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,account_1,Table,null
null,null,accounts,Table,null
null,null,accounts-copy,Table,null
null,null,all-datatype,Table,null
null,null,branch,Table,null
null,null,car,Table,null
null,null,company,Table,null
null,null,contacts,Table,null
null,null,custom_index,Table,null
null,null,dates,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, "account_1", 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,account_1,City,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,Column1,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,Column2,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,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,account_1,FirstName,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,Gender,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,LastName,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,State,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,_id,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,account_1,_index,12,VARCHAR,null,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 Elasticsearch 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 Elasticsearch.

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

TABLE_CAT,TABLE_SCHEM,TABLE_NAME,COLUMN_NAME,KEY_SEQ,PK_NAME
null,null,account_1,_id,1,null

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
AccessKey	String	""	AWS Access Key to be used for signing requests when using AWS v4 authentication.
AccessSecret	String	""	AWS Secret Key paired with the AccessKey, used for secure request signing.
ApiKey	String	""	Secret Key used in conjunction with ApiKeyId to authenticate requests.
ApiKeyId	String	""	Identifier for an Elasticsearch API Key.
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	"None"	The current authentication method being used. Refer to the Authentication section for more details.
AWSRegion	String	""	The AWS region your Elasticsearch cluster is hosted in.
BaseUrl	String	""	The root endpoint of your Elasticsearch cluster.
CacheExpirationTime	Integer	30	Defines the expiration time for cache. A value of 0 disables caching.
CertificatePassword	String	""	The password used to access the keystore file.
ClientId	String	""	The ClientId used to access Elasticsearch.
ClientSecret	String	""	The ClientSecret used to access Elasticsearch.
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 Elasticsearch API.
IgnoreCertificateErrors	Boolean	false	Specifies whether to verify the certificate when connecting to Elasticsearch. 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.
Issuer	String	""	The OIDC Issuer URL - the base URL of the identity provider that issues the tokens.
IsEncodedToken	Boolean	false	Flag indicating whether the token is base64 encoded.
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.
MaxRowsToScanForFieldDiscovery	Integer	100	This allows you to set how many rows will be scanned when the JDBC driver populates table metadata.
OemKey	String	""	The OEM license key.
Password	String	""	The Password of the Elasticsearch account used to authenticate requests to the Elasticsearch API.
PathToCertificate	String	""	The file path where a token is stored.
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	1000	ReadBatchSize is used to set how many records can be read from Elasticsearch in a single call.
Realm	String	""	The name or identifier of the configured OIDC realm in Elasticsearch.
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.
ScrollRate	Integer	0	The ScrollRate parameter indicates how long Elasticsearch should retain the search context for the request.
ScrollRateUnit	String	""	The ScrollRateUnit parameter allows you to choose the unit of time for the specified value of the ScrollRate parameter
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 Elasticsearch API.
SessionToken	String	""	Temporary AWS session token.
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.
UserName	String	""	The user name of the Elasticsearch account that will be used to authenticate requests to the Elasticsearch API.
UseScroll	Boolean	true	The UseScroll parameter allows you to determine whether to paginate requests using index or by Scroll API
WriteBatchSize	Integer	200	WriteBatchSize is used to set how many records can be written to Elasticsearch in a single call.

Elasticsearch JDBC Driver

Documentation for Elasticsearch drivers found within JDBC Driver Pack

Elasticsearch

Building the JDBC URL

General Page

Authentication Methods for Elasticsearch

Advanced Settings Page

Using the JDBC Driver

Executing Statements

SELECT

INSERT

UPDATE

DELETE

Executing Prepared Statements

SELECT

INSERT

UPDATE

DELETE

Metadata Discovery

Tables

Columns

Primary Keys

Connection Settings