PostgreSQL JDBC Driver 42.7.2 · org.postgresql.jdbc.TypeInfoCache

Modifier and Type	Field and Description
private final Map<Integer, Character>	arrayOidToDelimiter
private final BaseConnection	conn
private @Nullable PreparedStatement	getAllTypeInfoStatement
private @Nullable PreparedStatement	getArrayDelimiterStatement
private @Nullable PreparedStatement	getArrayElementOidStatement
private @Nullable PreparedStatement	getNameStatement
private @Nullable PreparedStatement	getOidStatementComplexArray
private @Nullable PreparedStatement	getOidStatementComplexNonArray
private @Nullable PreparedStatement	getOidStatementSimple
private @Nullable PreparedStatement	getTypeInfoStatement
private final Map<String, Integer>	javaArrayTypeToOid
private final ResourceLock	lock
private static final Logger	LOGGER
private final Map<Integer, String>	oidToPgName
private final Map<Integer, Integer>	oidToSQLType
private final Map<Integer, Integer>	pgArrayToPgType
private final Map<String, String>	pgNameToJavaClass
private final Map<String, Integer>	pgNameToOid
private final Map<String, Class<? extends PGobject>>	pgNameToPgObject
private final Map<String, Integer>	pgNameToSQLType
private static final ConcurrentMap<String, String>	TYPE_ALIASES PG maps several alias to real type names.
private static final Object[][]	types
private final int	unknownLength

Access	Constructor and Description
public	TypeInfoCache(BaseConnection conn, int unknownLength)

Method Summary

