Trait

org.apache.spark.sql.sources

UpdatableRelation

Related Doc: package sources

Permalink

trait UpdatableRelation extends BaseRelation with MutableRelation with SingleRowInsertableRelation

Annotations
@DeveloperApi()
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UpdatableRelation
  2. SingleRowInsertableRelation
  3. MutableRelation
  4. DestroyRelation
  5. BaseRelation
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def destroy(ifExists: Boolean): Unit

    Permalink

    Destroy and cleanup this relation.

    Destroy and cleanup this relation. It may include, but not limited to, dropping the external table that this relation represents.

    Definition Classes
    DestroyRelation
  2. abstract def executeUpdate(sql: String, defaultSchema: String): Int

    Permalink

    Execute a DML SQL and return the number of rows affected.

    Execute a DML SQL and return the number of rows affected.

    Definition Classes
    SingleRowInsertableRelation
  3. abstract def getDeletePlan(relation: LogicalRelation, child: SparkPlan, keyColumns: Seq[Attribute]): SparkPlan

    Permalink

    Get a spark plan to delete rows the relation.

    Get a spark plan to delete rows the relation. The result of SparkPlan execution should be a count of number of updated rows.

    Definition Classes
    MutableRelation
  4. abstract def getKeyColumns: Seq[String]

    Permalink

    Get the "key" columns for the table that need to be projected out by UPDATE and DELETE operations for affecting the selected rows.

    Get the "key" columns for the table that need to be projected out by UPDATE and DELETE operations for affecting the selected rows.

    Definition Classes
    MutableRelation
  5. abstract def getPrimaryKeyColumns: Seq[String]

    Permalink

    Get the "primary key" of the row table and "key columns" of the column table

    Get the "primary key" of the row table and "key columns" of the column table

    Definition Classes
    MutableRelation
  6. abstract def getUpdatePlan(relation: LogicalRelation, child: SparkPlan, updateColumns: Seq[Attribute], updateExpressions: Seq[Expression], keyColumns: Seq[Attribute]): SparkPlan

    Permalink

    Get a spark plan to update rows in the relation.

    Get a spark plan to update rows in the relation. The result of SparkPlan execution should be a count of number of updated rows.

    Definition Classes
    MutableRelation
  7. abstract def partitionColumns: Seq[String]

    Permalink

    Get the partitioning columns for the table, if any.

    Get the partitioning columns for the table, if any.

    Definition Classes
    MutableRelation
  8. abstract def schema: StructType

    Permalink
    Definition Classes
    BaseRelation
  9. abstract def sqlContext: SQLContext

    Permalink
    Definition Classes
    BaseRelation
  10. abstract def table: String

    Permalink

    Name of this mutable table as stored in catalog.

    Name of this mutable table as stored in catalog.

    Definition Classes
    MutableRelation
  11. abstract def truncate(): Unit

    Permalink

    Truncate the table represented by this relation.

    Truncate the table represented by this relation.

    Definition Classes
    DestroyRelation
  12. abstract def update(filterExpr: String, newColumnValues: Row, updateColumns: Seq[String]): Int

    Permalink

    Update a set of rows matching given criteria.

    Update a set of rows matching given criteria.

    filterExpr

    SQL WHERE criteria to select rows that will be updated

    newColumnValues

    updated values for the columns being changed; must match updateColumns

    updateColumns

    the columns to be updated; must match updatedColumns

    returns

    number of rows affected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def needConversion: Boolean

    Permalink
    Definition Classes
    BaseRelation
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. def sizeInBytes: Long

    Permalink
    Definition Classes
    BaseRelation
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. def unhandledFilters(filters: Array[Filter]): Array[Filter]

    Permalink
    Definition Classes
    BaseRelation
  20. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. def withKeyColumns(relation: LogicalRelation, keyColumns: Seq[String]): LogicalRelation

    Permalink

    If required inject the key columns in the original relation.

    If required inject the key columns in the original relation.

    Definition Classes
    MutableRelation

Inherited from MutableRelation

Inherited from DestroyRelation

Inherited from BaseRelation

Inherited from AnyRef

Inherited from Any

Ungrouped