org.apache.spark.sql.connector.read

Enum Scan.ColumnarSupportMode

Object

Enum<Scan.ColumnarSupportMode>

org.apache.spark.sql.connector.read.Scan.ColumnarSupportMode

All Implemented Interfaces:

java.io.Serializable, Comparable<Scan.ColumnarSupportMode>

Enclosing interface:

Scan

public static enum Scan.ColumnarSupportMode
extends Enum<Scan.ColumnarSupportMode>

This enum defines how the columnar support for the partitions of the data source should be determined. The default value is `PARTITION_DEFINED` which indicates that each partition can determine if it should be columnar or not. SUPPORTED and UNSUPPORTED provide default shortcuts to indicate support for columnar data or not.

Since:

3.5.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
PARTITION_DEFINED
SUPPORTED
UNSUPPORTED

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PARTITION_DEFINED

public static final Scan.ColumnarSupportMode PARTITION_DEFINED

SUPPORTED

public static final Scan.ColumnarSupportMode SUPPORTED

UNSUPPORTED

public static final Scan.ColumnarSupportMode UNSUPPORTED

Method Detail

values

public static Scan.ColumnarSupportMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Scan.ColumnarSupportMode c : Scan.ColumnarSupportMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Scan.ColumnarSupportMode 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