Modifier and Type	Method and Description
public void	addCoreType(String pgTypeName, Integer oid, Integer sqlType, String javaClass, Integer arrayOid) Implements org.postgresql.core.TypeInfo.addCoreType.
public void	addDataType(String type, Class<? extends PGobject> klass) Implements org.postgresql.core.TypeInfo.addDataType.
public void	cacheSQLTypes()
protected int	Returns: oid of the array's base element or the provided oid (if not array) convertArrayToBaseOid(int input oid oid) Return the oid of the array's base element if it's an array, if not return the provided oid.
public char	getArrayDelimiter(int the array type's OID oid) Implements org.postgresql.core.TypeInfo.getArrayDelimiter. Determine the delimiter for the elements of the given array type oid.
public int	getDisplaySize(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getDisplaySize.
public int	getJavaArrayType(String className) Implements org.postgresql.core.TypeInfo.getJavaArrayType.
public String	getJavaClass(int oid) Implements org.postgresql.core.TypeInfo.getJavaClass.
public int	getMaximumPrecision(int oid) Implements org.postgresql.core.TypeInfo.getMaximumPrecision.
private PreparedStatement	getOidStatement(String pgTypeName)
public int	getPGArrayElement(int the array type's OID oid) Implements org.postgresql.core.TypeInfo.getPGArrayElement. Look up the oid of an array's base type given the array's type oid.
public int	getPGArrayType(@Nullable String the base type's elementTypeName) Implements org.postgresql.core.TypeInfo.getPGArrayType. Determine the oid of the given base postgresql type's array type.
public @Nullable Class<? extends PGobject>	getPGobject(String type) Implements org.postgresql.core.TypeInfo.getPGobject.
public int	getPGType(String the server type name to look up pgTypeName) Implements org.postgresql.core.TypeInfo.getPGType. Look up the oid for a given postgresql type name.
public @Nullable String	getPGType(int the type's OID oid) Implements org.postgresql.core.TypeInfo.getPGType. Look up the postgresql type name for a given oid.
public Iterator<String>	getPGTypeNamesWithSQLTypes() Implements org.postgresql.core.TypeInfo.getPGTypeNamesWithSQLTypes.
public Iterator<Integer>	getPGTypeOidsWithSQLTypes() Implements org.postgresql.core.TypeInfo.getPGTypeOidsWithSQLTypes.
public int	getPrecision(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getPrecision.
public int	getScale(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getScale.
public int	getSQLType(String the server type name to look up pgTypeName) Implements org.postgresql.core.TypeInfo.getSQLType. Look up the SQL typecode for a given postgresql type name.
public int	getSQLType(int the type's OID typeOid) Implements org.postgresql.core.TypeInfo.getSQLType. Look up the SQL typecode for a given type oid.
private int	getSQLTypeFromQueryResult(ResultSet rs)
private String	getSQLTypeQuery(boolean typoidParam)
public @Nullable String	getTypeForAlias(@Nullable String alias) Implements org.postgresql.core.TypeInfo.getTypeForAlias.
public long	intOidToLong(int the (signed) integer oid to convert into a long. oid) Implements org.postgresql.core.TypeInfo.intOidToLong. Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers.
public boolean	isCaseSensitive(int oid) Implements org.postgresql.core.TypeInfo.isCaseSensitive.
public boolean	isSigned(int oid) Implements org.postgresql.core.TypeInfo.isSigned.
public int	longOidToInt(long the oid as a long. oid) Implements org.postgresql.core.TypeInfo.longOidToInt. Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers.
private PreparedStatement	prepareGetAllTypeInfoStatement()
private PreparedStatement	prepareGetArrayDelimiterStatement()
private PreparedStatement	prepareGetArrayElementOidStatement()
private PreparedStatement	prepareGetNameStatement()
private PreparedStatement	prepareGetTypeInfoStatement()
public boolean	requiresQuoting(int oid) Implements org.postgresql.core.TypeInfo.requiresQuoting.
public boolean	Returns: true if the type requires quoting requiresQuotingSqlType(int sql type as in java.sql.Types sqlType) Implements org.postgresql.core.TypeInfo.requiresQuotingSqlType. Returns true if particular sqlType requires quoting.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

arrayOidToDelimiter	back to summary
private final Map<Integer, Character> arrayOidToDelimiter

conn	back to summary
private final BaseConnection conn

getAllTypeInfoStatement	back to summary
private @Nullable PreparedStatement getAllTypeInfoStatement

getArrayDelimiterStatement	back to summary
private @Nullable PreparedStatement getArrayDelimiterStatement

getArrayElementOidStatement	back to summary
private @Nullable PreparedStatement getArrayElementOidStatement

getNameStatement	back to summary
private @Nullable PreparedStatement getNameStatement

getOidStatementComplexArray	back to summary
private @Nullable PreparedStatement getOidStatementComplexArray

getOidStatementComplexNonArray	back to summary
private @Nullable PreparedStatement getOidStatementComplexNonArray

getOidStatementSimple	back to summary
private @Nullable PreparedStatement getOidStatementSimple

getTypeInfoStatement	back to summary
private @Nullable PreparedStatement getTypeInfoStatement

javaArrayTypeToOid	back to summary
private final Map<String, Integer> javaArrayTypeToOid

lock	back to summary
private final ResourceLock lock

LOGGER	back to summary
private static final Logger LOGGER

oidToPgName	back to summary
private final Map<Integer, String> oidToPgName

oidToSQLType	back to summary
private final Map<Integer, Integer> oidToSQLType

pgArrayToPgType	back to summary
private final Map<Integer, Integer> pgArrayToPgType

pgNameToJavaClass	back to summary
private final Map<String, String> pgNameToJavaClass

pgNameToOid	back to summary
private final Map<String, Integer> pgNameToOid

pgNameToPgObject	back to summary
private final Map<String, Class<? extends PGobject>> pgNameToPgObject

pgNameToSQLType	back to summary
private final Map<String, Integer> pgNameToSQLType

TYPE_ALIASES	back to summary
private static final ConcurrentMap<String, String> TYPE_ALIASES PG maps several alias to real type names. When we do queries against pg_catalog, we must use the real type, not an alias, so use this mapping. Additional values used at runtime (including case variants) will be added to the map.

types	back to summary
private static final Object[][] types

unknownLength	back to summary
private final int unknownLength

TypeInfoCache	back to summary
public TypeInfoCache(BaseConnection conn, int unknownLength) Annotations @SuppressWarnings:method.invocation

Method Detail

addCoreType	back to summary
public void addCoreType(String pgTypeName, Integer oid, Integer sqlType, String javaClass, Integer arrayOid) Implements org.postgresql.core.TypeInfo.addCoreType. Annotations @Override

addCoreType

back to summary

public void addCoreType(String pgTypeName, Integer oid, Integer sqlType, String javaClass, Integer arrayOid)

Implements org.postgresql.core.TypeInfo.addCoreType.

Annotations

@Override

addDataType	back to summary
public void addDataType(String type, Class<? extends PGobject> klass) throws SQLException Implements org.postgresql.core.TypeInfo.addDataType. Annotations @Override

addDataType

back to summary

public void addDataType(String type, Class<? extends PGobject> klass) throws SQLException

Implements org.postgresql.core.TypeInfo.addDataType.

Annotations

@Override

cacheSQLTypes	back to summary
public void cacheSQLTypes() throws SQLException

convertArrayToBaseOid	back to summary
protected int convertArrayToBaseOid(int oid) Return the oid of the array's base element if it's an array, if not return the provided oid. This doesn't do any database lookups, so it's only useful for the originally provided type mappings. This is fine for it's intended uses where we only have intimate knowledge of types that are already known to the driver. Parameters oid:int input oid Returns:int oid of the array's base element or the provided oid (if not array)

convertArrayToBaseOid

back to summary

protected int convertArrayToBaseOid(int oid)

Return the oid of the array's base element if it's an array, if not return the provided oid. This doesn't do any database lookups, so it's only useful for the originally provided type mappings. This is fine for it's intended uses where we only have intimate knowledge of types that are already known to the driver.

Parameters

oid:int: input oid

Returns:int

oid of the array's base element or the provided oid (if not array)

getArrayDelimiter	back to summary
public char getArrayDelimiter(int oid) throws SQLException Implements org.postgresql.core.TypeInfo.getArrayDelimiter. Doc from org.postgresql.core.TypeInfo.getArrayDelimiter. Determine the delimiter for the elements of the given array type oid. Parameters oid:int the array type's OID Returns:char the base type's array type delimiter Annotations @Override Exceptions SQLException: if an error occurs when retrieving array delimiter

getArrayDelimiter

back to summary

public char getArrayDelimiter(int oid) throws SQLException

Implements org.postgresql.core.TypeInfo.getArrayDelimiter.

Doc from org.postgresql.core.TypeInfo.getArrayDelimiter.

Determine the delimiter for the elements of the given array type oid.

Parameters

oid:int: the array type's OID

Returns:char

the base type's array type delimiter

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving array delimiter

getDisplaySize	back to summary
public int getDisplaySize(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getDisplaySize. Annotations @Override

getDisplaySize

back to summary

public int getDisplaySize(int oid, int typmod)

Implements org.postgresql.core.TypeInfo.getDisplaySize.

Annotations

@Override

getJavaArrayType	back to summary
public int getJavaArrayType(String className) throws SQLException Implements org.postgresql.core.TypeInfo.getJavaArrayType. Annotations @Override

getJavaArrayType

back to summary

public int getJavaArrayType(String className) throws SQLException

Implements org.postgresql.core.TypeInfo.getJavaArrayType.

Annotations

@Override

getJavaClass	back to summary
public String getJavaClass(int oid) throws SQLException Implements org.postgresql.core.TypeInfo.getJavaClass. Annotations @Override

getJavaClass

back to summary

public String getJavaClass(int oid) throws SQLException

Implements org.postgresql.core.TypeInfo.getJavaClass.

Annotations

@Override

getMaximumPrecision	back to summary
public int getMaximumPrecision(int oid) Implements org.postgresql.core.TypeInfo.getMaximumPrecision. Annotations @Override

getMaximumPrecision

back to summary

public int getMaximumPrecision(int oid)

Implements org.postgresql.core.TypeInfo.getMaximumPrecision.

Annotations

@Override

getOidStatement	back to summary
private PreparedStatement getOidStatement(String pgTypeName) throws SQLException

getPGArrayElement	back to summary
public int getPGArrayElement(int oid) throws SQLException Implements org.postgresql.core.TypeInfo.getPGArrayElement. Doc from org.postgresql.core.TypeInfo.getPGArrayElement. Look up the oid of an array's base type given the array's type oid. Parameters oid:int the array type's OID Returns:int the base type's OID, or 0 if unknown Annotations @Override Exceptions SQLException: if an error occurs when retrieving array element

getPGArrayElement

back to summary

public int getPGArrayElement(int oid) throws SQLException

Implements org.postgresql.core.TypeInfo.getPGArrayElement.

Doc from org.postgresql.core.TypeInfo.getPGArrayElement.

Look up the oid of an array's base type given the array's type oid.

Parameters

oid:int: the array type's OID

Returns:int

the base type's OID, or 0 if unknown

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving array element

getPGArrayType	back to summary
public int getPGArrayType(@Nullable String elementTypeName) throws SQLException Implements org.postgresql.core.TypeInfo.getPGArrayType. Doc from org.postgresql.core.TypeInfo.getPGArrayType. Determine the oid of the given base postgresql type's array type. Parameters elementTypeName:@Nullable String the base type's Returns:int the array type's OID, or 0 if unknown Annotations @Override Exceptions SQLException: if an error occurs when retrieving array type

getPGArrayType

back to summary

public int getPGArrayType(@Nullable String elementTypeName) throws SQLException

Implements org.postgresql.core.TypeInfo.getPGArrayType.

Doc from org.postgresql.core.TypeInfo.getPGArrayType.

Determine the oid of the given base postgresql type's array type.

Parameters

elementTypeName:@Nullable String: the base type's

Returns:int

the array type's OID, or 0 if unknown

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving array type

getPGobject	back to summary
public @Nullable Class<? extends PGobject> getPGobject(String type) Implements org.postgresql.core.TypeInfo.getPGobject. Annotations @Override

getPGobject

back to summary

public @Nullable Class<? extends PGobject> getPGobject(String type)

Implements org.postgresql.core.TypeInfo.getPGobject.

Annotations

@Override

getPGType back to summary

getPGType	back to summary
public int getPGType(String pgTypeName) throws SQLException Implements org.postgresql.core.TypeInfo.getPGType. Doc from org.postgresql.core.TypeInfo.getPGType. Look up the oid for a given postgresql type name. This is the inverse of `getPGType(int)`. Parameters pgTypeName:String the server type name to look up Returns:int the type's OID, or 0 if unknown Annotations @Override Exceptions SQLException: if an error occurs when retrieving PG type

public int getPGType(String pgTypeName) throws SQLException

Implements org.postgresql.core.TypeInfo.getPGType.

Doc from org.postgresql.core.TypeInfo.getPGType.

Look up the oid for a given postgresql type name. This is the inverse of getPGType(int).

Parameters

pgTypeName:String: the server type name to look up

Returns:int

the type's OID, or 0 if unknown

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving PG type

getPGType back to summary

getPGType	back to summary
public @Nullable String getPGType(int oid) throws SQLException Implements org.postgresql.core.TypeInfo.getPGType. Doc from org.postgresql.core.TypeInfo.getPGType. Look up the postgresql type name for a given oid. This is the inverse of `getPGType(String)`. Parameters oid:int the type's OID Returns:@Nullable String the server type name for that OID or null if unknown Annotations @Override Exceptions SQLException: if an error occurs when retrieving PG type

public @Nullable String getPGType(int oid) throws SQLException

Implements org.postgresql.core.TypeInfo.getPGType.

Doc from org.postgresql.core.TypeInfo.getPGType.

Look up the postgresql type name for a given oid. This is the inverse of getPGType(String).

Parameters

oid:int: the type's OID

Returns:@Nullable String

the server type name for that OID or null if unknown

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving PG type

getPGTypeNamesWithSQLTypes	back to summary
public Iterator<String> getPGTypeNamesWithSQLTypes() Implements org.postgresql.core.TypeInfo.getPGTypeNamesWithSQLTypes. Annotations @Override

getPGTypeNamesWithSQLTypes

back to summary

public Iterator<String> getPGTypeNamesWithSQLTypes()

Implements org.postgresql.core.TypeInfo.getPGTypeNamesWithSQLTypes.

Annotations

@Override

getPGTypeOidsWithSQLTypes	back to summary
public Iterator<Integer> getPGTypeOidsWithSQLTypes() Implements org.postgresql.core.TypeInfo.getPGTypeOidsWithSQLTypes. Annotations @Override

getPGTypeOidsWithSQLTypes

back to summary

public Iterator<Integer> getPGTypeOidsWithSQLTypes()

Implements org.postgresql.core.TypeInfo.getPGTypeOidsWithSQLTypes.

Annotations

@Override

getPrecision	back to summary
public int getPrecision(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getPrecision. Annotations @Override

getPrecision

back to summary

public int getPrecision(int oid, int typmod)

Implements org.postgresql.core.TypeInfo.getPrecision.

Annotations

@Override

getScale	back to summary
public int getScale(int oid, int typmod) Implements org.postgresql.core.TypeInfo.getScale. Annotations @Override

getScale

back to summary

public int getScale(int oid, int typmod)

Implements org.postgresql.core.TypeInfo.getScale.

Annotations

@Override

getSQLType back to summary

getSQLType	back to summary
public int getSQLType(String pgTypeName) throws SQLException Implements org.postgresql.core.TypeInfo.getSQLType. Doc from org.postgresql.core.TypeInfo.getSQLType. Look up the SQL typecode for a given postgresql type name. Parameters pgTypeName:String the server type name to look up Returns:int the SQL type code (a constant from `java.sql.Types`) for the type Annotations @Override Exceptions SQLException: if an error occurs when retrieving sql type

public int getSQLType(String pgTypeName) throws SQLException

Implements org.postgresql.core.TypeInfo.getSQLType.

Doc from org.postgresql.core.TypeInfo.getSQLType.

Look up the SQL typecode for a given postgresql type name.

Parameters

pgTypeName:String: the server type name to look up

Returns:int

the SQL type code (a constant from java.sql.Types) for the type

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving sql type

getSQLType back to summary

getSQLType	back to summary
public int getSQLType(int typeOid) throws SQLException Implements org.postgresql.core.TypeInfo.getSQLType. Doc from org.postgresql.core.TypeInfo.getSQLType. Look up the SQL typecode for a given type oid. Parameters typeOid:int the type's OID Returns:int the SQL type code (a constant from `java.sql.Types`) for the type Annotations @Override Exceptions SQLException: if an error occurs when retrieving sql type

public int getSQLType(int typeOid) throws SQLException

Implements org.postgresql.core.TypeInfo.getSQLType.

Doc from org.postgresql.core.TypeInfo.getSQLType.

Look up the SQL typecode for a given type oid.

Parameters

typeOid:int: the type's OID

Returns:int

the SQL type code (a constant from java.sql.Types) for the type

Annotations

@Override

Exceptions

SQLException:: if an error occurs when retrieving sql type

getSQLTypeFromQueryResult	back to summary
private int getSQLTypeFromQueryResult(ResultSet rs) throws SQLException

getSQLTypeQuery	back to summary
private String getSQLTypeQuery(boolean typoidParam)

getTypeForAlias

back to summary

public @Nullable String getTypeForAlias(@Nullable String alias)

Implements org.postgresql.core.TypeInfo.getTypeForAlias.

Annotations

@Override

intOidToLong

back to summary

public long intOidToLong(int oid)

Implements org.postgresql.core.TypeInfo.intOidToLong.

Doc from org.postgresql.core.TypeInfo.intOidToLong.

Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers. We must therefore first map the (internal) integer representation to a positive long value before sending it to postgresql, or we would be unable to correctly handle the upper half of the oid space because these negative values are disallowed as OID values.

Parameters

oid:int: the (signed) integer oid to convert into a long.

Returns:long

the non-negative value of this oid, stored as a java long.

Annotations

@Override

isCaseSensitive

back to summary

public boolean isCaseSensitive(int oid)

Implements org.postgresql.core.TypeInfo.isCaseSensitive.

Annotations

@Override

isSigned

back to summary

public boolean isSigned(int oid)

Implements org.postgresql.core.TypeInfo.isSigned.

Annotations

@Override

longOidToInt

back to summary

public int longOidToInt(long oid) throws SQLException

Implements org.postgresql.core.TypeInfo.longOidToInt.

Doc from org.postgresql.core.TypeInfo.longOidToInt.

Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers. We therefore read them as positive long values and then force them into signed integers (wrapping around into negative values when required) or we'd be unable to correctly handle the upper half of the oid space.

This function handles the mapping of uint32-values in the long to java integers, and throws for values that are out of range.

Parameters

oid:long: the oid as a long.

Returns:int

the (internal) signed integer representation of the (unsigned) oid.

Annotations

@Override

Exceptions

SQLException:: if the long has a value outside of the range representable by uint32

prepareGetAllTypeInfoStatement	back to summary
private PreparedStatement prepareGetAllTypeInfoStatement() throws SQLException

prepareGetArrayDelimiterStatement	back to summary
private PreparedStatement prepareGetArrayDelimiterStatement() throws SQLException

prepareGetArrayElementOidStatement	back to summary
private PreparedStatement prepareGetArrayElementOidStatement() throws SQLException

prepareGetNameStatement	back to summary
private PreparedStatement prepareGetNameStatement() throws SQLException

prepareGetTypeInfoStatement	back to summary
private PreparedStatement prepareGetTypeInfoStatement() throws SQLException

requiresQuoting

back to summary

public boolean requiresQuoting(int oid) throws SQLException

Implements org.postgresql.core.TypeInfo.requiresQuoting.

Annotations

@Override

requiresQuotingSqlType

back to summary

public boolean requiresQuotingSqlType(int sqlType) throws SQLException

Implements org.postgresql.core.TypeInfo.requiresQuotingSqlType.

Returns true if particular sqlType requires quoting. This method is used internally by the driver, so it might disappear without notice.

Parameters

sqlType:int: sql type as in java.sql.Types

Returns:boolean

true if the type requires quoting

Annotations

@Override

Exceptions

SQLException:: if something goes wrong

public Class TypeInfoCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail