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

Modifier and Type	Field and Description
protected final BaseConnection	connection
private boolean	fieldInfoFetched
protected final Field[]	fields

Access	Constructor and Description
public	PgResultSetMetaData(BaseConnection the connection to retrieve metadata connection, Field[] the array of field descriptors fields) Initialise for a result with a tuple set and a field descriptor set

Method Summary

Modifier and Type	Method and Description
private void	fetchFieldMetaData()
public String	getBaseColumnName(int column position (1-based) column) Implements org.postgresql.PGResultSetMetaData.getBaseColumnName. Returns the underlying column name of a query result, or "" if it is unable to be determined.
public String	getBaseSchemaName(int column position (1-based) column) Implements org.postgresql.PGResultSetMetaData.getBaseSchemaName. Returns the underlying schema name of query result, or "" if it is unable to be determined.
public String	getBaseTableName(int column position (1-based) column) Implements org.postgresql.PGResultSetMetaData.getBaseTableName. Returns the underlying table name of query result, or "" if it is unable to be determined.
public String	Returns: catalog name, or "" if not applicable getCatalogName(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.getCatalogName. Gets the designated column's table's catalog name.
public String	getColumnClassName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnClassName. Returns the fully-qualified name of the Java class whose instances are manufactured if the method `ResultSet.getObject` is called to retrieve a value from the column.
public int	getColumnCount() Implements java.sql.ResultSetMetaData.getColumnCount. Returns the number of columns in this `ResultSet` object.
public int	getColumnDisplaySize(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnDisplaySize. Indicates the designated column's normal maximum width in characters.
public String	getColumnLabel(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnLabel. Gets the designated column's suggested title for use in printouts and displays.
public String	getColumnName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnName. Get the designated column's name.
public int	getColumnType(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnType. Retrieves the designated column's SQL type.
public String	getColumnTypeName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getColumnTypeName. Retrieves the designated column's database-specific type name.
protected Field	Returns: the Field description getField(int the first column is 1, the second is 2... columnIndex) For several routines in this package, we need to convert a columnIndex into a Field[] descriptor.
public int	getFormat(int column position (1-based) column) Implements org.postgresql.PGResultSetMetaData.getFormat. Is a column Text or Binary?
protected @Nullable String	getPGType(int columnIndex)
public int	getPrecision(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getPrecision. Get the designated column's specified column size.
public int	getScale(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getScale. Gets the designated column's number of digits to right of the decimal point.
public String	getSchemaName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getSchemaName. Get the designated column's table's schema.
protected int	getSQLType(int columnIndex)
public String	getTableName(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.getTableName. Gets the designated column's table name.
public boolean	Returns: true if so isAutoIncrement(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.isAutoIncrement. Indicates whether the designated column is automatically numbered.
public boolean	Returns: true if so isCaseSensitive(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.isCaseSensitive. Indicates whether a column's case matters.
public boolean	Returns: true if its a cash column isCurrency(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.isCurrency. Indicates whether the designated column is a cash value.
public boolean	Returns: true if so isDefinitelyWritable(int the first column is 1, the second is 2, etc.. column) Implements java.sql.ResultSetMetaData.isDefinitelyWritable. Indicates whether a write on the designated column will definitely succeed.
public int	isNullable(int the first column is 1, the second is 2, ... column) Implements java.sql.ResultSetMetaData.isNullable. Indicates the nullability of values in the designated column.
public boolean	Returns: true if so* isReadOnly(int the first column is 1, the second is 2, etc.* column) Implements java.sql.ResultSetMetaData.isReadOnly. Indicates whether the designated column is definitely not writable.
public boolean	Returns: true if they can be used in a WHERE clause isSearchable(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.isSearchable. Indicates whether the designated column can be used in a where clause.
public boolean	Returns: true if so isSigned(int the first column is 1, the second is 2... column) Implements java.sql.ResultSetMetaData.isSigned. Indicates whether values in the designated column are signed numbers.
public boolean	isWrapperFor(Class<?> a Class defining an interface. iface) Implements java.sql.Wrapper.isWrapperFor. Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
public boolean	Returns: true if so isWritable(int the first column is 1, the second is 2, etc. column) Implements java.sql.ResultSetMetaData.isWritable. Indicates whether it is possible for a write on the designated column to succeed.
private boolean	populateFieldsWithMetadata(Gettable<FieldMetadata.Key, FieldMetadata> metadata)
public <T> T	unwrap(Class<T> A Class defining an interface that the result must implement. iface) Implements java.sql.Wrapper.unwrap. Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

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

connection	back to summary
protected final BaseConnection connection

fieldInfoFetched	back to summary
private boolean fieldInfoFetched

fields	back to summary
protected final Field[] fields

Method Detail

fetchFieldMetaData	back to summary
private void fetchFieldMetaData() throws SQLException

getBaseColumnName	back to summary
public String getBaseColumnName(int column) throws SQLException Implements org.postgresql.PGResultSetMetaData.getBaseColumnName. Doc from org.postgresql.PGResultSetMetaData.getBaseColumnName. Returns the underlying column name of a query result, or "" if it is unable to be determined. Parameters column:int column position (1-based) Returns:String underlying column name of a query result Annotations @Override Exceptions SQLException: if something wrong happens

getBaseColumnName

back to summary

public String getBaseColumnName(int column) throws SQLException

Implements org.postgresql.PGResultSetMetaData.getBaseColumnName.

Doc from org.postgresql.PGResultSetMetaData.getBaseColumnName.

Returns the underlying column name of a query result, or "" if it is unable to be determined.

Parameters

column:int: column position (1-based)

Returns:String

underlying column name of a query result

Annotations

@Override

Exceptions

SQLException:: if something wrong happens

getBaseSchemaName	back to summary
public String getBaseSchemaName(int column) throws SQLException Implements org.postgresql.PGResultSetMetaData.getBaseSchemaName. Doc from org.postgresql.PGResultSetMetaData.getBaseSchemaName. Returns the underlying schema name of query result, or "" if it is unable to be determined. Parameters column:int column position (1-based) Returns:String underlying schema name of query result Annotations @Override Exceptions SQLException: if something wrong happens

getBaseSchemaName

back to summary

public String getBaseSchemaName(int column) throws SQLException

Implements org.postgresql.PGResultSetMetaData.getBaseSchemaName.

Doc from org.postgresql.PGResultSetMetaData.getBaseSchemaName.

Returns the underlying schema name of query result, or "" if it is unable to be determined.

Parameters

column:int: column position (1-based)

Returns:String

underlying schema name of query result

Annotations

@Override

Exceptions

SQLException:: if something wrong happens

getBaseTableName	back to summary
public String getBaseTableName(int column) throws SQLException Implements org.postgresql.PGResultSetMetaData.getBaseTableName. Doc from org.postgresql.PGResultSetMetaData.getBaseTableName. Returns the underlying table name of query result, or "" if it is unable to be determined. Parameters column:int column position (1-based) Returns:String underlying table name of query result Annotations @Override Exceptions SQLException: if something wrong happens

getBaseTableName

back to summary

public String getBaseTableName(int column) throws SQLException

Implements org.postgresql.PGResultSetMetaData.getBaseTableName.

Doc from org.postgresql.PGResultSetMetaData.getBaseTableName.

Returns the underlying table name of query result, or "" if it is unable to be determined.

Parameters

column:int: column position (1-based)

Returns:String

underlying table name of query result

Annotations

@Override

Exceptions

SQLException:: if something wrong happens

getCatalogName	back to summary
public String getCatalogName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getCatalogName. Doc from java.sql.ResultSetMetaData.getCatalogName. Gets the designated column's table's catalog name. As with getSchemaName(), we can say that if getTableName() returns n/a, then we can too - otherwise, we need to work on it. Parameters column:int the first column is 1, the second is 2... Returns:String catalog name, or "" if not applicable Annotations @Override Exceptions SQLException: if a database access error occurs

getCatalogName

back to summary

public String getCatalogName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getCatalogName.

Doc from java.sql.ResultSetMetaData.getCatalogName.

Gets the designated column's table's catalog name.

As with getSchemaName(), we can say that if getTableName() returns n/a, then we can too - otherwise, we need to work on it.

Parameters

column:int: the first column is 1, the second is 2...

Returns:String

catalog name, or "" if not applicable

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnClassName back to summary

getColumnClassName	back to summary
public String getColumnClassName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnClassName. Doc from java.sql.ResultSetMetaData.getColumnClassName. Returns the fully-qualified name of the Java class whose instances are manufactured if the method `ResultSet.getObject` is called to retrieve a value from the column. `ResultSet.getObject` may return a subclass of the class returned by this method. Parameters column:int the first column is 1, the second is 2, ... Returns:String the fully-qualified name of the class in the Java programming language that would be used by the method `ResultSet.getObject` to retrieve the value in the specified column. This is the class name used for custom mapping. Annotations @Override Exceptions SQLException: if a database access error occurs

public String getColumnClassName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnClassName.

Doc from java.sql.ResultSetMetaData.getColumnClassName.

Returns the fully-qualified name of the Java class whose instances are manufactured if the method ResultSet.getObject is called to retrieve a value from the column. ResultSet.getObject may return a subclass of the class returned by this method.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

the fully-qualified name of the class in the Java programming language that would be used by the method ResultSet.getObject to retrieve the value in the specified column. This is the class name used for custom mapping.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnCount back to summary

getColumnCount	back to summary
public int getColumnCount() throws SQLException Implements java.sql.ResultSetMetaData.getColumnCount. Doc from java.sql.ResultSetMetaData.getColumnCount. Returns the number of columns in this `ResultSet` object. Returns:int the number of columns Annotations @Override Exceptions SQLException: if a database access error occurs

public int getColumnCount() throws SQLException

Implements java.sql.ResultSetMetaData.getColumnCount.

Doc from java.sql.ResultSetMetaData.getColumnCount.

Returns the number of columns in this ResultSet object.

Returns:int

the number of columns

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnDisplaySize	back to summary
public int getColumnDisplaySize(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnDisplaySize. Doc from java.sql.ResultSetMetaData.getColumnDisplaySize. Indicates the designated column's normal maximum width in characters. Parameters column:int the first column is 1, the second is 2, ... Returns:int the normal maximum number of characters allowed as the width of the designated column Annotations @Override Exceptions SQLException: if a database access error occurs

getColumnDisplaySize

back to summary

public int getColumnDisplaySize(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnDisplaySize.

Doc from java.sql.ResultSetMetaData.getColumnDisplaySize.

Indicates the designated column's normal maximum width in characters.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:int

the normal maximum number of characters allowed as the width of the designated column

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnLabel back to summary

getColumnLabel	back to summary
public String getColumnLabel(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnLabel. Doc from java.sql.ResultSetMetaData.getColumnLabel. Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL `AS` clause. If a SQL `AS` is not specified, the value returned from `getColumnLabel` will be the same as the value returned by the `getColumnName` method. Parameters column:int the first column is 1, the second is 2, ... Returns:String the suggested column title Annotations @Override Exceptions SQLException: if a database access error occurs

public String getColumnLabel(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnLabel.

Doc from java.sql.ResultSetMetaData.getColumnLabel.

Gets the designated column's suggested title for use in printouts and displays. The suggested title is usually specified by the SQL AS clause. If a SQL AS is not specified, the value returned from getColumnLabel will be the same as the value returned by the getColumnName method.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

the suggested column title

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnName	back to summary
public String getColumnName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnName. Doc from java.sql.ResultSetMetaData.getColumnName. Get the designated column's name. Parameters column:int the first column is 1, the second is 2, ... Returns:String column name Annotations @Override Exceptions SQLException: if a database access error occurs

getColumnName

back to summary

public String getColumnName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnName.

Doc from java.sql.ResultSetMetaData.getColumnName.

Get the designated column's name.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

column name

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnType	back to summary
public int getColumnType(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnType. Doc from java.sql.ResultSetMetaData.getColumnType. Retrieves the designated column's SQL type. Parameters column:int the first column is 1, the second is 2, ... Returns:int SQL type from java.sql.Types Annotations @Override Exceptions SQLException: if a database access error occurs

getColumnType

back to summary

public int getColumnType(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnType.

Doc from java.sql.ResultSetMetaData.getColumnType.

Retrieves the designated column's SQL type.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:int

SQL type from java.sql.Types

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getColumnTypeName	back to summary
public String getColumnTypeName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getColumnTypeName. Doc from java.sql.ResultSetMetaData.getColumnTypeName. Retrieves the designated column's database-specific type name. Parameters column:int the first column is 1, the second is 2, ... Returns:String type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned. Annotations @Override Exceptions SQLException: if a database access error occurs

getColumnTypeName

back to summary

public String getColumnTypeName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getColumnTypeName.

Doc from java.sql.ResultSetMetaData.getColumnTypeName.

Retrieves the designated column's database-specific type name.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

type name used by the database. If the column type is a user-defined type, then a fully-qualified type name is returned.

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getField	back to summary
protected Field getField(int columnIndex) throws SQLException For several routines in this package, we need to convert a columnIndex into a Field[] descriptor. Rather than do the same code several times, here it is. Parameters columnIndex:int the first column is 1, the second is 2... Returns:Field the Field description Exceptions SQLException: if a database access error occurs

getField

back to summary

protected Field getField(int columnIndex) throws SQLException

For several routines in this package, we need to convert a columnIndex into a Field[] descriptor. Rather than do the same code several times, here it is.

Parameters

columnIndex:int: the first column is 1, the second is 2...

Returns:Field

the Field description

Exceptions

SQLException:: if a database access error occurs

getFormat	back to summary
public int getFormat(int column) throws SQLException Implements org.postgresql.PGResultSetMetaData.getFormat. Doc from org.postgresql.PGResultSetMetaData.getFormat. Is a column Text or Binary? Parameters column:int column position (1-based) Returns:int 0 if column data format is TEXT, or 1 if BINARY Annotations @Override Exceptions SQLException: if something wrong happens

getFormat

back to summary

public int getFormat(int column) throws SQLException

Implements org.postgresql.PGResultSetMetaData.getFormat.

Doc from org.postgresql.PGResultSetMetaData.getFormat.

Is a column Text or Binary?

Parameters

column:int: column position (1-based)

Returns:int

0 if column data format is TEXT, or 1 if BINARY

Annotations

@Override

Exceptions

SQLException:: if something wrong happens

getPGType	back to summary
protected @Nullable String getPGType(int columnIndex) throws SQLException

getPrecision	back to summary
public int getPrecision(int column) throws SQLException Implements java.sql.ResultSetMetaData.getPrecision. Doc from java.sql.ResultSetMetaData.getPrecision. Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable. Parameters column:int the first column is 1, the second is 2, ... Returns:int precision Annotations @Override Exceptions SQLException: if a database access error occurs

getPrecision

back to summary

public int getPrecision(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getPrecision.

Doc from java.sql.ResultSetMetaData.getPrecision.

Get the designated column's specified column size. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:int

precision

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getScale	back to summary
public int getScale(int column) throws SQLException Implements java.sql.ResultSetMetaData.getScale. Doc from java.sql.ResultSetMetaData.getScale. Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable. Parameters column:int the first column is 1, the second is 2, ... Returns:int scale Annotations @Override Exceptions SQLException: if a database access error occurs

getScale

back to summary

public int getScale(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getScale.

Doc from java.sql.ResultSetMetaData.getScale.

Gets the designated column's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:int

scale

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getSchemaName	back to summary
public String getSchemaName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getSchemaName. Doc from java.sql.ResultSetMetaData.getSchemaName. Get the designated column's table's schema. Parameters column:int the first column is 1, the second is 2, ... Returns:String schema name or "" if not applicable Annotations @Override Exceptions SQLException: if a database access error occurs

getSchemaName

back to summary

public String getSchemaName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getSchemaName.

Doc from java.sql.ResultSetMetaData.getSchemaName.

Get the designated column's table's schema.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

schema name or "" if not applicable

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

getSQLType	back to summary
protected int getSQLType(int columnIndex) throws SQLException

getTableName	back to summary
public String getTableName(int column) throws SQLException Implements java.sql.ResultSetMetaData.getTableName. Doc from java.sql.ResultSetMetaData.getTableName. Gets the designated column's table name. Parameters column:int the first column is 1, the second is 2, ... Returns:String table name or "" if not applicable Annotations @Override Exceptions SQLException: if a database access error occurs

getTableName

back to summary

public String getTableName(int column) throws SQLException

Implements java.sql.ResultSetMetaData.getTableName.

Doc from java.sql.ResultSetMetaData.getTableName.

Gets the designated column's table name.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:String

table name or "" if not applicable

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isAutoIncrement	back to summary
public boolean isAutoIncrement(int column) throws SQLException Implements java.sql.ResultSetMetaData.isAutoIncrement. Doc from java.sql.ResultSetMetaData.isAutoIncrement. Indicates whether the designated column is automatically numbered. It is believed that PostgreSQL does not support this feature. Parameters column:int the first column is 1, the second is 2... Returns:boolean true if so Annotations @Override Exceptions SQLException: if a database access error occurs

isAutoIncrement

back to summary

public boolean isAutoIncrement(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isAutoIncrement.

Doc from java.sql.ResultSetMetaData.isAutoIncrement.

Indicates whether the designated column is automatically numbered.

It is believed that PostgreSQL does not support this feature.

Parameters

column:int: the first column is 1, the second is 2...

Returns:boolean

true if so

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isCaseSensitive	back to summary
public boolean isCaseSensitive(int column) throws SQLException Implements java.sql.ResultSetMetaData.isCaseSensitive. Doc from java.sql.ResultSetMetaData.isCaseSensitive. Indicates whether a column's case matters. Does a column's case matter? ASSUMPTION: Any field that is not obviously case insensitive is assumed to be case sensitive Parameters column:int the first column is 1, the second is 2... Returns:boolean true if so Annotations @Override Exceptions SQLException: if a database access error occurs

isCaseSensitive

back to summary

public boolean isCaseSensitive(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCaseSensitive.

Doc from java.sql.ResultSetMetaData.isCaseSensitive.

Indicates whether a column's case matters.

Does a column's case matter? ASSUMPTION: Any field that is not obviously case insensitive is assumed to be case sensitive

Parameters

column:int: the first column is 1, the second is 2...

Returns:boolean

true if so

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isCurrency	back to summary
public boolean isCurrency(int column) throws SQLException Implements java.sql.ResultSetMetaData.isCurrency. Doc from java.sql.ResultSetMetaData.isCurrency. Indicates whether the designated column is a cash value. Is the column a cash value? 6.1 introduced the cash/money type, which haven't been incorporated as of 970414, so I just check the type name for both 'cash' and 'money' Parameters column:int the first column is 1, the second is 2... Returns:boolean true if its a cash column Annotations @Override Exceptions SQLException: if a database access error occurs

isCurrency

back to summary

public boolean isCurrency(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isCurrency.

Doc from java.sql.ResultSetMetaData.isCurrency.

Indicates whether the designated column is a cash value.

Is the column a cash value? 6.1 introduced the cash/money type, which haven't been incorporated as of 970414, so I just check the type name for both 'cash' and 'money'

Parameters

column:int: the first column is 1, the second is 2...

Returns:boolean

true if its a cash column

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isDefinitelyWritable	back to summary
public boolean isDefinitelyWritable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isDefinitelyWritable. Doc from java.sql.ResultSetMetaData.isDefinitelyWritable. Indicates whether a write on the designated column will definitely succeed. Hmmm...this is a bad one, since the two preceding functions have not been really defined. I cannot tell is the short answer. I thus return isWritable() just to give us an idea. Parameters column:int the first column is 1, the second is 2, etc.. Returns:boolean true if so Annotations @Override Exceptions SQLException: if a database access error occurs

isDefinitelyWritable

back to summary

public boolean isDefinitelyWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isDefinitelyWritable.

Doc from java.sql.ResultSetMetaData.isDefinitelyWritable.

Indicates whether a write on the designated column will definitely succeed.

Hmmm...this is a bad one, since the two preceding functions have not been really defined. I cannot tell is the short answer. I thus return isWritable() just to give us an idea.

Parameters

column:int: the first column is 1, the second is 2, etc..

Returns:boolean

true if so

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isNullable back to summary

isNullable	back to summary
public int isNullable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isNullable. Doc from java.sql.ResultSetMetaData.isNullable. Indicates the nullability of values in the designated column. Parameters column:int the first column is 1, the second is 2, ... Returns:int the nullability status of the given column; one of `columnNoNulls`, `columnNullable` or `columnNullableUnknown` Annotations @Override Exceptions SQLException: if a database access error occurs

public int isNullable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isNullable.

Doc from java.sql.ResultSetMetaData.isNullable.

Indicates the nullability of values in the designated column.

Parameters

column:int: the first column is 1, the second is 2, ...

Returns:int

the nullability status of the given column; one of columnNoNulls, columnNullable or columnNullableUnknown

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isReadOnly	back to summary
public boolean isReadOnly(int column) throws SQLException Implements java.sql.ResultSetMetaData.isReadOnly. Doc from java.sql.ResultSetMetaData.isReadOnly. Indicates whether the designated column is definitely not writable. In reality, we would have to check the GRANT/REVOKE stuff for this to be effective, and I haven't really looked into that yet, so this will get re-visited. Parameters column:int the first column is 1, the second is 2, etc.* Returns:boolean true if so* Annotations @Override Exceptions SQLException: if a database access error occurs

isReadOnly

back to summary

public boolean isReadOnly(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isReadOnly.

Doc from java.sql.ResultSetMetaData.isReadOnly.

Indicates whether the designated column is definitely not writable.

In reality, we would have to check the GRANT/REVOKE stuff for this to be effective, and I haven't really looked into that yet, so this will get re-visited.

Parameters

column:int: the first column is 1, the second is 2, etc.*

Returns:boolean

true if so*

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isSearchable	back to summary
public boolean isSearchable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isSearchable. Doc from java.sql.ResultSetMetaData.isSearchable. Indicates whether the designated column can be used in a where clause. Can the column be used in a WHERE clause? Basically for this, I split the functions into two types: recognised types (which are always useable), and OTHER types (which may or may not be useable). The OTHER types, for now, I will assume they are useable. We should really query the catalog to see if they are useable. Parameters column:int the first column is 1, the second is 2... Returns:boolean true if they can be used in a WHERE clause Annotations @Override Exceptions SQLException: if a database access error occurs

isSearchable

back to summary

public boolean isSearchable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSearchable.

Doc from java.sql.ResultSetMetaData.isSearchable.

Indicates whether the designated column can be used in a where clause.

Can the column be used in a WHERE clause? Basically for this, I split the functions into two types: recognised types (which are always useable), and OTHER types (which may or may not be useable). The OTHER types, for now, I will assume they are useable. We should really query the catalog to see if they are useable.

Parameters

column:int: the first column is 1, the second is 2...

Returns:boolean

true if they can be used in a WHERE clause

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isSigned	back to summary
public boolean isSigned(int column) throws SQLException Implements java.sql.ResultSetMetaData.isSigned. Doc from java.sql.ResultSetMetaData.isSigned. Indicates whether values in the designated column are signed numbers. Is the column a signed number? In PostgreSQL, all numbers are signed, so this is trivial. However, strings are not signed (duh!) Parameters column:int the first column is 1, the second is 2... Returns:boolean true if so Annotations @Override Exceptions SQLException: if a database access error occurs

isSigned

back to summary

public boolean isSigned(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isSigned.

Doc from java.sql.ResultSetMetaData.isSigned.

Indicates whether values in the designated column are signed numbers.

Is the column a signed number? In PostgreSQL, all numbers are signed, so this is trivial. However, strings are not signed (duh!)

Parameters

column:int: the first column is 1, the second is 2...

Returns:boolean

true if so

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException Implements java.sql.Wrapper.isWrapperFor. Doc from java.sql.Wrapper.isWrapperFor. Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling `isWrapperFor` on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to `unwrap` so that callers can use this method to avoid expensive `unwrap` calls that may fail. If this method returns true then calling `unwrap` with the same argument should succeed. Parameters iface:Class<?> a Class defining an interface. Returns:boolean true if this implements the interface or directly or indirectly wraps an object that does. Annotations @Override Exceptions SQLException: if an error occurs while determining whether this is a wrapper for an object with the given interface.

public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Doc from java.sql.Wrapper.isWrapperFor.

Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does. Returns false otherwise. If this implements the interface then return true, else if this is a wrapper then return the result of recursively calling isWrapperFor on the wrapped object. If this does not implement the interface and is not a wrapper, return false. This method should be implemented as a low-cost operation compared to unwrap so that callers can use this method to avoid expensive unwrap calls that may fail. If this method returns true then calling unwrap with the same argument should succeed.

Parameters

iface:Class<?>: a Class defining an interface.

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does.

Annotations

@Override

Exceptions

SQLException:: if an error occurs while determining whether this is a wrapper for an object with the given interface.

isWritable	back to summary
public boolean isWritable(int column) throws SQLException Implements java.sql.ResultSetMetaData.isWritable. Doc from java.sql.ResultSetMetaData.isWritable. Indicates whether it is possible for a write on the designated column to succeed. In reality have to check the GRANT/REVOKE stuff, which I haven't worked with as yet. However, if it isn't ReadOnly, then it is obviously writable. Parameters column:int the first column is 1, the second is 2, etc. Returns:boolean true if so Annotations @Override Exceptions SQLException: if a database access error occurs

isWritable

back to summary

public boolean isWritable(int column) throws SQLException

Implements java.sql.ResultSetMetaData.isWritable.

Doc from java.sql.ResultSetMetaData.isWritable.

Indicates whether it is possible for a write on the designated column to succeed.

In reality have to check the GRANT/REVOKE stuff, which I haven't worked with as yet. However, if it isn't ReadOnly, then it is obviously writable.

Parameters

column:int: the first column is 1, the second is 2, etc.

Returns:boolean

true if so

Annotations

@Override

Exceptions

SQLException:: if a database access error occurs

populateFieldsWithMetadata	back to summary
private boolean populateFieldsWithMetadata(Gettable<FieldMetadata.Key, FieldMetadata> metadata)

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> iface) throws SQLException Implements java.sql.Wrapper.unwrap. Doc from java.sql.Wrapper.unwrap. Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling `unwrap` recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an `SQLException` is thrown. Parameters <T> the type of the class modeled by this Class object iface:Class<T> A Class defining an interface that the result must implement. Returns:T an object that implements the interface. May be a proxy for the actual implementing object. Annotations @Override Exceptions SQLException: If no object found that implements the interface

public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Doc from java.sql.Wrapper.unwrap.

Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy. If the receiver implements the interface then the result is the receiver or a proxy for the receiver. If the receiver is a wrapper and the wrapped object implements the interface then the result is the wrapped object or a proxy for the wrapped object. Otherwise return the the result of calling unwrap recursively on the wrapped object or a proxy for that result. If the receiver is not a wrapper and does not implement the interface, then an SQLException is thrown.

Parameters

<T>: the type of the class modeled by this Class object
iface:Class<T>: A Class defining an interface that the result must implement.

Returns:T

an object that implements the interface. May be a proxy for the actual implementing object.

Annotations

@Override

Exceptions

SQLException:: If no object found that implements the interface

public Class PgResultSetMetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail