org.apache.hadoop.hive.metastore.properties

Class HMSPropertyManager

java.lang.Object

org.apache.hadoop.hive.metastore.properties.PropertyManager

org.apache.hadoop.hive.metastore.properties.HMSPropertyManager

public class HMSPropertyManager
extends PropertyManager

A property manager tailored for the HiveMetaStore. It describes properties for cluster, database and table based on declared schemas. A property is of the form:

• name : when it refers to a cluster property named 'name'
• db.name : when it refers to a database property named 'name' for the database 'db'
• db.table.name : when it refers to a table property named 'name' for the table 'table' in the database 'db

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HMSPropertyManager.MaintenanceOpStatus Table maintenance operation status.
static class	HMSPropertyManager.MaintenanceOpType Table maintenance operation type.

Nested classes/interfaces inherited from class org.apache.hadoop.hive.metastore.properties.PropertyManager

PropertyManager.MapWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static PropertySchema	CLUSTER_SCHEMA The cluster declared properties.
static PropertySchema	DATABASE_SCHEMA The database declared properties.
static PropertyType<HMSPropertyManager.MaintenanceOpType>	MAINTENANCE_OPERATION Maintenance Operation Type.
static PropertyType<HMSPropertyManager.MaintenanceOpStatus>	MAINTENANCE_STATUS Maintenance Operation Status.
static PropertySchema	TABLE_SCHEMA The table declared properties.

Fields inherited from class org.apache.hadoop.hive.metastore.properties.PropertyManager

dirtyMaps, LOGGER, namespace, store

Constructor Summary

Constructors

Constructor and Description
HMSPropertyManager(PropertyStore store)
HMSPropertyManager(String ns, PropertyStore store) Creates manager from a property store instance.

Method Summary

Modifier and Type	Method and Description
static void	declareClusterProperty(String name, PropertyType<?> type, Object defaultValue) Declares a new cluster property.
static void	declareDatabaseProperty(String name, PropertyType<?> type, Object defaultValue) Declares a new database property.
static void	declareTableProperty(String name, PropertyType<?> type, Object defaultValue) Declares a new table property.
static HMSPropertyManager.MaintenanceOpStatus	findOpStatus(int ordinal) Finds an op-type by its ordinal.
static HMSPropertyManager.MaintenanceOpType	findOpType(int ordinal) Finds an op-type by its ordinal.
protected int	getMapNameLength(String[] keys) The number of fragments that will be used to determine the map name.
PropertySchema	getSchema(String schemaName) The property map factory.
protected PropertySchema	schemaOf(String[] keys) Determines the schema from the property name fragments.

Methods inherited from class org.apache.hadoop.hive.metastore.properties.PropertyManager

commit, create, declare, dropProperties, exportPropertyValue, getProperty, getProperty, getPropertyValue, getPropertyValue, importDefaultValues, mapKey, mapKey, mapKey, mapName, propertyName, propertyName, rollback, runScript, selectProperties, selectProperties, selectProperties, selectProperties, selectProperties, setProperties, setProperties, setProperty, setProperty, splitKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAINTENANCE_OPERATION

public static final PropertyType<HMSPropertyManager.MaintenanceOpType> MAINTENANCE_OPERATION

Maintenance Operation Type.

MAINTENANCE_STATUS

public static final PropertyType<HMSPropertyManager.MaintenanceOpStatus> MAINTENANCE_STATUS

Maintenance Operation Status.

CLUSTER_SCHEMA

public static final PropertySchema CLUSTER_SCHEMA

The cluster declared properties.

DATABASE_SCHEMA

public static final PropertySchema DATABASE_SCHEMA

The database declared properties.

TABLE_SCHEMA

public static final PropertySchema TABLE_SCHEMA

The table declared properties.

Constructor Detail

HMSPropertyManager

public HMSPropertyManager(String ns,
                          PropertyStore store)

Creates manager from a property store instance.

Parameters:

store - the store

HMSPropertyManager

public HMSPropertyManager(PropertyStore store)

Method Detail

findOpType

public static HMSPropertyManager.MaintenanceOpType findOpType(int ordinal)

Finds an op-type by its ordinal.

Parameters:

ordinal - the enum ordinal

Returns:

the enum value or null if not found

findOpStatus

public static HMSPropertyManager.MaintenanceOpStatus findOpStatus(int ordinal)

Finds an op-type by its ordinal.

Parameters:

ordinal - the enum ordinal

Returns:

the enum value or null if not found

declareClusterProperty

public static void declareClusterProperty(String name,
                                          PropertyType<?> type,
                                          Object defaultValue)

Declares a new cluster property.

Parameters:

name - the property name

type - the property type

defaultValue - the property default value or null if none

declareDatabaseProperty

public static void declareDatabaseProperty(String name,
                                           PropertyType<?> type,
                                           Object defaultValue)

Declares a new database property.

Parameters:

name - the property name

type - the property type

defaultValue - the property default value or null if none

declareTableProperty

public static void declareTableProperty(String name,
                                        PropertyType<?> type,
                                        Object defaultValue)

Declares a new table property.

Parameters:

name - the property name

type - the property type

defaultValue - the property default value or null if none

getSchema

public PropertySchema getSchema(String schemaName)

The property map factory.

Overrides:

getSchema in class PropertyManager

Parameters:

schemaName - the map type (cluster, database, table)

Returns:

a property schema instance

schemaOf

protected PropertySchema schemaOf(String[] keys)

Determines the schema from the property name fragments.

The number of fragments is enough to determine if we are dealing with cluster (1 fragment, the property name), database (2 fragments, 1 for db name, 2 for property), table (3 fragments, db name;, table name, property name).

Overrides:

schemaOf in class PropertyManager

Parameters:

keys - the property key fragments

Returns:

the schema

getMapNameLength

protected int getMapNameLength(String[] keys)

The number of fragments that will be used to determine the map name.

Overrides:

getMapNameLength in class PropertyManager

Parameters:

keys - key fragments

Returns:

a number equal (or inferior) to keys.length - 1 since a property name is at least 1 fragment