SessionCatalog

Value Members

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

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. def alterDatabase(dbDefinition: CatalogDatabase): Unit

   

5. def alterPartitions(tableName: TableIdentifier, parts: Seq[CatalogTablePartition]): Unit

   

   Alter one or many table partitions whose specs that match those specified in parts, assuming the partitions exist.

   Alter one or many table partitions whose specs that match those specified in parts, assuming the partitions exist.

   If no database is specified, assume the table is in the current database.

   Note: If the underlying implementation does not support altering a certain field, this becomes a no-op.

6. def alterTable(tableDefinition: CatalogTable): Unit

   

   Alter the metadata of an existing metastore table identified by tableDefinition.

   Alter the metadata of an existing metastore table identified by tableDefinition.

   If no database is specified in tableDefinition, assume the table is in the current database.

   Note: If the underlying implementation does not support altering a certain field, this becomes a no-op.

7. def alterTableSchema(identifier: TableIdentifier, newSchema: StructType): Unit

   

   Alter the schema of a table identified by the provided table identifier.

   Alter the schema of a table identified by the provided table identifier. The new schema should still contain the existing bucket columns and partition columns used by the table. This method will also update any Spark SQL-related parameters stored as Hive table properties (such as the schema itself).

   identifier

   TableIdentifier

   newSchema

   Updated schema to be used for the table (must contain existing partition and bucket columns, and partition columns need to be at the end)

8. def alterTempViewDefinition(name: TableIdentifier, viewDefinition: LogicalPlan): Boolean

   

   Alter the definition of a local/global temp view matching the given name, returns true if a temp view is matched and altered, false otherwise.

9. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

10. def cacheTable(t: QualifiedTableName, l: LogicalPlan): Unit

    

    This method provides a way to cache a plan.

11. def clearTempTables(): Unit

    

    Drop all existing temporary tables.

    Drop all existing temporary tables. For testing only.

12. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

13. def createDatabase(dbDefinition: CatalogDatabase, ignoreIfExists: Boolean): Unit

    

14. def createFunction(funcDefinition: CatalogFunction, ignoreIfExists: Boolean): Unit

    

    Create a metastore function in the database specified in funcDefinition.

    Create a metastore function in the database specified in funcDefinition. If no such database is specified, create it in the current database.

15. def createGlobalTempView(name: String, viewDefinition: LogicalPlan, overrideIfExists: Boolean): Unit

    

    Create a global temporary view.

16. def createPartitions(tableName: TableIdentifier, parts: Seq[CatalogTablePartition], ignoreIfExists: Boolean): Unit

    

    Create partitions in an existing table, assuming it exists.

    Create partitions in an existing table, assuming it exists. If no database is specified, assume the table is in the current database.

17. def createTable(tableDefinition: CatalogTable, ignoreIfExists: Boolean): Unit

    

    Create a metastore table in the database specified in tableDefinition.

    Create a metastore table in the database specified in tableDefinition. If no such database is specified, create it in the current database.

18. def createTempView(name: String, tableDefinition: LogicalPlan, overrideIfExists: Boolean): Unit

    

    Create a local temporary view.

19. var currentDb: String

    

    Attributes

    protected

20. def databaseExists(db: String): Boolean

    

21. def defaultTablePath(tableIdent: TableIdentifier): URI

    

22. def dropDatabase(db: String, ignoreIfNotExists: Boolean, cascade: Boolean): Unit

    

23. def dropFunction(name: FunctionIdentifier, ignoreIfNotExists: Boolean): Unit

    

    Drop a metastore function.

    Drop a metastore function. If no database is specified, assume the function is in the current database.

24. def dropGlobalTempView(name: String): Boolean

    

    Drop a global temporary view.

    Drop a global temporary view.

    Returns true if this view is dropped successfully, false otherwise.

25. def dropPartitions(tableName: TableIdentifier, specs: Seq[TablePartitionSpec], ignoreIfNotExists: Boolean, purge: Boolean, retainData: Boolean): Unit

    

    Drop partitions from a table, assuming they exist.

    Drop partitions from a table, assuming they exist. If no database is specified, assume the table is in the current database.

