ObjectStore (Hive Metastore Server 4.0.0 API)

java.lang.Object
- org.apache.hadoop.hive.metastore.ObjectStore

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable, RawStore
```
public class ObjectStore
extends Object
implements RawStore, org.apache.hadoop.conf.Configurable
```
This class is the interface between the application logic and the database store that contains the objects. Refrain putting any logic in mode.M* objects or in this file as former could be auto generated and this class would need to be made into a interface that can read both from a database and a filestore.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ObjectStore.GetDbHelper`
`class`	`ObjectStore.GetHelper<T>` Helper class for getting stuff w/transaction, direct SQL, perf logging, etc.
`class`	`ObjectStore.UpdateMDatabaseURIRetVal`
`class`	`ObjectStore.UpdateMStorageDescriptorTblURIRetVal`
`class`	`ObjectStore.UpdatePropURIRetVal`
`class`	`ObjectStore.UpdateSerdeURIRetVal`

Nested classes/interfaces inherited from interface org.apache.hadoop.hive.metastore.RawStore
RawStore.CanNotRetry

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`TRUSTSTORE_PASSWORD_KEY`
`static String`	`TRUSTSTORE_PATH_KEY` Java system properties for configuring SSL to the database store
`static String`	`TRUSTSTORE_TYPE_KEY`

Constructor Summary

Constructors
Constructor and Description

ObjectStore()

Constructors
Constructor and Description
`ObjectStore()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`List<SQLCheckConstraint>`	`addCheckConstraints(List<SQLCheckConstraint> nns)` Add check constraints to a table.
`List<SQLDefaultConstraint>`	`addDefaultConstraints(List<SQLDefaultConstraint> nns)` Add default values to a table definition.
`List<SQLForeignKey>`	`addForeignKeys(List<SQLForeignKey> fks)` Add a foreign key to a table.
`int`	`addMasterKey(String key)`
`void`	`addNotificationEvent(NotificationEvent entry)` Add a notification entry.
`List<SQLNotNullConstraint>`	`addNotNullConstraints(List<SQLNotNullConstraint> nns)` Add not null constraints to a table.
`void`	`addPackage(AddPackageRequest request)`
`boolean`	`addPartition(Partition part)` Add a partition.
`boolean`	`addPartitions(String catName, String dbName, String tblName, List<Partition> parts)` Add a list of partitions to a table.
`boolean`	`addPartitions(String catName, String dbName, String tblName, PartitionSpecProxy partitionSpec, boolean ifNotExists)`
`List<SQLPrimaryKey>`	`addPrimaryKeys(List<SQLPrimaryKey> pks)` Add a primary key to a table.
`void`	`addReplicationMetrics(ReplicationMetricList replicationMetricList)` Add the replication metrics and progress info.
`boolean`	`addRole(String roleName, String ownerName)`
`void`	`addRuntimeStat(RuntimeStat stat)` Adds a RuntimeStat for persistence.
`void`	`addSchemaVersion(SchemaVersion schemaVersion)` Create a new version of an existing schema.
`void`	`addSerde(SerDeInfo serde)` Add a serde.
`boolean`	`addToken(String tokenId, String delegationToken)`
`List<SQLUniqueConstraint>`	`addUniqueConstraints(List<SQLUniqueConstraint> uks)` Add unique constraints to a table.
`void`	`alterCatalog(String catName, Catalog cat)` Alter an existing catalog.
`boolean`	`alterDatabase(String catName, String dbName, Database db)` Alter the database object in metastore.
`boolean`	`alterDataConnector(String dcName, DataConnector connector)` Alter the dataconnector object in metastore.
`void`	`alterFunction(String catName, String dbName, String funcName, Function newFunction)` Alter function based on new function specs.
`void`	`alterISchema(ISchemaName schemaName, ISchema newSchema)` Alter an existing ISchema.
`Partition`	`alterPartition(String catName, String dbname, String name, List<String> part_vals, Partition newPart, String validWriteIds)` Alter a partition.
`List<Partition>`	`alterPartitions(String catName, String dbName, String tblName, List<List<String>> part_vals, List<Partition> newParts, long writeId, String queryWriteIdList)` Alter a set of partitions.
`void`	`alterPool(WMNullablePool pool, String poolPath)`
`WMFullResourcePlan`	`alterResourcePlan(String name, String ns, WMNullableResourcePlan changes, boolean canActivateDisabled, boolean canDeactivate, boolean isReplace)`
`void`	`alterSchemaVersion(SchemaVersionDescriptor version, SchemaVersion newVersion)` Alter a schema version.
`Table`	`alterTable(String catName, String dbname, String name, Table newTable, String queryValidWriteIds)` Alter a table.
`void`	`alterWMTrigger(WMTrigger trigger)`
`void`	`cleanNotificationEvents(int olderThan)` Remove older notification events.
`long`	`cleanupEvents()`
`void`	`cleanWriteNotificationEvents(int olderThan)` Remove older notification events.
`boolean`	`commitTransaction()` if this is the commit of the first open call then an actual commit is called.
`void`	`createCatalog(Catalog cat)` Create a new catalog.
`void`	`createDatabase(Database db)` Create a database.
`void`	`createDataConnector(DataConnector connector)` Create a dataconnector.
`void`	`createFunction(Function func)` Register a user-defined function based on the function specification passed in.
`void`	`createISchema(ISchema schema)` Create a new ISchema.
`void`	`createOrUpdateStoredProcedure(StoredProcedure proc)`
`void`	`createOrUpdateWMMapping(WMMapping mapping, boolean update)`
`void`	`createPool(WMPool pool)`
`void`	`createResourcePlan(WMResourcePlan resourcePlan, String copyFromName, int defaultPoolSize)`
`void`	`createTable(Table tbl)`
`SQLAllTableConstraints`	`createTableWithConstraints(Table tbl, SQLAllTableConstraints constraints)` Create a table with constraints
`boolean`	`createType(Type type)`
`void`	`createWMTrigger(WMTrigger trigger)`
`void`	`createWMTriggerToPoolMapping(String resourcePlanName, String triggerName, String poolPath, String ns)`
`void`	`deleteAllPartitionColumnStatistics(TableName tn, String writeIdList)`
`boolean`	`deletePartitionColumnStatistics(String catName, String dbName, String tableName, String partName, List<String> partVals, String colName, String engine)` Deletes column statistics if present associated with a given db, table, partition and col.
`int`	`deleteReplicationMetrics(int maxRetainSecs)`
`int`	`deleteRuntimeStats(int maxRetainSecs)` Removes outdated statistics.
`int`	`deleteScheduledExecutions(int maxRetainSecs)`
`boolean`	`deleteTableColumnStatistics(String catName, String dbName, String tableName, String colName, String engine)` Delete statistics for a single column or all columns in a table.
`boolean`	`doesPartitionExist(String catName, String dbName, String tableName, List<FieldSchema> partKeys, List<String> partVals)` Check whether a partition exists.
`void`	`dropCatalog(String catalogName)` Drop a catalog.
`void`	`dropConstraint(String catName, String dbName, String tableName, String constraintName, boolean missingOk)` Drop a constraint, any constraint.
`boolean`	`dropDatabase(String catName, String dbname)` Drop a database.
`boolean`	`dropDataConnector(String dcname)` Drop a dataconnector.
`void`	`dropFunction(String catName, String dbName, String funcName)` Drop a function definition.
`void`	`dropISchema(ISchemaName schemaName)` Drop an ISchema.
`void`	`dropPackage(DropPackageRequest request)`
`boolean`	`dropPartition(String catName, String dbName, String tableName, List<String> part_vals)` Drop a partition.
`boolean`	`dropPartition(String catName, String dbName, String tableName, String partName)` Drop a partition.
`void`	`dropPartitions(String catName, String dbName, String tblName, List<String> partNames)` Drop a list of partitions.
`boolean`	`dropProperties(String key)`
`void`	`dropResourcePlan(String name, String ns)`
`void`	`dropSchemaVersion(SchemaVersionDescriptor version)` Drop a version of the schema.
`void`	`dropStoredProcedure(String catName, String dbName, String funcName)`
`boolean`	`dropTable(String catName, String dbName, String tableName)` Drop a table.
`boolean`	`dropType(String typeName)`
`void`	`dropWMMapping(WMMapping mapping)`
`void`	`dropWMPool(String resourcePlanName, String poolPath, String ns)`
`void`	`dropWMTrigger(String resourcePlanName, String triggerName, String ns)`
`void`	`dropWMTriggerToPoolMapping(String resourcePlanName, String triggerName, String poolPath, String ns)`
`MTable`	`ensureGetMTable(String catName, String dbName, String tblName)` Gets the table object for a given table, throws if anything goes wrong.
`Collection<?>`	`executeJDOQLSelect(String queryStr)` The following API - executeJDOQLSelect is used by HiveMetaTool.
`long`	`executeJDOQLUpdate(String queryStr)` The following API - executeJDOQLUpdate is used by HiveMetaTool.
`<T> T`	`fetchProperties(String key, Function<MMetastoreDBProperties,T> transform)`
`Package`	`findPackage(GetPackageRequest request)`
`void`	`flushCache()`
`AggrStats`	`get_aggr_stats_for(String catName, String dbName, String tblName, List<String> partNames, List<String> colNames, String engine)` Get aggregated stats for a table or partition(s).
`AggrStats`	`get_aggr_stats_for(String catName, String dbName, String tblName, List<String> partNames, List<String> colNames, String engine, String writeIdList)` Get aggregated stats for a table or partition(s).
`WMFullResourcePlan`	`getActiveResourcePlan(String ns)`
`List<String>`	`getAllDatabases(String catName)` Get names of all the databases in a catalog.
`List<String>`	`getAllDataConnectorNames()` Get names of all the databases in a catalog.
`List<Function>`	`getAllFunctions(String catName)` Retrieve all functions.
`List<Table>`	`getAllMaterializedViewObjectsForRewriting(String catName)` Retrieve all materialized views.
`List<WMResourcePlan>`	`getAllResourcePlans(String ns)`
`List<SchemaVersion>`	`getAllSchemaVersion(ISchemaName schemaName)` Get all of the versions of a schema.
`List<String>`	`getAllStoredProcedures(ListStoredProcedureRequest request)`
`SQLAllTableConstraints`	`getAllTableConstraints(AllTableConstraintsRequest request)` Api to fetch all constraints at once
`SQLAllTableConstraints`	`getAllTableConstraints(String catName, String dbName, String tblName)` Deprecated.
`List<TableName>`	`getAllTableNamesForStats()`
`List<String>`	`getAllTables(String catName, String dbName)` Get all tables in a database.
`List<String>`	`getAllTokenIdentifiers()`
`List<WriteEventInfo>`	`getAllWriteEventInfo(long txnId, String dbName, String tableName)` Get all write events for a specific transaction .
`Catalog`	`getCatalog(String catalogName)` Get a catalog.
`List<String>`	`getCatalogs()` Get all the catalogs.
`List<SQLCheckConstraint>`	`getCheckConstraints(CheckConstraintsRequest request)` SQLCheckConstraint represents a single check constraint column.
`List<SQLCheckConstraint>`	`getCheckConstraints(String catName, String db_name, String tbl_name)` Get check constraints for columns in a table.
`protected List<SQLCheckConstraint>`	`getCheckConstraintsInternal(String catName, String db_name_input, String tbl_name_input, boolean allowSql, boolean allowJdo)`
`PrincipalPrivilegeSet`	`getColumnPrivilegeSet(String catName, String dbName, String tableName, String partitionName, String columnName, String userName, List<String> groupNames)` Get privileges for a column in a table or partition for a user.
`org.apache.hadoop.conf.Configuration`	`getConf()`
`PrincipalPrivilegeSet`	`getConnectorPrivilegeSet(String catName, String connectorName, String userName, List<String> groupNames)` Get privileges for a connector for a user.
`CurrentNotificationEventId`	`getCurrentNotificationEventId()` Get the last issued notification event id.
`Database`	`getDatabase(String catalogName, String name)` Get a database.
`int`	`getDatabaseCount()` Gets total number of databases.
`Database`	`getDatabaseInternal(String catalogName, String name)`
`List<String>`	`getDatabases(String catName, String pattern)` Get all database in a catalog having names that match a pattern.
`DataConnector`	`getDataConnector(String name)` Get the dataconnector with a given name, if exists.
`PrincipalPrivilegeSet`	`getDBPrivilegeSet(String catName, String dbName, String userName, List<String> groupNames)` Get privileges for a database for a user.
`List<SQLDefaultConstraint>`	`getDefaultConstraints(DefaultConstraintsRequest request)` SQLDefaultConstraint represents a single default constraint column.
`List<SQLDefaultConstraint>`	`getDefaultConstraints(String catName, String db_name, String tbl_name)` Get default values for columns in a table.
`ByteBuffer[]`	`getFileMetadata(List<Long> fileIds)`
`void`	`getFileMetadataByExpr(List<Long> fileIds, FileMetadataExprType type, byte[] expr, ByteBuffer[] metadatas, ByteBuffer[] stripeBitsets, boolean[] eliminated)` Gets file metadata from cache after applying a format-specific expression that can produce additional information based on file metadata and also filter the file list.
`FileMetadataHandler`	`getFileMetadataHandler(FileMetadataExprType type)` Gets file metadata handler for the corresponding type.
`List<SQLForeignKey>`	`getForeignKeys(ForeignKeysRequest request)` SQLForeignKey represents a single foreign key column.
`List<SQLForeignKey>`	`getForeignKeys(String catName, String parent_db_name, String parent_tbl_name, String foreign_db_name, String foreign_tbl_name)` Get the foreign keys for a table.
`Function`	`getFunction(String catName, String dbName, String funcName)` Retrieve function by name.
`List<String>`	`getFunctions(String catName, String dbName, String pattern)` Retrieve list of function names based on name pattern.
`protected List<Function>`	`getFunctionsInternal(String catalogName)`
`ISchema`	`getISchema(ISchemaName schemaName)` Get an ISchema by name.
`Database`	`getJDODatabase(String catName, String name)`
`SchemaVersion`	`getLatestSchemaVersion(ISchemaName schemaName)` Get the latest version of a schema.
`String[]`	`getMasterKeys()`
`List<String>`	`getMaterializedViewsForRewriting(String catName, String dbName)` Get list of materialized views in a database.
`List<MetadataTableSummary>`	`getMetadataSummary(String catalogFilter, String dbFilter, String tableFilter)` Using resultSet to read the HMS_SUMMARY table.
`String`	`getMetastoreDbUuid()` Gets the unique id of the backing datastore for the metadata.
`String`	`getMetaStoreSchemaVersion()`
`Optional<MScheduledQuery>`	`getMScheduledQuery(ScheduledQueryKey key)`
`NotificationEventResponse`	`getNextNotification(NotificationEventRequest rqst)` Get the next notification event.
`NotificationEventsCountResponse`	`getNotificationEventsCount(NotificationEventsCountRequest rqst)` Get the number of events corresponding to given database with fromEventId.
`List<SQLNotNullConstraint>`	`getNotNullConstraints(NotNullConstraintsRequest request)` SQLNotNullConstraint represents a single not null constraint column.
`List<SQLNotNullConstraint>`	`getNotNullConstraints(String catName, String db_name, String tbl_name)` Get not null constraints on a table.
`protected List<SQLNotNullConstraint>`	`getNotNullConstraintsInternal(String catName, String db_name_input, String tbl_name_input, boolean allowSql, boolean allowJdo)`
`int`	`getNumPartitionsByExpr(String catName, String dbName, String tblName, byte[] expr)` Get the number of partitions that match an already parsed expression.
`int`	`getNumPartitionsByFilter(String catName, String dbName, String tblName, String filter)` Get the number of partitions that match a provided SQL filter.
`int`	`getNumPartitionsByPs(String catName, String dbName, String tblName, List<String> partVals)` Get the number of partitions that match a given partial specification.
`Partition`	`getPartition(String catName, String dbName, String tableName, List<String> part_vals)` Get a partition.
`Partition`	`getPartition(String catName, String dbName, String tableName, List<String> part_vals, String validWriteIds)` Get a partition.
`List<MetaStoreServerUtils.ColStatsObjWithSourceInfo>`	`getPartitionColStatsForDatabase(String catName, String dbName)` Get column stats for all partitions of all tables in the database
`Map<String,List<String>>`	`getPartitionColsWithStats(String catName, String dbName, String tableName)`
`List<List<ColumnStatistics>>`	`getPartitionColumnStatistics(String catName, String dbName, String tableName, List<String> partNames, List<String> colNames)` Get statistics for a partition for a set of columns.
`List<ColumnStatistics>`	`getPartitionColumnStatistics(String catName, String dbName, String tableName, List<String> partNames, List<String> colNames, String engine)` Get statistics for a partition for a set of columns.
`List<ColumnStatistics>`	`getPartitionColumnStatistics(String catName, String dbName, String tableName, List<String> partNames, List<String> colNames, String engine, String writeIdList)` Get statistics for a partition for a set of columns.
`protected List<ColumnStatistics>`	`getPartitionColumnStatisticsInternal(String catName, String dbName, String tableName, List<String> partNames, List<String> colNames, String engine, boolean allowSql, boolean allowJdo)`
`int`	`getPartitionCount()` Gets total number of partitions.
`Map<String,String>`	`getPartitionLocations(String catName, String dbName, String tblName, String baseLocationToNotShow, int max)` Get the location for every partition of a given table.
`PrincipalPrivilegeSet`	`getPartitionPrivilegeSet(String catName, String dbName, String tableName, String partition, String userName, List<String> groupNames)` Get privileges for a partition for a user.
`List<Partition>`	`getPartitions(String catName, String dbName, String tableName, GetPartitionsArgs args)` Get some or all partitions for a table.
`boolean`	`getPartitionsByExpr(String catName, String dbName, String tblName, List<Partition> result, GetPartitionsArgs args)` Get partitions using an already parsed expression.
`protected boolean`	`getPartitionsByExprInternal(String catName, String dbName, String tblName, List<Partition> result, boolean allowSql, boolean allowJdo, GetPartitionsArgs args)`
`List<Partition>`	`getPartitionsByFilter(String catName, String dbName, String tblName, GetPartitionsArgs args)` Get partitions with a filter.
`protected List<Partition>`	`getPartitionsByFilterInternal(String catName, String dbName, String tblName, boolean allowSql, boolean allowJdo, GetPartitionsArgs args)`
`List<Partition>`	`getPartitionsByNames(String catName, String dbName, String tblName, GetPartitionsArgs args)` Get partitions by name.
`protected List<Partition>`	`getPartitionsByNamesInternal(String catName, String dbName, String tblName, boolean allowSql, boolean allowJdo, GetPartitionsArgs args)`
`protected List<Partition>`	`getPartitionsInternal(String catName, String dbName, String tblName, boolean allowSql, boolean allowJdo, GetPartitionsArgs args)`
`List<Partition>`	`getPartitionSpecsByFilterAndProjection(Table table, GetProjectionsSpec partitionsProjectSpec, GetPartitionsFilterSpec filterSpec)` Generic Partition request API, providing different kinds of filtering and controlling output.
`Partition`	`getPartitionWithAuth(String catName, String dbName, String tblName, List<String> partVals, String user_name, List<String> group_names)` Fetch a partition along with privilege information for a particular user.
`javax.jdo.PersistenceManager`	`getPersistenceManager()`
`List<SQLPrimaryKey>`	`getPrimaryKeys(PrimaryKeysRequest request)` SQLPrimaryKey represents a single primary key column.
`List<SQLPrimaryKey>`	`getPrimaryKeys(String catName, String db_name, String tbl_name)` Get the primary associated with a table.
`PropertyStore`	`getPropertyStore()` Persistent Property Management.
`ReplicationMetricList`	`getReplicationMetrics(GetReplicationMetricsRequest replicationMetricsRequest)` Gets the replication metrics and progress info.
`WMFullResourcePlan`	`getResourcePlan(String name, String ns)`
`Role`	`getRole(String roleName)`
`List<RuntimeStat>`	`getRuntimeStats(int maxEntries, int maxCreateTime)` Reads runtime statistic entries.
`ScheduledQuery`	`getScheduledQuery(ScheduledQueryKey key)` Returns details about a scheduled query by name.
`SchemaVersion`	`getSchemaVersion(SchemaVersionDescriptor version)` Get a specific schema version.
`List<SchemaVersion>`	`getSchemaVersionsByColumns(String colName, String colNamespace, String type)` Find all SchemaVersion objects that match a query.
`SerDeInfo`	`getSerDeInfo(String serDeName)` Get serde information.
`StoredProcedure`	`getStoredProcedure(String catName, String db, String name)`
`Table`	`getTable(String catName, String dbName, String tableName)` Get a table object.
`Table`	`getTable(String catName, String dbName, String tableName, String writeIdList)` Get a table object.
`Table`	`getTable(String catalogName, String dbName, String tableName, String writeIdList, long tableId)` Get a table object.
`List<ColumnStatistics>`	`getTableColumnStatistics(String catName, String dbName, String tableName, List<String> colNames)` Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.
`ColumnStatistics`	`getTableColumnStatistics(String catName, String dbName, String tableName, List<String> colNames, String engine)` Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.
`ColumnStatistics`	`getTableColumnStatistics(String catName, String dbName, String tableName, List<String> colNames, String engine, String writeIdList)` Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.
`protected ColumnStatistics`	`getTableColumnStatisticsInternal(String catName, String dbName, String tableName, List<String> colNames, String engine, boolean allowSql, boolean allowJdo)`
`int`	`getTableCount()` Gets total number of tables.
`List<TableMeta>`	`getTableMeta(String catName, String dbNames, String tableNames, List<String> tableTypes)`
`List<TableName>`	`getTableNamesWithStats()`
`List<Table>`	`getTableObjectsByName(String catName, String db, List<String> tbl_names)`
`List<Table>`	`getTableObjectsByName(String catName, String db, List<String> tbl_names, GetProjectionsSpec projectionSpec, String tablePattern)`
`PrincipalPrivilegeSet`	`getTablePrivilegeSet(String catName, String dbName, String tableName, String userName, List<String> groupNames)` Get privileges for a table for a user.
`List<String>`	`getTables(String catName, String dbName, String pattern)` Get table names that match a pattern.
`List<String>`	`getTables(String catName, String dbName, String pattern, TableType tableType, int limit)` Get table names that match a pattern.
`protected List<String>`	`getTablesInternal(String catName, String dbName, String pattern, TableType tableType, boolean allowSql, boolean allowJdo, int limit)`
`String`	`getToken(String tokenId)`
`List<WMTrigger>`	`getTriggersForResourcePlan(String resourcePlanName, String ns)`
`Type`	`getType(String typeName)`
`List<SQLUniqueConstraint>`	`getUniqueConstraints(String catName, String db_name, String tbl_name)` Get unique constraints associated with a table.
`List<SQLUniqueConstraint>`	`getUniqueConstraints(UniqueConstraintsRequest request)` SQLUniqueConstraint represents a single unique constraint column.
`PrincipalPrivilegeSet`	`getUserPrivilegeSet(String userName, List<String> groupNames)`
`boolean`	`grantPrivileges(PrivilegeBag privileges)`
`boolean`	`grantRole(Role role, String userName, PrincipalType principalType, String grantor, PrincipalType grantorType, boolean grantOption)`
`boolean`	`isActiveTransaction()`
`static boolean`	`isCurrentStatsValidForTheQuery(Map<String,String> statsParams, long statsWriteId, String queryValidWriteIdList, boolean isCompleteStatsWriter)`
`boolean`	`isFileMetadataSupported()`
`boolean`	`isPartitionMarkedForEvent(String catName, String dbName, String tblName, Map<String,String> partName, PartitionEventType evtType)`
`List<String>`	`isPartOfMaterializedView(String catName, String dbName, String tblName)` Checking if table is part of a materialized view.
`List<HiveObjectPrivilege>`	`listAllTableGrants(String principalName, PrincipalType principalType, String catName, String dbName, String tableName)` For a given principal name and type, list the Table Grants
`List<HiveObjectPrivilege>`	`listDBGrantsAll(String catName, String dbName)` Find all the privileges for a given database.
`List<HiveObjectPrivilege>`	`listDCGrantsAll(String dcName)` Find all the privileges for a given data connector.
`Set<String>`	`listFSRoots()` The following API - listFSRoots is used by HiveMetaTool.
`List<HiveObjectPrivilege>`	`listGlobalGrantsAll()`
`List<MRoleMap>`	`listMRoleMembers(String roleName)`
`List<MRoleMap>`	`listMRoles(String principalName, PrincipalType principalType)`
`List<String>`	`listPackages(ListPackageRequest request)`
`List<HiveObjectPrivilege>`	`listPartitionColumnGrantsAll(String catName, String dbName, String tableName, String partitionName, String columnName)` Find all of the privileges for a given column in a given partition.
`List<HiveObjectPrivilege>`	`listPartitionGrantsAll(String catName, String dbName, String tableName, String partitionName)` Find all of the privileges for a given partition.
`List<String>`	`listPartitionNames(String catName, String dbName, String tableName, short max)` Get a partial or complete list of names for partitions of a table.
`List<String>`	`listPartitionNames(String catName, String dbName, String tblName, String defaultPartName, byte[] exprBytes, String order, short maxParts)` Get a partial or complete list of names for partitions of a table.
`List<String>`	`listPartitionNamesPs(String catName, String dbName, String tableName, List<String> part_vals, short max_parts)` Lists partition names that match a given partial specification
`List<Partition>`	`listPartitionsPsWithAuth(String catName, String db_name, String tbl_name, GetPartitionsArgs args)` Lists partitions that match a given partial specification and sets their auth privileges.
`PartitionValuesResponse`	`listPartitionValues(String catName, String dbName, String tableName, List<FieldSchema> cols, boolean applyDistinct, String filter, boolean ascending, List<FieldSchema> order, long maxParts)` Get a list of partition values as one big struct.
`List<HiveObjectPrivilege>`	`listPrincipalDBGrants(String principalName, PrincipalType principalType, String catName, String dbName)` For a given principal name and type, list the DB Grants
`List<HiveObjectPrivilege>`	`listPrincipalDBGrantsAll(String principalName, PrincipalType principalType)` List all DB grants for a given principal.
`List<HiveObjectPrivilege>`	`listPrincipalDCGrants(String principalName, PrincipalType principalType, String dcName)` For a given principal name and type, list the DC Grants
`List<HiveObjectPrivilege>`	`listPrincipalDCGrantsAll(String principalName, PrincipalType principalType)` List all DC grants for a given principal.
`List<HiveObjectPrivilege>`	`listPrincipalGlobalGrants(String principalName, PrincipalType principalType)`
`List<HiveObjectPrivilege>`	`listPrincipalPartitionColumnGrants(String principalName, PrincipalType principalType, String catName, String dbName, String tableName, List<String> partValues, String partitionName, String columnName)` For a given principal name and type, list the Table Grants
`List<HiveObjectPrivilege>`	`listPrincipalPartitionColumnGrantsAll(String principalName, PrincipalType principalType)` List all Partition column grants for a given principal
`List<HiveObjectPrivilege>`	`listPrincipalPartitionGrants(String principalName, PrincipalType principalType, String catName, String dbName, String tableName, List<String> partValues, String partName)` For a given principal name and type, list the Table Grants
`List<HiveObjectPrivilege>`	`listPrincipalPartitionGrantsAll(String principalName, PrincipalType principalType)` List all Partition grants for a given principal
`List<HiveObjectPrivilege>`	`listPrincipalTableColumnGrants(String principalName, PrincipalType principalType, String catName, String dbName, String tableName, String columnName)` For a given principal name and type, list the Table Grants
`List<HiveObjectPrivilege>`	`listPrincipalTableColumnGrantsAll(String principalName, PrincipalType principalType)` List all Table column grants for a given principal
`List<HiveObjectPrivilege>`	`listPrincipalTableGrantsAll(String principalName, PrincipalType principalType)` List all Table grants for a given principal
`List<RolePrincipalGrant>`	`listRoleMembers(String roleName)` Get the role to principal grant mapping for given role
`List<String>`	`listRoleNames()`
`List<Role>`	`listRoles(String principalName, PrincipalType principalType)`
`List<RolePrincipalGrant>`	`listRolesWithGrants(String principalName, PrincipalType principalType)`
`List<HiveObjectPrivilege>`	`listTableColumnGrantsAll(String catName, String dbName, String tableName, String columnName)` Find all of the privileges for a given column in a given table.
`List<HiveObjectPrivilege>`	`listTableGrantsAll(String catName, String dbName, String tableName)` Find all of the privileges for a given table
`List<String>`	`listTableNamesByFilter(String catName, String dbName, String filter, short maxTables)` Gets a list of tables based on a filter string and filter type.
`Table`	`markPartitionForEvent(String catName, String dbName, String tblName, Map<String,String> partName, PartitionEventType evtType)`
`int`	`markScheduledExecutionsTimedOut(int timeoutSecs)`
`boolean`	`openTransaction()` Opens a new one or the one already created.
`boolean`	`openTransaction(String isolationLevel)` Opens a new one or the one already created.
`void`	`putFileMetadata(List<Long> fileIds, List<ByteBuffer> metadata, FileMetadataExprType type)`
`MMetastoreDBProperties`	`putProperties(String key, String value, String description, byte[] content)`
`boolean`	`refreshPrivileges(HiveObjectRef objToRefresh, String authorizer, PrivilegeBag grantPrivileges)`
`boolean`	`removeMasterKey(Integer id)`
`boolean`	`removeRole(String roleName)`
`boolean`	`removeToken(String tokenId)`
`boolean`	`renameProperties(String mapKey, String newKey)`
`boolean`	`revokePrivileges(PrivilegeBag privileges, boolean grantOption)`
`boolean`	`revokeRole(Role role, String userName, PrincipalType principalType, boolean grantOption)`
`void`	`rollbackTransaction()` Rolls back the current transaction if it is active
`boolean`	`runInTransaction(Runnable exec)`
`void`	`scheduledQueryDelete(ScheduledQuery scheduledQuery)`
`void`	`scheduledQueryInsert(ScheduledQuery scheduledQuery)`
`void`	`scheduledQueryMaintenance(ScheduledQueryMaintenanceRequest request)` Carries out maintenance of scheduled queries (insert/update/drop).
`ScheduledQueryPollResponse`	`scheduledQueryPoll(ScheduledQueryPollRequest request)` Checks whenever a query is available for execution.
`void`	`scheduledQueryProgress(ScheduledQueryProgressInfo info)` Registers the progress a scheduled query being executed.
`void`	`scheduledQueryUpdate(ScheduledQuery scheduledQuery)`
`<T> Map<String,T>`	`selectProperties(String key, Function<MMetastoreDBProperties,T> transform)`
`void`	`setConf(org.apache.hadoop.conf.Configuration conf)` Called whenever this object is instantiated using ReflectionUtils, and also on connection retries.
`void`	`setMetaStoreSchemaVersion(String schemaVersion, String comment)`
`static void`	`setSchemaVerified(boolean val)`
`void`	`shutdown()`
`void`	`updateCreationMetadata(String catName, String dbname, String tablename, CreationMetadata cm)` Update creation metadata for a materialized view.
`void`	`updateMasterKey(Integer id, String key)`
`ObjectStore.UpdateMDatabaseURIRetVal`	`updateMDatabaseURI(URI oldLoc, URI newLoc, boolean dryRun)` The following APIs - updateMDatabaseURI is used by HiveMetaTool.
`ObjectStore.UpdatePropURIRetVal`	`updateMStorageDescriptorTblPropURI(URI oldLoc, URI newLoc, String tblPropKey, boolean isDryRun)` Deprecated.
`ObjectStore.UpdateMStorageDescriptorTblURIRetVal`	`updateMStorageDescriptorTblURI(URI oldLoc, URI newLoc, boolean isDryRun)` The following APIs - updateMStorageDescriptorTblURI is used by HiveMetaTool.
`Map<String,String>`	`updatePartitionColumnStatistics(ColumnStatistics colStats, List<String> partVals, String validWriteIds, long writeId)` Persists the given column statistics object to the metastore
`Map<String,String>`	`updatePartitionColumnStatistics(Table table, MTable mTable, ColumnStatistics colStats, List<String> partVals, String validWriteIds, long writeId)`
`Map<String,Map<String,String>>`	`updatePartitionColumnStatisticsInBatch(Map<String,ColumnStatistics> partColStatsMap, Table tbl, List<TransactionalMetaStoreEventListener> listeners, String validWriteIds, long writeId)`
`ObjectStore.UpdateSerdeURIRetVal`	`updateSerdeURI(URI oldLoc, URI newLoc, String serdeProp, boolean isDryRun)` The following APIs - updateSerdeURI is used by HiveMetaTool.
`Map<String,String>`	`updateTableColumnStatistics(ColumnStatistics colStats, String validWriteIds, long writeId)` Persists the given column statistics object to the metastore
`ObjectStore.UpdatePropURIRetVal`	`updateTblPropURI(URI oldLoc, URI newLoc, String tblPropKey, boolean isDryRun)` The following APIs - updateMStorageDescriptorTblPropURI is used by HiveMetaTool.
`WMValidateResourcePlanResponse`	`validateResourcePlan(String name, String ns)`
`void`	`validateTableCols(Table table, List<String> colNames)`
`void`	`verifySchema()`
`static String`	`verifyStatsChangeCtx(String fullTableName, Map<String,String> oldP, Map<String,String> newP, long writeId, String validWriteIds, boolean isColStatsChange)` Verifies that the stats JSON string is unchanged for alter table (txn stats).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hive.metastore.RawStore
dropConstraint, getPartitions, getPartitionsByExpr, getPartitionsByFilter, getPartitionsByNames, getPartitionsWithAuth, listPartitionsPsWithAuth

