Package org.apache.arrow.adbc.core

Enum AdbcConnection.GetObjectsDepth

java.lang.Object

java.lang.Enum<AdbcConnection.GetObjectsDepth>

org.apache.arrow.adbc.core.AdbcConnection.GetObjectsDepth

All Implemented Interfaces:

Serializable, Comparable<AdbcConnection.GetObjectsDepth>

Enclosing interface:

AdbcConnection

public static enum AdbcConnection.GetObjectsDepth
extends Enum<AdbcConnection.GetObjectsDepth>

The level of nesting to retrieve for AdbcConnection.getObjects(GetObjectsDepth, String, String, String, String[], String).

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Display ALL objects (catalog, database schemas, tables, and columns).
CATALOGS	Display only catalogs.
DB_SCHEMAS	Display catalogs and database schemas.
TABLES	Display catalogs, database schemas, and tables.

Method Summary

Modifier and Type	Method	Description
static AdbcConnection.GetObjectsDepth	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AdbcConnection.GetObjectsDepth[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final AdbcConnection.GetObjectsDepth ALL

Display ALL objects (catalog, database schemas, tables, and columns).

CATALOGS

public static final AdbcConnection.GetObjectsDepth CATALOGS

Display only catalogs.

DB_SCHEMAS

public static final AdbcConnection.GetObjectsDepth DB_SCHEMAS

Display catalogs and database schemas.

TABLES

public static final AdbcConnection.GetObjectsDepth TABLES

Display catalogs, database schemas, and tables.

Method Details

values

public static AdbcConnection.GetObjectsDepth[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AdbcConnection.GetObjectsDepth valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null