Package org.postgresql
Enum Class PGEnvironment
- All Implemented Interfaces:
Serializable
,Comparable<PGEnvironment>
,Constable
Some environment variables are intended to have same meaning as libpq describes here:
https://www.postgresql.org/docs/current/libpq-envars.html
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe database name.Name of host to connect to.Specified location of password file.The password of user.Port number to connect to at the server host.The connection service name to be found in PGSERVICEFILE.The connection service resource (file, url) allows connection parameters to be associated with a single service name.The connection user.The database name.Name of host to connect to.Specified location of password file.The password of user.Port number to connect to at the server host.The connection service name to be found in PGSERVICEFILE.The connection service resource (file, url) allows connection parameters to be associated with a single service name.sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files.The connection user. -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
PGEnvironment
(String name, String defaultValue, String description) -
Method Summary
Modifier and TypeMethodDescriptionstatic PGEnvironment
Deprecated.instead of PGSERVICEFILE.getDefaultValue() use OSUtil.getDefaultPgServiceFilename(), getDefaultValue() returns null for all other enum values.Returns the description for this parameter.getName()
Returns the name of the parameter.static PGEnvironment
Returns the enum constant of this class with the specified name.static PGEnvironment[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ORG_POSTGRESQL_PGDATABASE
The database name. -
PGDATABASE
The database name. -
ORG_POSTGRESQL_PGHOST
Name of host to connect to. -
PGHOST
Name of host to connect to. -
ORG_POSTGRESQL_PGPASSFILE
Specified location of password file. -
PGPASSFILE
Specified location of password file. -
ORG_POSTGRESQL_PGPASSWORD
The password of user. -
PGPASSWORD
The password of user. -
ORG_POSTGRESQL_PGPORT
Port number to connect to at the server host. -
PGPORT
Port number to connect to at the server host. -
ORG_POSTGRESQL_PGSERVICE
The connection service name to be found in PGSERVICEFILE. -
PGSERVICE
The connection service name to be found in PGSERVICEFILE. -
ORG_POSTGRESQL_PGSERVICEFILE
The connection service resource (file, url) allows connection parameters to be associated with a single service name. -
PGSERVICEFILE
The connection service resource (file, url) allows connection parameters to be associated with a single service name. -
PGSYSCONFDIR
sets the directory containing the PGSERVICEFILE file and possibly other system-wide configuration files. -
ORG_POSTGRESQL_PGUSER
The connection user. -
PGUSER
The connection user.
-
-
Field Details
-
name
-
defaultValue
-
description
-
PROPS_BY_NAME
-
-
Constructor Details
-
PGEnvironment
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum class has no constant with the specified nameNullPointerException
- if the argument is null
-
forName
-
getName
Returns the name of the parameter.- Returns:
- the name of the parameter
-
getDefaultValue
Deprecated.instead of PGSERVICEFILE.getDefaultValue() use OSUtil.getDefaultPgServiceFilename(), getDefaultValue() returns null for all other enum values.Returns the default value for this parameter.- Returns:
- the default value for this parameter or null
-
getDescription
Returns the description for this parameter.- Returns:
- the description for this parameter
-
readStringValue
-