Package com.apple.foundationdb.relational.api

Interface ArrayMetaData

All Superinterfaces:

java.sql.Wrapper

All Known Implementing Classes:

RelationalArrayMetaData

public interface ArrayMetaData
extends java.sql.Wrapper

Metadata describing what is in a RelationalArray.

Method Summary

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

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Method Detail

isElementNullable

int isElementNullable()
               throws java.sql.SQLException

Throws:

java.sql.SQLException

getElementName

java.lang.String getElementName()
                         throws java.sql.SQLException

Throws:

java.sql.SQLException

getElementType

int getElementType()
            throws java.sql.SQLException

Throws:

java.sql.SQLException

getElementTypeName

java.lang.String getElementTypeName()
                             throws java.sql.SQLException

Throws:

java.sql.SQLException

getElementStructMetaData

default StructMetaData getElementStructMetaData()
                                         throws java.sql.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:

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

getElementArrayMetaData

ArrayMetaData getElementArrayMetaData()
                               throws java.sql.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:

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