All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.querydsl.sql.dml.AbstractSQLInsertClause Maven / Gradle / Ivy

There is a newer version: 6.9
Show newest version
/*
 * Copyright 2015, The Querydsl Team (http://www.querydsl.com/team)
 *
 * 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 com.querydsl.sql.dml;

import com.querydsl.core.DefaultQueryMetadata;
import com.querydsl.core.JoinType;
import com.querydsl.core.QueryFlag;
import com.querydsl.core.QueryFlag.Position;
import com.querydsl.core.QueryMetadata;
import com.querydsl.core.dml.InsertClause;
import com.querydsl.core.types.*;
import com.querydsl.core.util.CollectionUtils;
import com.querydsl.core.util.ResultSetAdapter;
import com.querydsl.sql.*;
import com.querydsl.sql.types.Null;
import java.sql.*;
import java.util.*;
import java.util.function.Supplier;
import java.util.logging.Logger;
import org.jetbrains.annotations.Nullable;

/**
 * Provides a base class for dialect-specific INSERT clauses.
 *
 * @author tiwe
 * @param  The type extending this class.
 */
public abstract class AbstractSQLInsertClause>
    extends AbstractSQLClause implements InsertClause {

  protected static final Logger logger = Logger.getLogger(AbstractSQLInsertClause.class.getName());

  protected final RelationalPath entity;

  protected final QueryMetadata metadata = new DefaultQueryMetadata();

  @Nullable protected SubQueryExpression subQuery;

  @Nullable protected SQLQuery subQueryBuilder;

  protected final List batches = new ArrayList();

  protected final List> columns = new ArrayList>();

  protected final List> values = new ArrayList>();

  protected transient String queryString;

  protected transient List constants;

  protected transient boolean batchToBulk;

  public AbstractSQLInsertClause(
      Connection connection,
      Configuration configuration,
      RelationalPath entity,
      SQLQuery subQuery) {
    this(connection, configuration, entity);
    this.subQueryBuilder = subQuery;
  }

  public AbstractSQLInsertClause(
      Connection connection, Configuration configuration, RelationalPath entity) {
    super(configuration, connection);
    this.entity = entity;
    metadata.addJoin(JoinType.DEFAULT, entity);
  }

  public AbstractSQLInsertClause(
      Supplier connection,
      Configuration configuration,
      RelationalPath entity,
      SQLQuery subQuery) {
    this(connection, configuration, entity);
    this.subQueryBuilder = subQuery;
  }

  public AbstractSQLInsertClause(
      Supplier connection, Configuration configuration, RelationalPath entity) {
    super(configuration, connection);
    this.entity = entity;
    metadata.addJoin(JoinType.DEFAULT, entity);
  }

  /**
   * Add the given String literal at the given position as a query flag
   *
   * @param position position
   * @param flag query flag
   * @return the current object
   */
  public C addFlag(Position position, String flag) {
    metadata.addFlag(new QueryFlag(position, flag));
    return (C) this;
  }

  /**
   * Add the given Expression at the given position as a query flag
   *
   * @param position position
   * @param flag query flag
   * @return the current object
   */
  public C addFlag(Position position, Expression flag) {
    metadata.addFlag(new QueryFlag(position, flag));
    return (C) this;
  }

  /**
   * Add the current state of bindings as a batch item
   *
   * @return the current object
   */
  public C addBatch() {
    if (subQueryBuilder != null) {
      subQuery = subQueryBuilder.select(values.toArray(new Expression[0])).clone();
      values.clear();
    }
    batches.add(new SQLInsertBatch(columns, values, subQuery));
    columns.clear();
    values.clear();
    subQuery = null;
    return (C) this;
  }

  /**
   * Set whether batches should be optimized into a single bulk operation. Will revert to batches,
   * if bulk is not supported
   */
  public void setBatchToBulk(boolean b) {
    this.batchToBulk = b && configuration.getTemplates().isBatchToBulkSupported();
  }

  @Override
  public void clear() {
    batches.clear();
    columns.clear();
    values.clear();
    subQuery = null;
  }

  @Override
  public C columns(Path... columns) {
    this.columns.addAll(Arrays.asList(columns));
    return (C) this;
  }

  /**
   * Execute the clause and return the generated key with the type of the given path. If no rows
   * were created, null is returned, otherwise the key of the first row is returned.
   *
   * @param 
   * @param path path for key
   * @return generated key
   */
  @SuppressWarnings("unchecked")
  @Nullable
  public  T executeWithKey(Path path) {
    return executeWithKey((Class) path.getType(), path);
  }

  /**
   * Execute the clause and return the generated key cast to the given type. If no rows were
   * created, null is returned, otherwise the key of the first row is returned.
   *
   * @param 
   * @param type type of key
   * @return generated key
   */
  public  T executeWithKey(Class type) {
    return executeWithKey(type, null);
  }

  protected  T executeWithKey(Class type, @Nullable Path path) {
    ResultSet rs = null;
    try {
      rs = executeWithKeys();
      if (rs.next()) {
        return configuration.get(rs, path, 1, type);
      } else {
        return null;
      }
    } catch (SQLException e) {
      throw configuration.translate(e);
    } finally {
      if (rs != null) {
        close(rs);
      }
      reset();
    }
  }

  /**
   * Execute the clause and return the generated key with the type of the given path. If no rows
   * were created, or the referenced column is not a generated key, null is returned. Otherwise, the
   * key of the first row is returned.
   *
   * @param 
   * @param path path for key
   * @return generated keys
   */
  @SuppressWarnings("unchecked")
  public  List executeWithKeys(Path path) {
    return executeWithKeys((Class) path.getType(), path);
  }

  public  List executeWithKeys(Class type) {
    return executeWithKeys(type, null);
  }

  protected  List executeWithKeys(Class type, @Nullable Path path) {
    ResultSet rs = null;
    try {
      rs = executeWithKeys();
      List rv = new ArrayList();
      while (rs.next()) {
        rv.add(configuration.get(rs, path, 1, type));
      }
      return rv;
    } catch (SQLException e) {
      throw configuration.translate(e);
    } finally {
      if (rs != null) {
        close(rs);
      }
      reset();
    }
  }

  protected PreparedStatement createStatement(boolean withKeys) throws SQLException {
    listeners.preRender(context);
    SQLSerializer serializer = createSerializer();
    if (subQueryBuilder != null) {
      subQuery = subQueryBuilder.select(values.toArray(new Expression[0])).clone();
      values.clear();
    }

    if (!batches.isEmpty() && batchToBulk) {
      serializer.serializeInsert(metadata, entity, batches);
    } else {
      serializer.serializeInsert(metadata, entity, columns, values, subQuery);
    }
    context.addSQL(createBindings(metadata, serializer));
    listeners.rendered(context);
    return prepareStatementAndSetParameters(serializer, withKeys);
  }

  protected Collection createStatements(boolean withKeys) throws SQLException {
    boolean addBatches = !configuration.getUseLiterals();
    listeners.preRender(context);

    if (subQueryBuilder != null) {
      subQuery = subQueryBuilder.select(values.toArray(new Expression[0])).clone();
      values.clear();
    }

    Map stmts = new HashMap<>();

    // add first batch
    SQLSerializer serializer = createSerializer();
    serializer.serializeInsert(
        metadata,
        entity,
        batches.get(0).getColumns(),
        batches.get(0).getValues(),
        batches.get(0).getSubQuery());
    PreparedStatement stmt = prepareStatementAndSetParameters(serializer, withKeys);
    if (addBatches) {
      stmt.addBatch();
    }
    stmts.put(serializer.toString(), stmt);
    context.addSQL(createBindings(metadata, serializer));
    listeners.rendered(context);

    // add other batches
    for (int i = 1; i < batches.size(); i++) {
      SQLInsertBatch batch = batches.get(i);

      listeners.preRender(context);
      serializer = createSerializer();
      serializer.serializeInsert(
          metadata, entity, batch.getColumns(), batch.getValues(), batch.getSubQuery());
      context.addSQL(createBindings(metadata, serializer));
      listeners.rendered(context);

      stmt = stmts.get(serializer.toString());
      if (stmt == null) {
        stmt = prepareStatementAndSetParameters(serializer, withKeys);
        stmts.put(serializer.toString(), stmt);
      } else {
        setParameters(
            stmt, serializer.getConstants(), serializer.getConstantPaths(), metadata.getParams());
      }
      if (addBatches) {
        stmt.addBatch();
      }
    }

    return stmts.values();
  }

  protected PreparedStatement prepareStatementAndSetParameters(
      SQLSerializer serializer, boolean withKeys) throws SQLException {
    listeners.prePrepare(context);

    queryString = serializer.toString();
    constants = serializer.getConstants();
    logQuery(logger, queryString, constants);
    PreparedStatement stmt;
    if (withKeys) {
      if (entity.getPrimaryKey() != null) {
        String[] target = new String[entity.getPrimaryKey().getLocalColumns().size()];
        for (int i = 0; i < target.length; i++) {
          Path path = entity.getPrimaryKey().getLocalColumns().get(i);
          String column = ColumnMetadata.getName(path);
          column = configuration.getColumnOverride(entity.getSchemaAndTable(), column);
          target[i] = column;
        }
        stmt = connection().prepareStatement(queryString, target);
      } else {
        stmt = connection().prepareStatement(queryString, Statement.RETURN_GENERATED_KEYS);
      }
    } else {
      stmt = connection().prepareStatement(queryString);
    }
    setParameters(
        stmt, serializer.getConstants(), serializer.getConstantPaths(), metadata.getParams());

    context.addPreparedStatement(stmt);
    listeners.prepared(context);
    return stmt;
  }

  /**
   * Execute the clause and return the generated keys as a ResultSet
   *
   * @return result set with generated keys
   */
  public ResultSet executeWithKeys() {
    context = startContext(connection(), metadata, entity);
    try {
      PreparedStatement stmt = null;
      if (batches.isEmpty()) {
        stmt = createStatement(true);
        listeners.notifyInsert(entity, metadata, columns, values, subQuery);

        listeners.preExecute(context);
        stmt.executeUpdate();
        listeners.executed(context);
      } else if (batchToBulk) {
        stmt = createStatement(true);
        listeners.notifyInserts(entity, metadata, batches);

        listeners.preExecute(context);
        stmt.executeUpdate();
        listeners.executed(context);
      } else {
        Collection stmts = createStatements(true);
        if (stmts != null && stmts.size() > 1) {
          throw new IllegalStateException(
              "executeWithKeys called with batch statement and multiple SQL strings");
        }
        stmt = stmts.iterator().next();
        listeners.notifyInserts(entity, metadata, batches);

        listeners.preExecute(context);
        stmt.executeBatch();
        listeners.executed(context);
      }

      final Statement stmt2 = stmt;
      ResultSet rs = stmt.getGeneratedKeys();
      return new ResultSetAdapter(rs) {
        @Override
        public void close() throws SQLException {
          try {
            super.close();
          } finally {
            stmt2.close();
            reset();
            endContext(context);
          }
        }
      };
    } catch (SQLException e) {
      onException(context, e);
      reset();
      endContext(context);
      throw configuration.translate(queryString, constants, e);
    }
  }

  @Override
  public long execute() {
    context = startContext(connection(), metadata, entity);
    PreparedStatement stmt = null;
    Collection stmts = null;
    try {
      if (batches.isEmpty()) {
        stmt = createStatement(false);
        listeners.notifyInsert(entity, metadata, columns, values, subQuery);

        listeners.preExecute(context);
        int rc = stmt.executeUpdate();
        listeners.executed(context);
        return rc;
      } else if (batchToBulk) {
        stmt = createStatement(false);
        listeners.notifyInserts(entity, metadata, batches);

        listeners.preExecute(context);
        int rc = stmt.executeUpdate();
        listeners.executed(context);
        return rc;
      } else {
        stmts = createStatements(false);
        listeners.notifyInserts(entity, metadata, batches);

        listeners.preExecute(context);
        long rc = executeBatch(stmts);
        listeners.executed(context);
        return rc;
      }
    } catch (SQLException e) {
      onException(context, e);
      throw configuration.translate(queryString, constants, e);
    } finally {
      if (stmt != null) {
        close(stmt);
      }
      if (stmts != null) {
        close(stmts);
      }
      reset();
      endContext(context);
    }
  }

  @Override
  public List getSQL() {
    if (batches.isEmpty()) {
      SQLSerializer serializer = createSerializer();
      serializer.serializeInsert(metadata, entity, columns, values, subQuery);
      return Collections.singletonList(createBindings(metadata, serializer));
    } else if (batchToBulk) {
      SQLSerializer serializer = createSerializer();
      serializer.serializeInsert(metadata, entity, batches);
      return Collections.singletonList(createBindings(metadata, serializer));
    } else {
      List builder = new ArrayList<>();
      for (SQLInsertBatch batch : batches) {
        SQLSerializer serializer = createSerializer();
        serializer.serializeInsert(
            metadata, entity, batch.getColumns(), batch.getValues(), batch.getSubQuery());
        builder.add(createBindings(metadata, serializer));
      }
      return CollectionUtils.unmodifiableList(builder);
    }
  }

  @Override
  public C select(SubQueryExpression sq) {
    subQuery = sq;
    for (Map.Entry, Object> entry : sq.getMetadata().getParams().entrySet()) {
      metadata.setParam((ParamExpression) entry.getKey(), entry.getValue());
    }
    return (C) this;
  }

  @Override
  public  C set(Path path, T value) {
    columns.add(path);
    if (value instanceof Expression) {
      values.add((Expression) value);
    } else if (value != null) {
      values.add(ConstantImpl.create(value));
    } else {
      values.add(Null.CONSTANT);
    }
    return (C) this;
  }

  @Override
  public  C set(Path path, Expression expression) {
    columns.add(path);
    values.add(expression);
    return (C) this;
  }

  @Override
  public  C setNull(Path path) {
    columns.add(path);
    values.add(Null.CONSTANT);
    return (C) this;
  }

  @Override
  public C values(Object... v) {
    for (Object value : v) {
      if (value instanceof Expression) {
        values.add((Expression) value);
      } else if (value != null) {
        values.add(ConstantImpl.create(value));
      } else {
        values.add(Null.CONSTANT);
      }
    }
    return (C) this;
  }

  @Override
  public String toString() {
    SQLSerializer serializer = createSerializer();
    if (!batches.isEmpty() && batchToBulk) {
      serializer.serializeInsert(metadata, entity, batches);
    } else {
      serializer.serializeInsert(metadata, entity, columns, values, subQuery);
    }
    return serializer.toString();
  }

  /**
   * Populate the INSERT clause with the properties of the given bean. The properties need to match
   * the fields of the clause's entity instance.
   *
   * @param bean bean to use for population
   * @return the current object
   */
  public C populate(Object bean) {
    return populate(bean, DefaultMapper.DEFAULT);
  }

  /**
   * Populate the INSERT clause with the properties of the given bean using the given Mapper.
   *
   * @param obj object to use for population
   * @param mapper mapper to use
   * @return the current object
   */
  @SuppressWarnings("rawtypes")
  public  C populate(T obj, Mapper mapper) {
    Map, Object> values = mapper.createMap(entity, obj);
    for (Map.Entry, Object> entry : values.entrySet()) {
      set((Path) entry.getKey(), entry.getValue());
    }
    return (C) this;
  }

  @Override
  public boolean isEmpty() {
    return values.isEmpty() && batches.isEmpty();
  }

  @Override
  public int getBatchCount() {
    return batches.size();
  }
}