org.apache.hadoop.hive.metastore

Class MetaStoreSchemaInfo

java.lang.Object

org.apache.hadoop.hive.metastore.MetaStoreSchemaInfo

All Implemented Interfaces:

IMetaStoreSchemaInfo

public class MetaStoreSchemaInfo
extends Object
implements IMetaStoreSchemaInfo

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CREATE_USER_PREFIX
protected String	dbType
protected static String	INIT_FILE_PREFIX
protected static String	PRE_UPGRADE_PREFIX
protected static String	UPGRADE_FILE_PREFIX
protected static String	VERSION_UPGRADE_LIST

Fields inherited from interface org.apache.hadoop.hive.metastore.IMetaStoreSchemaInfo

SQL_FILE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
MetaStoreSchemaInfo(String metastoreHome, String dbType)

Method Summary

Modifier and Type	Method and Description
String	generateInitFileName(String toVersion) Get the name of the script to initialize the schema for given version
String	getCreateUserScript() Get SQL script that will create the user and database for Metastore to use.
String	getHiveSchemaVersion() Get hive distribution schema version.
String	getMetaStoreSchemaVersion(HiveSchemaHelper.MetaStoreConnectionInfo connectionInfo) Get the schema version from the backend database.
String	getMetaStoreScriptDir() Find the directory of metastore scripts
String	getPreUpgradeScriptName(int index, String upgradeScriptName) Get the pre-upgrade script for a given script name.
List<String>	getUpgradeScripts(String fromVersion) Get the list of sql scripts required to upgrade from the give version to current
boolean	isVersionCompatible(String hiveVersion, String dbVersion) A dbVersion is compatible with hive version if it is greater or equal to the hive version.

Methods inherited from class java.lang.Object

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

Field Detail

UPGRADE_FILE_PREFIX

protected static final String UPGRADE_FILE_PREFIX

See Also:

Constant Field Values

INIT_FILE_PREFIX

protected static final String INIT_FILE_PREFIX

See Also:

Constant Field Values

VERSION_UPGRADE_LIST

protected static final String VERSION_UPGRADE_LIST

See Also:

Constant Field Values

PRE_UPGRADE_PREFIX

protected static final String PRE_UPGRADE_PREFIX

See Also:

Constant Field Values

CREATE_USER_PREFIX

protected static final String CREATE_USER_PREFIX

See Also:

Constant Field Values

dbType

protected final String dbType

Constructor Detail

MetaStoreSchemaInfo

public MetaStoreSchemaInfo(String metastoreHome,
                           String dbType)
                    throws HiveMetaException

Throws:

HiveMetaException

Method Detail

getUpgradeScripts

public List<String> getUpgradeScripts(String fromVersion)
                               throws HiveMetaException

Get the list of sql scripts required to upgrade from the give version to current

Specified by:

getUpgradeScripts in interface IMetaStoreSchemaInfo

Parameters:

fromVersion -

Returns:

Throws:

HiveMetaException

generateInitFileName

public String generateInitFileName(String toVersion)
                            throws HiveMetaException

Get the name of the script to initialize the schema for given version

Specified by:

generateInitFileName in interface IMetaStoreSchemaInfo

Parameters:

toVersion - Target version. If it's null, then the current server version is used

Returns:

Throws:

HiveMetaException

getCreateUserScript

public String getCreateUserScript()
                           throws HiveMetaException

Description copied from interface: IMetaStoreSchemaInfo

Get SQL script that will create the user and database for Metastore to use.

Specified by:

getCreateUserScript in interface IMetaStoreSchemaInfo

Returns:

filename

Throws:

HiveMetaException - if something goes wrong.

getMetaStoreScriptDir

public String getMetaStoreScriptDir()

Find the directory of metastore scripts

Specified by:

getMetaStoreScriptDir in interface IMetaStoreSchemaInfo

Returns:

getPreUpgradeScriptName

public String getPreUpgradeScriptName(int index,
                                      String upgradeScriptName)

Description copied from interface: IMetaStoreSchemaInfo

Get the pre-upgrade script for a given script name. Schema tool runs the pre-upgrade scripts returned by this method before running any upgrade scripts. These scripts could contain setup statements may fail on some database versions and failure is ignorable.

Specified by:

getPreUpgradeScriptName in interface IMetaStoreSchemaInfo

Parameters:

index - - index number of the file. The preupgrade script name is derived using the given index

upgradeScriptName - - upgrade script name

Returns:

name of the pre-upgrade script to be run before running upgrade script

getHiveSchemaVersion

public String getHiveSchemaVersion()

Description copied from interface: IMetaStoreSchemaInfo

Get hive distribution schema version. Schematool uses this version to identify the Hive version. It compares this version with the version found in metastore database to determine the upgrade or initialization scripts

Specified by:

getHiveSchemaVersion in interface IMetaStoreSchemaInfo

Returns:

Hive schema version

isVersionCompatible

public boolean isVersionCompatible(String hiveVersion,
                                   String dbVersion)

Description copied from interface: IMetaStoreSchemaInfo

A dbVersion is compatible with hive version if it is greater or equal to the hive version. This is result of the db schema upgrade design principles followed in hive project. The state where db schema version is ahead of hive software version is often seen when a 'rolling upgrade' or 'rolling downgrade' is happening. This is a state where hive is functional and returning non zero status for it is misleading.

Specified by:

isVersionCompatible in interface IMetaStoreSchemaInfo

Parameters:

hiveVersion - version of hive software

dbVersion - version of metastore rdbms schema

Returns:

true if versions are compatible

getMetaStoreSchemaVersion

public String getMetaStoreSchemaVersion(HiveSchemaHelper.MetaStoreConnectionInfo connectionInfo)
                                 throws HiveMetaException

Description copied from interface: IMetaStoreSchemaInfo

Get the schema version from the backend database. This version is used by SchemaTool to to compare the version returned by getHiveSchemaVersion and determine the upgrade order and scripts needed to upgrade the metastore schema

Specified by:

getMetaStoreSchemaVersion in interface IMetaStoreSchemaInfo

Parameters:

connectionInfo - Connection information needed to connect to the backend database

Returns:

Throws:

HiveMetaException - when unable to fetch the schema version