26. def dropTable(name: TableIdentifier, ignoreIfNotExists: Boolean, purge: Boolean): Unit

    

    Drop a table.

    Drop a table.

    If a database is specified in name, this will drop the table from that database. If no database is specified, this will first attempt to drop a temporary table with the same name, then, if that does not exist, drop the table from the current database.

27. def dropTempFunction(name: String, ignoreIfNotExists: Boolean): Unit

    

    Drop a temporary function.

28. def dropTempView(name: String): Boolean

    

    Drop a local temporary view.

    Drop a local temporary view.

    Returns true if this view is dropped successfully, false otherwise.

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

    

    Definition Classes

    AnyRef

30. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

31. val externalCatalog: ExternalCatalog

    

32. def failFunctionLookup(name: FunctionIdentifier): Nothing

    

    Attributes

    protected

33. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

34. def formatDatabaseName(name: String): String

    

    Format database name, taking into account case sensitivity.

    Format database name, taking into account case sensitivity.

    Attributes

    protected[this]

35. def formatTableName(name: String): String

    

    Format table name, taking into account case sensitivity.

    Format table name, taking into account case sensitivity.

    Attributes

    protected[this]

36. def functionExists(name: FunctionIdentifier): Boolean

    

    Check if the specified function exists.

37. def getCachedPlan(t: QualifiedTableName, c: Callable[LogicalPlan]): LogicalPlan

    

    This method provides a way to get a cached plan.

38. def getCachedTable(key: QualifiedTableName): LogicalPlan

    

    This method provides a way to get a cached plan if the key exists.

39. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

40. def getCurrentDatabase: String

    

41. def getDatabaseMetadata(db: String): CatalogDatabase

    

42. def getDefaultDBPath(db: String): URI

    

    Get the path for creating a non-default database when database location is not provided by users.

43. def getFunctionMetadata(name: FunctionIdentifier): CatalogFunction

    

    Retrieve the metadata of a metastore function.

    Retrieve the metadata of a metastore function.

    If a database is specified in name, this will return the function in that database. If no database is specified, this will return the function in the current database.

44. def getGlobalTempView(name: String): Option[LogicalPlan]

    

    Return a global temporary view exactly as it was stored.

45. def getPartition(tableName: TableIdentifier, spec: TablePartitionSpec): CatalogTablePartition

    

    Retrieve the metadata of a table partition, assuming it exists.

    Retrieve the metadata of a table partition, assuming it exists. If no database is specified, assume the table is in the current database.

46. def getTableMetadata(name: TableIdentifier): CatalogTable

    

    Retrieve the metadata of an existing permanent table/view.

    Retrieve the metadata of an existing permanent table/view. If no database is specified, assume the table/view is in the current database. If the specified table/view is not found in the database then a NoSuchTableException is thrown.

47. def getTableMetadataOption(name: TableIdentifier): Option[CatalogTable]

    

    Retrieve the metadata of an existing metastore table.

    Retrieve the metadata of an existing metastore table. If no database is specified, assume the table is in the current database. If the specified table is not found in the database then return None if it doesn't exist.

48. def getTempView(name: String): Option[LogicalPlan]

    

    Return a local temporary view exactly as it was stored.

49. def getTempViewOrPermanentTableMetadata(name: TableIdentifier): CatalogTable

    

    Retrieve the metadata of an existing temporary view or permanent table/view.

    Retrieve the metadata of an existing temporary view or permanent table/view.

    If a database is specified in name, this will return the metadata of table/view in that database. If no database is specified, this will first attempt to get the metadata of a temporary view with the same name, then, if that does not exist, return the metadata of table/view in the current database.

50. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

51. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

52. def invalidateAllCachedTables(): Unit

    

    This method provides a way to invalidate all the cached plans.

53. def invalidateCachedTable(key: QualifiedTableName): Unit

    

    This method provides a way to invalidate a cached plan.

54. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

55. def isTemporaryFunction(name: FunctionIdentifier): Boolean

    

    Returns whether it is a temporary function.

    Returns whether it is a temporary function. If not existed, returns false.

56. def isTemporaryTable(name: TableIdentifier): Boolean

    

    Return whether a table with the specified name is a temporary table.

    Return whether a table with the specified name is a temporary table.

    Note: The temporary table cache is checked only when database is not explicitly specified.

57. def isTraceEnabled(): Boolean

    

    Attributes

    protected

    Definition Classes

    Logging

58. def listDatabases(pattern: String): Seq[String]

    

59. def listDatabases(): Seq[String]

    

60. def listFunctions(db: String, pattern: String): Seq[(FunctionIdentifier, String)]

    

    List all matching functions in the specified database, including temporary functions.

    List all matching functions in the specified database, including temporary functions. This returns the function identifier and the scope in which it was defined (system or user defined).

61. def listFunctions(db: String): Seq[(FunctionIdentifier, String)]

    

    List all functions in the specified database, including temporary functions.

    List all functions in the specified database, including temporary functions. This returns the function identifier and the scope in which it was defined (system or user defined).

62. def listPartitionNames(tableName: TableIdentifier, partialSpec: Option[TablePartitionSpec] = None): Seq[String]

    

    List the names of all partitions that belong to the specified table, assuming it exists.

    List the names of all partitions that belong to the specified table, assuming it exists.

    A partial partition spec may optionally be provided to filter the partitions returned. For instance, if there exist partitions (a='1', b='2'), (a='1', b='3') and (a='2', b='4'), then a partial spec of (a='1') will return the first two only.

63. def listPartitions(tableName: TableIdentifier, partialSpec: Option[TablePartitionSpec] = None): Seq[CatalogTablePartition]

    

    List the metadata of all partitions that belong to the specified table, assuming it exists.

    List the metadata of all partitions that belong to the specified table, assuming it exists.

    A partial partition spec may optionally be provided to filter the partitions returned. For instance, if there exist partitions (a='1', b='2'), (a='1', b='3') and (a='2', b='4'), then a partial spec of (a='1') will return the first two only.

64. def listPartitionsByFilter(tableName: TableIdentifier, predicates: Seq[Expression]): Seq[CatalogTablePartition]

    

    List the metadata of partitions that belong to the specified table, assuming it exists, that satisfy the given partition-pruning predicate expressions.

65. def listTables(db: String, pattern: String): Seq[TableIdentifier]

    

    List all matching tables in the specified database, including local temporary tables.

    List all matching tables in the specified database, including local temporary tables.

    Note that, if the specified database is global temporary view database, we will list global temporary views.

66. def listTables(db: String): Seq[TableIdentifier]

    

    List all tables in the specified database, including local temporary tables.

    List all tables in the specified database, including local temporary tables.

    Note that, if the specified database is global temporary view database, we will list global temporary views.

67. def loadFunctionResources(resources: Seq[FunctionResource]): Unit

    

    Loads resources such as JARs and Files for a function.

    Loads resources such as JARs and Files for a function. Every resource is represented by a tuple (resource type, resource uri).

68. def loadPartition(name: TableIdentifier, loadPath: String, spec: TablePartitionSpec, isOverwrite: Boolean, inheritTableSpecs: Boolean, isSrcLocal: Boolean): Unit

    

    Load files stored in given path into the partition of an existing metastore table.

    Load files stored in given path into the partition of an existing metastore table. If no database is specified, assume the table is in the current database. If the specified table is not found in the database then a NoSuchTableException is thrown.

69. def loadTable(name: TableIdentifier, loadPath: String, isOverwrite: Boolean, isSrcLocal: Boolean): Unit

    

    Load files stored in given path into an existing metastore table.

    Load files stored in given path into an existing metastore table. If no database is specified, assume the table is in the current database. If the specified table is not found in the database then a NoSuchTableException is thrown.

70. def log: Logger

    

    Attributes

    protected

    Definition Classes

    Logging

71. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

