TableCapability (Spark 3.4.2 JavaDoc)

Object
- Enum<TableCapability>
- - org.apache.spark.sql.connector.catalog.TableCapability

All Implemented Interfaces:

java.io.Serializable, Comparable<TableCapability>
```
@Evolving
public enum TableCapability
extends Enum<TableCapability>
```
Capabilities that can be provided by a Table implementation.
Tables use Table.capabilities() to return a set of capabilities. Each capability signals to Spark that the table supports a feature identified by the capability. For example, returning BATCH_READ allows Spark to read from the table using a batch scan.

Since:

3.0.0

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACCEPT_ANY_SCHEMA` Signals that the table accepts input of any schema in a write operation.
`BATCH_READ` Signals that the table supports reads in batch execution mode.
`BATCH_WRITE` Signals that the table supports append writes in batch execution mode.
`CONTINUOUS_READ` Signals that the table supports reads in continuous streaming execution mode.
`MICRO_BATCH_READ` Signals that the table supports reads in micro-batch streaming execution mode.
`OVERWRITE_BY_FILTER` Signals that the table can replace existing data that matches a filter with appended data in a write operation.
`OVERWRITE_DYNAMIC` Signals that the table can dynamically replace existing data partitions with appended data in a write operation.
`STREAMING_WRITE` Signals that the table supports append writes in streaming execution mode.
`TRUNCATE` Signals that the table can be truncated in a write operation.
`V1_BATCH_WRITE` Signals that the table supports append writes using the V1 InsertableRelation interface.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static TableCapability`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TableCapability[]`	`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
  - BATCH_READ
```
public static final TableCapability BATCH_READ
```
    Signals that the table supports reads in batch execution mode.
  - MICRO_BATCH_READ
```
public static final TableCapability MICRO_BATCH_READ
```
    Signals that the table supports reads in micro-batch streaming execution mode.
  - CONTINUOUS_READ
```
public static final TableCapability CONTINUOUS_READ
```
    Signals that the table supports reads in continuous streaming execution mode.
  - BATCH_WRITE
```
public static final TableCapability BATCH_WRITE
```
    Signals that the table supports append writes in batch execution mode.
    Tables that return this capability must support appending data and may also support additional write modes, like TRUNCATE, OVERWRITE_BY_FILTER, and OVERWRITE_DYNAMIC.
  - STREAMING_WRITE
```
public static final TableCapability STREAMING_WRITE
```
    Signals that the table supports append writes in streaming execution mode.
    Tables that return this capability must support appending data and may also support additional write modes, like TRUNCATE, OVERWRITE_BY_FILTER, and OVERWRITE_DYNAMIC.
  - TRUNCATE
```
public static final TableCapability TRUNCATE
```
    Signals that the table can be truncated in a write operation.
    Truncating a table removes all existing rows.
    See SupportsTruncate.
  - OVERWRITE_BY_FILTER
```
public static final TableCapability OVERWRITE_BY_FILTER
```
    Signals that the table can replace existing data that matches a filter with appended data in a write operation.
    See SupportsOverwriteV2.
  - OVERWRITE_DYNAMIC
```
public static final TableCapability OVERWRITE_DYNAMIC
```
    Signals that the table can dynamically replace existing data partitions with appended data in a write operation.
    See SupportsDynamicOverwrite.
  - ACCEPT_ANY_SCHEMA
```
public static final TableCapability ACCEPT_ANY_SCHEMA
```
    Signals that the table accepts input of any schema in a write operation.
  - V1_BATCH_WRITE
```
public static final TableCapability V1_BATCH_WRITE
```
    Signals that the table supports append writes using the V1 InsertableRelation interface.
    Tables that return this capability must create a V1Write and may also support additional write modes, like TRUNCATE, and OVERWRITE_BY_FILTER, but cannot support OVERWRITE_DYNAMIC.
- Method Detail
  - values
```
public static TableCapability[] 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 (TableCapability c : TableCapability.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TableCapability 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

Enum TableCapability

Enum Constant Summary

Method Summary

Methods inherited from class Enum

Methods inherited from class Object

Enum Constant Detail

BATCH_READ

MICRO_BATCH_READ

CONTINUOUS_READ

BATCH_WRITE

STREAMING_WRITE

TRUNCATE

OVERWRITE_BY_FILTER

OVERWRITE_DYNAMIC

ACCEPT_ANY_SCHEMA

V1_BATCH_WRITE

Method Detail

values

valueOf