Field Detail
- TRUSTSTORE_PATH_KEY
```
public static final String TRUSTSTORE_PATH_KEY
```
  Java system properties for configuring SSL to the database store
  
  See Also:
  
  Constant Field Values
- TRUSTSTORE_PASSWORD_KEY
```
public static final String TRUSTSTORE_PASSWORD_KEY
```
  See Also:
  
  Constant Field Values
- TRUSTSTORE_TYPE_KEY
```
public static final String TRUSTSTORE_TYPE_KEY
```
  See Also:
  
  Constant Field Values

Constructor Detail
- ObjectStore
```
public ObjectStore()
```

Method Detail

getConf
```
public org.apache.hadoop.conf.Configuration getConf()
```
Specified by:

getConf in interface org.apache.hadoop.conf.Configurable

setConf
```
public void setConf(org.apache.hadoop.conf.Configuration conf)
```
Called whenever this object is instantiated using ReflectionUtils, and also on connection retries. In cases of connection retries, conf will usually contain modified values.

Specified by:

setConf in interface org.apache.hadoop.conf.Configurable

getPropertyStore
```
public PropertyStore getPropertyStore()
```
Description copied from interface: RawStore

Persistent Property Management.

Specified by:

getPropertyStore in interface RawStore

Returns:

the property store instance

getPersistenceManager

@InterfaceAudience.LimitedPrivate(value="HCATALOG")
 @InterfaceStability.Evolving
public javax.jdo.PersistenceManager getPersistenceManager()

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface RawStore

openTransaction
```
public boolean openTransaction()
```
Opens a new one or the one already created. Every call of this function must have corresponding commit or rollback function call.

Specified by:

openTransaction in interface RawStore

Returns:

an active transaction

openTransaction
```
public boolean openTransaction(String isolationLevel)
```
Opens a new one or the one already created. Every call of this function must have corresponding commit or rollback function call.

Specified by:

openTransaction in interface RawStore

Parameters:

isolationLevel - The transaction isolation level. Only possible to set on the first call.

Returns:

an active transaction

commitTransaction
```
public boolean commitTransaction()
```
if this is the commit of the first open call then an actual commit is called.

Specified by:

commitTransaction in interface RawStore

Returns:

Always returns true

isActiveTransaction
```
public boolean isActiveTransaction()
```
Specified by:

isActiveTransaction in interface RawStore

Returns:

true if there is an active transaction. If the current transaction is either committed or rolled back it returns false

rollbackTransaction
```
public void rollbackTransaction()
```
Rolls back the current transaction if it is active

Specified by:

rollbackTransaction in interface RawStore

createCatalog
```
public void createCatalog(Catalog cat)
                   throws MetaException
```
Description copied from interface: RawStore

Create a new catalog.

Specified by:

createCatalog in interface RawStore

Parameters:

cat - Catalog to create.

Throws:

MetaException - if something goes wrong, usually in storing it to the database.

alterCatalog
```
public void alterCatalog(String catName,
                         Catalog cat)
                  throws MetaException,
                         InvalidOperationException
```
Description copied from interface: RawStore

Alter an existing catalog. Only description and location can be changed, and the change of location is for internal use only.

Specified by:

alterCatalog in interface RawStore

Parameters:

catName - name of the catalog to alter.

cat - new version of the catalog.

Throws:

MetaException - something went wrong, usually in the database.

InvalidOperationException - attempt to change something about the catalog that is not changeable, like the name.

getCatalog
```
public Catalog getCatalog(String catalogName)
                   throws NoSuchObjectException,
                          MetaException
```
Description copied from interface: RawStore

Get a catalog.

Specified by:

getCatalog in interface RawStore

Parameters:

catalogName - name of the catalog.

Returns:

The catalog.

Throws:

NoSuchObjectException - no catalog of this name exists.

MetaException - if something goes wrong, usually in reading it from the database.

getCatalogs
```
public List<String> getCatalogs()
```
Description copied from interface: RawStore

Get all the catalogs.

Specified by:

getCatalogs in interface RawStore

Returns:

list of names of all catalogs in the system

dropCatalog
```
public void dropCatalog(String catalogName)
                 throws NoSuchObjectException,
                        MetaException
```
Description copied from interface: RawStore

Drop a catalog. The catalog must be empty.

Specified by:

dropCatalog in interface RawStore

Parameters:

catalogName - name of the catalog to drop.

Throws:

NoSuchObjectException - no catalog of this name exists.

MetaException - could mean the catalog isn't empty, could mean general database error.

createDatabase
```
public void createDatabase(Database db)
                    throws InvalidObjectException,
                           MetaException
```
Description copied from interface: RawStore

Create a database.

Specified by:

createDatabase in interface RawStore

Parameters:

db - database to create.

Throws:

InvalidObjectException - not sure it actually ever throws this.

MetaException - if something goes wrong, usually in writing it to the database.

getDatabase
```
public Database getDatabase(String catalogName,
                            String name)
                     throws NoSuchObjectException
```
Description copied from interface: RawStore

Get a database.

Specified by:

getDatabase in interface RawStore

Parameters:

catalogName - catalog the database is in.

name - name of the database.

Returns:

the database.

Throws:

NoSuchObjectException - if no such database exists.

getDatabaseInternal

public Database getDatabaseInternal(String catalogName,
                                    String name)
                             throws MetaException,
                                    NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getJDODatabase

public Database getJDODatabase(String catName,
                               String name)
                        throws NoSuchObjectException

Throws:: NoSuchObjectException

alterDatabase
```
public boolean alterDatabase(String catName,
                             String dbName,
                             Database db)
                      throws MetaException,
                             NoSuchObjectException
```
Alter the database object in metastore. Currently only the parameters of the database or the owner can be changed.

Specified by:

alterDatabase in interface RawStore

Parameters:

dbName - the database name

db - the Hive Database object

catName - name of the catalog the database is in.

Returns:

true if the change succeeds, could fail due to db constraint violations.

Throws:

MetaException - something went wrong, usually with the database.

NoSuchObjectException - no database of this name exists to alter.

dropDatabase
```
public boolean dropDatabase(String catName,
                            String dbname)
                     throws NoSuchObjectException,
                            MetaException
```
Description copied from interface: RawStore

Drop a database.

Specified by:

dropDatabase in interface RawStore

Parameters:

catName - catalog the database is in.

dbname - name of the database.

Returns:

true if the database was dropped, pretty much always returns this if it returns.

Throws:

NoSuchObjectException - no database in this catalog of this name to drop

MetaException - something went wrong, usually with the database.

getDatabases
```
public List<String> getDatabases(String catName,
                                 String pattern)
                          throws MetaException
```
Description copied from interface: RawStore

Get all database in a catalog having names that match a pattern.

Specified by:

getDatabases in interface RawStore

Parameters:

catName - name of the catalog to search for databases in

pattern - pattern names should match

Returns:

list of matching database names.

Throws:

MetaException - something went wrong, usually with the database.

getAllDatabases
```
public List<String> getAllDatabases(String catName)
                             throws MetaException
```
Description copied from interface: RawStore

Get names of all the databases in a catalog.

Specified by:

getAllDatabases in interface RawStore

Parameters:

catName - name of the catalog to search for databases in

Returns:

list of names of all databases in the catalog

Throws:

MetaException - something went wrong, usually with the database.

createDataConnector
```
public void createDataConnector(DataConnector connector)
                         throws InvalidObjectException,
                                MetaException
```
Description copied from interface: RawStore

Create a dataconnector.

Specified by:

createDataConnector in interface RawStore

Parameters:

connector - dataconnector to create.

Throws:

InvalidObjectException - not sure it actually ever throws this.

MetaException - if something goes wrong, usually in writing it to the dataconnector.

getDataConnector
```
public DataConnector getDataConnector(String name)
                               throws NoSuchObjectException
```
Description copied from interface: RawStore

Get the dataconnector with a given name, if exists.

Specified by:

getDataConnector in interface RawStore

Parameters:

name - pattern names should match

Returns:

DataConnector object.

Throws:

NoSuchObjectException - something went wrong, usually with the database.

getAllDataConnectorNames
```
public List<String> getAllDataConnectorNames()
                                      throws MetaException
```
Description copied from interface: RawStore

Get names of all the databases in a catalog.

Specified by:

getAllDataConnectorNames in interface RawStore

Returns:

list of names of all dataconnectors

Throws:

MetaException - something went wrong, usually with the database.

alterDataConnector
```
public boolean alterDataConnector(String dcName,
                                  DataConnector connector)
                           throws MetaException,
                                  NoSuchObjectException
```
Alter the dataconnector object in metastore. Currently only the parameters of the dataconnector or the owner can be changed.

Specified by:

alterDataConnector in interface RawStore

Parameters:

dcName - the dataconnector name

connector - the Hive DataConnector object

Returns:

true if the change succeeds, false otherwise.

Throws:

MetaException - something went wrong, usually with the backend HMSDB.

NoSuchObjectException - no dataconnector of this name exists to alter.

dropDataConnector
```
public boolean dropDataConnector(String dcname)
                          throws NoSuchObjectException,
                                 MetaException
```
Description copied from interface: RawStore

Drop a dataconnector.

Specified by:

dropDataConnector in interface RawStore

Parameters:

dcname - name of the dataconnector.

Returns:

true if the database was dropped, pretty much always returns this if it returns.

Throws:

NoSuchObjectException - no database in this catalog of this name to drop

MetaException - something went wrong, usually with the database.

createType
```
public boolean createType(Type type)
```
Specified by:

createType in interface RawStore

getType
```
public Type getType(String typeName)
```
Specified by:

getType in interface RawStore

dropType
```
public boolean dropType(String typeName)
```
Specified by:

dropType in interface RawStore

createTableWithConstraints

public SQLAllTableConstraints createTableWithConstraints(Table tbl,
                                                         SQLAllTableConstraints constraints)
                                                  throws InvalidObjectException,
                                                         MetaException

Description copied from interface: RawStore

Create a table with constraints

Specified by:: createTableWithConstraints in interface RawStore
Parameters:: tbl - table definition; constraints - wrapper of all table constraints
Returns:: list of constraint names
Throws:: InvalidObjectException - one of the provided objects is malformed.; MetaException - error accessing the RDBMS

createTable

public void createTable(Table tbl)
                 throws InvalidObjectException,
                        MetaException

Specified by:: createTable in interface RawStore
Throws:: InvalidObjectException; MetaException

dropTable
```
public boolean dropTable(String catName,
                         String dbName,
                         String tableName)
                  throws MetaException,
                         NoSuchObjectException,
                         InvalidObjectException,
                         InvalidInputException
```
Description copied from interface: RawStore

Drop a table.

Specified by:

dropTable in interface RawStore

Parameters:

catName - catalog the table is in

dbName - database the table is in

tableName - table name

Returns:

true if the table was dropped

Throws:

MetaException - something went wrong, usually in the RDBMS or storage

NoSuchObjectException - No table of this name

InvalidObjectException - Don't think this is ever actually thrown

InvalidInputException - Don't think this is ever actually thrown

isPartOfMaterializedView
```
public List<String> isPartOfMaterializedView(String catName,
                                             String dbName,
                                             String tblName)
```
Description copied from interface: RawStore

Checking if table is part of a materialized view.

Specified by:

isPartOfMaterializedView in interface RawStore

Parameters:

catName - catalog the table is in

dbName - database the table is in

tblName - table name

Returns:

list of materialized views that uses the table

getTable
```
public Table getTable(String catName,
                      String dbName,
                      String tableName)
               throws MetaException
```
Description copied from interface: RawStore

Get a table object.

Specified by:

getTable in interface RawStore

Parameters:

catName - catalog the table is in.

dbName - database the table is in.

tableName - table name.

Returns:

table object, or null if no such table exists (wow it would be nice if we either consistently returned null or consistently threw NoSuchObjectException).

Throws:

MetaException - something went wrong in the RDBMS

getTable
```
public Table getTable(String catName,
                      String dbName,
                      String tableName,
                      String writeIdList)
               throws MetaException
```
Description copied from interface: RawStore

Get a table object.

Specified by:

getTable in interface RawStore

Parameters:

catName - catalog the table is in.

dbName - database the table is in.

tableName - table name.

writeIdList - string format of valid writeId transaction list

Returns:

table object, or null if no such table exists (wow it would be nice if we either consistently returned null or consistently threw NoSuchObjectException).

Throws:

MetaException - something went wrong in the RDBMS

getTable
```
public Table getTable(String catalogName,
                      String dbName,
                      String tableName,
                      String writeIdList,
                      long tableId)
               throws MetaException
```
Description copied from interface: RawStore

Get a table object.

Specified by:

getTable in interface RawStore

Parameters:

catalogName - catalog the table is in.

dbName - database the table is in.

tableName - table name.

writeIdList - string format of valid writeId transaction list

Returns:

table object, or null if no such table exists (wow it would be nice if we either consistently returned null or consistently threw NoSuchObjectException).

Throws:

MetaException - something went wrong in the RDBMS

getTables
```
public List<String> getTables(String catName,
                              String dbName,
                              String pattern)
                       throws MetaException
```
Description copied from interface: RawStore

Get table names that match a pattern.

Specified by:

getTables in interface RawStore

Parameters:

catName - catalog to search in

dbName - database to search in

pattern - pattern to match

Returns:

list of table names, if any

Throws:

MetaException - failure in querying the RDBMS

getTables
```
public List<String> getTables(String catName,
                              String dbName,
                              String pattern,
                              TableType tableType,
                              int limit)
                       throws MetaException
```
Description copied from interface: RawStore

Get table names that match a pattern.

Specified by:

getTables in interface RawStore

Parameters:

catName - catalog to search in

dbName - database to search in

pattern - pattern to match

tableType - type of table to look for

limit - Maximum number of tables to return (undeterministic set)

Returns:

list of table names, if any

Throws:

MetaException - failure in querying the RDBMS

getTableNamesWithStats

public List<TableName> getTableNamesWithStats()
                                       throws MetaException,
                                              NoSuchObjectException

Specified by:: getTableNamesWithStats in interface RawStore
Throws:: MetaException; NoSuchObjectException

getPartitionColsWithStats

public Map<String,List<String>> getPartitionColsWithStats(String catName,
                                                          String dbName,
                                                          String tableName)
                                                   throws MetaException,
                                                          NoSuchObjectException

Specified by:: getPartitionColsWithStats in interface RawStore
Throws:: MetaException; NoSuchObjectException

getAllTableNamesForStats

public List<TableName> getAllTableNamesForStats()
                                         throws MetaException,
                                                NoSuchObjectException

Specified by:: getAllTableNamesForStats in interface RawStore
Throws:: MetaException; NoSuchObjectException

getTablesInternal

protected List<String> getTablesInternal(String catName,
                                         String dbName,
                                         String pattern,
                                         TableType tableType,
                                         boolean allowSql,
                                         boolean allowJdo,
                                         int limit)
                                  throws MetaException,
                                         NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getAllMaterializedViewObjectsForRewriting
```
public List<Table> getAllMaterializedViewObjectsForRewriting(String catName)
                                                      throws MetaException
```
Description copied from interface: RawStore

Retrieve all materialized views.

Specified by:

getAllMaterializedViewObjectsForRewriting in interface RawStore

Returns:

all materialized views in a catalog

Throws:

MetaException - error querying the RDBMS

getMaterializedViewsForRewriting

public List<String> getMaterializedViewsForRewriting(String catName,
                                                     String dbName)
                                              throws MetaException,
                                                     NoSuchObjectException

Description copied from interface: RawStore

Get list of materialized views in a database.

Specified by:: getMaterializedViewsForRewriting in interface RawStore
Parameters:: catName - catalog name; dbName - database name
Returns:: names of all materialized views in the database
Throws:: MetaException - error querying the RDBMS; NoSuchObjectException - no such database

getDatabaseCount
```
public int getDatabaseCount()
                     throws MetaException
```
Description copied from interface: RawStore

Gets total number of databases.

Specified by:

getDatabaseCount in interface RawStore

Throws:

MetaException

getPartitionCount
```
public int getPartitionCount()
                      throws MetaException
```
Description copied from interface: RawStore

Gets total number of partitions.

Specified by:

getPartitionCount in interface RawStore

Throws:

MetaException

getTableCount
```
public int getTableCount()
                  throws MetaException
```
Description copied from interface: RawStore

Gets total number of tables.

Specified by:

getTableCount in interface RawStore

Throws:

MetaException

getTableMeta

public List<TableMeta> getTableMeta(String catName,
                                    String dbNames,
                                    String tableNames,
                                    List<String> tableTypes)
                             throws MetaException

Specified by:: getTableMeta in interface RawStore
Parameters:: catName - catalog name to search in. Search must be confined to one catalog.; dbNames - databases to search in.; tableNames - names of tables to select.; tableTypes - types of tables to look for.
Returns:: list of matching table meta information.
Throws:: MetaException - failure in querying the RDBMS.

getAllTables
```
public List<String> getAllTables(String catName,
                                 String dbName)
                          throws MetaException
```
Description copied from interface: RawStore

Get all tables in a database.

Specified by:

getAllTables in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

Returns:

list of table names

Throws:

MetaException - failure in querying the RDBMS.

getTableObjectsByName

public List<Table> getTableObjectsByName(String catName,
                                         String db,
                                         List<String> tbl_names,
                                         GetProjectionsSpec projectionSpec,
                                         String tablePattern)
                                  throws MetaException,
                                         UnknownDBException

Specified by:: getTableObjectsByName in interface RawStore
Parameters:: catName - catalog name; db - The name of the database from which to retrieve the tables; tbl_names - The names of the tables to retrieve.; projectionSpec - Projection Specification containing the columns that need to be returned.
Returns:: A list of the tables retrievable from the database whose names are in the list tableNames. If there are duplicate names, only one instance of the table will be returned
Throws:: MetaException - failure in querying the RDBMS.; UnknownDBException

getTableObjectsByName
```
public List<Table> getTableObjectsByName(String catName,
                                         String db,
                                         List<String> tbl_names)
                                  throws MetaException,
                                         UnknownDBException
```
Specified by:

getTableObjectsByName in interface RawStore

Parameters:

catName - catalog name

db - The name of the database from which to retrieve the tables

tbl_names - The names of the tables to retrieve.

Returns:

A list of the tables retrievable from the database whose names are in the list tableNames. If there are duplicate names, only one instance of the table will be returned

Throws:

MetaException - failure in querying the RDBMS.

UnknownDBException

addPartitions
```
public boolean addPartitions(String catName,
                             String dbName,
                             String tblName,
                             List<Partition> parts)
                      throws InvalidObjectException,
                             MetaException
```
Description copied from interface: RawStore

Add a list of partitions to a table.

Specified by:

addPartitions in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

parts - list of partitions to be added.

Returns:

true if the operation succeeded.

Throws:

InvalidObjectException - never throws this AFAICT

MetaException - the partitions don't belong to the indicated table or error writing to the RDBMS.

addPartitions
```
public boolean addPartitions(String catName,
                             String dbName,
                             String tblName,
                             PartitionSpecProxy partitionSpec,
                             boolean ifNotExists)
                      throws InvalidObjectException,
                             MetaException
```
Specified by:

addPartitions in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

partitionSpec - specification for the partition

ifNotExists - whether it is in an error if the partition already exists. If true, then it is not an error if the partition exists, if false, it is.

Returns:

whether the partition was created.

Throws:

InvalidObjectException - The passed in partition spec or table specification is invalid.

MetaException - error writing to RDBMS.

addPartition
```
public boolean addPartition(Partition part)
                     throws InvalidObjectException,
                            MetaException
```
Description copied from interface: RawStore

Add a partition.

Specified by:

addPartition in interface RawStore

Parameters:

part - partition to add

Returns:

true if the partition was successfully added.

Throws:

InvalidObjectException - the provided partition object is not valid.

MetaException - error writing to the RDBMS.

getPartition

public Partition getPartition(String catName,
                              String dbName,
                              String tableName,
                              List<String> part_vals)
                       throws NoSuchObjectException,
                              MetaException

Description copied from interface: RawStore

Get a partition.

Specified by:: getPartition in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; part_vals - partition values for this table.
Returns:: the partition.
Throws:: NoSuchObjectException - no partition matching this specification exists.; MetaException - error reading from RDBMS.

getPartition

public Partition getPartition(String catName,
                              String dbName,
                              String tableName,
                              List<String> part_vals,
                              String validWriteIds)
                       throws NoSuchObjectException,
                              MetaException

Description copied from interface: RawStore

Get a partition.

Specified by:: getPartition in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; part_vals - partition values for this table.; validWriteIds - string format of valid writeId transaction list
Returns:: the partition.
Throws:: NoSuchObjectException - no partition matching this specification exists.; MetaException - error reading from RDBMS.

dropPartition

public boolean dropPartition(String catName,
                             String dbName,
                             String tableName,
                             List<String> part_vals)
                      throws MetaException,
                             NoSuchObjectException,
                             InvalidObjectException,
                             InvalidInputException

Description copied from interface: RawStore

Drop a partition.

Specified by:: dropPartition in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; part_vals - list of partition values.
Returns:: true if the partition was dropped.
Throws:: MetaException - Error accessing the RDBMS.; NoSuchObjectException - no partition matching this description exists; InvalidObjectException - error dropping the statistics for the partition; InvalidInputException - error dropping the statistics for the partition

dropPartition

public boolean dropPartition(String catName,
                             String dbName,
                             String tableName,
                             String partName)
                      throws MetaException,
                             NoSuchObjectException,
                             InvalidObjectException,
                             InvalidInputException

Description copied from interface: RawStore

Drop a partition.

Specified by:: dropPartition in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partName - partition name.
Returns:: true if the partition was dropped.
Throws:: MetaException - Error accessing the RDBMS.; NoSuchObjectException - no partition matching this description exists; InvalidObjectException - error dropping the statistics for the partition; InvalidInputException - error dropping the statistics for the partition

dropPartitions

public void dropPartitions(String catName,
                           String dbName,
                           String tblName,
                           List<String> partNames)
                    throws MetaException,
                           NoSuchObjectException

Description copied from interface: RawStore

Drop a list of partitions.

Specified by:: dropPartitions in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name; partNames - list of partition names.
Throws:: MetaException - error access RDBMS or storage.; NoSuchObjectException - One or more of the partitions does not exist.

getPartitions

public List<Partition> getPartitions(String catName,
                                     String dbName,
                                     String tableName,
                                     GetPartitionsArgs args)
                              throws MetaException,
                                     NoSuchObjectException

Description copied from interface: RawStore

Get some or all partitions for a table.

Specified by:: getPartitions in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name; args - additional arguments for getting partitions
Returns:: list of partitions
Throws:: MetaException - error access the RDBMS.; NoSuchObjectException - no such table exists

getPartitionLocations
```
public Map<String,String> getPartitionLocations(String catName,
                                                String dbName,
                                                String tblName,
                                                String baseLocationToNotShow,
                                                int max)
```
Description copied from interface: RawStore

Get the location for every partition of a given table. If a partition location is a child of baseLocationToNotShow then the partitionName is returned, but the only null location is returned.

Specified by:

getPartitionLocations in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

baseLocationToNotShow - Partition locations which are child of this path are omitted, and null value returned instead.

max - The maximum number of partition locations returned, or -1 for all

Returns:

The map of the partitionName, location pairs

getPartitionsInternal

protected List<Partition> getPartitionsInternal(String catName,
                                                String dbName,
                                                String tblName,
                                                boolean allowSql,
                                                boolean allowJdo,
                                                GetPartitionsArgs args)
                                         throws MetaException,
                                                NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getPartitionWithAuth

public Partition getPartitionWithAuth(String catName,
                                      String dbName,
                                      String tblName,
                                      List<String> partVals,
                                      String user_name,
                                      List<String> group_names)
                               throws NoSuchObjectException,
                                      MetaException,
                                      InvalidObjectException

Description copied from interface: RawStore

Fetch a partition along with privilege information for a particular user.

Specified by:: getPartitionWithAuth in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; partVals - partition values; user_name - user to get privilege information for.; group_names - groups to get privilege information for.
Returns:: a partition
Throws:: NoSuchObjectException - no such partition exists; MetaException - error accessing the RDBMS.; InvalidObjectException - error fetching privilege information

listPartitionNames
```
public List<String> listPartitionNames(String catName,
                                       String dbName,
                                       String tableName,
                                       short max)
                                throws MetaException
```
Description copied from interface: RawStore

Get a partial or complete list of names for partitions of a table.

Specified by:

listPartitionNames in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tableName - table name.

max - maximum number of partitions to retrieve, -1 for all.

Returns:

list of partition names.

Throws:

MetaException - there was an error accessing the RDBMS

listPartitionNames

public List<String> listPartitionNames(String catName,
                                       String dbName,
                                       String tblName,
                                       String defaultPartName,
                                       byte[] exprBytes,
                                       String order,
                                       short maxParts)
                                throws MetaException,
                                       NoSuchObjectException

Description copied from interface: RawStore

Get a partial or complete list of names for partitions of a table.

Specified by:: listPartitionNames in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; defaultPartName - default partition name.; exprBytes - expression for filtering resulting list, serialized from ExprNodeDesc.; order - ordered the resulting list.; maxParts - maximum number of partitions to retrieve, -1 for all.
Returns:: list of partition names.
Throws:: MetaException - there was an error accessing the RDBMS; NoSuchObjectException

listPartitionValues

public PartitionValuesResponse listPartitionValues(String catName,
                                                   String dbName,
                                                   String tableName,
                                                   List<FieldSchema> cols,
                                                   boolean applyDistinct,
                                                   String filter,
                                                   boolean ascending,
                                                   List<FieldSchema> order,
                                                   long maxParts)
                                            throws MetaException

Description copied from interface: RawStore

Get a list of partition values as one big struct.

Specified by:: listPartitionValues in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; cols - partition key columns; applyDistinct - whether to apply distinct to the list; filter - filter to apply to the partition names; ascending - whether to put in ascending order; order - whether to order; maxParts - maximum number of parts to return, or -1 for all
Returns:: struct with all of the partition value information
Throws:: MetaException - error access the RDBMS

getNumPartitionsByPs
```
public int getNumPartitionsByPs(String catName,
                                String dbName,
                                String tblName,
                                List<String> partVals)
                         throws MetaException,
                                NoSuchObjectException
```
Description copied from interface: RawStore

Get the number of partitions that match a given partial specification.

Specified by:

getNumPartitionsByPs in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

partVals - A partial list of values for partitions in order of the table's partition keys. Entries can be empty if you need to specify latter partitions.

Returns:

number of matching partitions.

Throws:

MetaException - error accessing the RDBMS or working with the specification.

NoSuchObjectException - no such table.

listPartitionsPsWithAuth

public List<Partition> listPartitionsPsWithAuth(String catName,
                                                String db_name,
                                                String tbl_name,
                                                GetPartitionsArgs args)
                                         throws MetaException,
                                                InvalidObjectException,
                                                NoSuchObjectException

Description copied from interface: RawStore

Lists partitions that match a given partial specification and sets their auth privileges. If userName and groupNames null, then no auth privileges are set.

Specified by:: listPartitionsPsWithAuth in interface RawStore
Parameters:: catName - catalog name.; db_name - The name of the database which has the partitions; tbl_name - The name of the table which has the partitions; args - additional arguments for getting partitions
Returns:: A list of partitions that match the partial spec.
Throws:: MetaException - error access RDBMS; InvalidObjectException - error access privilege information; NoSuchObjectException - No such table exists

listPartitionNamesPs
```
public List<String> listPartitionNamesPs(String catName,
                                         String dbName,
                                         String tableName,
                                         List<String> part_vals,
                                         short max_parts)
                                  throws MetaException,
                                         NoSuchObjectException
```
Description copied from interface: RawStore

Lists partition names that match a given partial specification

Specified by:

listPartitionNamesPs in interface RawStore

Parameters:

catName - catalog name.

dbName - The name of the database which has the partitions

tableName - The name of the table which has the partitions

part_vals - A partial list of values for partitions in order of the table's partition keys. Entries can be empty if you only want to specify latter partitions.

max_parts - The maximum number of partitions to return

Returns:

A list of partition names that match the partial spec.

Throws:

MetaException - error accessing RDBMS

NoSuchObjectException - No such table exists

getPartitionsByNames

public List<Partition> getPartitionsByNames(String catName,
                                            String dbName,
                                            String tblName,
                                            GetPartitionsArgs args)
                                     throws MetaException,
                                            NoSuchObjectException

Description copied from interface: RawStore

Get partitions by name.

Specified by:: getPartitionsByNames in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; args - additional arguments for getting partitions
Returns:: list of matching partitions
Throws:: MetaException - error accessing the RDBMS.; NoSuchObjectException - No such table.

getPartitionsByNamesInternal

protected List<Partition> getPartitionsByNamesInternal(String catName,
                                                       String dbName,
                                                       String tblName,
                                                       boolean allowSql,
                                                       boolean allowJdo,
                                                       GetPartitionsArgs args)
                                                throws MetaException,
                                                       NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getPartitionsByExpr

public boolean getPartitionsByExpr(String catName,
                                   String dbName,
                                   String tblName,
                                   List<Partition> result,
                                   GetPartitionsArgs args)
                            throws org.apache.thrift.TException

Description copied from interface: RawStore

Get partitions using an already parsed expression.

Specified by:: getPartitionsByExpr in interface RawStore
Parameters:: catName - catalog name.; dbName - database name; tblName - table name; args - additional arguments for getting partitions
Returns:: true if the result contains unknown partitions.
Throws:: org.apache.thrift.TException - error executing the expression

getPartitionsByExprInternal

protected boolean getPartitionsByExprInternal(String catName,
                                              String dbName,
                                              String tblName,
                                              List<Partition> result,
                                              boolean allowSql,
                                              boolean allowJdo,
                                              GetPartitionsArgs args)
                                       throws org.apache.thrift.TException

Throws:: org.apache.thrift.TException

getPartitionsByFilter

public List<Partition> getPartitionsByFilter(String catName,
                                             String dbName,
                                             String tblName,
                                             GetPartitionsArgs args)
                                      throws MetaException,
                                             NoSuchObjectException

Description copied from interface: RawStore

Get partitions with a filter. This is a portion of the SQL where clause.

Specified by:: getPartitionsByFilter in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tblName - table name; args - additional arguments for getting partitions
Returns:: list of partition objects matching the criteria
Throws:: MetaException - Error accessing the RDBMS or processing the filter.; NoSuchObjectException - no such table.

getNumPartitionsByFilter

public int getNumPartitionsByFilter(String catName,
                                    String dbName,
                                    String tblName,
                                    String filter)
                             throws MetaException,
                                    NoSuchObjectException

Description copied from interface: RawStore

Get the number of partitions that match a provided SQL filter.

Specified by:: getNumPartitionsByFilter in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; filter - filter from Hive's SQL where clause
Returns:: number of matching partitions.
Throws:: MetaException - error accessing the RDBMS or executing the filter; NoSuchObjectException - no such table

getNumPartitionsByExpr
```
public int getNumPartitionsByExpr(String catName,
                                  String dbName,
                                  String tblName,
                                  byte[] expr)
                           throws MetaException,
                                  NoSuchObjectException
```
Description copied from interface: RawStore

Get the number of partitions that match an already parsed expression.

Specified by:

getNumPartitionsByExpr in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

expr - an already parsed Hive expression

Returns:

number of matching partitions.

Throws:

MetaException - error accessing the RDBMS or working with the expression.

NoSuchObjectException - no such table.

getPartitionsByFilterInternal

protected List<Partition> getPartitionsByFilterInternal(String catName,
                                                        String dbName,
                                                        String tblName,
                                                        boolean allowSql,
                                                        boolean allowJdo,
                                                        GetPartitionsArgs args)
                                                 throws MetaException,
                                                        NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getPartitionSpecsByFilterAndProjection
```
public List<Partition> getPartitionSpecsByFilterAndProjection(Table table,
                                                              GetProjectionsSpec partitionsProjectSpec,
                                                              GetPartitionsFilterSpec filterSpec)
                                                       throws MetaException,
                                                              NoSuchObjectException
```
Description copied from interface: RawStore

Generic Partition request API, providing different kinds of filtering and controlling output.

Specified by:

getPartitionSpecsByFilterAndProjection in interface RawStore

Parameters:

table - table for which whose partitions are requested * @param table table for which partitions are requested

partitionsProjectSpec - the projection spec from the GetPartitionsRequest This projection spec includes a fieldList which represents the fields which must be returned. Any other field which is not in the fieldList may be unset in the returned partitions (it is up to the implementation to decide whether it chooses to include or exclude such fields). E.g. setting the field list to sd.location, serdeInfo.name, sd.cols.name, sd.cols.type will return partitions which will have location field set in the storage descriptor. Also the serdeInf in the returned storage descriptor will only have name field set. This applies to multi-valued fields as well like sd.cols, so in the example above only name and type fields will be set for sd.cols. If the fieldList is empty or not present, all the fields will be set. Additionally, it also includes a includeParamKeyPattern and excludeParamKeyPattern which is a SQL-92 compliant regex pattern to include or exclude parameters. The paramKeyPattern supports _ or % wildcards which represent one character and 0 or more characters respectively

filterSpec - The filter spec from GetPartitionsRequest which includes the filter mode and the list of filter strings. The filter mode could be BY_NAMES, BY_VALUES or BY_EXPR to filter by partition names, partition values or expression. The filter strings are provided in the list of filters within the filterSpec. When more than one filters are provided in the list they are logically AND together

Returns:

List of matching partitions which which may be partially filled according to fieldList.

Throws:

MetaException - in case of errors

NoSuchObjectException - when table isn't found

ensureGetMTable

public MTable ensureGetMTable(String catName,
                              String dbName,
                              String tblName)
                       throws NoSuchObjectException

Gets the table object for a given table, throws if anything goes wrong.

Specified by:: ensureGetMTable in interface RawStore
Parameters:: dbName - Database name.; tblName - Table name.
Returns:: Table object.
Throws:: NoSuchObjectException

listTableNamesByFilter
```
public List<String> listTableNamesByFilter(String catName,
                                           String dbName,
                                           String filter,
                                           short maxTables)
                                    throws MetaException
```
Description copied from interface: RawStore

Gets a list of tables based on a filter string and filter type.

Specified by:

listTableNamesByFilter in interface RawStore

Parameters:

catName - catalog name

dbName - The name of the database from which you will retrieve the table names

filter - The filter string

maxTables - The maximum number of tables returned

Returns:

A list of table names that match the desired filter

Throws:

MetaException

alterTable
```
public Table alterTable(String catName,
                        String dbname,
                        String name,
                        Table newTable,
                        String queryValidWriteIds)
                 throws InvalidObjectException,
                        MetaException
```
Description copied from interface: RawStore

Alter a table.

Specified by:

alterTable in interface RawStore

Parameters:

catName - catalog the table is in.

dbname - database the table is in.

name - name of the table.

newTable - New table object. Which parts of the table can be altered are implementation specific.

Returns:

Throws:

InvalidObjectException - The new table object is invalid.

MetaException - something went wrong, usually in the RDBMS or storage.

verifyStatsChangeCtx

public static String verifyStatsChangeCtx(String fullTableName,
                                          Map<String,String> oldP,
                                          Map<String,String> newP,
                                          long writeId,
                                          String validWriteIds,
                                          boolean isColStatsChange)

Verifies that the stats JSON string is unchanged for alter table (txn stats).

Returns:: Error message with the details of the change, or null if the value has not changed.

updateCreationMetadata

public void updateCreationMetadata(String catName,
                                   String dbname,
                                   String tablename,
                                   CreationMetadata cm)
                            throws MetaException

Description copied from interface: RawStore

Update creation metadata for a materialized view.

Specified by:: updateCreationMetadata in interface RawStore
Parameters:: catName - catalog name.; dbname - database name.; tablename - table name.; cm - new creation metadata
Throws:: MetaException - error accessing the RDBMS.

alterPartition

public Partition alterPartition(String catName,
                                String dbname,
                                String name,
                                List<String> part_vals,
                                Partition newPart,
                                String validWriteIds)
                         throws InvalidObjectException,
                                MetaException

Description copied from interface: RawStore

Alter a partition.

Specified by:: alterPartition in interface RawStore
Parameters:: catName - catalog name.; dbname - database name.; name - table name.; part_vals - partition values that describe the partition.; newPart - new partition object. This should be a complete copy of the old with changes values, not just the parts to update.
Returns:
Throws:: InvalidObjectException - No such partition.; MetaException - error accessing the RDBMS.

alterPartitions
```
public List<Partition> alterPartitions(String catName,
                                       String dbName,
                                       String tblName,
                                       List<List<String>> part_vals,
                                       List<Partition> newParts,
                                       long writeId,
                                       String queryWriteIdList)
                                throws InvalidObjectException,
                                       MetaException
```
Description copied from interface: RawStore

Alter a set of partitions.

Specified by:

alterPartitions in interface RawStore

Parameters:

catName - catalog name.

dbName - database name.

tblName - table name.

part_vals - list of list of partition values. Each outer list describes one partition (with its list of partition values).

newParts - list of new partitions. The order must match the old partitions described in part_vals_list. Each of these should be a complete copy of the new partition, not just the pieces to update.

writeId - write id of the transaction for the table

queryWriteIdList - valid write id list of the transaction on the current table

Returns:

Throws:

InvalidObjectException - One of the indicated partitions does not exist.

MetaException - error accessing the RDBMS.

addForeignKeys
```
public List<SQLForeignKey> addForeignKeys(List<SQLForeignKey> fks)
                                   throws InvalidObjectException,
                                          MetaException
```
Description copied from interface: RawStore

Add a foreign key to a table.

Specified by:

addForeignKeys in interface RawStore

Parameters:

fks - foreign key specification

Returns:

foreign key name.

Throws:

InvalidObjectException - the specification is malformed.

MetaException - error accessing the RDBMS.

getMetastoreDbUuid
```
public String getMetastoreDbUuid()
                          throws MetaException
```
Description copied from interface: RawStore

Gets the unique id of the backing datastore for the metadata.

Specified by:

getMetastoreDbUuid in interface RawStore

Returns:

Throws:

MetaException

runInTransaction

public boolean runInTransaction(Runnable exec)

dropProperties

public boolean dropProperties(String key)

putProperties

public MMetastoreDBProperties putProperties(String key,
                                            String value,
                                            String description,
                                            byte[] content)

renameProperties

public boolean renameProperties(String mapKey,
                                String newKey)

fetchProperties

public <T> T fetchProperties(String key,
                             Function<MMetastoreDBProperties,T> transform)

selectProperties

public <T> Map<String,T> selectProperties(String key,
                                          Function<MMetastoreDBProperties,T> transform)

addPrimaryKeys
```
public List<SQLPrimaryKey> addPrimaryKeys(List<SQLPrimaryKey> pks)
                                   throws InvalidObjectException,
                                          MetaException
```
Description copied from interface: RawStore

Add a primary key to a table.

Specified by:

addPrimaryKeys in interface RawStore

Parameters:

pks - Columns in the primary key.

Returns:

the name of the constraint, as a list of strings.

Throws:

InvalidObjectException - The SQLPrimaryKeys list is malformed

MetaException - error accessing the RDMBS

addUniqueConstraints
```
public List<SQLUniqueConstraint> addUniqueConstraints(List<SQLUniqueConstraint> uks)
                                               throws InvalidObjectException,
                                                      MetaException
```
Description copied from interface: RawStore

Add unique constraints to a table.

Specified by:

addUniqueConstraints in interface RawStore

Parameters:

uks - unique constraints specification

Returns:

unique constraint names.

Throws:

InvalidObjectException - the specification is malformed.

MetaException - error accessing the RDBMS.

addNotNullConstraints
```
public List<SQLNotNullConstraint> addNotNullConstraints(List<SQLNotNullConstraint> nns)
                                                 throws InvalidObjectException,
                                                        MetaException
```
Description copied from interface: RawStore

Add not null constraints to a table.

Specified by:

addNotNullConstraints in interface RawStore

Parameters:

nns - not null constraint specifications

Returns:

constraint names.

Throws:

InvalidObjectException - the specification is malformed.

MetaException - error accessing the RDBMS.

addDefaultConstraints
```
public List<SQLDefaultConstraint> addDefaultConstraints(List<SQLDefaultConstraint> nns)
                                                 throws InvalidObjectException,
                                                        MetaException
```
Description copied from interface: RawStore

Add default values to a table definition.

Specified by:

addDefaultConstraints in interface RawStore

Parameters:

nns - list of default values

Returns:

constraint names

Throws:

InvalidObjectException - the specification is malformed.

MetaException - error accessing the RDBMS.

addCheckConstraints
```
public List<SQLCheckConstraint> addCheckConstraints(List<SQLCheckConstraint> nns)
                                             throws InvalidObjectException,
                                                    MetaException
```
Description copied from interface: RawStore

Add check constraints to a table.

Specified by:

addCheckConstraints in interface RawStore

Parameters:

nns - check constraints to add

Returns:

list of constraint names

Throws:

InvalidObjectException - the specification is malformed

MetaException - error accessing the RDBMS

addRole

public boolean addRole(String roleName,
                       String ownerName)
                throws InvalidObjectException,
                       MetaException,
                       NoSuchObjectException

Specified by:: addRole in interface RawStore
Throws:: InvalidObjectException; MetaException; NoSuchObjectException

grantRole

public boolean grantRole(Role role,
                         String userName,
                         PrincipalType principalType,
                         String grantor,
                         PrincipalType grantorType,
                         boolean grantOption)
                  throws MetaException,
                         NoSuchObjectException,
                         InvalidObjectException

Specified by:: grantRole in interface RawStore
Throws:: MetaException; NoSuchObjectException; InvalidObjectException

revokeRole

public boolean revokeRole(Role role,
                          String userName,
                          PrincipalType principalType,
                          boolean grantOption)
                   throws MetaException,
                          NoSuchObjectException

Specified by:: revokeRole in interface RawStore
Throws:: MetaException; NoSuchObjectException

removeRole

public boolean removeRole(String roleName)
                   throws MetaException,
                          NoSuchObjectException

Specified by:: removeRole in interface RawStore
Throws:: MetaException; NoSuchObjectException

listMRoles

public List<MRoleMap> listMRoles(String principalName,
                                 PrincipalType principalType)

listRoles

public List<Role> listRoles(String principalName,
                            PrincipalType principalType)

Specified by:: listRoles in interface RawStore

listRolesWithGrants

public List<RolePrincipalGrant> listRolesWithGrants(String principalName,
                                                    PrincipalType principalType)

Specified by:: listRolesWithGrants in interface RawStore

getRole

public Role getRole(String roleName)
             throws NoSuchObjectException

Specified by:: getRole in interface RawStore
Throws:: NoSuchObjectException

listRoleNames
```
public List<String> listRoleNames()
```
Specified by:

listRoleNames in interface RawStore

getUserPrivilegeSet

public PrincipalPrivilegeSet getUserPrivilegeSet(String userName,
                                                 List<String> groupNames)
                                          throws InvalidObjectException,
                                                 MetaException

Specified by:: getUserPrivilegeSet in interface RawStore
Throws:: InvalidObjectException; MetaException

getDBPrivilegeSet

public PrincipalPrivilegeSet getDBPrivilegeSet(String catName,
                                               String dbName,
                                               String userName,
                                               List<String> groupNames)
                                        throws InvalidObjectException,
                                               MetaException

Description copied from interface: RawStore

Get privileges for a database for a user.

Specified by:: getDBPrivilegeSet in interface RawStore
Parameters:: catName - catalog name; dbName - database name; userName - user name; groupNames - list of groups the user is in
Returns:: privileges for that user on indicated database
Throws:: InvalidObjectException - no such database; MetaException - error accessing the RDBMS

getConnectorPrivilegeSet

public PrincipalPrivilegeSet getConnectorPrivilegeSet(String catName,
                                                      String connectorName,
                                                      String userName,
                                                      List<String> groupNames)
                                               throws InvalidObjectException,
                                                      MetaException

Description copied from interface: RawStore

Get privileges for a connector for a user.

Specified by:: getConnectorPrivilegeSet in interface RawStore
Parameters:: catName - catalog name; connectorName - connector name; userName - user name; groupNames - list of groups the user is in
Returns:: privileges for that user on indicated connector
Throws:: InvalidObjectException - no such database; MetaException - error accessing the RDBMS

getPartitionPrivilegeSet

public PrincipalPrivilegeSet getPartitionPrivilegeSet(String catName,
                                                      String dbName,
                                                      String tableName,
                                                      String partition,
                                                      String userName,
                                                      List<String> groupNames)
                                               throws InvalidObjectException,
                                                      MetaException

Description copied from interface: RawStore

Get privileges for a partition for a user.

Specified by:: getPartitionPrivilegeSet in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; partition - partition name; userName - user name; groupNames - list of groups the user is in
Returns:: privileges for that user on indicated partition
Throws:: InvalidObjectException - no such partition; MetaException - error accessing the RDBMS

getTablePrivilegeSet

public PrincipalPrivilegeSet getTablePrivilegeSet(String catName,
                                                  String dbName,
                                                  String tableName,
                                                  String userName,
                                                  List<String> groupNames)
                                           throws InvalidObjectException,
                                                  MetaException

Description copied from interface: RawStore

Get privileges for a table for a user.

Specified by:: getTablePrivilegeSet in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; userName - user name; groupNames - list of groups the user is in
Returns:: privileges for that user on indicated table
Throws:: InvalidObjectException - no such table; MetaException - error accessing the RDBMS

getColumnPrivilegeSet

public PrincipalPrivilegeSet getColumnPrivilegeSet(String catName,
                                                   String dbName,
                                                   String tableName,
                                                   String partitionName,
                                                   String columnName,
                                                   String userName,
                                                   List<String> groupNames)
                                            throws InvalidObjectException,
                                                   MetaException

Description copied from interface: RawStore

Get privileges for a column in a table or partition for a user.

Specified by:: getColumnPrivilegeSet in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; partitionName - partition name, or null for table level column permissions; columnName - column name; userName - user name; groupNames - list of groups the user is in
Returns:: privileges for that user on indicated column in the table or partition
Throws:: InvalidObjectException - no such table, partition, or column; MetaException - error accessing the RDBMS

grantPrivileges

public boolean grantPrivileges(PrivilegeBag privileges)
                        throws InvalidObjectException,
                               MetaException,
                               NoSuchObjectException

Specified by:: grantPrivileges in interface RawStore
Throws:: InvalidObjectException; MetaException; NoSuchObjectException

revokePrivileges

public boolean revokePrivileges(PrivilegeBag privileges,
                                boolean grantOption)
                         throws InvalidObjectException,
                                MetaException,
                                NoSuchObjectException

Specified by:: revokePrivileges in interface RawStore
Throws:: InvalidObjectException; MetaException; NoSuchObjectException

refreshPrivileges

public boolean refreshPrivileges(HiveObjectRef objToRefresh,
                                 String authorizer,
                                 PrivilegeBag grantPrivileges)
                          throws InvalidObjectException,
                                 MetaException,
                                 NoSuchObjectException

Specified by:: refreshPrivileges in interface RawStore
Throws:: InvalidObjectException; MetaException; NoSuchObjectException

listMRoleMembers

public List<MRoleMap> listMRoleMembers(String roleName)

listRoleMembers
```
public List<RolePrincipalGrant> listRoleMembers(String roleName)
```
Description copied from interface: RawStore

Get the role to principal grant mapping for given role

Specified by:

listRoleMembers in interface RawStore

Returns:

listPrincipalGlobalGrants

public List<HiveObjectPrivilege> listPrincipalGlobalGrants(String principalName,
                                                           PrincipalType principalType)

Specified by:: listPrincipalGlobalGrants in interface RawStore

listGlobalGrantsAll
```
public List<HiveObjectPrivilege> listGlobalGrantsAll()
```
Specified by:

listGlobalGrantsAll in interface RawStore

listPrincipalDBGrants

public List<HiveObjectPrivilege> listPrincipalDBGrants(String principalName,
                                                       PrincipalType principalType,
                                                       String catName,
                                                       String dbName)

Description copied from interface: RawStore

For a given principal name and type, list the DB Grants

Specified by:: listPrincipalDBGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; catName - catalog name; dbName - database name
Returns:: list of privileges for that principal on the specified database.

listPrincipalDBGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalDBGrantsAll(String principalName,
                                                          PrincipalType principalType)
```
Description copied from interface: RawStore

List all DB grants for a given principal.

Specified by:

listPrincipalDBGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all DB grants for this principal

listDBGrantsAll
```
public List<HiveObjectPrivilege> listDBGrantsAll(String catName,
                                                 String dbName)
```
Description copied from interface: RawStore

Find all the privileges for a given database.

Specified by:

listDBGrantsAll in interface RawStore

Parameters:

catName - catalog name

dbName - database name

Returns:

list of all privileges.

listPrincipalDCGrants

public List<HiveObjectPrivilege> listPrincipalDCGrants(String principalName,
                                                       PrincipalType principalType,
                                                       String dcName)

Description copied from interface: RawStore

For a given principal name and type, list the DC Grants

Specified by:: listPrincipalDCGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; dcName - data connector name
Returns:: list of privileges for that principal on the specified data connector.

listPrincipalDCGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalDCGrantsAll(String principalName,
                                                          PrincipalType principalType)
```
Description copied from interface: RawStore

List all DC grants for a given principal.

Specified by:

listPrincipalDCGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all DC grants for this principal

listDCGrantsAll
```
public List<HiveObjectPrivilege> listDCGrantsAll(String dcName)
```
Description copied from interface: RawStore

Find all the privileges for a given data connector.

Specified by:

listDCGrantsAll in interface RawStore

Parameters:

dcName - data connector name

Returns:

list of all privileges.

listAllTableGrants

public List<HiveObjectPrivilege> listAllTableGrants(String principalName,
                                                    PrincipalType principalType,
                                                    String catName,
                                                    String dbName,
                                                    String tableName)

Description copied from interface: RawStore

For a given principal name and type, list the Table Grants

Specified by:: listAllTableGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; catName - catalog name; dbName - database name; tableName - table name
Returns:: list of privileges for that principal on the specified database.

listPrincipalPartitionGrants

public List<HiveObjectPrivilege> listPrincipalPartitionGrants(String principalName,
                                                              PrincipalType principalType,
                                                              String catName,
                                                              String dbName,
                                                              String tableName,
                                                              List<String> partValues,
                                                              String partName)

Description copied from interface: RawStore

For a given principal name and type, list the Table Grants

Specified by:: listPrincipalPartitionGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; catName - catalog name; dbName - database name; tableName - table name; partName - partition name (not value)
Returns:: list of privileges for that principal on the specified database.

listPrincipalTableColumnGrants

public List<HiveObjectPrivilege> listPrincipalTableColumnGrants(String principalName,
                                                                PrincipalType principalType,
                                                                String catName,
                                                                String dbName,
                                                                String tableName,
                                                                String columnName)

Description copied from interface: RawStore

For a given principal name and type, list the Table Grants

Specified by:: listPrincipalTableColumnGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; catName - catalog name; dbName - database name; tableName - table name; columnName - column name
Returns:: list of privileges for that principal on the specified database.

listPrincipalPartitionColumnGrants

public List<HiveObjectPrivilege> listPrincipalPartitionColumnGrants(String principalName,
                                                                    PrincipalType principalType,
                                                                    String catName,
                                                                    String dbName,
                                                                    String tableName,
                                                                    List<String> partValues,
                                                                    String partitionName,
                                                                    String columnName)

Description copied from interface: RawStore

For a given principal name and type, list the Table Grants

Specified by:: listPrincipalPartitionColumnGrants in interface RawStore
Parameters:: principalName - principal name; principalType - type; catName - catalog name; dbName - database name; tableName - table name; partitionName - partition name (not value); columnName - column name
Returns:: list of privileges for that principal on the specified database.

listPrincipalPartitionColumnGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalPartitionColumnGrantsAll(String principalName,
                                                                       PrincipalType principalType)
```
Description copied from interface: RawStore

List all Partition column grants for a given principal

Specified by:

listPrincipalPartitionColumnGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all Partition column grants for this principal

listPartitionColumnGrantsAll

public List<HiveObjectPrivilege> listPartitionColumnGrantsAll(String catName,
                                                              String dbName,
                                                              String tableName,
                                                              String partitionName,
                                                              String columnName)

Description copied from interface: RawStore

Find all of the privileges for a given column in a given partition.

Specified by:: listPartitionColumnGrantsAll in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; partitionName - partition name (not value); columnName - column name
Returns:: all privileges on this column in this partition

listPrincipalTableGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalTableGrantsAll(String principalName,
                                                             PrincipalType principalType)
```
Description copied from interface: RawStore

List all Table grants for a given principal

Specified by:

listPrincipalTableGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all Table grants for this principal

listTableGrantsAll

public List<HiveObjectPrivilege> listTableGrantsAll(String catName,
                                                    String dbName,
                                                    String tableName)

Description copied from interface: RawStore

Find all of the privileges for a given table

Specified by:: listTableGrantsAll in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name
Returns:: all privileges on this table

listPrincipalPartitionGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalPartitionGrantsAll(String principalName,
                                                                 PrincipalType principalType)
```
Description copied from interface: RawStore

List all Partition grants for a given principal

Specified by:

listPrincipalPartitionGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all Partition grants for this principal

listPartitionGrantsAll

public List<HiveObjectPrivilege> listPartitionGrantsAll(String catName,
                                                        String dbName,
                                                        String tableName,
                                                        String partitionName)

Description copied from interface: RawStore

Find all of the privileges for a given partition.

Specified by:: listPartitionGrantsAll in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; partitionName - partition name (not value)
Returns:: all privileges on this partition

listPrincipalTableColumnGrantsAll
```
public List<HiveObjectPrivilege> listPrincipalTableColumnGrantsAll(String principalName,
                                                                   PrincipalType principalType)
```
Description copied from interface: RawStore

List all Table column grants for a given principal

Specified by:

listPrincipalTableColumnGrantsAll in interface RawStore

Parameters:

principalName - principal name

principalType - type

Returns:

all Table column grants for this principal

listTableColumnGrantsAll

public List<HiveObjectPrivilege> listTableColumnGrantsAll(String catName,
                                                          String dbName,
                                                          String tableName,
                                                          String columnName)

Description copied from interface: RawStore

Find all of the privileges for a given column in a given table.

Specified by:: listTableColumnGrantsAll in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; columnName - column name
Returns:: all privileges on this column in this table

isPartitionMarkedForEvent

public boolean isPartitionMarkedForEvent(String catName,
                                         String dbName,
                                         String tblName,
                                         Map<String,String> partName,
                                         PartitionEventType evtType)
                                  throws UnknownTableException,
                                         MetaException,
                                         InvalidPartitionException,
                                         UnknownPartitionException

Specified by:: isPartitionMarkedForEvent in interface RawStore
Throws:: UnknownTableException; MetaException; InvalidPartitionException; UnknownPartitionException

markPartitionForEvent

public Table markPartitionForEvent(String catName,
                                   String dbName,
                                   String tblName,
                                   Map<String,String> partName,
                                   PartitionEventType evtType)
                            throws MetaException,
                                   UnknownTableException,
                                   InvalidPartitionException,
                                   UnknownPartitionException

Specified by:: markPartitionForEvent in interface RawStore
Throws:: MetaException; UnknownTableException; InvalidPartitionException; UnknownPartitionException

executeJDOQLSelect
```
public Collection<?> executeJDOQLSelect(String queryStr)
                                 throws Exception
```
The following API - executeJDOQLSelect is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

Throws:

Exception

executeJDOQLUpdate
```
public long executeJDOQLUpdate(String queryStr)
                        throws Exception
```
The following API - executeJDOQLUpdate is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

Throws:

Exception

listFSRoots
```
public Set<String> listFSRoots()
```
The following API - listFSRoots is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

updateMDatabaseURI

public ObjectStore.UpdateMDatabaseURIRetVal updateMDatabaseURI(URI oldLoc,
                                                               URI newLoc,
                                                               boolean dryRun)

The following APIs - updateMDatabaseURI is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

updateTblPropURI

public ObjectStore.UpdatePropURIRetVal updateTblPropURI(URI oldLoc,
                                                        URI newLoc,
                                                        String tblPropKey,
                                                        boolean isDryRun)

The following APIs - updateMStorageDescriptorTblPropURI is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

updateMStorageDescriptorTblPropURI

@Deprecated
public ObjectStore.UpdatePropURIRetVal updateMStorageDescriptorTblPropURI(URI oldLoc,
                                                                                      URI newLoc,
                                                                                      String tblPropKey,
                                                                                      boolean isDryRun)

Deprecated.

The following APIs - updateMStorageDescriptorTblPropURI is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

updateMStorageDescriptorTblURI

public ObjectStore.UpdateMStorageDescriptorTblURIRetVal updateMStorageDescriptorTblURI(URI oldLoc,
                                                                                       URI newLoc,
                                                                                       boolean isDryRun)

The following APIs - updateMStorageDescriptorTblURI is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

updateSerdeURI

public ObjectStore.UpdateSerdeURIRetVal updateSerdeURI(URI oldLoc,
                                                       URI newLoc,
                                                       String serdeProp,
                                                       boolean isDryRun)

The following APIs - updateSerdeURI is used by HiveMetaTool. This API **shouldn't** be exposed via Thrift.

getMetadataSummary

public List<MetadataTableSummary> getMetadataSummary(String catalogFilter,
                                                     String dbFilter,
                                                     String tableFilter)
                                              throws SQLException

Using resultSet to read the HMS_SUMMARY table.

Parameters:: catalogFilter - the optional catalog name filter; dbFilter - the optional database name filter; tableFilter - the optional table name filter
Returns:: MetadataSummary
Throws:: SQLException

updateTableColumnStatistics

public Map<String,String> updateTableColumnStatistics(ColumnStatistics colStats,
                                                      String validWriteIds,
                                                      long writeId)
                                               throws NoSuchObjectException,
                                                      MetaException,
                                                      InvalidObjectException,
                                                      InvalidInputException

Description copied from interface: RawStore

Persists the given column statistics object to the metastore

Specified by:: updateTableColumnStatistics in interface RawStore
Parameters:: colStats - object to persist
Returns:: Boolean indicating the outcome of the operation
Throws:: NoSuchObjectException - No such table.; MetaException - error accessing the RDBMS.; InvalidObjectException - the stats object is invalid; InvalidInputException - unable to record the stats for the table

updatePartitionColumnStatistics

public Map<String,String> updatePartitionColumnStatistics(Table table,
                                                          MTable mTable,
                                                          ColumnStatistics colStats,
                                                          List<String> partVals,
                                                          String validWriteIds,
                                                          long writeId)
                                                   throws MetaException,
                                                          NoSuchObjectException,
                                                          InvalidObjectException,
                                                          InvalidInputException

Specified by:: updatePartitionColumnStatistics in interface RawStore
Throws:: MetaException; NoSuchObjectException; InvalidObjectException; InvalidInputException

updatePartitionColumnStatistics

public Map<String,String> updatePartitionColumnStatistics(ColumnStatistics colStats,
                                                          List<String> partVals,
                                                          String validWriteIds,
                                                          long writeId)
                                                   throws MetaException,
                                                          NoSuchObjectException,
                                                          InvalidObjectException,
                                                          InvalidInputException

Description copied from interface: RawStore

Persists the given column statistics object to the metastore

Specified by:: updatePartitionColumnStatistics in interface RawStore
Parameters:: colStats - object to persist; partVals - partition values to persist the stats for
Returns:: Boolean indicating the outcome of the operation
Throws:: MetaException - error accessing the RDBMS.; NoSuchObjectException - No such table.; InvalidObjectException - the stats object is invalid; InvalidInputException - unable to record the stats for the table

updatePartitionColumnStatisticsInBatch

public Map<String,Map<String,String>> updatePartitionColumnStatisticsInBatch(Map<String,ColumnStatistics> partColStatsMap,
                                                                             Table tbl,
                                                                             List<TransactionalMetaStoreEventListener> listeners,
                                                                             String validWriteIds,
                                                                             long writeId)
                                                                      throws NoSuchObjectException,
                                                                             MetaException,
                                                                             InvalidObjectException,
                                                                             InvalidInputException

Specified by:: updatePartitionColumnStatisticsInBatch in interface RawStore
Throws:: NoSuchObjectException; MetaException; InvalidObjectException; InvalidInputException

validateTableCols

public void validateTableCols(Table table,
                              List<String> colNames)
                       throws MetaException

Throws:: MetaException

getTableColumnStatistics

public List<ColumnStatistics> getTableColumnStatistics(String catName,
                                                       String dbName,
                                                       String tableName,
                                                       List<String> colNames)
                                                throws MetaException,
                                                       NoSuchObjectException

Description copied from interface: RawStore

Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.

Specified by:: getTableColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - name of the database, defaults to current database; tableName - name of the table; colNames - names of the columns for which statistics is requested
Returns:: Relevant column statistics for the column for the given table
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - No such table

getTableColumnStatistics

public ColumnStatistics getTableColumnStatistics(String catName,
                                                 String dbName,
                                                 String tableName,
                                                 List<String> colNames,
                                                 String engine)
                                          throws MetaException,
                                                 NoSuchObjectException

Description copied from interface: RawStore

Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.

Specified by:: getTableColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - name of the database, defaults to current database; tableName - name of the table; colNames - names of the columns for which statistics is requested; engine - engine requesting the statistics
Returns:: Relevant column statistics for the column for the given table
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - No such table

getTableColumnStatistics

public ColumnStatistics getTableColumnStatistics(String catName,
                                                 String dbName,
                                                 String tableName,
                                                 List<String> colNames,
                                                 String engine,
                                                 String writeIdList)
                                          throws MetaException,
                                                 NoSuchObjectException

Description copied from interface: RawStore

Returns the relevant column statistics for a given column in a given table in a given database if such statistics exist.

Specified by:: getTableColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - name of the database, defaults to current database; tableName - name of the table; colNames - names of the columns for which statistics is requested; engine - engine requesting the statistics; writeIdList - string format of valid writeId transaction list
Returns:: Relevant column statistics for the column for the given table
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - No such table

getTableColumnStatisticsInternal

protected ColumnStatistics getTableColumnStatisticsInternal(String catName,
                                                            String dbName,
                                                            String tableName,
                                                            List<String> colNames,
                                                            String engine,
                                                            boolean allowSql,
                                                            boolean allowJdo)
                                                     throws MetaException,
                                                            NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getPartitionColumnStatistics

public List<List<ColumnStatistics>> getPartitionColumnStatistics(String catName,
                                                                 String dbName,
                                                                 String tableName,
                                                                 List<String> partNames,
                                                                 List<String> colNames)
                                                          throws MetaException,
                                                                 NoSuchObjectException

Description copied from interface: RawStore

Get statistics for a partition for a set of columns.

Specified by:: getPartitionColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partNames - list of partition names. These are names so must be key1=val1[/key2=val2...]; colNames - list of columns to get stats for
Returns:: list of statistics objects
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - no such partition.

getPartitionColumnStatistics

public List<ColumnStatistics> getPartitionColumnStatistics(String catName,
                                                           String dbName,
                                                           String tableName,
                                                           List<String> partNames,
                                                           List<String> colNames,
                                                           String engine)
                                                    throws MetaException,
                                                           NoSuchObjectException

Description copied from interface: RawStore

Get statistics for a partition for a set of columns.

Specified by:: getPartitionColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partNames - list of partition names. These are names so must be key1=val1[/key2=val2...]; colNames - list of columns to get stats for; engine - engine requesting the statistics
Returns:: list of statistics objects
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - no such partition.

getPartitionColumnStatistics

public List<ColumnStatistics> getPartitionColumnStatistics(String catName,
                                                           String dbName,
                                                           String tableName,
                                                           List<String> partNames,
                                                           List<String> colNames,
                                                           String engine,
                                                           String writeIdList)
                                                    throws MetaException,
                                                           NoSuchObjectException

Description copied from interface: RawStore

Get statistics for a partition for a set of columns.

Specified by:: getPartitionColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partNames - list of partition names. These are names so must be key1=val1[/key2=val2...]; colNames - list of columns to get stats for; engine - engine requesting the statistics; writeIdList - string format of valid writeId transaction list
Returns:: list of statistics objects
Throws:: MetaException - error accessing the RDBMS; NoSuchObjectException - no such partition.

getPartitionColumnStatisticsInternal

protected List<ColumnStatistics> getPartitionColumnStatisticsInternal(String catName,
                                                                      String dbName,
                                                                      String tableName,
                                                                      List<String> partNames,
                                                                      List<String> colNames,
                                                                      String engine,
                                                                      boolean allowSql,
                                                                      boolean allowJdo)
                                                               throws MetaException,
                                                                      NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

get_aggr_stats_for

public AggrStats get_aggr_stats_for(String catName,
                                    String dbName,
                                    String tblName,
                                    List<String> partNames,
                                    List<String> colNames,
                                    String engine,
                                    String writeIdList)
                             throws MetaException,
                                    NoSuchObjectException

Description copied from interface: RawStore

Get aggregated stats for a table or partition(s).

Specified by:: get_aggr_stats_for in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; partNames - list of partition names. These are the names of the partitions, not values.; colNames - list of column names; engine - engine requesting the statistics; writeIdList - string format of valid writeId transaction list
Returns:: aggregated stats
Throws:: MetaException - error accessing RDBMS; NoSuchObjectException - no such table or partition

get_aggr_stats_for

public AggrStats get_aggr_stats_for(String catName,
                                    String dbName,
                                    String tblName,
                                    List<String> partNames,
                                    List<String> colNames,
                                    String engine)
                             throws MetaException,
                                    NoSuchObjectException

Description copied from interface: RawStore

Get aggregated stats for a table or partition(s).

Specified by:: get_aggr_stats_for in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tblName - table name.; partNames - list of partition names. These are the names of the partitions, not values.; colNames - list of column names; engine - engine requesting the statistics
Returns:: aggregated stats
Throws:: MetaException - error accessing RDBMS; NoSuchObjectException - no such table or partition

getPartitionColStatsForDatabase

public List<MetaStoreServerUtils.ColStatsObjWithSourceInfo> getPartitionColStatsForDatabase(String catName,
                                                                                            String dbName)
                                                                                     throws MetaException,
                                                                                            NoSuchObjectException

Description copied from interface: RawStore

Get column stats for all partitions of all tables in the database

Specified by:: getPartitionColStatsForDatabase in interface RawStore
Parameters:: catName - catalog name; dbName - database name
Returns:: List of column stats objects for all partitions of all tables in the database
Throws:: MetaException - error accessing RDBMS; NoSuchObjectException - no such database

flushCache
```
public void flushCache()
```
Specified by:

flushCache in interface RawStore

deleteAllPartitionColumnStatistics

public void deleteAllPartitionColumnStatistics(TableName tn,
                                               String writeIdList)

Specified by:: deleteAllPartitionColumnStatistics in interface RawStore

deletePartitionColumnStatistics

public boolean deletePartitionColumnStatistics(String catName,
                                               String dbName,
                                               String tableName,
                                               String partName,
                                               List<String> partVals,
                                               String colName,
                                               String engine)
                                        throws NoSuchObjectException,
                                               MetaException,
                                               InvalidObjectException,
                                               InvalidInputException

Description copied from interface: RawStore

Deletes column statistics if present associated with a given db, table, partition and col. If null is passed instead of a colName, stats when present for all columns associated with a given db, table and partition are deleted.

Specified by:: deletePartitionColumnStatistics in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partName - partition name.; partVals - partition values.; colName - column name.; engine - engine for which we want to delete statistics
Returns:: Boolean indicating the outcome of the operation
Throws:: NoSuchObjectException - no such partition; MetaException - error access the RDBMS; InvalidObjectException - error dropping the stats; InvalidInputException - bad input, such as null table or database name.

deleteTableColumnStatistics

public boolean deleteTableColumnStatistics(String catName,
                                           String dbName,
                                           String tableName,
                                           String colName,
                                           String engine)
                                    throws NoSuchObjectException,
                                           MetaException,
                                           InvalidObjectException,
                                           InvalidInputException

Description copied from interface: RawStore

Delete statistics for a single column or all columns in a table.

Specified by:: deleteTableColumnStatistics in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tableName - table name; colName - column name. Null to delete stats for all columns in the table.; engine - engine for which we want to delete statistics
Returns:: true if the statistics were deleted.
Throws:: NoSuchObjectException - no such table or column.; MetaException - error access the RDBMS.; InvalidObjectException - error dropping the stats; InvalidInputException - bad inputs, such as null table name.

cleanupEvents
```
public long cleanupEvents()
```
Specified by:

cleanupEvents in interface RawStore

addToken

public boolean addToken(String tokenId,
                        String delegationToken)

Specified by:: addToken in interface RawStore

removeToken
```
public boolean removeToken(String tokenId)
```
Specified by:

removeToken in interface RawStore

getToken
```
public String getToken(String tokenId)
```
Specified by:

getToken in interface RawStore

getAllTokenIdentifiers
```
public List<String> getAllTokenIdentifiers()
```
Specified by:

getAllTokenIdentifiers in interface RawStore

addMasterKey

public int addMasterKey(String key)
                 throws MetaException

Specified by:: addMasterKey in interface RawStore
Throws:: MetaException

updateMasterKey

public void updateMasterKey(Integer id,
                            String key)
                     throws NoSuchObjectException,
                            MetaException

Specified by:: updateMasterKey in interface RawStore
Throws:: NoSuchObjectException; MetaException

removeMasterKey
```
public boolean removeMasterKey(Integer id)
```
Specified by:

removeMasterKey in interface RawStore

getMasterKeys
```
public String[] getMasterKeys()
```
Specified by:

getMasterKeys in interface RawStore

verifySchema
```
public void verifySchema()
                  throws MetaException
```
Specified by:

verifySchema in interface RawStore

Throws:

MetaException

setSchemaVerified

public static void setSchemaVerified(boolean val)

getMetaStoreSchemaVersion
```
public String getMetaStoreSchemaVersion()
                                 throws MetaException
```
Specified by:

getMetaStoreSchemaVersion in interface RawStore

Throws:

MetaException

setMetaStoreSchemaVersion

public void setMetaStoreSchemaVersion(String schemaVersion,
                                      String comment)
                               throws MetaException

Specified by:: setMetaStoreSchemaVersion in interface RawStore
Throws:: MetaException

doesPartitionExist

public boolean doesPartitionExist(String catName,
                                  String dbName,
                                  String tableName,
                                  List<FieldSchema> partKeys,
                                  List<String> partVals)
                           throws MetaException

Description copied from interface: RawStore

Check whether a partition exists.

Specified by:: doesPartitionExist in interface RawStore
Parameters:: catName - catalog name.; dbName - database name.; tableName - table name.; partKeys - list of partition keys used to generate the partition name.; partVals - list of partition values.
Returns:: true if the partition exists, false otherwise.
Throws:: MetaException - failure reading RDBMS

createFunction
```
public void createFunction(Function func)
                    throws InvalidObjectException,
                           MetaException
```
Description copied from interface: RawStore

Register a user-defined function based on the function specification passed in.

Specified by:

createFunction in interface RawStore

Parameters:

func - function to create

Throws:

InvalidObjectException - incorrectly specified function

MetaException - error accessing the RDBMS

alterFunction

public void alterFunction(String catName,
                          String dbName,
                          String funcName,
                          Function newFunction)
                   throws InvalidObjectException,
                          MetaException

Description copied from interface: RawStore

Alter function based on new function specs.

Specified by:: alterFunction in interface RawStore; dbName - database name; funcName - function name; newFunction - new function specification
Throws:: InvalidObjectException - no such function, or incorrectly specified new function; MetaException - incorrectly specified function

dropFunction

public void dropFunction(String catName,
                         String dbName,
                         String funcName)
                  throws MetaException,
                         NoSuchObjectException,
                         InvalidObjectException,
                         InvalidInputException

Description copied from interface: RawStore

Drop a function definition.

Specified by:: dropFunction in interface RawStore; dbName - database name; funcName - function name
Throws:: MetaException - incorrectly specified function; NoSuchObjectException - no such function; InvalidObjectException - not sure when this is thrown; InvalidInputException - not sure when this is thrown

getFunction

public Function getFunction(String catName,
                            String dbName,
                            String funcName)
                     throws MetaException

Description copied from interface: RawStore

Retrieve function by name.

Specified by:: getFunction in interface RawStore; dbName - database name; funcName - function name
Returns:: the function
Throws:: MetaException - incorrectly specified function

getAllFunctions
```
public List<Function> getAllFunctions(String catName)
                               throws MetaException
```
Description copied from interface: RawStore

Retrieve all functions.

Specified by:

getAllFunctions in interface RawStore

Returns:

all functions in a catalog

Throws:

MetaException - incorrectly specified function

getFunctionsInternal

protected List<Function> getFunctionsInternal(String catalogName)
                                       throws MetaException,
                                              NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getFunctions
```
public List<String> getFunctions(String catName,
                                 String dbName,
                                 String pattern)
                          throws MetaException
```
Description copied from interface: RawStore

Retrieve list of function names based on name pattern.

Specified by:

getFunctions in interface RawStore

dbName - database name

pattern - pattern to match

Returns:

functions that match the pattern

Throws:

MetaException - incorrectly specified function

createOrUpdateStoredProcedure

public void createOrUpdateStoredProcedure(StoredProcedure proc)
                                   throws NoSuchObjectException,
                                          MetaException

Specified by:: createOrUpdateStoredProcedure in interface RawStore
Throws:: NoSuchObjectException; MetaException

getStoredProcedure

public StoredProcedure getStoredProcedure(String catName,
                                          String db,
                                          String name)
                                   throws MetaException

Specified by:: getStoredProcedure in interface RawStore
Throws:: MetaException

dropStoredProcedure

public void dropStoredProcedure(String catName,
                                String dbName,
                                String funcName)
                         throws MetaException

Specified by:: dropStoredProcedure in interface RawStore
Throws:: MetaException

getAllStoredProcedures

public List<String> getAllStoredProcedures(ListStoredProcedureRequest request)

Specified by:: getAllStoredProcedures in interface RawStore

addPackage

public void addPackage(AddPackageRequest request)
                throws NoSuchObjectException,
                       MetaException

Specified by:: addPackage in interface RawStore
Throws:: NoSuchObjectException; MetaException

findPackage

public Package findPackage(GetPackageRequest request)

Specified by:: findPackage in interface RawStore

listPackages

public List<String> listPackages(ListPackageRequest request)

Specified by:: listPackages in interface RawStore

dropPackage

public void dropPackage(DropPackageRequest request)

Specified by:: dropPackage in interface RawStore

getNextNotification
```
public NotificationEventResponse getNextNotification(NotificationEventRequest rqst)
```
Description copied from interface: RawStore

Get the next notification event.

Specified by:

getNextNotification in interface RawStore

Parameters:

rqst - Request containing information on the last processed notification.

Returns:

list of notifications, sorted by eventId

cleanWriteNotificationEvents
```
public void cleanWriteNotificationEvents(int olderThan)
```
Description copied from interface: RawStore

Remove older notification events.

Specified by:

cleanWriteNotificationEvents in interface RawStore

Parameters:

olderThan - Remove any events older or equal to a given number of seconds

getAllWriteEventInfo

public List<WriteEventInfo> getAllWriteEventInfo(long txnId,
                                                 String dbName,
                                                 String tableName)
                                          throws MetaException

Description copied from interface: RawStore

Get all write events for a specific transaction .

Specified by:: getAllWriteEventInfo in interface RawStore
Parameters:: txnId - get all the events done by this transaction; dbName - the name of db for which dump is being taken; tableName - the name of the table for which the dump is being taken
Throws:: MetaException

addNotificationEvent
```
public void addNotificationEvent(NotificationEvent entry)
                          throws MetaException
```
Description copied from interface: RawStore

Add a notification entry. This should only be called from inside the metastore

Specified by:

addNotificationEvent in interface RawStore

Parameters:

entry - the notification to add

Throws:

MetaException - error accessing RDBMS

cleanNotificationEvents
```
public void cleanNotificationEvents(int olderThan)
```
Description copied from interface: RawStore

Remove older notification events.

Specified by:

cleanNotificationEvents in interface RawStore

Parameters:

olderThan - Remove any events older or equal to a given number of seconds

getCurrentNotificationEventId
```
public CurrentNotificationEventId getCurrentNotificationEventId()
```
Description copied from interface: RawStore

Get the last issued notification event id. This is intended for use by the export command so that users can determine the state of the system at the point of the export, and determine which notification events happened before or after the export.

Specified by:

getCurrentNotificationEventId in interface RawStore

Returns:

getNotificationEventsCount
```
public NotificationEventsCountResponse getNotificationEventsCount(NotificationEventsCountRequest rqst)
```
Description copied from interface: RawStore

Get the number of events corresponding to given database with fromEventId. This is intended for use by the repl commands to track the progress of incremental dump.

Specified by:

getNotificationEventsCount in interface RawStore

Returns:

isFileMetadataSupported
```
public boolean isFileMetadataSupported()
```
Specified by:

isFileMetadataSupported in interface RawStore

Returns:

Whether file metadata cache is supported by this implementation.

getFileMetadata
```
public ByteBuffer[] getFileMetadata(List<Long> fileIds)
```
Specified by:

getFileMetadata in interface RawStore

Parameters:

fileIds - List of file IDs from the filesystem.

Returns:

File metadata buffers from file metadata cache. The array is fileIds-sized, and the entries (or nulls, if metadata is not in cache) correspond to fileIds in the list

putFileMetadata
```
public void putFileMetadata(List<Long> fileIds,
                            List<ByteBuffer> metadata,
                            FileMetadataExprType type)
```
Specified by:

putFileMetadata in interface RawStore

Parameters:

fileIds - List of file IDs from the filesystem.

metadata - Metadata buffers corresponding to fileIds in the list.

type - The type; determines the class that can do additional processing for metadata.

getFileMetadataByExpr
```
public void getFileMetadataByExpr(List<Long> fileIds,
                                  FileMetadataExprType type,
                                  byte[] expr,
                                  ByteBuffer[] metadatas,
                                  ByteBuffer[] stripeBitsets,
                                  boolean[] eliminated)
```
Description copied from interface: RawStore

Gets file metadata from cache after applying a format-specific expression that can produce additional information based on file metadata and also filter the file list.

Specified by:

getFileMetadataByExpr in interface RawStore

Parameters:

fileIds - List of file IDs from the filesystem.

type - Expression type; used to determine the class that handles the metadata.

expr - Format-specific serialized expression applicable to the files' metadatas.

metadatas - Output parameter; fileIds-sized array to receive the metadatas for corresponding files, if any.

stripeBitsets - Output parameter; fileIds-sized array to receive the format-specific expression results for the corresponding files.

eliminated - Output parameter; fileIds-sized array to receive the indication of whether the corresponding files are entirely eliminated by the expression.

getFileMetadataHandler
```
public FileMetadataHandler getFileMetadataHandler(FileMetadataExprType type)
```
Description copied from interface: RawStore

Gets file metadata handler for the corresponding type.

Specified by:

getFileMetadataHandler in interface RawStore

getPrimaryKeys
```
public List<SQLPrimaryKey> getPrimaryKeys(String catName,
                                          String db_name,
                                          String tbl_name)
                                   throws MetaException
```
Description copied from interface: RawStore

Get the primary associated with a table. Strangely enough each SQLPrimaryKey is actually a column in they key, not the key itself. Thus the list.

Specified by:

getPrimaryKeys in interface RawStore

Parameters:

catName - catalog name

db_name - database name

tbl_name - table name

Returns:

list of primary key columns or an empty list if the table does not have a primary key

Throws:

MetaException - error accessing the RDBMS

getPrimaryKeys
```
public List<SQLPrimaryKey> getPrimaryKeys(PrimaryKeysRequest request)
                                   throws MetaException
```
Description copied from interface: RawStore

SQLPrimaryKey represents a single primary key column. Since a table can have one or more primary keys ( in case of composite primary key ), this method returns List<SQLPrimaryKey>

Specified by:

getPrimaryKeys in interface RawStore

Parameters:

request - primary key request

Returns:

list of primary key columns or an empty list if the table does not have a primary key

Throws:

MetaException - error accessing the RDBMS

getForeignKeys
```
public List<SQLForeignKey> getForeignKeys(String catName,
                                          String parent_db_name,
                                          String parent_tbl_name,
                                          String foreign_db_name,
                                          String foreign_tbl_name)
                                   throws MetaException
```
Description copied from interface: RawStore

Get the foreign keys for a table. All foreign keys for a particular table can be fetched by passing null for the last two arguments.

Specified by:

getForeignKeys in interface RawStore

Parameters:

catName - catalog name.

parent_db_name - Database the table referred to is in. This can be null to match all databases.

parent_tbl_name - Table that is referred to. This can be null to match all tables.

foreign_db_name - Database the table with the foreign key is in.

foreign_tbl_name - Table with the foreign key.

Returns:

List of all matching foreign key columns. Note that if more than one foreign key matches the arguments the results here will be all mixed together into a single list.

Throws:

MetaException - error access the RDBMS.

getForeignKeys
```
public List<SQLForeignKey> getForeignKeys(ForeignKeysRequest request)
                                   throws MetaException
```
Description copied from interface: RawStore

SQLForeignKey represents a single foreign key column. Since a table can have one or more foreign keys ( in case of composite foreign key ), this method returns List<SQLForeignKey>

Specified by:

getForeignKeys in interface RawStore

Parameters:

request - ForeignKeysRequest object

Returns:

List of all matching foreign key columns. Note that if more than one foreign key matches the arguments the results here will be all mixed together into a single list.

Throws:

MetaException - error access the RDBMS.

getUniqueConstraints

public List<SQLUniqueConstraint> getUniqueConstraints(String catName,
                                                      String db_name,
                                                      String tbl_name)
                                               throws MetaException

Description copied from interface: RawStore

Get unique constraints associated with a table.

Specified by:: getUniqueConstraints in interface RawStore
Parameters:: catName - catalog name.; db_name - database name.; tbl_name - table name.
Returns:: list of unique constraints
Throws:: MetaException - error access the RDBMS.

getUniqueConstraints
```
public List<SQLUniqueConstraint> getUniqueConstraints(UniqueConstraintsRequest request)
                                               throws MetaException
```
Description copied from interface: RawStore

SQLUniqueConstraint represents a single unique constraint column. Since a table can have one or more unique constraint ( in case of composite unique constraint ), this method returns List<SQLUniqueConstraint>

Specified by:

getUniqueConstraints in interface RawStore

Parameters:

request - UniqueConstraintsRequest object.

Returns:

list of unique constraints

Throws:

MetaException - error access the RDBMS.

getNotNullConstraints

public List<SQLNotNullConstraint> getNotNullConstraints(String catName,
                                                        String db_name,
                                                        String tbl_name)
                                                 throws MetaException

Description copied from interface: RawStore

Get not null constraints on a table.

Specified by:: getNotNullConstraints in interface RawStore
Parameters:: catName - catalog name.; db_name - database name.; tbl_name - table name.
Returns:: list of not null constraints
Throws:: MetaException - error accessing the RDBMS.

getNotNullConstraints
```
public List<SQLNotNullConstraint> getNotNullConstraints(NotNullConstraintsRequest request)
                                                 throws MetaException
```
Description copied from interface: RawStore

SQLNotNullConstraint represents a single not null constraint column. Since a table can have one or more not null constraint ( in case of composite not null constraint ), this method returns List<SQLNotNullConstraint>

Specified by:

getNotNullConstraints in interface RawStore

Parameters:

request - NotNullConstraintsRequest object.

Returns:

list of not null constraints

Throws:

MetaException - error accessing the RDBMS.

getDefaultConstraints

public List<SQLDefaultConstraint> getDefaultConstraints(String catName,
                                                        String db_name,
                                                        String tbl_name)
                                                 throws MetaException

Description copied from interface: RawStore

Get default values for columns in a table.

Specified by:: getDefaultConstraints in interface RawStore
Parameters:: catName - catalog name; db_name - database name; tbl_name - table name
Returns:: list of default values defined on the table.
Throws:: MetaException - error accessing the RDBMS

getDefaultConstraints
```
public List<SQLDefaultConstraint> getDefaultConstraints(DefaultConstraintsRequest request)
                                                 throws MetaException
```
Description copied from interface: RawStore

SQLDefaultConstraint represents a single default constraint column. Since a table can have one or more default constraint ( in case of composite default constraint ), this method returns List<SQLDefaultConstraint>

Specified by:

getDefaultConstraints in interface RawStore

Parameters:

request - DefaultConstraintsRequest object.

Returns:

list of default values defined on the table.

Throws:

MetaException - error accessing the RDBMS

getCheckConstraints

public List<SQLCheckConstraint> getCheckConstraints(String catName,
                                                    String db_name,
                                                    String tbl_name)
                                             throws MetaException

Description copied from interface: RawStore

Get check constraints for columns in a table.

Specified by:: getCheckConstraints in interface RawStore
Parameters:: catName - catalog name.; db_name - database name; tbl_name - table name
Returns:: ccheck constraints for this table
Throws:: MetaException - error accessing the RDBMS

getCheckConstraints
```
public List<SQLCheckConstraint> getCheckConstraints(CheckConstraintsRequest request)
                                             throws MetaException
```
Description copied from interface: RawStore

SQLCheckConstraint represents a single check constraint column. Since a table can have one or more check constraint ( in case of composite check constraint ), this method returns List<SQLCheckConstraint>

Specified by:

getCheckConstraints in interface RawStore

Parameters:

request - CheckConstraintsRequest object.

Returns:

ccheck constraints for this table

Throws:

MetaException - error accessing the RDBMS

getCheckConstraintsInternal

protected List<SQLCheckConstraint> getCheckConstraintsInternal(String catName,
                                                               String db_name_input,
                                                               String tbl_name_input,
                                                               boolean allowSql,
                                                               boolean allowJdo)
                                                        throws MetaException,
                                                               NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getNotNullConstraintsInternal

protected List<SQLNotNullConstraint> getNotNullConstraintsInternal(String catName,
                                                                   String db_name_input,
                                                                   String tbl_name_input,
                                                                   boolean allowSql,
                                                                   boolean allowJdo)
                                                            throws MetaException,
                                                                   NoSuchObjectException

Throws:: MetaException; NoSuchObjectException

getAllTableConstraints

@Deprecated
public SQLAllTableConstraints getAllTableConstraints(String catName,
                                                                 String dbName,
                                                                 String tblName)
                                                          throws MetaException,
                                                                 NoSuchObjectException

Deprecated.

Api to fetch all constraints at once

Specified by:: getAllTableConstraints in interface RawStore
Parameters:: catName - catalog name; dbName - database name; tblName - table name
Returns:: list of all constraint for a given table
Throws:: MetaException; NoSuchObjectException

getAllTableConstraints

public SQLAllTableConstraints getAllTableConstraints(AllTableConstraintsRequest request)
                                              throws MetaException,
                                                     NoSuchObjectException

Api to fetch all constraints at once

Specified by:: getAllTableConstraints in interface RawStore
Parameters:: request - request object
Returns:: all table constraints
Throws:: MetaException; NoSuchObjectException

dropConstraint
```
public void dropConstraint(String catName,
                           String dbName,
                           String tableName,
                           String constraintName,
                           boolean missingOk)
                    throws NoSuchObjectException
```
Description copied from interface: RawStore

Drop a constraint, any constraint. I have no idea why add and get each have separate methods for each constraint type but drop has only one.

Specified by:

dropConstraint in interface RawStore

Parameters:

catName - catalog name

dbName - database name

tableName - table name

constraintName - name of the constraint

missingOk - if true, it is not an error if there is no constraint of this name. If false and there is no constraint of this name an exception will be thrown.

Throws:

NoSuchObjectException - no constraint of this name exists and missingOk = false

createISchema
```
public void createISchema(ISchema schema)
                   throws AlreadyExistsException,
                          MetaException,
                          NoSuchObjectException
