• Home
• io.github.mfvanek
• pg-index-health-model
• 0.13.1
• source code
• PgContext.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.github.mfvanek.pg.model.PgContext Maven / Gradle / Ivy

/*
 * Copyright (c) 2019-2024. Ivan Vakhrushev and others.
 * https://github.com/mfvanek/pg-index-health
 *
 * This file is a part of "pg-index-health" - a Java library for
 * analyzing and maintaining indexes health in PostgreSQL databases.
 *
 * Licensed under the Apache License 2.0
 */

package io.github.mfvanek.pg.model;

import io.github.mfvanek.pg.model.validation.Validators;

import java.util.Locale;
import javax.annotation.Nonnull;

/**
 * Represents a context for running maintenance queries.
 *
 * @author Ivan Vakhrushev
 */
public class PgContext {

    /**
     * Default bloat percentage threshold.
     */
    public static final double DEFAULT_BLOAT_PERCENTAGE_THRESHOLD = 10.0;
    /**
     * Default schema name.
     */
    public static final String DEFAULT_SCHEMA_NAME = "public";
    /**
     * Default sequence remaining values percentage threshold.
     */
    public static final double DEFAULT_REMAINING_PERCENTAGE_THRESHOLD = 10.0;

    private final String schemaName;
    private final double bloatPercentageThreshold;
    private final double remainingPercentageThreshold;

    private PgContext(@Nonnull final String schemaName, final double bloatPercentageThreshold, final double remainingPercentageThreshold) {
        this.schemaName = Validators.notBlank(schemaName, "schemaName").toLowerCase(Locale.ROOT);
        this.bloatPercentageThreshold = Validators.validPercent(bloatPercentageThreshold, "bloatPercentageThreshold");
        this.remainingPercentageThreshold = Validators.validPercent(remainingPercentageThreshold, "remainingPercentageThreshold");
    }

    /**
     * Returns the specified schema name.
     *
     * @return schema name
     */
    @Nonnull
    public String getSchemaName() {
        return schemaName;
    }

    /**
     * Determines whether the specified schema is public or not.
     *
     * @return true if it is the public schema
     */
    public boolean isDefaultSchema() {
        return DEFAULT_SCHEMA_NAME.equalsIgnoreCase(schemaName);
    }

    /**
     * Returns the specified bloat percentage threshold.
     *
     * @return bloat percentage threshold
     */
    public double getBloatPercentageThreshold() {
        return bloatPercentageThreshold;
    }

    /**
     * Returns the specified remaining percentage threshold.
     *
     * @return remaining percentage threshold
     */
    public double getRemainingPercentageThreshold() {
        return remainingPercentageThreshold;
    }

    /**
     * {@inheritDoc}
     */
    @Nonnull
    @Override
    public String toString() {
        return PgContext.class.getSimpleName() + '{' +
            "schemaName='" + schemaName + '\'' +
            ", bloatPercentageThreshold=" + bloatPercentageThreshold +
            ", remainingPercentageThreshold=" + remainingPercentageThreshold +
            '}';
    }

    /**
     * Complement the given object (table or index) name with the specified schema name if it is necessary.
     *
     * @param objectName given object name
     * @return object name with schema for non default schemas
     * @see #enrichSequenceWithSchema
     */
    @Nonnull
    public String enrichWithSchema(@Nonnull final String objectName) {
        Validators.notBlank(objectName, "objectName");

        if (isDefaultSchema()) {
            return objectName;
        }

        return enrichWithSchemaIfNeed(objectName);
    }

    /**
     * Complement the given sequence name with the specified schema name if it is necessary.
     *
     * @param sequenceName given sequence name
     * @return sequence name with schema for all schemas
     * @see #enrichWithSchema
     */
    @Nonnull
    public String enrichSequenceWithSchema(@Nonnull final String sequenceName) {
        Validators.notBlank(sequenceName, "sequenceName");

        return enrichWithSchemaIfNeed(sequenceName);
    }

    @Nonnull
    private String enrichWithSchemaIfNeed(@Nonnull final String objectName) {
        final String prefix = schemaName + ".";
        if (objectName.toLowerCase(Locale.ROOT).startsWith(prefix)) {
            return objectName;
        }

        return prefix + objectName;
    }

    /**
     * Creates a {@code PgContext} for the given schema with the specified bloat percentage threshold
     * and remaining percentage threshold.
     *
     * @param schemaName                   the given database schema name
     * @param bloatPercentageThreshold     the specified bloat percentage threshold; should be greater than or equal to zero
     * @param remainingPercentageThreshold the specified remaining percentage threshold
     * @return {@code PgContext}
     */
    @Nonnull
    public static PgContext of(@Nonnull final String schemaName,
                               final double bloatPercentageThreshold,
                               final double remainingPercentageThreshold) {
        return new PgContext(schemaName, bloatPercentageThreshold, remainingPercentageThreshold);
    }

    /**
     * Creates {@code PgContext} for given schema with given bloat percentage threshold.
     *
     * @param schemaName               given database schema
     * @param bloatPercentageThreshold given bloat percentage threshold; should be greater or equals to zero
     * @return {@code PgContext}
     * @see PgContext#DEFAULT_REMAINING_PERCENTAGE_THRESHOLD
     */
    @Nonnull
    public static PgContext of(@Nonnull final String schemaName,
                               final double bloatPercentageThreshold) {
        return new PgContext(schemaName, bloatPercentageThreshold, DEFAULT_REMAINING_PERCENTAGE_THRESHOLD);
    }

    /**
     * Creates {@code PgContext} for given schema with default bloat percentage threshold.
     *
     * @param schemaName given database schema
     * @return {@code PgContext}
     * @see PgContext#DEFAULT_BLOAT_PERCENTAGE_THRESHOLD
     */
    @Nonnull
    public static PgContext of(@Nonnull final String schemaName) {
        return of(schemaName, DEFAULT_BLOAT_PERCENTAGE_THRESHOLD);
    }

    /**
     * Creates {@code PgContext} for public schema with default bloat percentage threshold.
     *
     * @return {@code PgContext}
     * @see PgContext#DEFAULT_BLOAT_PERCENTAGE_THRESHOLD
     */
    @Nonnull
    public static PgContext ofPublic() {
        return of(DEFAULT_SCHEMA_NAME);
    }
}