Type Members

1.  case class ActionTypeDesc(fieldName: String = null, fieldExtractor: String = null, actionType: Option[String] = None) extends Descriptor with Product with Serializable

   Action Type Descriptor

   Action Type Descriptor

   fieldName

   the field name or method name of this action type field

   fieldExtractor

   the key of a ActionTypeExtractor instance

   actionType

   the explicitly given action type which take precedence over extracting

2.  trait ActionTypeExtractor extends (AnyRef) ⇒ PrivilegeObjectActionType with Extractor
3.  case class CatalogDesc(fieldName: String = "catalog", fieldExtractor: String = "CatalogPluginCatalogExtractor") extends Descriptor with Product with Serializable

   Catalog Descriptor

   Catalog Descriptor

   fieldName

   the field name or method name of this catalog field

   fieldExtractor

   the key of a CatalogExtractor instance

4.  trait CatalogExtractor extends (AnyRef) ⇒ Option[String] with Extractor
5.  class CatalogPluginCatalogExtractor extends CatalogExtractor

   org.apache.spark.sql.connector.catalog.CatalogPlugin

6.  class CatalogPluginOptionCatalogExtractor extends CatalogExtractor

   Option[org.apache.spark.sql.connector.catalog.CatalogPlugin]

7.  class CatalogTableOptionTableExtractor extends TableExtractor

   org.apache.spark.sql.catalyst.catalog.CatalogTable Option

8.  class CatalogTableTableExtractor extends TableExtractor

   org.apache.spark.sql.catalyst.catalog.CatalogTable

9.  case class ColumnDesc(fieldName: String, fieldExtractor: String) extends Descriptor with Product with Serializable

   Column Descriptor

   Column Descriptor

   fieldName

   the field name or method name of this column field

   fieldExtractor

   the key of a ColumnExtractor instance

10.  trait ColumnExtractor extends (AnyRef) ⇒ Seq[String] with Extractor
11.  trait CommandSpec extends AnyRef

    A command specification contains

    A command specification contains

    • different Descriptors for specific implementations. It's a list to cover:
      • A command may have multiple object to describe, such as create table A like B
      • An object descriptor may vary through spark versions, it wins at least once if one of the descriptors matches
    • the classname of a command which this spec point to
    • the OperationType of this command which finally maps to an access privilege
12.  class DataSourceV2RelationTableExtractor extends TableExtractor

    org.apache.spark.sql.execution.datasources.v2.DataSourceV2Relation

13.  case class Database(catalog: Option[String], database: String) extends Product with Serializable

    :: Developer API ::

    :: Developer API ::

    Represents a table identity with owner

    catalog

    catalog name or None

    database

    database name or None

14.  case class DatabaseCommandSpec(classname: String, databaseDescs: Seq[DatabaseDesc], opType: String = "QUERY") extends CommandSpec with Product with Serializable

    A specification describe a database command

    A specification describe a database command

    classname

    the database command classname

    databaseDescs

    a list of database descriptors

    opType

    operation type, e.g. CREATEDATABASE

15.  case class DatabaseDesc(fieldName: String, fieldExtractor: String, catalogDesc: Option[CatalogDesc] = None, isInput: Boolean = false) extends Descriptor with Product with Serializable

    Database Descriptor

    Database Descriptor

    fieldName

    the field name or method name of this database field

    fieldExtractor

    the key of a DatabaseExtractor instance

    isInput

    read or write

16.  trait DatabaseExtractor extends (AnyRef) ⇒ Database with Extractor
17.  sealed trait Descriptor extends AnyRef

    A database object(such as database, table, function) descriptor describes its name and getter in/from another object(such as a spark sql command).

18.  class ExpressionInfoFunctionExtractor extends FunctionExtractor

    org.apache.spark.sql.catalyst.expressions.ExpressionInfo

19.  class ExpressionInfoFunctionTypeExtractor extends FunctionTypeExtractor

    org.apache.spark.sql.catalyst.expressions.ExpressionInfo

20.  trait Extractor extends AnyRef

    Base trait for an field extractor

21.  case class Function(catalog: Option[String], database: Option[String], functionName: String) extends Product with Serializable

    :: Developer API ::

    :: Developer API ::

    Represents a function identity