```
Description copied from interface: RawStore

Create a new ISchema.

Specified by:

createISchema in interface RawStore

Parameters:

schema - schema to create

Throws:

AlreadyExistsException - there's already a schema with this name

MetaException - general database exception

NoSuchObjectException

alterISchema
```
public void alterISchema(ISchemaName schemaName,
                         ISchema newSchema)
                  throws NoSuchObjectException,
                         MetaException
```
Description copied from interface: RawStore

Alter an existing ISchema. This assumes the caller has already checked that such a schema. exists.

Specified by:

alterISchema in interface RawStore

Parameters:

schemaName - name of the schema

newSchema - new schema object

Throws:

NoSuchObjectException - no function with this name exists

MetaException - general database exception

getISchema
```
public ISchema getISchema(ISchemaName schemaName)
                   throws MetaException
```
Description copied from interface: RawStore

Get an ISchema by name.

Specified by:

getISchema in interface RawStore

Parameters:

schemaName - schema descriptor

Returns:

ISchema

Throws:

MetaException - general database exception

dropISchema
```
public void dropISchema(ISchemaName schemaName)
                 throws NoSuchObjectException,
                        MetaException
```
Description copied from interface: RawStore

Drop an ISchema. This does not check whether there are valid versions of the schema in existence, it assumes the caller has already done that.

Specified by:

dropISchema in interface RawStore

Parameters:

schemaName - schema descriptor

Throws:

NoSuchObjectException - no schema of this name exists

MetaException - general database exception

addSchemaVersion
```
public void addSchemaVersion(SchemaVersion schemaVersion)
                      throws AlreadyExistsException,
                             NoSuchObjectException,
                             MetaException
```
Description copied from interface: RawStore

Create a new version of an existing schema.

Specified by:

addSchemaVersion in interface RawStore

Parameters:

schemaVersion - version number

Throws:

AlreadyExistsException - a version of the schema with the same version number already exists.

NoSuchObjectException - no schema with the passed in name exists.

MetaException - general database exception

alterSchemaVersion
```
public void alterSchemaVersion(SchemaVersionDescriptor version,
                               SchemaVersion newVersion)
                        throws NoSuchObjectException,
                               MetaException
```
Description copied from interface: RawStore

Alter a schema version. Note that the Thrift interface only supports changing the serde mapping and states. This method does not guarantee it will check anymore than that. This method does not understand the state transitions and just assumes that the new state it is passed is reasonable.

Specified by:

alterSchemaVersion in interface RawStore

Parameters:

version - version descriptor for the schema

newVersion - altered SchemaVersion

Throws:

NoSuchObjectException - no such version of the named schema exists

MetaException - general database exception

getSchemaVersion
```
public SchemaVersion getSchemaVersion(SchemaVersionDescriptor version)
                               throws MetaException
```
Description copied from interface: RawStore

Get a specific schema version.

Specified by:

getSchemaVersion in interface RawStore

Parameters:

version - version descriptor for the schema

Returns:

the SchemaVersion

Throws:

MetaException - general database exception

getLatestSchemaVersion
```
public SchemaVersion getLatestSchemaVersion(ISchemaName schemaName)
                                     throws MetaException
```
Description copied from interface: RawStore

Get the latest version of a schema.

Specified by:

getLatestSchemaVersion in interface RawStore

Parameters:

schemaName - name of the schema

Returns:

latest version of the schema

Throws:

MetaException - general database exception

getAllSchemaVersion
```
public List<SchemaVersion> getAllSchemaVersion(ISchemaName schemaName)
                                        throws MetaException
```
Description copied from interface: RawStore

Get all of the versions of a schema.

Specified by:

getAllSchemaVersion in interface RawStore

Parameters:

schemaName - name of the schema

Returns:

all versions of the schema

Throws:

MetaException - general database exception

getSchemaVersionsByColumns
```
public List<SchemaVersion> getSchemaVersionsByColumns(String colName,
                                                      String colNamespace,
                                                      String type)
                                               throws MetaException
```
Description copied from interface: RawStore

Find all SchemaVersion objects that match a query. The query will select all SchemaVersions that are equal to all of the non-null passed in arguments. That is, if arguments colName='name', colNamespace=null, type='string' are passed in, then all schemas that have a column with colName 'name' and type 'string' will be returned.

Specified by:

getSchemaVersionsByColumns in interface RawStore

Parameters:

colName - column name. Null is ok, which will cause this field to not be used in the query.

colNamespace - column namespace. Null is ok, which will cause this field to not be used in the query.

type - column type. Null is ok, which will cause this field to not be used in the query.

Returns:

List of all SchemaVersions that match. Note that there is no expectation that these SchemaVersions derive from the same ISchema. The list will be empty if there are no matching SchemaVersions.

Throws:

MetaException - general database exception

dropSchemaVersion
```
public void dropSchemaVersion(SchemaVersionDescriptor version)
                       throws NoSuchObjectException,
                              MetaException
```
Description copied from interface: RawStore

Drop a version of the schema.

Specified by:

dropSchemaVersion in interface RawStore

Parameters:

version - version descriptor for the schema

Throws:

NoSuchObjectException - no such version of the named schema exists

MetaException - general database exception

getSerDeInfo
```
public SerDeInfo getSerDeInfo(String serDeName)
                       throws NoSuchObjectException,
                              MetaException
```
Description copied from interface: RawStore

Get serde information.

Specified by:

getSerDeInfo in interface RawStore

Parameters:

serDeName - name of the SerDe

Returns:

the SerDe, or null if there is no such serde

Throws:

NoSuchObjectException - no serde with this name exists

MetaException - general database exception

addSerde
```
public void addSerde(SerDeInfo serde)
              throws AlreadyExistsException,
                     MetaException
```
Description copied from interface: RawStore

Add a serde.

Specified by:

addSerde in interface RawStore

Parameters:

serde - serde to add

Throws:

AlreadyExistsException - a serde of this name already exists

MetaException - general database exception

createResourcePlan

public void createResourcePlan(WMResourcePlan resourcePlan,
                               String copyFromName,
                               int defaultPoolSize)
                        throws AlreadyExistsException,
                               InvalidObjectException,
                               MetaException,
                               NoSuchObjectException

Specified by:: createResourcePlan in interface RawStore
Throws:: AlreadyExistsException; InvalidObjectException; MetaException; NoSuchObjectException

getResourcePlan

public WMFullResourcePlan getResourcePlan(String name,
                                          String ns)
                                   throws NoSuchObjectException

Specified by:: getResourcePlan in interface RawStore
Throws:: NoSuchObjectException

getAllResourcePlans

public List<WMResourcePlan> getAllResourcePlans(String ns)
                                         throws MetaException

Specified by:: getAllResourcePlans in interface RawStore
Throws:: MetaException

alterResourcePlan

public WMFullResourcePlan alterResourcePlan(String name,
                                            String ns,
                                            WMNullableResourcePlan changes,
                                            boolean canActivateDisabled,
                                            boolean canDeactivate,
                                            boolean isReplace)
                                     throws AlreadyExistsException,
                                            NoSuchObjectException,
                                            InvalidOperationException,
                                            MetaException

Specified by:: alterResourcePlan in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

getActiveResourcePlan

public WMFullResourcePlan getActiveResourcePlan(String ns)
                                         throws MetaException

Specified by:: getActiveResourcePlan in interface RawStore
Throws:: MetaException

validateResourcePlan

public WMValidateResourcePlanResponse validateResourcePlan(String name,
                                                           String ns)
                                                    throws NoSuchObjectException,
                                                           InvalidObjectException,
                                                           MetaException

Specified by:: validateResourcePlan in interface RawStore
Throws:: NoSuchObjectException; InvalidObjectException; MetaException

dropResourcePlan

public void dropResourcePlan(String name,
                             String ns)
                      throws NoSuchObjectException,
                             MetaException

Specified by:: dropResourcePlan in interface RawStore
Throws:: NoSuchObjectException; MetaException

createWMTrigger

public void createWMTrigger(WMTrigger trigger)
                     throws AlreadyExistsException,
                            NoSuchObjectException,
                            InvalidOperationException,
                            MetaException

Specified by:: createWMTrigger in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

alterWMTrigger

public void alterWMTrigger(WMTrigger trigger)
                    throws NoSuchObjectException,
                           InvalidOperationException,
                           MetaException

Specified by:: alterWMTrigger in interface RawStore
Throws:: NoSuchObjectException; InvalidOperationException; MetaException

dropWMTrigger

public void dropWMTrigger(String resourcePlanName,
                          String triggerName,
                          String ns)
                   throws NoSuchObjectException,
                          InvalidOperationException,
                          MetaException

Specified by:: dropWMTrigger in interface RawStore
Throws:: NoSuchObjectException; InvalidOperationException; MetaException

getTriggersForResourcePlan

public List<WMTrigger> getTriggersForResourcePlan(String resourcePlanName,
                                                  String ns)
                                           throws NoSuchObjectException,
                                                  MetaException

Specified by:: getTriggersForResourcePlan in interface RawStore
Throws:: NoSuchObjectException; MetaException

createPool

public void createPool(WMPool pool)
                throws AlreadyExistsException,
                       NoSuchObjectException,
                       InvalidOperationException,
                       MetaException

Specified by:: createPool in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

alterPool

public void alterPool(WMNullablePool pool,
                      String poolPath)
               throws AlreadyExistsException,
                      NoSuchObjectException,
                      InvalidOperationException,
                      MetaException

Specified by:: alterPool in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

dropWMPool

public void dropWMPool(String resourcePlanName,
                       String poolPath,
                       String ns)
                throws NoSuchObjectException,
                       InvalidOperationException,
                       MetaException

Specified by:: dropWMPool in interface RawStore
Throws:: NoSuchObjectException; InvalidOperationException; MetaException

createOrUpdateWMMapping

public void createOrUpdateWMMapping(WMMapping mapping,
                                    boolean update)
                             throws AlreadyExistsException,
                                    NoSuchObjectException,
                                    InvalidOperationException,
                                    MetaException

Specified by:: createOrUpdateWMMapping in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

dropWMMapping

public void dropWMMapping(WMMapping mapping)
                   throws NoSuchObjectException,
                          InvalidOperationException,
                          MetaException

Specified by:: dropWMMapping in interface RawStore
Throws:: NoSuchObjectException; InvalidOperationException; MetaException

createWMTriggerToPoolMapping

public void createWMTriggerToPoolMapping(String resourcePlanName,
                                         String triggerName,
                                         String poolPath,
                                         String ns)
                                  throws AlreadyExistsException,
                                         NoSuchObjectException,
                                         InvalidOperationException,
                                         MetaException

Specified by:: createWMTriggerToPoolMapping in interface RawStore
Throws:: AlreadyExistsException; NoSuchObjectException; InvalidOperationException; MetaException

dropWMTriggerToPoolMapping

public void dropWMTriggerToPoolMapping(String resourcePlanName,
                                       String triggerName,
                                       String poolPath,
                                       String ns)
                                throws NoSuchObjectException,
                                       InvalidOperationException,
                                       MetaException

Specified by:: dropWMTriggerToPoolMapping in interface RawStore
Throws:: NoSuchObjectException; InvalidOperationException; MetaException

addRuntimeStat
```
public void addRuntimeStat(RuntimeStat stat)
                    throws MetaException
```
Description copied from interface: RawStore

Adds a RuntimeStat for persistence.

Specified by:

addRuntimeStat in interface RawStore

Throws:

MetaException

deleteRuntimeStats
```
public int deleteRuntimeStats(int maxRetainSecs)
                       throws MetaException
```
Description copied from interface: RawStore

Removes outdated statistics.

Specified by:

deleteRuntimeStats in interface RawStore

Throws:

MetaException

getRuntimeStats

public List<RuntimeStat> getRuntimeStats(int maxEntries,
                                         int maxCreateTime)
                                  throws MetaException

Description copied from interface: RawStore

Reads runtime statistic entries.

Specified by:: getRuntimeStats in interface RawStore
Throws:: MetaException

isCurrentStatsValidForTheQuery

public static boolean isCurrentStatsValidForTheQuery(Map<String,String> statsParams,
                                                     long statsWriteId,
                                                     String queryValidWriteIdList,
                                                     boolean isCompleteStatsWriter)
                                              throws MetaException

Throws:: MetaException

scheduledQueryPoll
```
public ScheduledQueryPollResponse scheduledQueryPoll(ScheduledQueryPollRequest request)
                                              throws MetaException
```
Description copied from interface: RawStore

Checks whenever a query is available for execution.

Specified by:

scheduledQueryPoll in interface RawStore

Returns:

optionally a scheduled query to be processed.

Throws:

MetaException

scheduledQueryProgress

public void scheduledQueryProgress(ScheduledQueryProgressInfo info)
                            throws InvalidOperationException,
                                   MetaException

Description copied from interface: RawStore

Registers the progress a scheduled query being executed.

Specified by:: scheduledQueryProgress in interface RawStore
Throws:: InvalidOperationException; MetaException

addReplicationMetrics
```
public void addReplicationMetrics(ReplicationMetricList replicationMetricList)
```
Description copied from interface: RawStore

Add the replication metrics and progress info.

Specified by:

addReplicationMetrics in interface RawStore

getReplicationMetrics
```
public ReplicationMetricList getReplicationMetrics(GetReplicationMetricsRequest replicationMetricsRequest)
```
Description copied from interface: RawStore

Gets the replication metrics and progress info.

Specified by:

getReplicationMetrics in interface RawStore

deleteReplicationMetrics
```
public int deleteReplicationMetrics(int maxRetainSecs)
```
Specified by:

deleteReplicationMetrics in interface RawStore

scheduledQueryMaintenance

public void scheduledQueryMaintenance(ScheduledQueryMaintenanceRequest request)
                               throws MetaException,
                                      NoSuchObjectException,
                                      AlreadyExistsException,
                                      InvalidInputException

Description copied from interface: RawStore

Carries out maintenance of scheduled queries (insert/update/drop).

Specified by:: scheduledQueryMaintenance in interface RawStore
Throws:: MetaException; NoSuchObjectException; AlreadyExistsException; InvalidInputException

scheduledQueryInsert

public void scheduledQueryInsert(ScheduledQuery scheduledQuery)
                          throws NoSuchObjectException,
                                 AlreadyExistsException,
                                 InvalidInputException

Throws:: NoSuchObjectException; AlreadyExistsException; InvalidInputException

scheduledQueryDelete

public void scheduledQueryDelete(ScheduledQuery scheduledQuery)
                          throws NoSuchObjectException,
                                 AlreadyExistsException

Throws:: NoSuchObjectException; AlreadyExistsException

scheduledQueryUpdate

public void scheduledQueryUpdate(ScheduledQuery scheduledQuery)
                          throws NoSuchObjectException,
                                 AlreadyExistsException,
                                 InvalidInputException

Throws:: NoSuchObjectException; AlreadyExistsException; InvalidInputException

getScheduledQuery
```
public ScheduledQuery getScheduledQuery(ScheduledQueryKey key)
                                 throws NoSuchObjectException
```
Description copied from interface: RawStore

Returns details about a scheduled query by name.

Specified by:

getScheduledQuery in interface RawStore

Throws:

NoSuchObjectException - if an object by the given name dosen't exists.

getMScheduledQuery

public Optional<MScheduledQuery> getMScheduledQuery(ScheduledQueryKey key)

deleteScheduledExecutions
```
public int deleteScheduledExecutions(int maxRetainSecs)
```
Specified by:

deleteScheduledExecutions in interface RawStore

markScheduledExecutionsTimedOut

public int markScheduledExecutionsTimedOut(int timeoutSecs)
                                    throws InvalidOperationException,
                                           MetaException

Specified by:: markScheduledExecutionsTimedOut in interface RawStore
Throws:: InvalidOperationException; MetaException

Class ObjectStore

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hive.metastore.RawStore

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.hive.metastore.RawStore

Field Detail

TRUSTSTORE_PATH_KEY

TRUSTSTORE_PASSWORD_KEY

TRUSTSTORE_TYPE_KEY

Constructor Detail

ObjectStore

Method Detail

getConf

setConf

getPropertyStore

getPersistenceManager

shutdown

openTransaction

openTransaction

commitTransaction

isActiveTransaction

rollbackTransaction

createCatalog

alterCatalog

getCatalog

getCatalogs

dropCatalog

createDatabase

getDatabase

getDatabaseInternal

getJDODatabase

alterDatabase

dropDatabase

getDatabases

getAllDatabases

createDataConnector

getDataConnector

getAllDataConnectorNames

alterDataConnector

dropDataConnector

createType

getType

dropType

createTableWithConstraints

createTable

dropTable

isPartOfMaterializedView

getTable

getTable

getTable

getTables

getTables

getTableNamesWithStats

getPartitionColsWithStats

getAllTableNamesForStats

getTablesInternal

getAllMaterializedViewObjectsForRewriting

getMaterializedViewsForRewriting

getDatabaseCount

getPartitionCount

getTableCount

getTableMeta

getAllTables

getTableObjectsByName

getTableObjectsByName

addPartitions

addPartitions

addPartition

getPartition

getPartition

dropPartition

dropPartition

dropPartitions

getPartitions

getPartitionLocations

getPartitionsInternal

getPartitionWithAuth