Skip to content

Expose compiled SQL for SqlTemplate to improve transparency #1612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tsegismont merged 1 commit into from
Feb 2, 2026
Merged

Expose compiled SQL for SqlTemplate to improve transparency #1612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions vertx-sql-client-templates/src/main/java/io/vertx/sqlclient/templates/SqlTemplate.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,12 @@ static SqlTemplate<Map<String, Object>, SqlResult<Void>> forUpdate(SqlClient cli
return new SqlTemplateImpl<>(client, sqlTemplate, query -> query.collecting(SqlTemplateImpl.NULL_COLLECTOR), sqlTemplate::mapTuple);
}


/**
* @return the computed SQL for this template
*/
String getSql();

/**
* Set a parameters user defined mapping function.
*
Expand Down
12 changes: 6 additions & 6 deletions ...sql-client-templates/src/main/java/io/vertx/sqlclient/templates/impl/SqlTemplateImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@

import io.vertx.core.Future;
import io.vertx.core.json.JsonObject;
import io.vertx.sqlclient.PreparedQuery;
import io.vertx.sqlclient.Row;
import io.vertx.sqlclient.RowSet;
import io.vertx.sqlclient.SqlClient;
import io.vertx.sqlclient.SqlResult;
import io.vertx.sqlclient.Tuple;
import io.vertx.sqlclient.*;
import io.vertx.sqlclient.templates.RowMapper;
import io.vertx.sqlclient.templates.TupleMapper;

Expand Down Expand Up @@ -37,6 +32,11 @@ public SqlTemplateImpl(SqlClient client,
this.tupleMapper = tupleMapper;
}

@Override
public String getSql() {
return sqlTemplate.getSql();
}

@Override
public <T> io.vertx.sqlclient.templates.SqlTemplate<T, R> mapFrom(TupleMapper<T> mapper) {
return new SqlTemplateImpl<>(client, sqlTemplate, queryMapper, params -> mapper.map(sqlTemplate, sqlTemplate.numberOfParams(), params));
Expand Down
4 changes: 3 additions & 1 deletion ...client-templates/src/test/java/io/vertx/tests/sqlclient/templates/PgTemplateTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,12 @@ protected <P, T, V> void testGet(TestContext ctx,
Function<T, V> extractor,
String column) {
Async async = ctx.async();
String query = "SELECT %s :: %s \"%s\"";
SqlTemplate<P, RowSet<T>> template = SqlTemplate
.forQuery(connection, "SELECT #{" + paramName + "} :: " + sqlType + " \"" + column + "\"")
.forQuery(connection, String.format(query, "#{" + paramName + "}", sqlType, column))
.mapFrom(paramsMapper)
.mapTo(rowMapper);
ctx.assertEquals(String.format(query, "$1", sqlType, column), template.getSql());
template
.execute(params)
.onComplete(ctx.asyncAssertSuccess(result -> {
Expand Down