marquez.db.FlywayFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marquez-api Show documentation
Collect, aggregate, and visualize a data ecosystem's metadata
There is a newer version: 0.49.0
/*
 * Copyright 2018-2023 contributors to the Marquez project
 * SPDX-License-Identifier: Apache-2.0
 */

package marquez.db;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import java.nio.charset.StandardCharsets;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;
import javax.sql.DataSource;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.NonNull;
import lombok.Setter;
import org.flywaydb.core.Flyway;

@NoArgsConstructor
public final class FlywayFactory {
  private static final int DEFAULT_CONNECT_RETRIES = 0;
  private static final boolean DEFAULT_BASELINE_ON_MIGRATE = false;
  private static final boolean DEFAULT_GROUP = false;
  private static final boolean DEFAULT_MIXED = false;
  private static final boolean DEFAULT_IGNORE_MISSING_MIGRATIONS = false;
  private static final boolean DEFAULT_IGNORE_IGNORED_MIGRATIONS = false;
  private static final boolean DEFAULT_IGNORE_PENDING_MIGRATIONS = false;
  private static final boolean DEFAULT_IGNORE_FUTURE_MIGRATIONS = false;
  private static final boolean DEFAULT_VALIDATE_MIGRATION_NAMING = false;
  private static final boolean DEFAULT_VALIDATE_ON_MIGRATE = false;
  private static final boolean DEFAULT_CLEAN_ON_VALIDATION_ERROR = false;
  private static final boolean DEFAULT_CLEAN_DISABLED = false;
  private static final boolean DEFAULT_OUT_OF_ORDER = false;
  private static final String DEFAULT_LOCATION = "marquez/db/migration";
  private static final String DEFAULT_MIGRATION_CLASSPATH = "classpath:marquez/db/migrations";
  private static final List DEFAULT_LOCATIONS =
      ImmutableList.of(DEFAULT_LOCATION, DEFAULT_MIGRATION_CLASSPATH);
  private static final String DEFAULT_ENCODING = StandardCharsets.UTF_8.name();
  private static final String DEFAULT_TABLE = "flyway_schema_history";
  private static final boolean DEFAULT_PLACEHOLDER_REPLACEMENT = false;
  private static final Map DEFAULT_PLACEHOLDERS = ImmutableMap.of();
  private static final String DEFAULT_PLACEHOLDER_PREFIX = "${";
  private static final String DEFAULT_PLACEHOLDER_SUFFIX = "}";
  private static final String DEFAULT_SQL_MIGRATION_PREFIX = "V";
  private static final String DEFAULT_REPEATABLE_SQL_MIGRATION_PREFIX = "R";

  @Getter @Setter private int connectRetries = DEFAULT_CONNECT_RETRIES;
  @Setter @Nullable private String initSql;
  @Getter @Setter private boolean baselineOnMigrate = DEFAULT_BASELINE_ON_MIGRATE;
  @Getter @Setter private boolean group = DEFAULT_GROUP;
  @Setter @Nullable private String installedBy;
  @Getter @Setter private boolean mixed = DEFAULT_MIXED;
  @Getter @Setter private boolean ignoreMissingMigrations = DEFAULT_IGNORE_MISSING_MIGRATIONS;
  @Getter @Setter private boolean ignoreIgnoredMigrations = DEFAULT_IGNORE_IGNORED_MIGRATIONS;
  @Getter @Setter private boolean ignorePendingMigrations = DEFAULT_IGNORE_PENDING_MIGRATIONS;
  @Getter @Setter private boolean ignoreFutureMigrations = DEFAULT_IGNORE_FUTURE_MIGRATIONS;
  @Getter @Setter private boolean validateMigrationNaming = DEFAULT_VALIDATE_MIGRATION_NAMING;
  @Getter @Setter private boolean validateOnMigrate = DEFAULT_VALIDATE_ON_MIGRATE;
  @Getter @Setter private boolean cleanOnValidationError = DEFAULT_CLEAN_ON_VALIDATION_ERROR;
  @Getter @Setter private boolean cleanDisabled = DEFAULT_CLEAN_DISABLED;
  @Getter @Setter private boolean outOfOrder = DEFAULT_OUT_OF_ORDER;
  @Getter @Setter private List locations = DEFAULT_LOCATIONS;
  @Getter @Setter private String encoding = DEFAULT_ENCODING;
  @Getter @Setter private String table = DEFAULT_TABLE;
  @Setter @Nullable private String tablespace;
  @Getter @Setter private boolean placeholderReplacement = DEFAULT_PLACEHOLDER_REPLACEMENT;
  @Getter @Setter private Map placeholders = DEFAULT_PLACEHOLDERS;
  @Getter @Setter private String placeholderPrefix = DEFAULT_PLACEHOLDER_PREFIX;
  @Getter @Setter private String placeholderSuffix = DEFAULT_PLACEHOLDER_SUFFIX;
  @Getter @Setter private String sqlMigrationPrefix = DEFAULT_SQL_MIGRATION_PREFIX;

  @Getter @Setter
  private String repeatableSqlMigrationPrefix = DEFAULT_REPEATABLE_SQL_MIGRATION_PREFIX;

  @Getter @Setter private String schema;

  public Flyway build(@NonNull DataSource source) {
    return Flyway.configure()
        .dataSource(source)
        .connectRetries(connectRetries)
        .initSql(initSql)
        .baselineOnMigrate(baselineOnMigrate)
        .group(group)
        .installedBy(installedBy)
        .mixed(mixed)
        .ignoreMissingMigrations(ignoreMissingMigrations)
        .ignoreIgnoredMigrations(ignoreIgnoredMigrations)
        .ignorePendingMigrations(ignorePendingMigrations)
        .ignoreFutureMigrations(ignoreFutureMigrations)
        .validateMigrationNaming(validateMigrationNaming)
        .validateOnMigrate(validateOnMigrate)
        .cleanOnValidationError(cleanOnValidationError)
        .cleanDisabled(cleanDisabled)
        .outOfOrder(outOfOrder)
        .locations(locations.stream().toArray(String[]::new))
        .encoding(encoding)
        .table(table)
        .tablespace(tablespace)
        .placeholderReplacement(placeholderReplacement)
        .placeholders(placeholders)
        .placeholderPrefix(placeholderPrefix)
        .placeholderSuffix(placeholderSuffix)
        .sqlMigrationPrefix(sqlMigrationPrefix)
        .repeatableSqlMigrationPrefix(repeatableSqlMigrationPrefix)
        .defaultSchema(schema)
        .load();
  }
}