72. def logDebug(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

73. def logError(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

74. def logError(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

75. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

76. def logInfo(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

77. def logName: String

    

    Attributes

    protected

    Definition Classes

    Logging

78. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

79. def logTrace(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

80. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

81. def logWarning(msg: ⇒ String): Unit

    

    Attributes

    protected

    Definition Classes

    Logging

82. def lookupFunction(name: FunctionIdentifier, children: Seq[Expression]): Expression

    

    Return an Expression that represents the specified function, assuming it exists.

    Return an Expression that represents the specified function, assuming it exists.

    For a temporary function or a permanent function that has been loaded, this method will simply lookup the function through the FunctionRegistry and create an expression based on the builder.

    For a permanent function that has not been loaded, we will first fetch its metadata from the underlying external catalog. Then, we will load all resources associated with this function (i.e. jars and files). Finally, we create a function builder based on the function class and put the builder into the FunctionRegistry. The name of this function in the FunctionRegistry will be databaseName.functionName.

83. def lookupFunctionInfo(name: FunctionIdentifier): ExpressionInfo

    

    Look up the ExpressionInfo associated with the specified function, assuming it exists.

84. def lookupRelation(name: TableIdentifier): LogicalPlan

    

    Return a LogicalPlan that represents the given table or view.

    Return a LogicalPlan that represents the given table or view.

    If a database is specified in name, this will return the table/view from that database. If no database is specified, this will first attempt to return a temporary table/view with the same name, then, if that does not exist, return the table/view from the current database.

    Note that, the global temp view database is also valid here, this will return the global temp view matching the given name.

    If the relation is a view, we generate a View operator from the view description, and wrap the logical plan in a SubqueryAlias which will track the name of the view.

    name

    The name of the table/view that we look up.

85. def makeFunctionBuilder(name: String, functionClassName: String): FunctionBuilder

    

    Construct a FunctionBuilder based on the provided class that represents a function.

    Construct a FunctionBuilder based on the provided class that represents a function.

    This performs reflection to decide what type of Expression to return in the builder.

    Attributes

    protected

86. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

87. final def notify(): Unit

    

    Definition Classes

    AnyRef

88. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

89. def refreshTable(name: TableIdentifier): Unit

    

    Refresh the cache entry for a metastore table, if any.

90. def registerFunction(funcDefinition: CatalogFunction, ignoreIfExists: Boolean, functionBuilder: Option[FunctionBuilder] = None): Unit

    

    Registers a temporary or permanent function into a session-specific FunctionRegistry

91. def renamePartitions(tableName: TableIdentifier, specs: Seq[TablePartitionSpec], newSpecs: Seq[TablePartitionSpec]): Unit

    

    Override the specs of one or many existing table partitions, assuming they exist.

    Override the specs of one or many existing table partitions, assuming they exist.

    This assumes index i of specs corresponds to index i of newSpecs. If no database is specified, assume the table is in the current database.

92. def renameTable(oldName: TableIdentifier, newName: TableIdentifier): Unit

    

    Rename a table.

    Rename a table.

    If a database is specified in oldName, this will rename the table in that database. If no database is specified, this will first attempt to rename a temporary table with the same name, then, if that does not exist, rename the table in the current database.

    This assumes the database specified in newName matches the one in oldName.

93. def reset(): Unit

    

    Drop all existing databases (except "default"), tables, partitions and functions, and set the current database to "default".

    Drop all existing databases (except "default"), tables, partitions and functions, and set the current database to "default".

    This is mainly used for tests.

94. def setCurrentDatabase(db: String): Unit

    

95. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

96. def tableExists(name: TableIdentifier): Boolean

    

    Return whether a table/view with the specified name exists.

    Return whether a table/view with the specified name exists. If no database is specified, check with current database.

97. val tempTables: HashMap[String, LogicalPlan]

    

    List of temporary tables, mapping from table name to their logical plan.

    List of temporary tables, mapping from table name to their logical plan.

    Attributes

    protected

98. def toString(): String

    

    Definition Classes

    AnyRef → Any

99. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

100. final def wait(arg0: Long, arg1: Int): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )

101. final def wait(arg0: Long): Unit

     

     Definition Classes

     AnyRef

     Annotations

     @throws( ... )