Package org.postgresql.jdbc
Class TypeInfoCache
- java.lang.Object
-
- org.postgresql.jdbc.TypeInfoCache
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Map<java.lang.Integer,java.lang.Character>
arrayOidToDelimiter
private BaseConnection
conn
private java.sql.PreparedStatement
getAllTypeInfoStatement
private java.sql.PreparedStatement
getArrayDelimiterStatement
private java.sql.PreparedStatement
getArrayElementOidStatement
private java.sql.PreparedStatement
getNameStatement
private java.sql.PreparedStatement
getOidStatementComplexArray
private java.sql.PreparedStatement
getOidStatementComplexNonArray
private java.sql.PreparedStatement
getOidStatementSimple
private java.sql.PreparedStatement
getTypeInfoStatement
private static java.util.logging.Logger
LOGGER
private java.util.Map<java.lang.Integer,java.lang.String>
oidToPgName
private java.util.Map<java.lang.Integer,java.lang.Integer>
oidToSQLType
private java.util.Map<java.lang.Integer,java.lang.Integer>
pgArrayToPgType
private java.util.Map<java.lang.String,java.lang.String>
pgNameToJavaClass
private java.util.Map<java.lang.String,java.lang.Integer>
pgNameToOid
private java.util.Map<java.lang.String,java.lang.Class<? extends PGobject>>
pgNameToPgObject
private java.util.Map<java.lang.String,java.lang.Integer>
pgNameToSQLType
private static java.util.HashMap<java.lang.String,java.lang.String>
typeAliases
PG maps several alias to real type names.private static java.lang.Object[][]
types
private int
unknownLength
-
Constructor Summary
Constructors Constructor Description TypeInfoCache(BaseConnection conn, int unknownLength)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCoreType(java.lang.String pgTypeName, java.lang.Integer oid, java.lang.Integer sqlType, java.lang.String javaClass, java.lang.Integer arrayOid)
void
addDataType(java.lang.String type, java.lang.Class<? extends PGobject> klass)
void
cacheSQLTypes()
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.char
getArrayDelimiter(int oid)
Determine the delimiter for the elements of the given array type oid.int
getDisplaySize(int oid, int typmod)
java.lang.String
getJavaClass(int oid)
int
getMaximumPrecision(int oid)
private java.sql.PreparedStatement
getOidStatement(java.lang.String pgTypeName)
int
getPGArrayElement(int oid)
Look up the oid of an array's base type given the array's type oid.int
getPGArrayType(java.lang.String elementTypeName)
Determine the oid of the given base postgresql type's array type.java.lang.Class<? extends PGobject>
getPGobject(java.lang.String type)
java.lang.String
getPGType(int oid)
Look up the postgresql type name for a given oid.int
getPGType(java.lang.String pgTypeName)
Look up the oid for a given postgresql type name.java.util.Iterator<java.lang.String>
getPGTypeNamesWithSQLTypes()
java.util.Iterator<java.lang.Integer>
getPGTypeOidsWithSQLTypes()
int
getPrecision(int oid, int typmod)
int
getScale(int oid, int typmod)
int
getSQLType(int typeOid)
Look up the SQL typecode for a given type oid.int
getSQLType(java.lang.String pgTypeName)
Look up the SQL typecode for a given postgresql type name.private int
getSQLTypeFromQueryResult(java.sql.ResultSet rs)
private java.lang.String
getSQLTypeQuery(boolean typoidParam)
java.lang.String
getTypeForAlias(java.lang.String alias)
long
intOidToLong(int oid)
Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers.boolean
isCaseSensitive(int oid)
boolean
isSigned(int oid)
int
longOidToInt(long oid)
Java Integers are signed 32-bit integers, but oids are unsigned 32-bit integers.private java.sql.PreparedStatement
prepareGetAllTypeInfoStatement()
private java.sql.PreparedStatement
prepareGetArrayDelimiterStatement()
private java.sql.PreparedStatement
prepareGetArrayElementOidStatement()
private java.sql.PreparedStatement
prepareGetNameStatement()
private java.sql.PreparedStatement
prepareGetTypeInfoStatement()
boolean
requiresQuoting(int oid)
boolean
requiresQuotingSqlType(int sqlType)
Returns true if particular sqlType requires quoting.
-
-
-
Field Detail
-
LOGGER
private static final java.util.logging.Logger LOGGER
-
pgNameToSQLType
private java.util.Map<java.lang.String,java.lang.Integer> pgNameToSQLType
-
oidToSQLType
private java.util.Map<java.lang.Integer,java.lang.Integer> oidToSQLType
-
pgNameToJavaClass
private java.util.Map<java.lang.String,java.lang.String> pgNameToJavaClass
-
oidToPgName
private java.util.Map<java.lang.Integer,java.lang.String> oidToPgName
-
pgNameToOid
private java.util.Map<java.lang.String,java.lang.Integer> pgNameToOid
-
pgNameToPgObject
private java.util.Map<java.lang.String,java.lang.Class<? extends PGobject>> pgNameToPgObject
-
pgArrayToPgType
private java.util.Map<java.lang.Integer,java.lang.Integer> pgArrayToPgType
-
arrayOidToDelimiter
private java.util.Map<java.lang.Integer,java.lang.Character> arrayOidToDelimiter
-
conn
private final BaseConnection conn
-
unknownLength
private final int unknownLength
-
getOidStatementSimple
private java.sql.PreparedStatement getOidStatementSimple
-
getOidStatementComplexNonArray
private java.sql.PreparedStatement getOidStatementComplexNonArray
-
getOidStatementComplexArray
private java.sql.PreparedStatement getOidStatementComplexArray
-
getNameStatement
private java.sql.PreparedStatement getNameStatement
-
getArrayElementOidStatement
private java.sql.PreparedStatement getArrayElementOidStatement
-
getArrayDelimiterStatement
private java.sql.PreparedStatement getArrayDelimiterStatement
-
getTypeInfoStatement
private java.sql.PreparedStatement getTypeInfoStatement
-
getAllTypeInfoStatement
private java.sql.PreparedStatement getAllTypeInfoStatement
-
types
private static final java.lang.Object[][] types
-
typeAliases
private static final java.util.HashMap<java.lang.String,java.lang.String> typeAliases
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.
-
-
Constructor Detail
-
TypeInfoCache
public TypeInfoCache(BaseConnection conn, int unknownLength)
-
-
Method Detail
-
addCoreType
public void addCoreType(java.lang.String pgTypeName, java.lang.Integer oid, java.lang.Integer sqlType, java.lang.String javaClass, java.lang.Integer arrayOid)
- Specified by:
addCoreType
in interfaceTypeInfo
-
addDataType
public void addDataType(java.lang.String type, java.lang.Class<? extends PGobject> klass) throws java.sql.SQLException
- Specified by:
addDataType
in interfaceTypeInfo
- Throws:
java.sql.SQLException
-
getPGTypeNamesWithSQLTypes
public java.util.Iterator<java.lang.String> getPGTypeNamesWithSQLTypes()
- Specified by:
getPGTypeNamesWithSQLTypes
in interfaceTypeInfo
-
getPGTypeOidsWithSQLTypes
public java.util.Iterator<java.lang.Integer> getPGTypeOidsWithSQLTypes()
- Specified by:
getPGTypeOidsWithSQLTypes
in interfaceTypeInfo
-
getSQLTypeQuery
private java.lang.String getSQLTypeQuery(boolean typoidParam)
-
getSQLTypeFromQueryResult
private int getSQLTypeFromQueryResult(java.sql.ResultSet rs) throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
prepareGetAllTypeInfoStatement
private java.sql.PreparedStatement prepareGetAllTypeInfoStatement() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
cacheSQLTypes
public void cacheSQLTypes() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
prepareGetTypeInfoStatement
private java.sql.PreparedStatement prepareGetTypeInfoStatement() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
getSQLType
public int getSQLType(java.lang.String pgTypeName) throws java.sql.SQLException
Description copied from interface:TypeInfo
Look up the SQL typecode for a given postgresql type name.- Specified by:
getSQLType
in interfaceTypeInfo
- Parameters:
pgTypeName
- the server type name to look up- Returns:
- the SQL type code (a constant from
Types
) for the type - Throws:
java.sql.SQLException
- if an error occurs when retrieving sql type
-
getSQLType
public int getSQLType(int typeOid) throws java.sql.SQLException
Description copied from interface:TypeInfo
Look up the SQL typecode for a given type oid.- Specified by:
getSQLType
in interfaceTypeInfo
- Parameters:
typeOid
- the type's OID- Returns:
- the SQL type code (a constant from
Types
) for the type - Throws:
java.sql.SQLException
- if an error occurs when retrieving sql type
-
getOidStatement
private java.sql.PreparedStatement getOidStatement(java.lang.String pgTypeName) throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
getPGType
public int getPGType(java.lang.String pgTypeName) throws java.sql.SQLException
Description copied from interface:TypeInfo
Look up the oid for a given postgresql type name. This is the inverse ofTypeInfo.getPGType(int)
.
-
getPGType
public java.lang.String getPGType(int oid) throws java.sql.SQLException
Description copied from interface:TypeInfo
Look up the postgresql type name for a given oid. This is the inverse ofTypeInfo.getPGType(String)
.
-
prepareGetNameStatement
private java.sql.PreparedStatement prepareGetNameStatement() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
getPGArrayType
public int getPGArrayType(java.lang.String elementTypeName) throws java.sql.SQLException
Description copied from interface:TypeInfo
Determine the oid of the given base postgresql type's array type.- Specified by:
getPGArrayType
in interfaceTypeInfo
- Parameters:
elementTypeName
- the base type's- Returns:
- the array type's OID, or 0 if unknown
- Throws:
java.sql.SQLException
- if an error occurs when retrieving array type
-
convertArrayToBaseOid
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
- input oid- Returns:
- oid of the array's base element or the provided oid (if not array)
-
getArrayDelimiter
public char getArrayDelimiter(int oid) throws java.sql.SQLException
Description copied from interface:TypeInfo
Determine the delimiter for the elements of the given array type oid.- Specified by:
getArrayDelimiter
in interfaceTypeInfo
- Parameters:
oid
- the array type's OID- Returns:
- the base type's array type delimiter
- Throws:
java.sql.SQLException
- if an error occurs when retrieving array delimiter
-
prepareGetArrayDelimiterStatement
private java.sql.PreparedStatement prepareGetArrayDelimiterStatement() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
getPGArrayElement
public int getPGArrayElement(int oid) throws java.sql.SQLException
Description copied from interface:TypeInfo
Look up the oid of an array's base type given the array's type oid.- Specified by:
getPGArrayElement
in interfaceTypeInfo
- Parameters:
oid
- the array type's OID- Returns:
- the base type's OID, or 0 if unknown
- Throws:
java.sql.SQLException
- if an error occurs when retrieving array element
-
prepareGetArrayElementOidStatement
private java.sql.PreparedStatement prepareGetArrayElementOidStatement() throws java.sql.SQLException
- Throws:
java.sql.SQLException
-
getPGobject
public java.lang.Class<? extends PGobject> getPGobject(java.lang.String type)
- Specified by:
getPGobject
in interfaceTypeInfo
-
getJavaClass
public java.lang.String getJavaClass(int oid) throws java.sql.SQLException
- Specified by:
getJavaClass
in interfaceTypeInfo
- Throws:
java.sql.SQLException
-
getTypeForAlias
public java.lang.String getTypeForAlias(java.lang.String alias)
- Specified by:
getTypeForAlias
in interfaceTypeInfo
-
getPrecision
public int getPrecision(int oid, int typmod)
- Specified by:
getPrecision
in interfaceTypeInfo
-
isCaseSensitive
public boolean isCaseSensitive(int oid)
- Specified by:
isCaseSensitive
in interfaceTypeInfo
-
getDisplaySize
public int getDisplaySize(int oid, int typmod)
- Specified by:
getDisplaySize
in interfaceTypeInfo
-
getMaximumPrecision
public int getMaximumPrecision(int oid)
- Specified by:
getMaximumPrecision
in interfaceTypeInfo
-
requiresQuoting
public boolean requiresQuoting(int oid) throws java.sql.SQLException
- Specified by:
requiresQuoting
in interfaceTypeInfo
- Throws:
java.sql.SQLException
-
requiresQuotingSqlType
public boolean requiresQuotingSqlType(int sqlType) throws java.sql.SQLException
Returns true if particular sqlType requires quoting. This method is used internally by the driver, so it might disappear without notice.- Specified by:
requiresQuotingSqlType
in interfaceTypeInfo
- Parameters:
sqlType
- sql type as in java.sql.Types- Returns:
- true if the type requires quoting
- Throws:
java.sql.SQLException
- if something goes wrong
-
longOidToInt
public int longOidToInt(long oid) throws java.sql.SQLException
Description copied from interface:TypeInfo
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.
- Specified by:
longOidToInt
in interfaceTypeInfo
- Parameters:
oid
- the oid as a long.- Returns:
- the (internal) signed integer representation of the (unsigned) oid.
- Throws:
java.sql.SQLException
- if the long has a value outside of the range representable by uint32
-
intOidToLong
public long intOidToLong(int oid)
Description copied from interface:TypeInfo
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.- Specified by:
intOidToLong
in interfaceTypeInfo
- Parameters:
oid
- the (signed) integer oid to convert into a long.- Returns:
- the non-negative value of this oid, stored as a java long.
-
-