OpenSearch

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

Authentication Methods for OpenSearch

Advanced Settings Page

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

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 OpenSearch 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 OpenSearch, 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

UPDATE

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

In OpenSearch, 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

DELETE

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

In OpenSearch, 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

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

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

String sql = "UPSERT INTO students (_id, name) VALUES ('565e27c2', 'name-565e27c2') ON DUPLICATE KEY UPDATE UPSERTFIELDS = (_id)";
try {
    statement.executeUpdate(sql);
    LOGGER.info(statement.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors,isnew
565e27c2,null,null,{"doc":{"name":"name-565e27c2"},"doc_as_upsert":true},false,true

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:

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 students WHERE _id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "1");
    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.

In OpenSearch, 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. 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 students (_id, name) VALUES (?, ?)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "565e27c2");
    ps.setString(2, "fullname");
    ps.executeUpdate();

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

id,errorcode,errormessage,processdata,haserrors
565e27c2,null,null,{"name":"fullname"},false

UPDATE

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

In OpenSearch, 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. 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 students SET gpa = ? WHERE _id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setDouble(1, 3.2);
    ps.setString(2, "565e27c2");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.severe(e.toString());
}

id,errorcode,errormessage,processdata,haserrors
565e27c2,null,null,{"doc":{"gpa":3.2}},false

DELETE

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

In OpenSearch, 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 students WHERE _id = ?";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "565e27c2");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    e.printStackTrace();
}

id,errorcode,errormessage,processdata,haserrors
565e27c2,null,null,null,false

UPSERT

Using the UPSERT operation, you can either insert or update an existing record in one call.

Not all tables support the upsert operation. Query the system.tables table to identify which tables support UPSERT operations.

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

String sql = "UPSERT INTO students (_id, name) VALUES (?, ?) ON DUPLICATE KEY UPDATE UPSERTFIELDS = (_id)";
try {
    PreparedStatement ps = connection.prepareStatement(sql);
    ps.setString(1, "565e27c2");
    ps.setString(2, "name-565e27c2");
    ps.executeUpdate();
    LOGGER.info(ps.getResultSet().toString());
} catch (SQLException e) {
    LOGGER.error(e);
}

id,errorcode,errormessage,processdata,haserrors,isnew
565e27c2,null,null,{"doc":{"name":"name-565e27c2"},"doc_as_upsert":true},false,true

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,.opendistro_security,Table,null
null,null,.plugins-ml-config,Table,null
null,null,security-auditlog-2025.10.18,Table,null
null,null,security-auditlog-2025.10.20,Table,null
null,null,security-auditlog-2025.10.21,Table,null
null,null,security-auditlog-2025.10.22,Table,null
null,null,students,Table,null
null,null,system.columns,Table,null
null,null,system.tables,Table,null
null,null,top_queries-2025.10.18-55817,Table,null

......

The getTables method returns the following metadata columns:

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, "students", 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,students,_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,students,_index,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,students,_primary_term,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,null,null,null,null,DT_I8
null,null,students,_score,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,null,null,null,null,DT_I8
null,null,students,_seq_no,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,null,null,null,null,DT_I8
null,null,students,_type,12,VARCHAR,null,null,0,0,null,null,null,12,null,null,null,null,null,null,null,null,null,null,DT_WSTR
null,null,students,_version,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,null,null,null,null,DT_I8
null,null,students,gpa,6,FLOAT,null,null,0,0,null,null,null,6,null,null,null,null,null,null,null,null,null,null,DT_R8
null,null,students,grad_year,-5,BIGINT,null,null,0,0,null,null,null,-5,null,null,null,null,null,null,null,null,null,null,DT_I8
null,null,students,name,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:

Primary Keys

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

try {
    ResultSet resultSet = connection.getMetaData().getPrimaryKeys(null, null, "students");
    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,students,_id,1,null

The getPrimaryKeys method returns the following columns:

Connection Settings