Class

org.apache.spark.sql.internal

CatalogImpl

Related Doc: package internal

Permalink

class CatalogImpl extends Catalog

Internal implementation of the user-facing Catalog.

Source
CatalogImpl.scala
Linear Supertypes
Catalog, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. CatalogImpl
  2. Catalog
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new CatalogImpl(sparkSession: SparkSession)

    Permalink

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 cacheTable(tableName: String): Unit

    Permalink

    Caches the specified table in-memory.

    Caches the specified table in-memory.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  6. def clearCache(): Unit

    Permalink

    Removes all cached tables from the in-memory cache.

    Removes all cached tables from the in-memory cache.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createExternalTable(tableName: String, source: String, schema: StructType, options: Map[String, String]): DataFrame

    Permalink

    :: Experimental :: (Scala-specific) Create an external table from the given path based on a data source, a schema and a set of options.

    :: Experimental :: (Scala-specific) Create an external table from the given path based on a data source, a schema and a set of options. Then, returns the corresponding DataFrame.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  9. def createExternalTable(tableName: String, source: String, schema: StructType, options: Map[String, String]): DataFrame

    Permalink

    :: Experimental :: Create an external table from the given path based on a data source, a schema and a set of options.

    :: Experimental :: Create an external table from the given path based on a data source, a schema and a set of options. Then, returns the corresponding DataFrame.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  10. def createExternalTable(tableName: String, source: String, options: Map[String, String]): DataFrame

    Permalink

    :: Experimental :: (Scala-specific) Creates an external table from the given path based on a data source and a set of options.

    :: Experimental :: (Scala-specific) Creates an external table from the given path based on a data source and a set of options. Then, returns the corresponding DataFrame.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  11. def createExternalTable(tableName: String, source: String, options: Map[String, String]): DataFrame

    Permalink

    :: Experimental :: Creates an external table from the given path based on a data source and a set of options.

    :: Experimental :: Creates an external table from the given path based on a data source and a set of options. Then, returns the corresponding DataFrame.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  12. def createExternalTable(tableName: String, path: String, source: String): DataFrame

    Permalink

    :: Experimental :: Creates an external table from the given path based on a data source and returns the corresponding DataFrame.

    :: Experimental :: Creates an external table from the given path based on a data source and returns the corresponding DataFrame.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  13. def createExternalTable(tableName: String, path: String): DataFrame

    Permalink

    :: Experimental :: Creates an external table from the given path and returns the corresponding DataFrame.

    :: Experimental :: Creates an external table from the given path and returns the corresponding DataFrame. It will use the default data source configured by spark.sql.sources.default.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @Experimental()
    Since

    2.0.0

  14. def currentDatabase: String

    Permalink

    Returns the current default database in this session.

    Returns the current default database in this session.

    Definition Classes
    CatalogImplCatalog
  15. def databaseExists(dbName: String): Boolean

    Permalink

    Check if the database with the specified name exists.

    Check if the database with the specified name exists.

    Definition Classes
    CatalogImplCatalog
  16. def dropGlobalTempView(viewName: String): Boolean

    Permalink

    Drops the global temporary view with the given view name in the catalog.

    Drops the global temporary view with the given view name in the catalog. If the view has been cached/persisted before, it's also unpersisted.

    viewName

    the name of the view to be dropped.

    returns

    true if the view is dropped successfully, false otherwise.

    Definition Classes
    CatalogImplCatalog
    Since

    2.1.0

  17. def dropTempView(viewName: String): Boolean

    Permalink

    Drops the local temporary view with the given view name in the catalog.

    Drops the local temporary view with the given view name in the catalog. If the view has been cached/persisted before, it's also unpersisted.

    viewName

    the name of the view to be dropped.

    returns

    true if the view is dropped successfully, false otherwise.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  18. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def functionExists(dbName: String, functionName: String): Boolean

    Permalink

    Check if the function with the specified name exists in the specified database.

    Check if the function with the specified name exists in the specified database.

    Definition Classes
    CatalogImplCatalog
  22. def functionExists(functionName: String): Boolean

    Permalink

    Check if the function with the specified name exists.

    Check if the function with the specified name exists. This can either be a temporary function or a function in the current database.

    Definition Classes
    CatalogImplCatalog
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def getDatabase(dbName: String): Database

    Permalink

    Get the database with the specified name.

    Get the database with the specified name. This throws an AnalysisException when no Database can be found.

    Definition Classes
    CatalogImplCatalog
  25. def getFunction(dbName: String, functionName: String): Function

    Permalink

    Get the function with the specified name.

    Get the function with the specified name. This returns None when no Function can be found.

    Definition Classes
    CatalogImplCatalog
  26. def getFunction(functionName: String): Function

    Permalink

    Get the function with the specified name.

    Get the function with the specified name. This function can be a temporary function or a function in the current database. This throws an AnalysisException when no Function can be found.

    Definition Classes
    CatalogImplCatalog
  27. def getTable(dbName: String, tableName: String): Table

    Permalink

    Get the table or view with the specified name in the specified database.

    Get the table or view with the specified name in the specified database. This throws an AnalysisException when no Table can be found.

    Definition Classes
    CatalogImplCatalog
  28. def getTable(tableName: String): Table

    Permalink

    Get the table or view with the specified name.

    Get the table or view with the specified name. This table can be a temporary view or a table/view in the current database. This throws an AnalysisException when no Table can be found.

    Definition Classes
    CatalogImplCatalog
  29. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  30. def isCached(qName: Dataset[_]): Boolean

    Permalink

    Returns true if the Dataset is currently cached in-memory.

    Returns true if the Dataset is currently cached in-memory.

    Attributes
    protected[org.apache.spark.sql]
    Since

    2.0.0

  31. def isCached(tableName: String): Boolean

    Permalink

    Returns true if the table is currently cached in-memory.

    Returns true if the table is currently cached in-memory.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. def listColumns(dbName: String, tableName: String): Dataset[catalog.Column]

    Permalink

    Returns a list of columns for the given table in the specified database.

    Returns a list of columns for the given table in the specified database.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @throws( "database or table does not exist" )
  34. def listColumns(tableName: String): Dataset[catalog.Column]

    Permalink

    Returns a list of columns for the given table in the current database.

    Returns a list of columns for the given table in the current database.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @throws( "table does not exist" )
  35. def listDatabases(): Dataset[Database]

    Permalink

    Returns a list of databases available across all sessions.

    Returns a list of databases available across all sessions.

    Definition Classes
    CatalogImplCatalog
  36. def listFunctions(dbName: String): Dataset[Function]

    Permalink

    Returns a list of functions registered in the specified database.

    Returns a list of functions registered in the specified database. This includes all temporary functions

    Definition Classes
    CatalogImplCatalog
    Annotations
    @throws( "database does not exist" )
  37. def listFunctions(): Dataset[Function]

    Permalink

    Returns a list of functions registered in the current database.

    Returns a list of functions registered in the current database. This includes all temporary functions

    Definition Classes
    CatalogImplCatalog
  38. def listTables(dbName: String): Dataset[Table]

    Permalink

    Returns a list of tables in the specified database.

    Returns a list of tables in the specified database. This includes all temporary tables.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @throws( "database does not exist" )
  39. def listTables(): Dataset[Table]

    Permalink

    Returns a list of tables in the current database.

    Returns a list of tables in the current database. This includes all temporary tables.

    Definition Classes
    CatalogImplCatalog
  40. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  41. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  43. def refreshByPath(resourcePath: String): Unit

    Permalink

    Refresh the cache entry and the associated metadata for all dataframes (if any), that contain the given data source path.

    Refresh the cache entry and the associated metadata for all dataframes (if any), that contain the given data source path.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  44. def refreshTable(tableName: String): Unit

    Permalink

    Refresh the cache entry for a table, if any.

    Refresh the cache entry for a table, if any. For Hive metastore table, the metadata is refreshed. For data source tables, the schema will not be inferred and refreshed.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  45. def setCurrentDatabase(dbName: String): Unit

    Permalink

    Sets the current default database in this session.

    Sets the current default database in this session.

    Definition Classes
    CatalogImplCatalog
    Annotations
    @throws( "database does not exist" )
  46. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  47. def tableExists(dbName: String, tableName: String): Boolean

    Permalink

    Check if the table or view with the specified name exists in the specified database.

    Check if the table or view with the specified name exists in the specified database.

    Definition Classes
    CatalogImplCatalog
  48. def tableExists(tableName: String): Boolean

    Permalink

    Check if the table or view with the specified name exists.

    Check if the table or view with the specified name exists. This can either be a temporary view or a table/view in the current database.

    Definition Classes
    CatalogImplCatalog
  49. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  50. def uncacheTable(tableName: String): Unit

    Permalink

    Removes the specified table from the in-memory cache.

    Removes the specified table from the in-memory cache.

    Definition Classes
    CatalogImplCatalog
    Since

    2.0.0

  51. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Catalog

Inherited from AnyRef

Inherited from Any

cachemgmt

ddl_ops

Ungrouped