Set custom query id using ThreadLocal

[skauppin]

Summary

Older JDBC driver had the possibility to set a custom query ID using com.clickhouse.client.ClickHouseRequestManager. Seems like the latest version doesn't have a way to do the same. We have a use case where we need to check whether an database query (maybe an insert also) is already running and not start it again if it is. This may happen e.g. if the operation times out on the client side.

How to now set a custom query ID

Client.setThreadQueryId("my-query-id");

// execute a query

Client.removeThreadQueryId();

This seems to set the query Id as we want, even in the case that we are using Spring JdbcTemplate for executing db operations. com.clickhouse.client.api.query.QuerySettings has a setter and getter for a query ID, but we did not find any way to actually set it that way.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[chernser]

Good day, @skauppin !

Do you need client to check if query is running? (It would be great if you describe your need in an issue)

Here is an example how it supposed to be used:

 settings = new InsertSettings()
                .setDeduplicationToken(RandomStringUtils.randomAlphabetic(36))
                .setQueryId(String.valueOf(UUID.randomUUID()));
           InsertResponse response = client.insert(tableName, simplePOJOs, settings).get(EXECUTE_CMD_TIMEOUT, TimeUnit.SECONDS);

It is up to application how to implement checking queryID.

As for JDBC - it should be implemented in JDBC code. But we need kind of feature description to understand how to implement.

Thanks!

[skauppin]

Thanks for the quick reply!

I created an example project showing how we are currently executing ClickHouse operations using Spring JdbcTemplate:
https://github.com/skauppin/spring-clickhouse-db
and specifically
https://github.com/skauppin/spring-clickhouse-db/blob/master/src/main/java/com/example/spring_clickhouse_db/DatabaseOperations.java

ClickHouse jdbc driver version is 0.7.2, and this version supports creating a custom implementation of com.clickhouse.client.ClickHouseRequestManager that we use to set query Id.

The point is that we are not using Clickhouse client directly, but relying on standard JDBC api and Spring JdbcTemplate on top of that.

Hope this example clarifies it. I can also try to create an issue if needed.

[chernser]

@skauppin
I appreciate the example and will look into it this week.
I agree we need to support the Spring and will try to find suitable way for this.

[chernser]

/windsurf-review

[windsurf-bot]

1 file skipped due to size limits:

• client-v2/src/main/java/com/clickhouse/client/api/Client.java