com.google.cloud.spanner.hibernate.schema.RunBatchDdl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-spanner-hibernate-dialect Show documentation
The newest version!
/*
 * Copyright 2019-2023 Google LLC
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
 */

package com.google.cloud.spanner.hibernate.schema;

import com.google.cloud.spanner.hibernate.SpannerDialect;
import java.util.ArrayList;
import java.util.List;
import org.hibernate.boot.model.relational.AuxiliaryDatabaseObject;
import org.hibernate.boot.model.relational.SqlStringGenerationContext;
import org.hibernate.dialect.Dialect;
import org.hibernate.tool.schema.Action;

/** Custom {@link AuxiliaryDatabaseObject} which generates the RUN BATCH statement. */
public class RunBatchDdl implements AuxiliaryDatabaseObject {
  private static final long serialVersionUID = 1L;

  private final Action schemaAction;

  private final List statements;

  /**
   * Constructs the {@link RunBatchDdl} auxiliary database object.
   *
   * @param schemaAction the DDL mode being used for schema generation.
   */
  public RunBatchDdl(Action schemaAction) {
    this.schemaAction = schemaAction;
    this.statements = new ArrayList<>();
    this.statements.add("RUN BATCH");
  }

  /**
   * Add a statement to run after the DDL batch is completed. This is useful for executing
   * additional DML statements since these cannot be run in a DDL batch.
   */
  public void addAfterDdlStatement(String statement) {
    statements.add(statement);
  }

  @Override
  public String getExportIdentifier() {
    return "RUN_BATCH_DDL";
  }

  @Override
  public boolean appliesToDialect(Dialect dialect) {
    return SpannerDialect.class.isAssignableFrom(dialect.getClass());
  }

  @Override
  public boolean beforeTablesOnCreation() {
    return schemaAction != Action.CREATE
        && schemaAction != Action.CREATE_ONLY
        && schemaAction != Action.UPDATE;
  }

  @Override
  public String[] sqlCreateStrings(SqlStringGenerationContext context) {
    return statements.toArray(new String[statements.size()]);
  }

  @Override
  public String[] sqlDropStrings(SqlStringGenerationContext context) {
    if (schemaAction == Action.UPDATE) {
      return new String[] {};
    } else {
      return statements.toArray(new String[statements.size()]);
    }
  }
}