dbeaver/pro#9617 api for data-import settings

Author: HocKu7

server/bundles/io.cloudbeaver.model/src/io/cloudbeaver/model/WebConnectionInfo.java

@@ -593,4 +593,13 @@ public void setCredentialsSavedInSession(@Nullable Boolean credentialsSavedInSes
         this.credentialsSavedInSession = credentialsSavedInSession;
     }
 
+    /**
+     * Database-dependent metadata describing the data import settings available for this connection
+     */
+    @Property
+    @NotNull
+    public WebDataImportSettings getDataImportSettings() {
+        return new WebDataImportSettings(dataSourceContainer);
+    }
+
 }

server/bundles/io.cloudbeaver.model/src/io/cloudbeaver/model/WebDataImportSettings.java

@@ -0,0 +1,53 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2026 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.cloudbeaver.model;
+
+import org.jkiss.code.NotNull;
+import org.jkiss.dbeaver.model.DBPDataSourceContainer;
+import org.jkiss.dbeaver.model.meta.Property;
+import org.jkiss.dbeaver.model.sql.SQLDialectInsertReplaceMethod;
+import org.jkiss.dbeaver.model.sql.SQLDialectMetadata;
+import org.jkiss.utils.CommonUtils;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.stream.Collectors;
+
+public class WebDataImportSettings {
+
+    public static final String SETTING_ON_DUPLICATE_KEY_METHOD = "onDuplicateKeyMethod";
+
+    @NotNull
+    private final DBPDataSourceContainer dataSourceContainer;
+
+    public WebDataImportSettings(@NotNull DBPDataSourceContainer dataSourceContainer) {
+        this.dataSourceContainer = dataSourceContainer;
+    }
+
+    @Property
+    @NotNull
+    public List<WebDataImportSettingValueInfo> getReplaceMethods() {
+        SQLDialectMetadata dialect = dataSourceContainer.getDriver().getScriptDialect();
+        List<SQLDialectInsertReplaceMethod> replaceMethods = dialect.getSupportedInsertReplaceMethodsDescriptors();
+        if (CommonUtils.isEmpty(replaceMethods)) {
+            return Collections.emptyList();
+        }
+        return replaceMethods.stream()
+            .map(method -> new WebDataImportSettingValueInfo(method.getId(), method.getLabel(), method.getDescription()))
+            .collect(Collectors.toList());
+    }
+}

server/bundles/io.cloudbeaver.server/schema/service.core.graphqls