22.  case class FunctionCommandSpec(classname: String, functionDescs: Seq[FunctionDesc], opType: String) extends CommandSpec with Product with Serializable

    A specification describe a function command

    A specification describe a function command

    classname

    the database command classname

    functionDescs

    a list of function descriptors

    opType

    operation type, e.g. DROPFUNCTION

23.  case class FunctionDesc(fieldName: String, fieldExtractor: String, databaseDesc: Option[DatabaseDesc] = None, functionTypeDesc: Option[FunctionTypeDesc] = None, isInput: Boolean = false) extends Descriptor with Product with Serializable

    Function Descriptor

    Function Descriptor

    fieldName

    the field name or method name of this function field

    fieldExtractor

    the key of a FunctionExtractor instance

    databaseDesc

    which kinds of functions are skipped checking

    functionTypeDesc

    indicates the function type if necessary

    isInput

    read or write

24.  trait FunctionExtractor extends (AnyRef) ⇒ Function with Extractor
25.  class FunctionIdentifierFunctionExtractor extends FunctionExtractor

    org.apache.spark.sql.catalyst.FunctionIdentifier

26.  class FunctionIdentifierFunctionTypeExtractor extends FunctionTypeExtractor

    org.apache.spark.sql.catalyst.FunctionIdentifier

27.  class FunctionNameFunctionTypeExtractor extends FunctionTypeExtractor

    String

28.  case class FunctionTypeDesc(fieldName: String, fieldExtractor: String, skipTypes: Seq[String]) extends Descriptor with Product with Serializable

    Function Type Descriptor

    Function Type Descriptor

    fieldName

    the field name or method name of this function type field

    fieldExtractor

    the key of a FunctionTypeExtractor instance

    skipTypes

    which kinds of functions are skipped checking

29.  trait FunctionTypeExtractor extends (AnyRef, SparkSession) ⇒ FunctionType with Extractor
30.  class IdentifierTableExtractor extends TableExtractor

    org.apache.spark.sql.connector.catalog.Identifier

31.  class LogicalPlanOptionQueryExtractor extends QueryExtractor

    Option[org.apache.spark.sql.catalyst.plans.logical.LogicalPlan]

32.  class LogicalPlanQueryExtractor extends QueryExtractor

    org.apache.spark.sql.catalyst.plans.logical.LogicalPlan

33.  class LogicalRelationTableExtractor extends TableExtractor

    org.apache.spark.sql.execution.datasources.LogicalRelation

34.  class OverwriteOrInsertActionTypeExtractor extends ActionTypeExtractor

    Boolean

35.  class PartitionColumnExtractor extends ColumnExtractor
36.  class PartitionLocsSeqColumnExtractor extends ColumnExtractor
37.  class PartitionOptionColumnExtractor extends ColumnExtractor
38.  class PartitionSeqColumnExtractor extends ColumnExtractor
39.  class QualifiedNameStringFunctionExtractor extends FunctionExtractor

    * String

40.  case class QueryDesc(fieldName: String, fieldExtractor: String = "LogicalPlanQueryExtractor") extends Descriptor with Product with Serializable

    Query Descriptor which represents one or more query fields of a command

    Query Descriptor which represents one or more query fields of a command

    fieldName

    the field name or method name of this query field

    fieldExtractor

    the key of a QueryExtractor instance The default value is LogicalPlanQueryExtractor which return the original plan directly.

41.  trait QueryExtractor extends (AnyRef) ⇒ Option[LogicalPlan] with Extractor
42.  class ResolvedDBObjectNameDatabaseExtractor extends DatabaseExtractor

    org.apache.spark.sql.catalyst.analysis.ResolvedDbObjectName

43.  class ResolvedDbObjectNameTableExtractor extends TableExtractor

    org.apache.spark.sql.catalyst.analysis.ResolvedDbObjectName

44.  class ResolvedIdentifierTableExtractor extends TableExtractor

    org.apache.spark.sql.catalyst.analysis.ResolvedIdentifier

45.  class ResolvedNamespaceDatabaseExtractor extends DatabaseExtractor

    org.apache.spark.sql.catalyst.analysis.ResolvedNamespace

46.  class ResolvedTableTableExtractor extends TableExtractor

    org.apache.spark.sql.catalyst.analysis.ResolvedTable

47.  class SaveModeActionTypeExtractor extends ActionTypeExtractor

    org.apache.spark.sql.SaveMode

