command

Type Members

1. case class AddFileCommand(path: String) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Adds a file to the current session so it can be used.

2. case class AddJarCommand(path: String) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Adds a jar to the current session so it can be used (for UDFs or serdes).

3. case class AlterDatabasePropertiesCommand(databaseName: String, props: Map[String, String]) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   A command for users to add new (key, value) pairs into DBPROPERTIES If the database does not exist, an error message will be issued to indicate the database does not exist.

   A command for users to add new (key, value) pairs into DBPROPERTIES If the database does not exist, an error message will be issued to indicate the database does not exist. The syntax of using this command in SQL is:

   ALTER (DATABASE|SCHEMA) database_name SET DBPROPERTIES (property_name=property_value, ...)

4. case class AlterTableAddPartitionCommand(tableName: TableIdentifier, partitionSpecsAndLocs: Seq[(TablePartitionSpec, Option[String])], ifNotExists: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Add Partition in ALTER TABLE: add the table partitions.

   Add Partition in ALTER TABLE: add the table partitions.

   'partitionSpecsAndLocs': the syntax of ALTER VIEW is identical to ALTER TABLE, EXCEPT that it is ILLEGAL to specify a LOCATION clause. An error message will be issued if the partition exists, unless 'ifNotExists' is true.

   The syntax of this command is:

   ALTER TABLE table ADD [IF NOT EXISTS] PARTITION spec [LOCATION 'loc1']

5. case class AlterTableDropPartitionCommand(tableName: TableIdentifier, specs: Seq[TablePartitionSpec], ifExists: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Drop Partition in ALTER TABLE: to drop a particular partition for a table.

   Drop Partition in ALTER TABLE: to drop a particular partition for a table.

   This removes the data and metadata for this partition. The data is actually moved to the .Trash/Current directory if Trash is configured, unless 'purge' is true, but the metadata is completely lost. An error message will be issued if the partition does not exist, unless 'ifExists' is true. Note: purge is always false when the target is a view.

   The syntax of this command is:

   ALTER TABLE table DROP [IF EXISTS] PARTITION spec1[, PARTITION spec2, ...] [PURGE];

6. case class AlterTableRecoverPartitionsCommand(tableName: TableIdentifier, cmd: String = "ALTER TABLE RECOVER PARTITIONS") extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Recover Partitions in ALTER TABLE: recover all the partition in the directory of a table and update the catalog.

   Recover Partitions in ALTER TABLE: recover all the partition in the directory of a table and update the catalog.

   The syntax of this command is:

   ALTER TABLE table RECOVER PARTITIONS;
   MSCK REPAIR TABLE table;

7. case class AlterTableRenameCommand(oldName: TableIdentifier, newName: TableIdentifier, isView: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   A command that renames a table/view.

   A command that renames a table/view.

   The syntax of this command is:

   ALTER TABLE table1 RENAME TO table2;
   ALTER VIEW view1 RENAME TO view2;

8. case class AlterTableRenamePartitionCommand(tableName: TableIdentifier, oldPartition: TablePartitionSpec, newPartition: TablePartitionSpec) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   Alter a table partition's spec.

   Alter a table partition's spec.

   The syntax of this command is:

   ALTER TABLE table PARTITION spec1 RENAME TO PARTITION spec2;

9. case class AlterTableSerDePropertiesCommand(tableName: TableIdentifier, serdeClassName: Option[String], serdeProperties: Option[Map[String, String]], partSpec: Option[TablePartitionSpec]) extends LogicalPlan with RunnableCommand with Product with Serializable

   

   A command that sets the serde class and/or serde properties of a table/view.

   A command that sets the serde class and/or serde properties of a table/view.

   The syntax of this command is:

   ALTER TABLE table [PARTITION spec] SET SERDE serde_name [WITH SERDEPROPERTIES props];
   ALTER TABLE table [PARTITION spec] SET SERDEPROPERTIES serde_properties;

10. case class AlterTableSetLocationCommand(tableName: TableIdentifier, partitionSpec: Option[TablePartitionSpec], location: String) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command that sets the location of a table or a partition.

    A command that sets the location of a table or a partition.

    For normal tables, this just sets the location URI in the table/partition's storage format. For datasource tables, this sets a "path" parameter in the table/partition's serde properties.

    The syntax of this command is:

    ALTER TABLE table_name [PARTITION partition_spec] SET LOCATION "loc";

11. case class AlterTableSetPropertiesCommand(tableName: TableIdentifier, properties: Map[String, String], isView: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command that sets table/view properties.

    A command that sets table/view properties.

    The syntax of this command is:

    ALTER TABLE table1 SET TBLPROPERTIES ('key1' = 'val1', 'key2' = 'val2', ...);
    ALTER VIEW view1 SET TBLPROPERTIES ('key1' = 'val1', 'key2' = 'val2', ...);

12. case class AlterTableUnsetPropertiesCommand(tableName: TableIdentifier, propKeys: Seq[String], ifExists: Boolean, isView: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command that unsets table/view properties.

    A command that unsets table/view properties.

    The syntax of this command is:

    ALTER TABLE table1 UNSET TBLPROPERTIES [IF EXISTS] ('key1', 'key2', ...);
    ALTER VIEW view1 UNSET TBLPROPERTIES [IF EXISTS] ('key1', 'key2', ...);

13. case class AnalyzeTableCommand(tableName: String) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Analyzes the given table in the current database to generate statistics, which will be used in query optimizations.

    Analyzes the given table in the current database to generate statistics, which will be used in query optimizations.

    Right now, it only supports Hive tables and it only updates the size of a Hive table in the Hive metastore.

14. case class CacheTableCommand(tableIdent: TableIdentifier, plan: Option[LogicalPlan], isLazy: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

15. case class CreateDataSourceTableAsSelectCommand(tableIdent: TableIdentifier, provider: String, partitionColumns: Array[String], bucketSpec: Option[BucketSpec], mode: SaveMode, options: Map[String, String], query: LogicalPlan) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command used to create a data source table using the result of a query.

    A command used to create a data source table using the result of a query.

    Note: This is different from CreateTableAsSelectLogicalPlan. Please check the syntax for difference. This is not intended for temporary tables.

    The syntax of using this command in SQL is:

    CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
    USING format OPTIONS ([option1_name "option1_value", option2_name "option2_value", ...])
    AS SELECT ...

16. case class CreateDataSourceTableCommand(tableIdent: TableIdentifier, userSpecifiedSchema: Option[StructType], provider: String, options: Map[String, String], partitionColumns: Array[String], bucketSpec: Option[BucketSpec], ignoreIfExists: Boolean, managedIfNoPath: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command used to create a data source table.

    A command used to create a data source table.

    Note: This is different from CreateTableCommand. Please check the syntax for difference. This is not intended for temporary tables.

    The syntax of using this command in SQL is:

    CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
    [(col1 data_type [COMMENT col_comment], ...)]
    USING format OPTIONS ([option1_name "option1_value", option2_name "option2_value", ...])

17. case class CreateDatabaseCommand(databaseName: String, ifNotExists: Boolean, path: Option[String], comment: Option[String], props: Map[String, String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to create a new database.

    A command for users to create a new database.

    It will issue an error message when the database with the same name already exists, unless 'ifNotExists' is true. The syntax of using this command in SQL is:

    CREATE (DATABASE|SCHEMA) [IF NOT EXISTS] database_name
      [COMMENT database_comment]
      [LOCATION database_directory]
      [WITH DBPROPERTIES (property_name=property_value, ...)];

18. case class CreateFunctionCommand(databaseName: Option[String], functionName: String, className: String, resources: Seq[FunctionResource], isTemp: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    The DDL command that creates a function.

    The DDL command that creates a function. To create a temporary function, the syntax of using this command in SQL is:

    CREATE TEMPORARY FUNCTION functionName
    AS className [USING JAR\FILE 'uri' [, JAR|FILE 'uri']]

    To create a permanent function, the syntax in SQL is:

    CREATE FUNCTION [databaseName.]functionName
    AS className [USING JAR\FILE 'uri' [, JAR|FILE 'uri']]

19. case class CreateHiveTableAsSelectLogicalPlan(tableDesc: CatalogTable, child: LogicalPlan, allowExisting: Boolean) extends UnaryNode with Command with Product with Serializable

    

20. case class CreateTableCommand(table: CatalogTable, ifNotExists: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command to create a table.

    A command to create a table.

    Note: This is currently used only for creating Hive tables. This is not intended for temporary tables.

    The syntax of using this command in SQL is:

    CREATE [EXTERNAL] TABLE [IF NOT EXISTS] [db_name.]table_name
    [(col1 data_type [COMMENT col_comment], ...)]
    [COMMENT table_comment]
    [PARTITIONED BY (col3 data_type [COMMENT col_comment], ...)]
    [CLUSTERED BY (col1, ...) [SORTED BY (col1 [ASC|DESC], ...)] INTO num_buckets BUCKETS]
    [SKEWED BY (col1, col2, ...) ON ((col_value, col_value, ...), ...)
    [STORED AS DIRECTORIES]
    [ROW FORMAT row_format]
    [STORED AS file_format | STORED BY storage_handler_class [WITH SERDEPROPERTIES (...)]]
    [LOCATION path]
    [TBLPROPERTIES (property_name=property_value, ...)]
    [AS select_statement];

21. case class CreateTableLikeCommand(targetTable: TableIdentifier, sourceTable: TableIdentifier, ifNotExists: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command to create a table with the same definition of the given existing table.

    A command to create a table with the same definition of the given existing table.

    The syntax of using this command in SQL is:

    CREATE TABLE [IF NOT EXISTS] [db_name.]table_name
    LIKE [other_db_name.]existing_table_name

22. case class CreateViewCommand(tableDesc: CatalogTable, child: LogicalPlan, allowExisting: Boolean, replace: Boolean, isTemporary: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Create Hive view on non-hive-compatible tables by specifying schema ourselves instead of depending on Hive meta-store.

    Create Hive view on non-hive-compatible tables by specifying schema ourselves instead of depending on Hive meta-store.

    tableDesc

    the catalog table

    child

    the logical plan that represents the view; this is used to generate a canonicalized version of the SQL that can be saved in the catalog.

    allowExisting

    if true, and if the view already exists, noop; if false, and if the view already exists, throws analysis exception.

    replace

    if true, and if the view already exists, updates it; if false, and if the view already exists, throws analysis exception.

    isTemporary

    if true, the view is created as a temporary view. Temporary views are dropped at the end of current Spark session. Existing permanent relations with the same name are not visible to the current session while the temporary view exists, unless they are specified with full qualified table name with database prefix.

23. case class DescribeDatabaseCommand(databaseName: String, extended: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to show the name of the database, its comment (if one has been set), and its root location on the filesystem.

    A command for users to show the name of the database, its comment (if one has been set), and its root location on the filesystem. When extended is true, it also shows the database's properties If the database does not exist, an error message will be issued to indicate the database does not exist. The syntax of using this command in SQL is

    DESCRIBE DATABASE [EXTENDED] db_name

24. case class DescribeFunctionCommand(functionName: FunctionIdentifier, isExtended: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to get the usage of a registered function.

    A command for users to get the usage of a registered function. The syntax of using this command in SQL is

    DESCRIBE FUNCTION [EXTENDED] upper;

25. case class DescribeTableCommand(table: TableIdentifier, isExtended: Boolean, isFormatted: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Command that looks like

    Command that looks like

    DESCRIBE [EXTENDED|FORMATTED] table_name;

26. case class DropDatabaseCommand(databaseName: String, ifExists: Boolean, cascade: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to remove a database from the system.

    A command for users to remove a database from the system.

    'ifExists': - true, if database_name does't exist, no action - false (default), if database_name does't exist, a warning message will be issued 'cascade': - true, the dependent objects are automatically dropped before dropping database. - false (default), it is in the Restrict mode. The database cannot be dropped if it is not empty. The inclusive tables must be dropped at first.

    The syntax of using this command in SQL is:

    DROP DATABASE [IF EXISTS] database_name [RESTRICT|CASCADE];

27. case class DropFunctionCommand(databaseName: Option[String], functionName: String, ifExists: Boolean, isTemp: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    The DDL command that drops a function.

    The DDL command that drops a function. ifExists: returns an error if the function doesn't exist, unless this is true. isTemp: indicates if it is a temporary function.

28. case class DropTableCommand(tableName: TableIdentifier, ifExists: Boolean, isView: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Drops a table/view from the metastore and removes it if it is cached.

    Drops a table/view from the metastore and removes it if it is cached.

    The syntax of this command is:

    DROP TABLE [IF EXISTS] table_name;
    DROP VIEW [IF EXISTS] [db_name.]view_name;

29. case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute] = ..., extended: Boolean = false, codegen: Boolean = false) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    An explain command for users to see how a command will be executed.

    An explain command for users to see how a command will be executed.

    Note that this command takes in a logical plan, runs the optimizer on the logical plan (but do NOT actually execute it).

    EXPLAIN (EXTENDED | CODEGEN) SELECT * FROM ...

    logicalPlan

    plan to explain

    output

    output schema

    extended

    whether to do extended explain or not

    codegen

    whether to output generated code from whole-stage codegen or not

30. case class ListFilesCommand(files: Seq[String] = Seq.empty[String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Returns a list of file paths that are added to resources.

    Returns a list of file paths that are added to resources. If file paths are provided, return the ones that are added to resources.

31. case class ListJarsCommand(jars: Seq[String] = Seq.empty[String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Returns a list of jar files that are added to resources.

    Returns a list of jar files that are added to resources. If jar files are provided, return the ones that are added to resources.

32. case class LoadDataCommand(table: TableIdentifier, path: String, isLocal: Boolean, isOverwrite: Boolean, partition: Option[TablePartitionSpec]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command that loads data into a Hive table.

    A command that loads data into a Hive table.

    The syntax of this command is:

    LOAD DATA [LOCAL] INPATH 'filepath' [OVERWRITE] INTO TABLE tablename
    [PARTITION (partcol1=val1, partcol2=val2 ...)]

33. case class SetCommand(kv: Option[(String, Option[String])]) extends LogicalPlan with RunnableCommand with Logging with Product with Serializable

    

    Command that runs

    Command that runs

    set key = value;
    set -v;
    set;

34. case class SetDatabaseCommand(databaseName: String) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    Command for setting the current database.

    Command for setting the current database.

    USE database_name;

35. case class ShowColumnsCommand(table: TableIdentifier) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command to list the column names for a table.

    A command to list the column names for a table. This function creates a ShowColumnsCommand logical plan.

    The syntax of using this command in SQL is:

    SHOW COLUMNS (FROM | IN) table_identifier [(FROM | IN) database];

36. case class ShowCreateTableCommand(table: TableIdentifier) extends LogicalPlan with RunnableCommand with Product with Serializable

    

37. case class ShowDatabasesCommand(databasePattern: Option[String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to list the databases/schemas.

    A command for users to list the databases/schemas. If a databasePattern is supplied then the databases that only matches the pattern would be listed. The syntax of using this command in SQL is:

    SHOW (DATABASES|SCHEMAS) [LIKE 'identifier_with_wildcards'];

38. case class ShowFunctionsCommand(db: Option[String], pattern: Option[String], showUserFunctions: Boolean, showSystemFunctions: Boolean) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to list all of the registered functions.

    A command for users to list all of the registered functions. The syntax of using this command in SQL is:

    SHOW FUNCTIONS [LIKE pattern]

    For the pattern, '*' matches any sequence of characters (including no characters) and '|' is for alternation. For example, "show functions like 'yea*|windo*'" will return "window" and "year".

39. case class ShowPartitionsCommand(table: TableIdentifier, spec: Option[TablePartitionSpec]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command to list the partition names of a table.

    A command to list the partition names of a table. If the partition spec is specified, partitions that match the spec are returned. AnalysisException exception is thrown under the following conditions:

    1. If the command is called for a non partitioned table. 2. If the partition spec refers to the columns that are not defined as partitioning columns.

    This function creates a ShowPartitionsCommand logical plan

    The syntax of using this command in SQL is:

    SHOW PARTITIONS [db_name.]table_name [PARTITION(partition_spec)]

40. case class ShowTablePropertiesCommand(table: TableIdentifier, propertyKey: Option[String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to list the properties for a table If propertyKey is specified, the value for the propertyKey is returned.

    A command for users to list the properties for a table If propertyKey is specified, the value for the propertyKey is returned. If propertyKey is not specified, all the keys and their corresponding values are returned. The syntax of using this command in SQL is:

    SHOW TBLPROPERTIES table_name[('propertyKey')];

41. case class ShowTablesCommand(databaseName: Option[String], tableIdentifierPattern: Option[String]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command for users to get tables in the given database.

    A command for users to get tables in the given database. If a databaseName is not given, the current database will be used. The syntax of using this command in SQL is:

    SHOW TABLES [(IN|FROM) database_name] [[LIKE] 'identifier_with_wildcards'];

42. case class TruncateTableCommand(tableName: TableIdentifier, partitionSpec: Option[TablePartitionSpec]) extends LogicalPlan with RunnableCommand with Product with Serializable

    

    A command to truncate table.

    A command to truncate table.

    The syntax of this command is:

    TRUNCATE TABLE tablename [PARTITION (partcol1=val1, partcol2=val2 ...)]

43. case class UncacheTableCommand(tableIdent: TableIdentifier) extends LogicalPlan with RunnableCommand with Product with Serializable