Package com.apple.foundationdb.relational.api

Interface ArrayMetaData

All Superinterfaces:

Wrapper

All Known Implementing Classes:

RelationalArrayMetaData

public interface ArrayMetaData
extends Wrapper

Metadata describing what is in a RelationalArray.

Method Summary

Modifier and Type	Method	Description
ArrayMetaData	getElementArrayMetaData()	Get the Metadata for an array type.
String	getElementName()
default StructMetaData	getElementStructMetaData()	Get the Metadata for a nested struct type.
int	getElementType()
String	getElementTypeName()
int	isElementNullable()

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Details

isElementNullable

int isElementNullable()
               throws SQLException

Throws:

SQLException

getElementName

String getElementName()
               throws SQLException

Throws:

SQLException

getElementType

int getElementType()
            throws SQLException

Throws:

SQLException

getElementTypeName

String getElementTypeName()
                   throws SQLException

Throws:

SQLException

getElementStructMetaData

default StructMetaData getElementStructMetaData()
                                         throws SQLException

Get the Metadata for a nested struct type. If the column is not a struct type, this will throw an error.

Returns:

the metadata for the struct at column oneBasedColumn

Throws:

SQLException - if the type of the column is not a struct, or if something else goes wrong.

getElementArrayMetaData

ArrayMetaData getElementArrayMetaData()
                               throws SQLException

Get the Metadata for an array type. If the column is not an array type, this will throw an error.

Returns:

the metadata for the array at column oneBasedColumn

Throws:

SQLException - if the type of the column is not an array, or if something else goes wrong.