Allow passing of parameters to reactive sql client connect options

[edeandrea]

Allow passing of parameters to reactive sql client connect options

Fixes #25914

[edeandrea]

@geoand / @Sanne I took a stab at this. I implemented it using a generic properties container that gets passed along to the underlying SqlConnectOptions.addProperty. This way, configuration like this works:

quarkus:
  datasource:
    username: myusername
    password: mypassword
    reactive:
      url: postgresql://free-tier14.aws-us-east-1.cockroachlabs.cloud:26257/defaultdb
      properties:
        options: --cluster=heroes-db-2463
      postgresql:
        ssl-mode: require

or

quarkus.datasource.username=myusername
quarkus.datasource.password=mypassword
quarkus.datasource.reactive.url=postgresql://free-tier14.aws-us-east-1.cockroachlabs.cloud:26257/defaultdb
quarkus.datasource.reactive.properties.options=--cluster=heroes-db-2463
quarkus.datasource.reactive.postgresql.ssl-mode=require

If you'd rather just have a specific config property for options rather than a Map for properties, I can change things around.

[tsegismont]

Thank you @edeandrea

Just one suggestion, not mandatory.

[tsegismont]

Perhaps, for consistency, we could call this additionalProperties:

quarkus/extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSourceJdbcRuntimeConfig.java

Lines 135 to 139 in 15677f0

	/**
	* Other unspecified properties to be passed to the JDBC driver when creating new connections.
	*/
	@ConfigItem
	public Map<String, String> additionalJdbcProperties;

[edeandrea]

Sure I can do that. I was staying consistent with the getProperties/setProperties/addProperty naming conventions on io.vertx.sqlclient.SqlConnectOptions rather than trying to match what the JDBC stuff calls it.

[edeandrea]

Done

[tsegismont]

Thank you

[kdubb]

@edeandrea Just by reading, the naming is a little confusing. Does cockroach support a PGConnectOptions option named options?

We need to set the search_path, would I do that as follows?

quarkus.datasource.username=myusername
quarkus.datasource.password=mypassword
quarkus.datasource.reactive.url=postgresql://host/db
quarkus.datasource.reactive.additional-properties.search_path=my_schema,public

[kdubb]

BTW the naming issues start with vertx. As you know the name of the class is PGConnectOptions but it has addProperty and addProperties. So, naming it additionalProperties also seems inline as long as we ignore the "options" outlier.

[edeandrea]

@kdubb CockroachDB serverless DBaaS requires a connection parameter named options which has a value of --cluster=<cluster_name>. See their documentation (https://www.cockroachlabs.com/docs/v22.1/connection-parameters#connect-using-a-url).

With this change, quarkus.datasource.reactive.additional-properties.search_path=my_schema,public would set

search_path=my_schema,public as a property on the SqlConnectOptions (the parent class of PgConnectOptions). This change flows on all the reactive drivers, not just the postgres one.

[kdubb]

@edeandrea Perfect. Thanks this is exactly what we need.

@gsmet This seems ready to go. Who do we ping to get this in for 2.10? I don't think I'm allowed to exercise my labeling powers to add this to the milestone lol

[geoand]

Who do we ping to get this in for 2.10? I don't think I'm allowed to exercise my labeling powers to add this to the milestone lol

As long as it's merged in the next few days, it will be part of 2.10.

@Sanne can you take a look at it? It looks good to me, but this is not my wheelhouse.

[Sanne]

I'm wondering if this should be clarified: technically these options are passed directly to the PG database server each time a new connection is initiated.

[edeandrea]

@Sanne What if we said something like this?

Other unspecified properties to be passed through the Reactive SQL Client directly to the database when new connections are initiated.

Not that this change is for all the reactive sql clients - not just the PG one.

[Sanne]

yes sounds good! thanks

[edeandrea]

Done. Just pushed an update.

[Sanne]

Great, thanks!