Merge pull request #1103 from daneshk/main

Provide a way to set the current schema when initializing the db connection

.gitignore

@@ -53,6 +53,7 @@ gradle-app.setting
 
 # log files
 **/test_log.conf
+**/bin
 
 # Examples
 examples/**/Dependencies.toml

ballerina/Ballerina.toml

@@ -22,5 +22,5 @@ path = "../native/build/libs/postgresql-native-1.14.0-SNAPSHOT.jar"
 groupId = "io.ballerina.stdlib"
 artifactId = "sql-native"
 version = "1.15.0"
-path = "./lib/sql-native-1.15.0-20241208-002900-e3bd25f.jar"
+path = "./lib/sql-native-1.15.0-20241218-171100-16f31a4.jar"
 

ballerina/Dependencies.toml

@@ -5,7 +5,7 @@
 
 [ballerina]
 dependencies-toml-version = "2"
-distribution-version = "2201.11.0-20241121-075100-c4c87cbc"
+distribution-version = "2201.11.0-20241218-101200-109f6cc7"
 
 [[package]]
 org = "ballerina"

ballerina/client.bal

@@ -158,6 +158,7 @@ type ClientConfiguration record {|
 #                         so that the cancel message itself can get stuck. The default value is 10 seconds
 # + keepAliveTcpProbe - Enable or disable the TCP keep-alive probe
 # + binaryTransfer - Use the binary format for sending and receiving data if possible
+# + currentSchema - The schema to be used by the client
 public type Options record {|
     SecureSocket ssl?;
     decimal connectTimeout = 0;
@@ -172,6 +173,7 @@ public type Options record {|
     decimal cancelSignalTimeout = 10;
     boolean keepAliveTcpProbe?;
     boolean binaryTransfer?;
+    string currentSchema?;
 |};
 
 # Possible values for the SSL mode.

ballerina/tests/connection-init-test.bal

@@ -251,6 +251,20 @@ function testWithConnectionParams3() returns error? {
     test:assertExactEquals(exitCode, (), "Initialising connection with connection params fails.");
 }
 
+@test:Config {
+    groups: ["connection", "connection-init"]
+}
+function testWithConnectionDBSchema() returns error? {
+    Options options = {
+        currentSchema: "test_schema"
+    };
+    Client dbClient = check new (host = host, username = user, password = password, options = options);
+    int count = check dbClient->queryRow(`Select count(*) from "NumericTypes3"`);
+    test:assertEquals(count, 1, "Initialising connection with custom schema failed.");
+    error? exitCode = dbClient.close();
+    test:assertExactEquals(exitCode, (), "Initialising connection with custom schema failed.");
+}
+
 @test:Config {
     groups: ["connection", "connection-init"]
 }

ballerina/tests/resources/sql-scripts/init-scripts/table-init-script.sql

@@ -910,3 +910,46 @@ INSERT INTO ArrayTypes5 (
    ARRAY[Null, Null] :: MONEY ARRAY,
    ARRAY[Null, Null] :: PG_LSN ARRAY
    );
+
+DROP SCHEMA IF EXISTS "test_schema" CASCADE;
+
+CREATE SCHEMA "test_schema";
+
+CREATE TABLE "test_schema"."NumericTypes3" (
+  row_id SERIAL,
+  smallint_type SMALLINT,
+  int_type INTEGER,
+  bigint_type BIGINT,
+  decimal_type DECIMAL,
+  numeric_type NUMERIC,
+  real_type REAL,
+  double_type DOUBLE PRECISION,
+  smallserial_type SMALLSERIAL,
+  serial_type SERIAL,
+  bigserial_type BIGSERIAL,
+  PRIMARY KEY (row_id)
+);
+
+INSERT INTO "test_schema"."NumericTypes3" (
+  smallint_type,
+  int_type,
+  bigint_type,
+  decimal_type,
+  numeric_type,
+  real_type,
+  double_type,
+  smallserial_type,
+  serial_type,
+  bigserial_type
+) VALUES (
+  1,
+  123,
+  123456,
+  123.456,
+  123.456,
+  234.567,
+  234.567,
+  1,
+  123,
+  123456
+);

changelog.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- [Provide a way to set the current schema when initializing the db connection](https://github.com/ballerina-platform/ballerina-library/issues/7517)
+
+## [1.13.2] - 2024-11-11
+
 ### Added
 - [Allow prepareThreshold, preparedStatementCacheQueries and preparedStatementCacheSizeMiB to pass 0 values](https://github.com/ballerina-platform/ballerina-standard-library/issues/7345)
 

docs/spec/spec.md

@@ -87,6 +87,7 @@ public isolated function init(string host = "localhost", string? username = "pos
   #                         so that the cancel message itself can get stuck. The default value is 10 seconds
   # + keepAliveTcpProbe - Enable or disable the TCP keep-alive probe
   # + binaryTransfer - Use the binary format for sending and receiving data if possible
+  # + currentSchema - The schema to be used by the client
   public type Options record {|
       SecureSocket ssl = {};
       decimal connectTimeout = 0;
@@ -101,6 +102,7 @@ public isolated function init(string host = "localhost", string? username = "pos
       decimal cancelSignalTimeout = 10;
       boolean keepAliveTcpProbe?;
       boolean binaryTransfer?;
+      string currentSchema?;
   |};
   ``` 
 * SSL Connection:

gradle.properties

@@ -58,4 +58,4 @@ stdlibHttpVersion=2.13.0-20250128-151800-532e2e7
 stdlibTransactionVersion=1.11.0-20250128-164000-57ba991
 
 # Ballerina extended library
-stdlibPostgresqlDriverVersion=1.6.0-20241126-144300-59acbb0
+stdlibPostgresqlDriverVersion=1.6.0-20250124-122300-f24ae72

native/src/main/java/io/ballerina/stdlib/postgresql/Constants.java

@@ -62,6 +62,7 @@ public static final class Options {
         public static final BString CANCEL_SIGNAL_TIMEOUT = StringUtils.fromString("cancelSignalTimeout");
         public static final BString TCP_KEEP_ALIVE = StringUtils.fromString("keepAliveTcpProbe");
         public static final BString BINARY_TRANSFER = StringUtils.fromString("binaryTransfer");
+        public static final BString CURRENT_SCHEMA = StringUtils.fromString("currentSchema");
     }
     /**
      * Constants for ssl configuration.
@@ -112,6 +113,7 @@ public static final class DatabaseProps {
         public static final BString LOGIN_TIMEOUT = StringUtils.fromString("loginTimeout");
         public static final BString ROW_FETCH_SIZE = StringUtils.fromString("defaultRowFetchSize");
         public static final BString BINARY_TRANSFER = StringUtils.fromString("binaryTransfer");
+        public static final BString CURRENT_SCHEMA = StringUtils.fromString("currentSchema");
     }
     /**
      * Constants for Out Parameter Type Names. 

native/src/main/java/io/ballerina/stdlib/postgresql/utils/Utils.java

@@ -106,6 +106,10 @@ public static BMap generateOptionsMap(BMap postgresqlOptions) {
                     options.put(Constants.DatabaseProps.BINARY_TRANSFER, false);
                 }
             }
+            if (postgresqlOptions.containsKey(Constants.Options.CURRENT_SCHEMA)) {
+                options.put(Constants.DatabaseProps.CURRENT_SCHEMA, postgresqlOptions
+                        .getStringValue(Constants.Options.CURRENT_SCHEMA));
+            }
             return options;
         }
         return null;