Merge pull request #22 from ydb-platform/additional_configs

alex268 · web-flow · commit 271ec8c17737 · 2023-09-25T19:06:09.000+01:00
Additional config for query modes
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+## 2.0.1 ##
+
+* Added parameter `forceQueryMode` to use for specifying the type of query
+* Execution of scan or scheme query inside active transaction will raise exception
+
+## 2.0.0 ##
+
+* Auto detect of YDB query type
+* Support of batch queries
+* Support of standart positional parameters
+* Added the ability to set the YQL variable by alphabetic order
+
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/YdbConst.java b/jdbc/src/main/java/tech/ydb/jdbc/YdbConst.java
@@ -91,6 +91,10 @@ public final class YdbConst {
     public static final String UNSUPPORTED_QUERY_TYPE_IN_PS = "Query type in prepared statement not supported: ";
     public static final String STATEMENT_IS_NOT_A_BATCH = "Statement cannot be executed as batch statement: ";
     public static final String MULTI_TYPES_IN_ONE_QUERY = "Query cannot contain expressions with different types: ";
+    public static final String SCAN_QUERY_INSIDE_TRANSACTION = "Scan query cannot be executed inside active "
+            + "transaction. This behavior may be changed by property scanQueryTxMode";
+    public static final String SCHEME_QUERY_INSIDE_TRANSACTION = "Scheme query cannot be executed inside active "
+            + "transaction. This behavior may be changed by property schemeQueryTxMode";
 
     // Cast errors
 
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/impl/YdbConnectionImpl.java b/jdbc/src/main/java/tech/ydb/jdbc/impl/YdbConnectionImpl.java
@@ -36,8 +36,11 @@
 import tech.ydb.jdbc.context.YdbContext;
 import tech.ydb.jdbc.context.YdbExecutor;
 import tech.ydb.jdbc.context.YdbTxState;
+import tech.ydb.jdbc.exception.YdbExecutionException;
 import tech.ydb.jdbc.query.QueryType;
 import tech.ydb.jdbc.query.YdbQuery;
+import tech.ydb.jdbc.settings.FakeTxMode;
+import tech.ydb.jdbc.settings.YdbOperationProperties;
 import tech.ydb.table.Session;
 import tech.ydb.table.query.DataQuery;
 import tech.ydb.table.query.DataQueryResult;
@@ -61,6 +64,8 @@ public class YdbConnectionImpl implements YdbConnection {
     private final YdbContext ctx;
     private final YdbExecutor executor;
     private final Supplier<YdbDatabaseMetaData> metaDataSupplier;
+    private final FakeTxMode scanQueryTxMode;
+    private final FakeTxMode schemeQueryTxMode;
 
     private volatile YdbTxState state;
 
@@ -69,10 +74,11 @@ public YdbConnectionImpl(YdbContext context) throws SQLException {
         this.metaDataSupplier = Suppliers.memoize(() -> new YdbDatabaseMetaDataImpl(this))::get;
         this.executor = new YdbExecutor(LOGGER);
 
-        int txLevel = ctx.getOperationProperties().getTransactionLevel();
-        boolean txAutoCommit = ctx.getOperationProperties().isAutoCommit();
-        this.state = YdbTxState.create(txLevel, txAutoCommit);
+        YdbOperationProperties props = ctx.getOperationProperties();
+        this.scanQueryTxMode = props.getScanQueryTxMode();
+        this.schemeQueryTxMode = props.getSchemeQueryTxMode();
 
+        this.state = YdbTxState.create(props.getTransactionLevel(), props.isAutoCommit());
         this.ctx.register();
     }
 
@@ -256,7 +262,17 @@ public void executeSchemeQuery(YdbQuery query, YdbExecutor executor) throws SQLE
         ensureOpened();
 
         if (state.isInsideTransaction()) {
-            commit();
+            switch (schemeQueryTxMode) {
+                case FAKE_TX:
+                    break;
+                case SHADOW_COMMIT:
+                    commit();
+                    break;
+                case ERROR:
+                default:
+                    throw new YdbExecutionException(YdbConst.SCHEME_QUERY_INSIDE_TRANSACTION);
+
+            }
         }
 
         // Scheme query does not affect transactions or result sets
@@ -292,6 +308,20 @@ public DataQueryResult executeDataQuery(YdbQuery query, YdbExecutor executor,
     public ResultSetReader executeScanQuery(YdbQuery query, YdbExecutor executor, Params params) throws SQLException {
         ensureOpened();
 
+        if (state.isInsideTransaction()) {
+            switch (scanQueryTxMode) {
+                case FAKE_TX:
+                    break;
+                case SHADOW_COMMIT:
+                    commit();
+                    break;
+                case ERROR:
+                default:
+                    throw new YdbExecutionException(YdbConst.SCAN_QUERY_INSIDE_TRANSACTION);
+
+            }
+        }
+
         String yql = query.getYqlQuery(params);
         Collection<ResultSetReader> resultSets = new LinkedBlockingQueue<>();
         Duration scanQueryTimeout = ctx.getOperationProperties().getScanQueryTimeout();
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQuery.java b/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQuery.java
@@ -91,7 +91,7 @@ public QueryType type() {
     }
 
     public static YdbQuery from(YdbQueryOptions opts, String sql) throws SQLException {
-        YdbQueryBuilder builder = new YdbQueryBuilder(sql);
+        YdbQueryBuilder builder = new YdbQueryBuilder(sql, opts.getForcedQueryType());
         JdbcQueryLexer.buildQuery(builder, opts);
         return new YdbQuery(opts, builder);
     }
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQueryBuilder.java b/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQueryBuilder.java
@@ -15,13 +15,15 @@ public class YdbQueryBuilder {
     private final String origin;
     private final StringBuilder query;
     private final List<String> args = new ArrayList<>();
+    private final QueryType forcedType;
 
     private int argsCounter = 0;
     private QueryType currentType = null;
 
-    public YdbQueryBuilder(String origin) {
+    public YdbQueryBuilder(String origin, QueryType forcedType) {
         this.origin = origin;
         this.query = new StringBuilder(origin.length() + 10);
+        this.forcedType = forcedType;
     }
 
     public String createNextArgName() {
@@ -36,6 +38,10 @@ public String createNextArgName() {
     }
 
     public void setQueryType(QueryType type) throws YdbNonRetryableException {
+        if (forcedType != null) {
+            return;
+        }
+
         if (currentType != null && currentType != type) {
             String msg = YdbConst.MULTI_TYPES_IN_ONE_QUERY + currentType + ", " + type;
             throw new YdbNonRetryableException(msg, StatusCode.BAD_REQUEST);
@@ -44,7 +50,15 @@ public void setQueryType(QueryType type) throws YdbNonRetryableException {
     }
 
     public QueryType getQueryType() {
-        return currentType != null ? currentType : QueryType.DATA_QUERY;
+        if (forcedType != null) {
+            return forcedType;
+        }
+
+        if (currentType != null) {
+            return currentType;
+        }
+
+        return QueryType.DATA_QUERY;
     }
 
     public String getOriginSQL() {
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQueryOptions.java b/jdbc/src/main/java/tech/ydb/jdbc/query/YdbQueryOptions.java
@@ -23,14 +23,17 @@ public class YdbQueryOptions {
     private final boolean isPrepareDataQueries;
     private final boolean isDetectBatchQueries;
 
+    private final QueryType forcedType;
+
     @VisibleForTesting
     YdbQueryOptions(
             boolean enforceV1,
             boolean detectQueryType,
             boolean detectJbdcParams,
             boolean declareJdbcParams,
             boolean prepareDataQuery,
-            boolean detectBatchQuery
+            boolean detectBatchQuery,
+            QueryType forcedType
     ) {
         this.isEnforceSyntaxV1 = enforceV1;
 
@@ -40,6 +43,8 @@ public class YdbQueryOptions {
 
         this.isPrepareDataQueries = prepareDataQuery;
         this.isDetectBatchQueries = detectBatchQuery;
+
+        this.forcedType = forcedType;
     }
 
     public boolean isEnforceSyntaxV1() {
@@ -66,6 +71,10 @@ public boolean isDetectBatchQueries() {
         return isDetectBatchQueries;
     }
 
+    public QueryType getForcedQueryType() {
+        return forcedType;
+    }
+
     public static YdbQueryOptions createFrom(YdbOperationProperties props) {
         int level = props.getJdbcSupportLevel();
 
@@ -111,13 +120,16 @@ public static YdbQueryOptions createFrom(YdbOperationProperties props) {
             declareJdbcParams = declareJdbcParams && detectJbdcParams;
         }
 
+        QueryType forcedQueryType = props.getForcedQueryType();
+
         return new YdbQueryOptions(
                 enforceV1,
                 detectQueryType,
                 detectJbdcParams,
                 declareJdbcParams,
                 prepareDataQuery,
-                detectBatchQuery
+                detectBatchQuery,
+                forcedQueryType
         );
     }
 }
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/settings/FakeTxMode.java b/jdbc/src/main/java/tech/ydb/jdbc/settings/FakeTxMode.java
@@ -0,0 +1,11 @@
+package tech.ydb.jdbc.settings;
+
+/**
+ *
+ * @author Aleksandr Gorshenin
+ */
+public enum FakeTxMode {
+    ERROR,
+    FAKE_TX,
+    SHADOW_COMMIT,
+}
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/settings/PropertyConverter.java b/jdbc/src/main/java/tech/ydb/jdbc/settings/PropertyConverter.java
@@ -14,6 +14,17 @@ static PropertyConverter<String> stringValue() {
         return value -> value;
     }
 
+    static <E extends Enum<E>> PropertyConverter<E> enumValue(Class<E> clazz) {
+        return value -> {
+            for (E v: clazz.getEnumConstants()) {
+                if (value.equalsIgnoreCase(v.name())) {
+                    return v;
+                }
+            }
+            return null;
+        };
+    }
+
     static PropertyConverter<Duration> durationValue() {
         return value -> {
             String targetValue = "PT" + value.replace(" ", "").toUpperCase(Locale.ROOT);
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbJdbcTools.java b/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbJdbcTools.java
@@ -1,10 +1,9 @@
 package tech.ydb.jdbc.settings;
 
+import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URLEncoder;
-import java.nio.charset.StandardCharsets;
-import java.io.UnsupportedEncodingException;
 import java.sql.SQLException;
 import java.util.Collection;
 import java.util.Collections;
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbOperationProperties.java b/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbOperationProperties.java
@@ -4,6 +4,8 @@
 import java.util.Map;
 import java.util.Objects;
 
+import tech.ydb.jdbc.query.QueryType;
+
 public class YdbOperationProperties {
     public static final int MAX_ROWS = 1000; // TODO: how to figure out the max rows of current connection?
 
@@ -21,6 +23,10 @@ public class YdbOperationProperties {
 
     private final int jdbcSupportLevel;
 
+    private final FakeTxMode scanQueryTxMode;
+    private final FakeTxMode schemeQueryTxMode;
+    private final QueryType forcedQueryType;
+
     public YdbOperationProperties(Map<YdbOperationProperty<?>, ParsedProperty> params) {
         this.params = Objects.requireNonNull(params);
 
@@ -36,6 +42,12 @@ public YdbOperationProperties(Map<YdbOperationProperty<?>, ParsedProperty> param
         this.cacheConnectionsInDriver = params.get(YdbOperationProperty.CACHE_CONNECTIONS_IN_DRIVER).getParsedValue();
 
         this.jdbcSupportLevel = params.get(YdbOperationProperty.JDBC_SUPPORT_LEVEL).getParsedValue();
+
+        this.scanQueryTxMode = params.get(YdbOperationProperty.SCAN_QUERY_TX_MODE).getParsedValue();
+        this.schemeQueryTxMode = params.get(YdbOperationProperty.SCHEME_QUERY_TX_MODE).getParsedValue();
+
+        ParsedProperty forcedType = params.get(YdbOperationProperty.FORCE_QUERY_MODE);
+        this.forcedQueryType = forcedType != null ? forcedType.getParsedValue() : null;
     }
 
     public Map<YdbOperationProperty<?>, ParsedProperty> getParams() {
@@ -58,6 +70,18 @@ public boolean isFailOnTruncatedResult() {
         return failOnTruncatedResult;
     }
 
+    public FakeTxMode getScanQueryTxMode() {
+        return scanQueryTxMode;
+    }
+
+    public FakeTxMode getSchemeQueryTxMode() {
+        return schemeQueryTxMode;
+    }
+
+    public QueryType getForcedQueryType() {
+        return forcedQueryType;
+    }
+
     public Duration getSessionTimeout() {
         return sessionTimeout;
     }
diff --git a/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbOperationProperty.java b/jdbc/src/main/java/tech/ydb/jdbc/settings/YdbOperationProperty.java
@@ -7,6 +7,7 @@
 import javax.annotation.Nullable;
 
 import tech.ydb.jdbc.YdbConst;
+import tech.ydb.jdbc.query.QueryType;
 
 
 public class YdbOperationProperty<T> extends AbstractYdbProperty<T, Void> {
@@ -138,6 +139,30 @@ public class YdbOperationProperty<T> extends AbstractYdbProperty<T, Void> {
                     Integer.class,
                     PropertyConverter.integerValue());
 
+    public static final YdbOperationProperty<FakeTxMode> SCAN_QUERY_TX_MODE =
+            new YdbOperationProperty<>("scanQueryTxMode",
+                    "Mode of execution scan query inside transaction. "
+                            + "Possible values - ERROR(by default), FAKE_TX and SHADOW_COMMIT",
+                    "ERROR",
+                    FakeTxMode.class,
+                    PropertyConverter.enumValue(FakeTxMode.class));
+
+    public static final YdbOperationProperty<FakeTxMode> SCHEME_QUERY_TX_MODE =
+            new YdbOperationProperty<>("schemeQueryTxMode",
+                    "Mode of execution scheme query inside transaction. "
+                            + "Possible values - ERROR(by default), FAKE_TX and SHADOW_COMMIT",
+                    "ERROR",
+                    FakeTxMode.class,
+                    PropertyConverter.enumValue(FakeTxMode.class));
+
+    public static final YdbOperationProperty<QueryType> FORCE_QUERY_MODE =
+            new YdbOperationProperty<>("forceQueryMode",
+                    "Force usage one of query modes (DATA_QUERY, SCAN_QUERY, SCHEME_QUERY or EXPLAIN_QUERYn) "
+                            + "for all statements",
+                    null,
+                    QueryType.class,
+                    PropertyConverter.enumValue(QueryType.class));
+
     protected YdbOperationProperty(String name,
                                    String description,
                                    @Nullable String defaultValue,
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/YdbDriverProperitesTest.java b/jdbc/src/test/java/tech/ydb/jdbc/YdbDriverProperitesTest.java
@@ -332,7 +332,11 @@ static DriverPropertyInfo[] defaultPropertyInfo(@Nullable String localDatacenter
                 YdbOperationProperty.DISABLE_JDBC_PARAMETERS.toDriverPropertyInfo("false"),
                 YdbOperationProperty.DISABLE_JDBC_PARAMETERS_DECLARE.toDriverPropertyInfo("false"),
 
-                YdbOperationProperty.JDBC_SUPPORT_LEVEL.toDriverPropertyInfo("" + YdbConst.DEFAULT_JDBC_SUPPORT_LEVEL)
+                YdbOperationProperty.JDBC_SUPPORT_LEVEL.toDriverPropertyInfo("" + YdbConst.DEFAULT_JDBC_SUPPORT_LEVEL),
+
+                YdbOperationProperty.SCAN_QUERY_TX_MODE.toDriverPropertyInfo("ERROR"),
+                YdbOperationProperty.SCHEME_QUERY_TX_MODE.toDriverPropertyInfo("ERROR"),
+                YdbOperationProperty.FORCE_QUERY_MODE.toDriverPropertyInfo(null),
         };
     }
 
@@ -371,6 +375,11 @@ static Properties customizedProperties() {
         properties.setProperty("disableJdbcParameters", "true");
         properties.setProperty("disableJdbcParameterDeclare", "true");
         properties.setProperty("jdbcSupportLevel", "0");
+
+        properties.setProperty("scanQueryTxMode", "FAKE_TX");
+        properties.setProperty("schemeQueryTxMode", "SHADOW_COMMIT");
+
+        properties.setProperty("forceQueryMode", "SCAN_QUERY");
         return properties;
     }
 
@@ -408,7 +417,11 @@ static DriverPropertyInfo[] customizedPropertyInfo() {
                 YdbOperationProperty.DISABLE_JDBC_PARAMETERS.toDriverPropertyInfo("true"),
                 YdbOperationProperty.DISABLE_JDBC_PARAMETERS_DECLARE.toDriverPropertyInfo("true"),
 
-                YdbOperationProperty.JDBC_SUPPORT_LEVEL.toDriverPropertyInfo("0")
+                YdbOperationProperty.JDBC_SUPPORT_LEVEL.toDriverPropertyInfo("0"),
+
+                YdbOperationProperty.SCAN_QUERY_TX_MODE.toDriverPropertyInfo("FAKE_TX"),
+                YdbOperationProperty.SCHEME_QUERY_TX_MODE.toDriverPropertyInfo("SHADOW_COMMIT"),
+                YdbOperationProperty.FORCE_QUERY_MODE.toDriverPropertyInfo("SCAN_QUERY"),
         };
     }
 
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbConnectionImplTest.java b/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbConnectionImplTest.java
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbPreparedStatementImplTest.java b/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbPreparedStatementImplTest.java
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbPreparedStatementWithDataQueryImplTest.java b/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbPreparedStatementWithDataQueryImplTest.java
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbStatementImplTest.java b/jdbc/src/test/java/tech/ydb/jdbc/impl/YdbStatementImplTest.java
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/impl/helper/JdbcConnectionExtention.java b/jdbc/src/test/java/tech/ydb/jdbc/impl/helper/JdbcConnectionExtention.java
diff --git a/jdbc/src/test/java/tech/ydb/jdbc/query/QueryLexerTest.java b/jdbc/src/test/java/tech/ydb/jdbc/query/QueryLexerTest.java

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public QueryType type() {`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`public static YdbQuery from(YdbQueryOptions opts, String sql) throws SQLException {`
`94`		`- YdbQueryBuilder builder = new YdbQueryBuilder(sql);`
	`94`	`+ YdbQueryBuilder builder = new YdbQueryBuilder(sql, opts.getForcedQueryType());`
`95`	`95`	`JdbcQueryLexer.buildQuery(builder, opts);`
`96`	`96`	`return new YdbQuery(opts, builder);`
`97`	`97`	`}`