Type Members

1.  case class AlterColumnSyncIdentity(table: LogicalPlan, column: FieldName) extends LogicalPlan with AlterTableCommand with Product with Serializable
2.  case class AlterTableAddConstraint(table: LogicalPlan, constraintName: String, expr: String) extends LogicalPlan with AlterTableCommand with Product with Serializable

   The logical plan of the ALTER TABLE ...

   The logical plan of the ALTER TABLE ... ADD CONSTRAINT command.

3.  case class AlterTableDropConstraint(table: LogicalPlan, constraintName: String, ifExists: Boolean) extends LogicalPlan with AlterTableCommand with Product with Serializable

   The logical plan of the ALTER TABLE ...

   The logical plan of the ALTER TABLE ... DROP CONSTRAINT command.

4.  case class AlterTableDropFeature(table: LogicalPlan, featureName: String, truncateHistory: Boolean) extends LogicalPlan with AlterTableCommand with Product with Serializable

   The logical plan of the ALTER TABLE ...

   The logical plan of the ALTER TABLE ... DROP FEATURE command.

5.  case class CloneTableStatement(source: LogicalPlan, target: LogicalPlan, ifNotExists: Boolean, isReplaceCommand: Boolean, isCreateCommand: Boolean, tablePropertyOverrides: Map[String, String], targetLocation: Option[String]) extends LogicalPlan with BinaryNode with Product with Serializable

   CLONE TABLE statement, as parsed from SQL

   CLONE TABLE statement, as parsed from SQL

   source

   source plan for table to be cloned

   target

   target path or table name where clone should be instantiated

   ifNotExists

   if a table exists at the target, we should not go through with the clone

   isReplaceCommand

   when true, replace the target table if one exists

   isCreateCommand

   when true, create the target table if none exists

   tablePropertyOverrides

   user-defined table properties that should override any properties with the same key from the source table

   targetLocation

   if target is a table name then user can provide a targetLocation to create an external table with this location

6.  case class DeltaDelete(child: LogicalPlan, condition: Option[Expression]) extends LogicalPlan with UnaryNode with Product with Serializable
7.  case class DeltaMergeAction(targetColNameParts: Seq[String], expr: Expression, targetColNameResolved: Boolean = false) extends UnaryExpression with DeltaUnevaluable with Product with Serializable

   Represents an action in MERGE's UPDATE or INSERT clause where a target columns is assigned the value of an expression

   Represents an action in MERGE's UPDATE or INSERT clause where a target columns is assigned the value of an expression

   targetColNameParts

   The name parts of the target column. This is a sequence to support nested fields as targets.

   expr

   Expression to generate the value of the target column.

   targetColNameResolved

   Whether the targetColNameParts have undergone resolution and checks for validity.

8.  case class DeltaMergeInto(target: LogicalPlan, source: LogicalPlan, condition: Expression, matchedClauses: Seq[DeltaMergeIntoMatchedClause], notMatchedClauses: Seq[DeltaMergeIntoNotMatchedClause], notMatchedBySourceClauses: Seq[DeltaMergeIntoNotMatchedBySourceClause], withSchemaEvolution: Boolean, finalSchema: Option[StructType]) extends LogicalPlan with Command with SupportsSubquery with Product with Serializable

   Merges changes specified in the source plan into a target table, based on the given search condition and the actions to perform when the condition is matched or not matched by the rows.

   Merges changes specified in the source plan into a target table, based on the given search condition and the actions to perform when the condition is matched or not matched by the rows.

   The syntax of the MERGE statement is as follows.

   MERGE [WITH SCHEMA EVOLUTION] INTO <target_table_with_alias>
   USING <source_table_with_alias>
   ON <search_condition>
   [ WHEN MATCHED [ AND <condition> ] THEN <matched_action> ]
   [ WHEN MATCHED [ AND <condition> ] THEN <matched_action> ]
   ...
   [ WHEN NOT MATCHED [BY TARGET] [ AND <condition> ] THEN <not_matched_action> ]
   [ WHEN NOT MATCHED [BY TARGET] [ AND <condition> ] THEN <not_matched_action> ]
   ...
   [ WHEN NOT MATCHED BY SOURCE [ AND <condition> ] THEN <not_matched_by_source_action> ]
   [ WHEN NOT MATCHED BY SOURCE [ AND <condition> ] THEN <not_matched_by_source_action> ]
   ...
   
   
   where
   <matched_action> =
     DELETE |
     UPDATE SET column1 = value1 [, column2 = value2 ...] |
     UPDATE SET * [EXCEPT (column1, ...)]
   <not_matched_action> = INSERT (column1 [, column2 ...]) VALUES (expr1 [, expr2 ...])
   <not_matched_by_source_action> =
     DELETE |
     UPDATE SET column1 = value1 [, column2 = value2 ...]

   - There can be any number of WHEN clauses. - WHEN MATCHED clauses:

   • Each WHEN MATCHED clause can have an optional condition. However, if there are multiple WHEN MATCHED clauses, only the last can omit the condition.
   • WHEN MATCHED clauses are dependent on their ordering; that is, the first clause that satisfies the clause's condition has its corresponding action executed. - WHEN NOT MATCHED clause:
   • Can only have the INSERT action. If present, they must follow the last WHEN MATCHED clause.
   • Each WHEN NOT MATCHED clause can have an optional condition. However, if there are multiple clauses, only the last can omit the condition.
   • WHEN NOT MATCHED clauses are dependent on their ordering; that is, the first clause that satisfies the clause's condition has its corresponding action executed. - WHEN NOT MATCHED BY SOURCE clauses:
   • Each WHEN NOT MATCHED BY SOURCE clause can have an optional condition. However, if there are multiple WHEN NOT MATCHED BY SOURCE clauses, only the last can omit the condition.
   • WHEN NOT MATCHED BY SOURCE clauses are dependent on their ordering; that is, the first clause that satisfies the clause's condition has its corresponding action executed.
