Package io.substrait.relation

Class AbstractWriteRel

java.lang.Object

io.substrait.relation.AbstractRel

io.substrait.relation.SingleInputRel

io.substrait.relation.AbstractWriteRel

All Implemented Interfaces:

HasExtension, Rel

Direct Known Subclasses:

ExtensionWrite, NamedWrite

public abstract class AbstractWriteRel
extends SingleInputRel
implements HasExtension

Base class for write relations with a single input.

Defines table schema, write operation, create mode, and output mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractWriteRel.CreateMode	Behavior when the target table already exists.
static enum	AbstractWriteRel.OutputMode	Output behavior for write operations.
static enum	AbstractWriteRel.WriteOp	Logical write operation kinds.

Nested classes/interfaces inherited from interface io.substrait.relation.Rel

Rel.Remap

Constructor Summary

Constructors

Constructor	Description
AbstractWriteRel()

Method Summary

Modifier and Type	Method	Description
Type.Struct	deriveRecordType()	Derives the output record type from the input relation.
abstract AbstractWriteRel.CreateMode	getCreateMode()	Returns the table creation behavior when the target exists.
abstract AbstractWriteRel.WriteOp	getOperation()	Returns the write operation (insert/delete/update/ctas).
abstract AbstractWriteRel.OutputMode	getOutputMode()	Returns the output behavior of the write (e.g., rows returned).
abstract NamedStruct	getTableSchema()	Returns the target table schema (names + types).

Methods inherited from class io.substrait.relation.SingleInputRel

getInput, getInputs

Methods inherited from class io.substrait.relation.AbstractRel

getRecordType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.substrait.relation.HasExtension

getExtension

Methods inherited from interface io.substrait.relation.Rel

accept, getCommonExtension, getHint, getRemap

Constructor Details

AbstractWriteRel

public AbstractWriteRel()

Method Details

getTableSchema

public abstract NamedStruct getTableSchema()

Returns the target table schema (names + types).

Returns:

target table NamedStruct

getOperation

public abstract AbstractWriteRel.WriteOp getOperation()

Returns the write operation (insert/delete/update/ctas).

Returns:

write operation

getCreateMode

public abstract AbstractWriteRel.CreateMode getCreateMode()

Returns the table creation behavior when the target exists.

Returns:

create mode

getOutputMode

public abstract AbstractWriteRel.OutputMode getOutputMode()

Returns the output behavior of the write (e.g., rows returned).

Returns:

output mode

deriveRecordType

public Type.Struct deriveRecordType()

Derives the output record type from the input relation.

Specified by:

deriveRecordType in class AbstractRel

Returns:

input record Type.Struct