48.  case class ScanDesc(fieldName: String, fieldExtractor: String, catalogDesc: Option[CatalogDesc] = None) extends Descriptor with Product with Serializable
49.  case class ScanSpec(classname: String, scanDescs: Seq[ScanDesc], functionDescs: Seq[FunctionDesc] = Seq.empty) extends CommandSpec with Product with Serializable
50.  class StringColumnExtractor extends ColumnExtractor
51.  class StringDatabaseExtractor extends DatabaseExtractor

    String

52.  class StringFunctionExtractor extends FunctionExtractor

    String

53.  class StringOptionCatalogExtractor extends CatalogExtractor

    Option[String]

54.  class StringOptionDatabaseExtractor extends DatabaseExtractor

    Option[String]

55.  class StringSeqColumnExtractor extends ColumnExtractor
56.  class StringSeqDatabaseExtractor extends DatabaseExtractor

    Seq[String]

57.  class StringSeqLastColumnExtractor extends ColumnExtractor
58.  class StringSeqOptionColumnExtractor extends ColumnExtractor
59.  class StringSeqOptionDatabaseExtractor extends DatabaseExtractor

    Option[Seq[String]]

60.  class StructFieldSeqColumnExtractor extends ColumnExtractor

    org.apache.spark.sql.types.StructField

61.  case class Table(catalog: Option[String], database: Option[String], table: String, owner: Option[String]) extends Product with Serializable

    :: Developer API ::

    :: Developer API ::

    Represents a table identity with owner

    catalog

    catalog name or None

    database

    database name or None

    table

    table name

    owner

    table owner if any, otherwise None

62.  case class TableCommandSpec(classname: String, tableDescs: Seq[TableDesc], opType: String = OperationType.QUERY.toString, queryDescs: Seq[QueryDesc] = Nil) extends CommandSpec with Product with Serializable

    A specification describe a table command

    A specification describe a table command

    classname

    the database command classname

    tableDescs

    a list of table descriptors

    opType

    operation type, e.g. DROPFUNCTION

    queryDescs

    the query descriptors a table command may have

63.  case class TableDesc(fieldName: String, fieldExtractor: String, columnDesc: Option[ColumnDesc] = None, actionTypeDesc: Option[ActionTypeDesc] = None, tableTypeDesc: Option[TableTypeDesc] = None, catalogDesc: Option[CatalogDesc] = None, isInput: Boolean = false, setCurrentDatabaseIfMissing: Boolean = false) extends Descriptor with Product with Serializable

    Table Descriptor

    Table Descriptor

    fieldName

    the field name or method name of this table field

    fieldExtractor

    the key of a TableExtractor instance

    columnDesc

    optional ColumnDesc instance if columns field are specified

    actionTypeDesc

    optional ActionTypeDesc indicates the action type

    tableTypeDesc

    optional TableTypeDesc indicates the table type

    catalogDesc

    optional CatalogDesc instance if a catalog field is specified, the catalog will respect the one resolved from fieldExtractor first

    isInput

    read or write

    setCurrentDatabaseIfMissing

    whether to use current database if the database field is missing

64.  trait TableExtractor extends (SparkSession, AnyRef) ⇒ Option[Table] with Extractor

    A trait for extracting database and table as string tuple from the give object whose class type is define by key.

65.  class TableIdentifierTableExtractor extends TableExtractor

    org.apache.spark.sql.catalyst.TableIdentifier

66.  class TableIdentifierTableTypeExtractor extends TableTypeExtractor

    org.apache.spark.sql.catalyst.TableIdentifier

67.  case class TableTypeDesc(fieldName: String, fieldExtractor: String, skipTypes: Seq[String]) extends Descriptor with Product with Serializable

    Table Type Descriptor

    Table Type Descriptor

    fieldName

    the field name or method name of this table type field

    fieldExtractor

    the key of a TableTypeExtractor instance

    skipTypes

    which kinds of table or view are skipped checking

68.  trait TableTypeExtractor extends (AnyRef, SparkSession) ⇒ TableType with Extractor
69.  class TempMarkerFunctionTypeExtractor extends FunctionTypeExtractor

    org.apache.spark.sql.catalyst.analysis.ViewType

70.  class ViewTypeTableTypeExtractor extends TableTypeExtractor

    org.apache.spark.sql.catalyst.analysis.ViewType