@@ -570,6 +570,25 @@ type ConnectionInfo {
 
     "List of tools that can be used with this connection. Returns empty list if no tools are available"
     tools: [String!]! @since(version: "24.1.3")
+
+    "Database-dependent metadata describing the data import settings available for this connection"
+    dataImportSettings: DataImportSettingsInfo! @since(version: "26.1.2")
+}
+
+"Database-dependent metadata describing the data import settings available for a connection."
+type DataImportSettingsInfo {
+    "Supported 'on duplicate key' replace methods for this connection's SQL dialect (setting id: 'onDuplicateKeyMethod')"
+    replaceMethods: [DataImportSettingValueInfo!]!
+}
+
+"Generic metadata of a single allowed value (option) of a data import setting"
+type DataImportSettingValueInfo {
+    "Value ID. Passed back in the import query 'settings' map for the corresponding setting"
+    id: ID!
+    "Human readable value name"
+    name: String!
+    "Value description"
+    description: String
 }
 
 type ConnectionFolderInfo {

server/bundles/io.cloudbeaver.service.data.transfer/src/io/cloudbeaver/service/data/transfer/DBWServiceDataTransfer.java

@@ -29,13 +29,15 @@
 import io.cloudbeaver.service.sql.WebSQLProcessor;
 import io.cloudbeaver.service.sql.WebSQLResultsInfo;
 import org.jkiss.code.NotNull;
+import org.jkiss.code.Nullable;
 import org.jkiss.dbeaver.DBException;
 import org.jkiss.dbeaver.model.rm.RMConstants;
 import org.jkiss.dbeaver.model.runtime.DBRProgressMonitor;
 
 import java.io.OutputStream;
 import java.nio.file.Path;
 import java.util.List;
+import java.util.Map;
 
 /**
  * Web service implementation
@@ -64,6 +66,7 @@ WebAsyncTaskInfo asyncImportDataContainer(
         @NotNull String processorId,
         @NotNull Path path,
         @NotNull WebSQLResultsInfo webSQLResultsInfo,
+        @Nullable Map<String, Object> settings,
         @NotNull WebSession webSession) throws DBWebException;
 
     @NotNull

server/bundles/io.cloudbeaver.service.data.transfer/src/io/cloudbeaver/service/data/transfer/impl/WebDataTransferImportServlet.java

@@ -97,6 +97,7 @@ protected void processServiceRequest(
             String contextId = JSONUtils.getString(variables, "contextId");
             String resultId = JSONUtils.getString(variables, "resultsId");
             String processorId = JSONUtils.getString(variables, "processorId");
+            Map<String, Object> settings = JSONUtils.getObjectOrNull(variables, "settings");
 
             if (projectId == null || connectionId == null || contextId == null || resultId == null || processorId == null) {
                 throw new IllegalArgumentException("Missing required parameters");
@@ -122,7 +123,7 @@ protected void processServiceRequest(
             }
 
             WebAsyncTaskInfo asyncImportDataContainer =
-                    dbwServiceDataTransfer.asyncImportDataContainer(processorId, filePath, webSQLResultsInfo, session);
+                    dbwServiceDataTransfer.asyncImportDataContainer(processorId, filePath, webSQLResultsInfo, settings, session);
             response.setContentType(HttpConstants.CONTENT_TYPE_JSON);
             Map<String, Object> parameters = new LinkedHashMap<>();
             parameters.put("id", asyncImportDataContainer.getId());

server/bundles/io.cloudbeaver.service.data.transfer/src/io/cloudbeaver/service/data/transfer/impl/WebServiceDataTransfer.java

@@ -19,6 +19,7 @@
 import io.cloudbeaver.DBWConstants;
 import io.cloudbeaver.DBWebException;
 import io.cloudbeaver.model.WebAsyncTaskInfo;
+import io.cloudbeaver.model.WebDataImportSettings;
 import io.cloudbeaver.model.session.WebAsyncTaskProcessor;
 import io.cloudbeaver.model.session.WebSession;
 import io.cloudbeaver.server.CBConstants;
@@ -237,6 +238,7 @@ public WebAsyncTaskInfo asyncImportDataContainer(
         @NotNull String processorId,
         @NotNull Path path,
         @NotNull WebSQLResultsInfo sqlContext,
+        @Nullable Map<String, Object> settings,
         @NotNull WebSession webSession
     ) throws DBWebException {
         webSession.addInfoMessage("Import data");
@@ -254,7 +256,7 @@ public void run(@NotNull DBRProgressMonitor monitor) throws InvocationTargetExce
                 try {
                     monitor.subTask("Import data using " + processor.getName());
                     try {
-                        importData(monitor, processor, (DBSDataManipulator) dataContainer, path);
+                        importData(monitor, processor, (DBSDataManipulator) dataContainer, path, settings);
                     } catch (Exception e) {
                         if (e instanceof DBException) {
                             throw e;
@@ -342,7 +344,8 @@ private void importData(
         @NotNull DBRProgressMonitor monitor,
         @NotNull DataTransferProcessorDescriptor processor,
         @NotNull DBSDataManipulator dataContainer,
-        @NotNull Path path
+        @NotNull Path path,
+        @Nullable Map<String, Object> settings
     ) throws DBException {
         IDataTransferProcessor processorInstance = processor.getInstance();
 
@@ -354,6 +357,7 @@ private void importData(
             DatabaseConsumerSettings databaseConsumerSettings = new DatabaseConsumerSettings();
             databaseConsumerSettings.setContainer((DBSObjectContainer) dataContainer.getDataSource());
             databaseConsumerSettings.setEnableQmLogging(true);
+            applyImportSettings(databaseConsumerSettings, settings);
             consumer.setSettings(databaseConsumerSettings);
 
             StreamProducerSettings producerSettings = new StreamProducerSettings();
@@ -384,4 +388,19 @@ private void importData(
         }
     }
 
+    private void applyImportSettings(
+        @NotNull DatabaseConsumerSettings consumerSettings,
+        @Nullable Map<String, Object> settings
+    ) {
+        if (CommonUtils.isEmpty(settings)) {
+            return;
+        }
+        // todo add more import settings here
+        String onDuplicateKeyMethod = CommonUtils.toString(
+            settings.get(WebDataImportSettings.SETTING_ON_DUPLICATE_KEY_METHOD), null);
+        if (!CommonUtils.isEmpty(onDuplicateKeyMethod)) {
+            consumerSettings.setOnDuplicateKeyInsertMethodId(onDuplicateKeyMethod);
+        }
+    }
+
 }

server/test/io.cloudbeaver.test.platform/src/io/cloudbeaver/test/platform/connection/ConnectionDataImportSettingsTest.java

@@ -0,0 +1,66 @@
+/*
+ * DBeaver - Universal Database Manager
+ * Copyright (C) 2010-2026 DBeaver Corp and others
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.cloudbeaver.test.platform.connection;
+
+import io.cloudbeaver.test.platform.CloudbeaverDBTest;
+import org.jkiss.dbeaver.model.data.json.JSONUtils;
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.Map;
+
+public class ConnectionDataImportSettingsTest extends CloudbeaverDBTest {
+
+    private static final String GQL_CONNECTION_DATA_IMPORT_SETTINGS = """
+        query connectionInfo($projectId: ID!, $connectionId: ID!) {
+          result: connectionInfo(projectId: $projectId, id: $connectionId) {
+            id
+            dataImportSettings {
+              replaceMethods {
+                id
+                name
+                description
+              }
+            }
+          }
+        }""";
+
+    @Test
+    public void connectionExposesDataImportSettings() throws Exception {
+        Map<String, Object> connection = client.sendQuery(
+            GQL_CONNECTION_DATA_IMPORT_SETTINGS,
+            Map.of(
+                "projectId", globalProject.getId(),
+                "connectionId", databaseContainer.getId()
+            )
+        );
+        Assertions.assertNotNull(connection);
+        Assertions.assertEquals(databaseContainer.getId(), JSONUtils.getString(connection, "id"));
+
+        Map<String, Object> dataImportSettings = JSONUtils.getObjectOrNull(connection, "dataImportSettings");
+        Assertions.assertNotNull(dataImportSettings, "dataImportSettings must be present on a connection");
+
+        List<Map<String, Object>> replaceMethods = JSONUtils.getObjectList(dataImportSettings, "replaceMethods");
+        Assertions.assertNotNull(replaceMethods, "replaceMethods must be a non-null list");
+
+        for (Map<String, Object> replaceMethod : replaceMethods) {
+            Assertions.assertNotNull(JSONUtils.getString(replaceMethod, "id"), "replace method id must not be null");
+            Assertions.assertNotNull(JSONUtils.getString(replaceMethod, "name"), "replace method name must not be null");
+        }
+    }
+}