Merge pull request #99 from domaframework/identity-reservation

バッチ更新においてパフォーマンスが悪くなる問題をデータベースのIDENTITYを事前に予約することで解決

Author: nakamura-to

src/main/java/org/seasar/doma/jdbc/dialect/Dialect.java

@@ -142,6 +142,8 @@ boolean supportsSelectForUpdate(SelectForUpdateType type,
      */
     boolean supportsResultSetReturningAsOutParameter();
 
+    boolean supportsIdentityReservation();
+
     /**
      * データベースで生成されたIDENTITYを取得するためのSQLを返します。
      * <p>
@@ -165,6 +167,32 @@ boolean supportsSelectForUpdate(SelectForUpdateType type,
     Sql<?> getIdentitySelectSql(String catalogName, String schemaName,
             String tableName, String columnName, boolean isQuoteRequired);
 
+    /**
+     * データベースのIDENTITYを予約するためのSQLを返します。
+     * <p>
+     * {@link #supportsIdentityReservation()} が {@code true} を返す場合にのみ呼び出し可能です。
+     * 
+     * @param catalogName
+     *            カタログの名前
+     * @param schemaName
+     *            スキーマの名前
+     * @param tableName
+     *            テーブルの名前
+     * @param columnName
+     *            IDENTITYカラムの名前
+     * @param isQuoteRequired
+     *            引用符が必要かどうか
+     * @param reservationSize
+     *            予約サイズ
+     * @return IDENTITYを予約するためのSQL
+     * @throws DomaNullPointerException
+     *             {@code tableName} と {@code columnName} のいずれかが {@code null}
+     *             の場合
+     */
+    Sql<?> getIdentityReservationSql(String catalogName, String schemaName,
+            String tableName, String columnName, boolean isQuoteRequired,
+            int reservationSize);
+
     /**
      * シーケンスの次の値を取得するためのSQLを返します。
      * <p>

src/main/java/org/seasar/doma/jdbc/dialect/PostgresDialect.java

@@ -31,6 +31,7 @@
 import org.seasar.doma.jdbc.JdbcMappingVisitor;
 import org.seasar.doma.jdbc.ScriptBlockContext;
 import org.seasar.doma.jdbc.SelectForUpdateType;
+import org.seasar.doma.jdbc.Sql;
 import org.seasar.doma.jdbc.SqlKind;
 import org.seasar.doma.jdbc.SqlLogFormattingVisitor;
 import org.seasar.doma.jdbc.SqlLogType;
@@ -170,18 +171,49 @@ public PreparedSql getIdentitySelectSql(String catalogName,
         if (columnName == null) {
             throw new DomaNullPointerException("columnName");
         }
-        String qualifiedTableName = DatabaseObjectUtil.getQualifiedName(
-                isQuoteRequired ? this::applyQuote : Function.identity(),
-                catalogName, schemaName, tableName + "_" + columnName + "_seq");
+        String identityTableName = createIdentityTableName(catalogName,
+                schemaName, tableName, columnName, isQuoteRequired);
         StringBuilder buf = new StringBuilder(64);
         buf.append("select currval('");
-        buf.append(qualifiedTableName);
+        buf.append(identityTableName);
         buf.append("')");
         String rawSql = buf.toString();
         return new PreparedSql(SqlKind.SELECT, rawSql, rawSql, null,
                 Collections.<InParameter<?>> emptyList(), SqlLogType.FORMATTED);
     }
 
+    @Override
+    public Sql<?> getIdentityReservationSql(String catalogName,
+            String schemaName, String tableName, String columnName,
+            boolean isQuoteRequired, int reservationSize) {
+        if (tableName == null) {
+            throw new DomaNullPointerException("tableName");
+        }
+        if (columnName == null) {
+            throw new DomaNullPointerException("columnName");
+        }
+        String identityTableName = createIdentityTableName(catalogName,
+                schemaName, tableName, columnName, isQuoteRequired);
+        StringBuilder buf = new StringBuilder(64);
+        buf.append("select nextval('");
+        buf.append(identityTableName);
+        buf.append("') from generate_series(1, ");
+        buf.append(reservationSize);
+        buf.append(")");
+        String rawSql = buf.toString();
+        return new PreparedSql(SqlKind.SELECT, rawSql, rawSql, null,
+                Collections.<InParameter<?>> emptyList(), SqlLogType.FORMATTED);
+    }
+
+    protected String createIdentityTableName(String catalogName,
+            String schemaName, String tableName, String columnName,
+            boolean isQuoteRequired) {
+        String qualifiedTableName = DatabaseObjectUtil.getQualifiedName(
+                isQuoteRequired ? this::applyQuote : Function.identity(),
+                catalogName, schemaName, tableName + "_" + columnName + "_seq");
+        return qualifiedTableName;
+    }
+
     @Override
     public PreparedSql getSequenceNextValSql(String qualifiedSequenceName,
             long allocationSize) {
@@ -203,6 +235,11 @@ public boolean supportsSequence() {
         return true;
     }
 
+    @Override
+    public boolean supportsIdentityReservation() {
+        return true;
+    }
+
     @Override
     public boolean supportsSelectForUpdate(SelectForUpdateType type,
             boolean withTargets) {

src/main/java/org/seasar/doma/jdbc/dialect/StandardDialect.java

@@ -410,6 +410,11 @@ public boolean supportsSequence() {
         return false;
     }
 
+    @Override
+    public boolean supportsIdentityReservation() {
+        return false;
+    }
+
     @Override
     public boolean includesIdentityColumn() {
         return false;
@@ -439,6 +444,14 @@ public Sql<?> getIdentitySelectSql(String catalogName, String schemaName,
                 "getIdentitySelectSql");
     }
 
+    @Override
+    public Sql<?> getIdentityReservationSql(String catalogName,
+            String schemaName, String tableName, String columnName,
+            boolean isQuoteRequired, int reservationSize) {
+        throw new JdbcUnsupportedOperationException(getClass().getName(),
+                "getIdentityReservationSql");
+    }
+
     @Override
     public PreparedSql getSequenceNextValSql(String qualifiedSequenceName,
             long allocationSize) {

src/main/java/org/seasar/doma/jdbc/id/BuiltinIdentityIdGenerator.java

@@ -37,27 +37,40 @@ public class BuiltinIdentityIdGenerator extends AbstractIdGenerator implements
 
     @Override
     public boolean supportsBatch(IdGenerationConfig config) {
-        return false;
+        return config.getIdProvider().isAvailable();
     }
 
     @Override
     public boolean includesIdentityColumn(IdGenerationConfig config) {
+        if (config.getIdProvider().isAvailable()) {
+            return true;
+        }
         return config.getDialect().includesIdentityColumn();
     }
 
     @Override
     public boolean supportsAutoGeneratedKeys(IdGenerationConfig config) {
+        if (config.getIdProvider().isAvailable()) {
+            return false;
+        }
         return config.getDialect().supportsAutoGeneratedKeys();
     }
 
     @Override
     public Long generatePreInsert(IdGenerationConfig config) {
+        IdProvider idProvider = config.getIdProvider();
+        if (idProvider.isAvailable()) {
+            return idProvider.get();
+        }
         return null;
     }
 
     @Override
     public Long generatePostInsert(IdGenerationConfig config,
             Statement statement) {
+        if (config.getIdProvider().isAvailable()) {
+            return null;
+        }
         if (config.getDialect().supportsAutoGeneratedKeys()) {
             return getGeneratedValue(config, statement);
         }

src/main/java/org/seasar/doma/jdbc/id/IdGenerationConfig.java

@@ -40,6 +40,9 @@ public class IdGenerationConfig {
     /** 識別子が属するエンティティ */
     protected final EntityType<?> entityType;
 
+    /** 識別子プロバイダ */
+    protected final IdProvider idProvider;
+
     /**
      * インスタンスを構築します。
      * 
@@ -49,9 +52,25 @@ public class IdGenerationConfig {
      *            識別子が属するエンティティ
      */
     public IdGenerationConfig(Config config, EntityType<?> entityType) {
-        assertNotNull(config, entityType);
+        this(config, entityType, new UnavailableIdProvider());
+    }
+
+    /**
+     * インスタンスを構築します。
+     * 
+     * @param config
+     *            JDBCの設定
+     * @param entityType
+     *            識別子が属するエンティティ
+     * @param idProvider
+     *            識別子プロバイダ
+     */
+    public IdGenerationConfig(Config config, EntityType<?> entityType,
+            IdProvider idProvider) {
+        assertNotNull(config, entityType, idProvider);
         this.config = config;
         this.entityType = entityType;
+        this.idProvider = idProvider;
     }
 
     public DataSource getDataSource() {
@@ -94,4 +113,20 @@ public EntityType<?> getEntityType() {
         return entityType;
     }
 
+    public IdProvider getIdProvider() {
+        return idProvider;
+    }
+
+    protected static class UnavailableIdProvider implements IdProvider {
+        @Override
+        public boolean isAvailable() {
+            return false;
+        }
+
+        @Override
+        public long get() {
+            throw new UnsupportedOperationException();
+        }
+
+    }
 }

src/main/java/org/seasar/doma/jdbc/id/IdProvider.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2004-2010 the Seasar Foundation and the 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 org.seasar.doma.jdbc.id;
+
+/**
+ * 識別子プロバイダです。
+ * 
+ * @author nakamura-to
+ * @since 2.5.0
+ */
+public interface IdProvider {
+
+    /**
+     * 識別子を返せるならば {@literal true}
+     * 
+     * @return 識別子を返せるかどうか
+     */
+    boolean isAvailable();
+
+    /**
+     * 識別子を返します。
+     * 
+     * @return 識別子
+     * @throws IllegalStateException
+     *             不正な内部状態により識別子を返せない場合
+     * @throws UnsupportedOperationException
+     *             このメソッドの呼び出しをサポートしていない場合
+     */
+    long get();
+}