9.  sealed trait DeltaMergeIntoClause extends Expression with DeltaUnevaluable

   Trait that represents a WHEN clause in MERGE.

   Trait that represents a WHEN clause in MERGE. See DeltaMergeInto. It extends Expression so that Catalyst can find all the expressions in the clause implementations.

10.  sealed trait DeltaMergeIntoMatchedClause extends Expression with DeltaMergeIntoClause

    Trait that represents WHEN MATCHED clause in MERGE.

    Trait that represents WHEN MATCHED clause in MERGE. See DeltaMergeInto.

11.  case class DeltaMergeIntoMatchedDeleteClause(condition: Option[Expression]) extends Expression with DeltaMergeIntoMatchedClause with Product with Serializable

    Represents the clause WHEN MATCHED THEN DELETE in MERGE.

    Represents the clause WHEN MATCHED THEN DELETE in MERGE. See DeltaMergeInto.

12.  case class DeltaMergeIntoMatchedUpdateClause(condition: Option[Expression], actions: Seq[Expression]) extends Expression with DeltaMergeIntoMatchedClause with Product with Serializable

    Represents the clause WHEN MATCHED THEN UPDATE in MERGE.

    Represents the clause WHEN MATCHED THEN UPDATE in MERGE. See DeltaMergeInto.

13.  sealed trait DeltaMergeIntoNotMatchedBySourceClause extends Expression with DeltaMergeIntoClause

    Trait that represents WHEN NOT MATCHED BY SOURCE clause in MERGE.

    Trait that represents WHEN NOT MATCHED BY SOURCE clause in MERGE. See DeltaMergeInto.

14.  case class DeltaMergeIntoNotMatchedBySourceDeleteClause(condition: Option[Expression]) extends Expression with DeltaMergeIntoNotMatchedBySourceClause with Product with Serializable

    Represents the clause WHEN NOT MATCHED BY SOURCE THEN DELETE in MERGE.

    Represents the clause WHEN NOT MATCHED BY SOURCE THEN DELETE in MERGE. See DeltaMergeInto.

15.  case class DeltaMergeIntoNotMatchedBySourceUpdateClause(condition: Option[Expression], actions: Seq[Expression]) extends Expression with DeltaMergeIntoNotMatchedBySourceClause with Product with Serializable

    Represents the clause WHEN NOT MATCHED BY SOURCE THEN UPDATE in MERGE.

    Represents the clause WHEN NOT MATCHED BY SOURCE THEN UPDATE in MERGE. See DeltaMergeInto.

16.  sealed trait DeltaMergeIntoNotMatchedClause extends Expression with DeltaMergeIntoClause

    Trait that represents WHEN NOT MATCHED clause in MERGE.

    Trait that represents WHEN NOT MATCHED clause in MERGE. See DeltaMergeInto.

17.  case class DeltaMergeIntoNotMatchedInsertClause(condition: Option[Expression], actions: Seq[Expression]) extends Expression with DeltaMergeIntoNotMatchedClause with Product with Serializable

    Represents the clause WHEN NOT MATCHED THEN INSERT in MERGE.

    Represents the clause WHEN NOT MATCHED THEN INSERT in MERGE. See DeltaMergeInto.

18.  trait DeltaUnevaluable extends Expression

    A copy of Spark SQL Unevaluable for cross-version compatibility.

    A copy of Spark SQL Unevaluable for cross-version compatibility. In 3.0, implementers of the original Unevaluable must explicitly override foldable to false; in 3.1 onwards, this explicit override is invalid.

19.  case class DeltaUpdateTable(child: LogicalPlan, updateColumns: Seq[Expression], updateExpressions: Seq[Expression], condition: Option[Expression]) extends LogicalPlan with UnaryNode with Product with Serializable

    Perform UPDATE on a table

    Perform UPDATE on a table

    child

    the logical plan representing target table

20.  case class RestoreTableStatement(table: TimeTravel) extends LogicalPlan with UnaryNode with Product with Serializable

    RESTORE TABLE statement as parsed from SQL

    RESTORE TABLE statement as parsed from SQL

    table

    - logical node of the table that will be restored, internally contains either version or timestamp.

21.  case class SyncIdentity(fieldNames: Array[String]) extends ColumnChange with Product with Serializable

    A ColumnChange to model ALTER TABLE ... ALTER (CHANGE) COLUMN ... SYNC IDENTITY command.

    A ColumnChange to model ALTER TABLE ... ALTER (CHANGE) COLUMN ... SYNC IDENTITY command.

    fieldNames

    The (potentially nested) column name.