org.apache.spark.sql.connector.catalog

Enum TableCatalogCapability

Object

Enum<TableCatalogCapability>

org.apache.spark.sql.connector.catalog.TableCatalogCapability

All Implemented Interfaces:

java.io.Serializable, Comparable<TableCatalogCapability>

@Evolving
public enum TableCatalogCapability
extends Enum<TableCatalogCapability>

Capabilities that can be provided by a TableCatalog implementation.

TableCatalogs use TableCatalog.capabilities() to return a set of capabilities. Each capability signals to Spark that the catalog supports a feature identified by the capability. For example, returning SUPPORTS_CREATE_TABLE_WITH_GENERATED_COLUMNS allows Spark to accept GENERATED ALWAYS AS expressions in CREATE TABLE statements.

Since:

3.4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
SUPPORT_COLUMN_DEFAULT_VALUE Signals that the TableCatalog supports defining column default value as expression in CREATE/REPLACE/ALTER TABLE.
SUPPORTS_CREATE_TABLE_WITH_GENERATED_COLUMNS Signals that the TableCatalog supports defining generated columns upon table creation in SQL.

Method Summary

Modifier and Type	Method and Description
static TableCatalogCapability	valueOf(String name) Returns the enum constant of this type with the specified name.
static TableCatalogCapability[]	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

SUPPORTS_CREATE_TABLE_WITH_GENERATED_COLUMNS

public static final TableCatalogCapability SUPPORTS_CREATE_TABLE_WITH_GENERATED_COLUMNS

Signals that the TableCatalog supports defining generated columns upon table creation in SQL.

Without this capability, any create/replace table statements with a generated column defined in the table schema will throw an exception during analysis.

A generated column is defined with syntax: colName colType GENERATED ALWAYS AS (expr)

Generation expression are included in the column definition for APIs like TableCatalog.createTable(org.apache.spark.sql.connector.catalog.Identifier, org.apache.spark.sql.types.StructType, org.apache.spark.sql.connector.expressions.Transform[], java.util.Map<java.lang.String, java.lang.String>). See Column.generationExpression().

SUPPORT_COLUMN_DEFAULT_VALUE

public static final TableCatalogCapability SUPPORT_COLUMN_DEFAULT_VALUE

Signals that the TableCatalog supports defining column default value as expression in CREATE/REPLACE/ALTER TABLE.

Without this capability, any CREATE/REPLACE/ALTER TABLE statement with a column default value defined in the table schema will throw an exception during analysis.

A column default value is defined with syntax: colName colType DEFAULT expr

Column default value expression is included in the column definition for APIs like TableCatalog.createTable(org.apache.spark.sql.connector.catalog.Identifier, org.apache.spark.sql.types.StructType, org.apache.spark.sql.connector.expressions.Transform[], java.util.Map<java.lang.String, java.lang.String>). See Column.defaultValue().

Method Detail

values

public static TableCatalogCapability[] 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 (TableCatalogCapability c : TableCatalogCapability.values())
    System.out.println(c);

Returns:

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

valueOf

public static TableCatalogCapability 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