com.google.cloud.spanner.hibernate.schema.SpannerSchemaDropper 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 java.sql.Connection;
import java.sql.SQLException;
import org.hibernate.boot.Metadata;
import org.hibernate.resource.transaction.spi.DdlTransactionIsolator;
import org.hibernate.tool.schema.Action;
import org.hibernate.tool.schema.internal.SchemaDropperImpl;
import org.hibernate.tool.schema.spi.ContributableMatcher;
import org.hibernate.tool.schema.spi.DelayedDropAction;
import org.hibernate.tool.schema.spi.ExecutionOptions;
import org.hibernate.tool.schema.spi.SchemaDropper;
import org.hibernate.tool.schema.spi.SourceDescriptor;
import org.hibernate.tool.schema.spi.TargetDescriptor;

/**
 * A modified version of the {@link SchemaDropperImpl} which batches DDL statements to optimize
 * performance.
 */
public class SpannerSchemaDropper implements SchemaDropper {

  private final SpannerSchemaManagementTool tool;
  private final SchemaDropper schemaDropper;

  public SpannerSchemaDropper(SpannerSchemaManagementTool tool, SchemaDropper schemaDropper) {
    this.tool = tool;
    this.schemaDropper = schemaDropper;
  }

  @Override
  public void doDrop(
      Metadata metadata,
      ExecutionOptions options,
      ContributableMatcher contributableInclusionFilter,
      SourceDescriptor sourceDescriptor,
      TargetDescriptor targetDescriptor) {

    // Initialize auxiliary database objects to enable DDL statement batching.
    metadata.getDatabase().addAuxiliaryDatabaseObject(new StartBatchDdl(Action.DROP));
    metadata.getDatabase().addAuxiliaryDatabaseObject(new RunBatchDdl(Action.DROP));

    DdlTransactionIsolator isolator = tool.getDdlTransactionIsolator(options);
    try {
      Connection connection = isolator.getIsolatedConnection();
      // Initialize exporters with drop table dependencies so tables are dropped in the right order.
      SpannerDatabaseInfo spannerDatabaseInfo =
          new SpannerDatabaseInfo(metadata.getDatabase(), connection.getMetaData());
      tool.getSpannerTableExporter(options).init(metadata, spannerDatabaseInfo, Action.DROP);
      tool.getForeignKeyExporter(options).init(spannerDatabaseInfo);
      schemaDropper.doDrop(
          metadata, options, contributableInclusionFilter, sourceDescriptor, targetDescriptor);
    } catch (SQLException e) {
      throw new RuntimeException("Failed to update Spanner table schema.", e);
    } finally {
      isolator.release();
    }
  }

  @Override
  public DelayedDropAction buildDelayedAction(
      Metadata metadata,
      ExecutionOptions options,
      ContributableMatcher contributableInclusionFilter,
      SourceDescriptor sourceDescriptor) {

    DdlTransactionIsolator isolator = tool.getDdlTransactionIsolator(options);
    try {
      Connection connection = isolator.getIsolatedConnection();
      // Initialize exporters with drop table dependencies so tables are dropped in the right order.
      SpannerDatabaseInfo spannerDatabaseInfo =
          new SpannerDatabaseInfo(metadata.getDatabase(), connection.getMetaData());
      tool.getSpannerTableExporter(options).init(metadata, spannerDatabaseInfo, Action.DROP);
      tool.getForeignKeyExporter(options).init(spannerDatabaseInfo);
      return schemaDropper.buildDelayedAction(
          metadata, options, contributableInclusionFilter, sourceDescriptor);
    } catch (SQLException e) {
      throw new RuntimeException("Failed to update Spanner table schema.", e);
    } finally {
      isolator.release();
    }
  }
}