Package io.github.mfvanek.pg.model.context

Class PgContext

java.lang.Object

io.github.mfvanek.pg.model.context.PgContext

@Immutable
@ThreadSafe
public final class PgContext
extends Object

Represents a context for running maintenance queries.

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_BLOAT_PERCENTAGE_THRESHOLD	Default bloat percentage threshold.
static final double	DEFAULT_REMAINING_PERCENTAGE_THRESHOLD	Default sequence remaining values percentage threshold.
static final String	DEFAULT_SCHEMA_NAME	Default schema name.

Method Summary

Modifier and Type	Method	Description
String	enrichWithSchema(String objectName)	Complement the given object (table or index) name with the specified schema name if it is necessary.
double	getBloatPercentageThreshold()	Returns the specified bloat percentage threshold.
double	getRemainingPercentageThreshold()	Returns the specified remaining percentage threshold.
String	getSchemaName()	Returns the specified schema name.
boolean	isDefaultSchema()	Determines whether the specified schema is public or not.
static PgContext	of(String schemaName)	Creates PgContext for given schema with default bloat percentage threshold.
static PgContext	of(String schemaName, double bloatPercentageThreshold)	Creates PgContext for given schema with given bloat percentage threshold.
static PgContext	of(String schemaName, double bloatPercentageThreshold, double remainingPercentageThreshold)	Creates a PgContext for the given schema with the specified bloat percentage threshold and remaining percentage threshold.
static PgContext	ofPublic()	Creates PgContext for public schema with default bloat percentage threshold.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_BLOAT_PERCENTAGE_THRESHOLD

public static final double DEFAULT_BLOAT_PERCENTAGE_THRESHOLD

Default bloat percentage threshold.

See Also:

• Constant Field Values

DEFAULT_SCHEMA_NAME

public static final String DEFAULT_SCHEMA_NAME

Default schema name.

See Also:

• Constant Field Values

DEFAULT_REMAINING_PERCENTAGE_THRESHOLD

public static final double DEFAULT_REMAINING_PERCENTAGE_THRESHOLD

Default sequence remaining values percentage threshold.

See Also:

• Constant Field Values

Method Details

getSchemaName

@Nonnull
public String getSchemaName()

Returns the specified schema name.

Returns:

schema name

isDefaultSchema

public boolean isDefaultSchema()

Determines whether the specified schema is public or not.

Returns:

true if it is the public schema

getBloatPercentageThreshold

public double getBloatPercentageThreshold()

Returns the specified bloat percentage threshold.

Returns:

bloat percentage threshold

getRemainingPercentageThreshold

public double getRemainingPercentageThreshold()

Returns the specified remaining percentage threshold.

Returns:

remaining percentage threshold

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

enrichWithSchema

@Nonnull
public String enrichWithSchema(@Nonnull
 String objectName)

Complement the given object (table or index) name with the specified schema name if it is necessary.

Parameters:

objectName - given object name

Returns:

object name with schema for non default schemas

of

@Nonnull
public static PgContext of(@Nonnull
 String schemaName,
 double bloatPercentageThreshold,
 double remainingPercentageThreshold)

Creates a PgContext for the given schema with the specified bloat percentage threshold and remaining percentage threshold.

Parameters:

schemaName - the given database schema name

bloatPercentageThreshold - the specified bloat percentage threshold; should be greater than or equal to zero

remainingPercentageThreshold - the specified remaining percentage threshold

Returns:

PgContext

of

@Nonnull
public static PgContext of(@Nonnull
 String schemaName,
 double bloatPercentageThreshold)

Creates PgContext for given schema with given bloat percentage threshold.

Parameters:

schemaName - given database schema

bloatPercentageThreshold - given bloat percentage threshold; should be greater or equals to zero

Returns:

PgContext

See Also:

• DEFAULT_REMAINING_PERCENTAGE_THRESHOLD

of

@Nonnull
public static PgContext of(@Nonnull
 String schemaName)

Creates PgContext for given schema with default bloat percentage threshold.

Parameters:

schemaName - given database schema

Returns:

PgContext

See Also:

• DEFAULT_BLOAT_PERCENTAGE_THRESHOLD

ofPublic

@Nonnull
public static PgContext ofPublic()

Creates PgContext for public schema with default bloat percentage threshold.

Returns:

PgContext

See Also:

• DEFAULT_BLOAT_PERCENTAGE_THRESHOLD