org.apache.hive.hcatalog.templeton

Class Server

java.lang.Object

org.apache.hive.hcatalog.templeton.Server

public class Server
extends java.lang.Object

The Templeton Web API server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	DDL_ID
static java.lang.String	DO_AS_PARAM
protected static ExecService	execService
static java.util.Map<java.lang.String,java.lang.String>	STATUS_OK The status message.
static java.util.Map<java.lang.String,java.lang.Object>	SUPPORTED_FORMATS The list of supported return formats.
static java.util.Map<java.lang.String,java.lang.Object>	SUPPORTED_VERSIONS The list of supported api versions.
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
Server()

Method Summary

Modifier and Type	Method and Description
Response	addOneColumn(java.lang.String db, java.lang.String table, java.lang.String column, ColumnDesc desc) Create a column in an hcat table.
Response	addOnePartition(java.lang.String db, java.lang.String table, java.lang.String partition, PartitionDesc desc) Create a partition in an hcat table.
Response	addOneTableProperty(java.lang.String db, java.lang.String table, java.lang.String property, TablePropertyDesc desc) Add a single property on an hcat table.
CompleteBean	completeJob(java.lang.String jobid) Notify on a completed job.
Response	createDatabase(java.lang.String db, DatabaseDesc desc) Create a database
Response	createTable(java.lang.String db, java.lang.String table, TableDesc desc) Create a new table.
Response	createTableLike(java.lang.String db, java.lang.String existingTable, java.lang.String newTable, TableLikeDesc desc) Create a new table like another table.
ExecBean	ddl(java.lang.String exec, java.lang.String group, java.lang.String permissions) Execute an hcat ddl expression on the local box.
QueueStatusBean	deleteJobId(java.lang.String jobid) Kill a job in the queue.
QueueStatusBean	deleteQueueId(java.lang.String jobid) Deprecated. use DELETE jobs/{jobid} instead.
Response	descColumn(java.lang.String db, java.lang.String table, java.lang.String column) Describe a single column in an hcat table.
Response	descDatabase(java.lang.String db, java.lang.String format) Describe a database
Response	descOneTableProperty(java.lang.String db, java.lang.String table, java.lang.String property) Describe a single property on an hcat table.
Response	descPartition(java.lang.String db, java.lang.String table, java.lang.String partition) Describe a single partition in an hcat table.
Response	descTable(java.lang.String db, java.lang.String table, java.lang.String format) Describe an hcat table.
Response	dropDatabase(java.lang.String db, boolean ifExists, java.lang.String option, java.lang.String group, java.lang.String permissions) Drop a database
Response	dropPartition(java.lang.String db, java.lang.String table, java.lang.String partition, boolean ifExists, java.lang.String group, java.lang.String permissions) Drop a partition in an hcat table.
Response	dropTable(java.lang.String db, java.lang.String table, boolean ifExists, java.lang.String group, java.lang.String permissions) Drop an hcat table.
java.lang.String	getCompletedUrl() The callback url on this server when a task is completed.
EnqueueBean	hive(java.lang.String execute, java.lang.String srcFile, java.util.List<java.lang.String> hiveArgs, java.lang.String otherFiles, java.util.List<java.lang.String> defines, java.lang.String statusdir, java.lang.String callback, boolean enablelog) Run a Hive job.
Response	listColumns(java.lang.String db, java.lang.String table) List the columns in an hcat table.
Response	listDatabases(java.lang.String dbPattern) List all databases, or those that match a pattern.
Response	listPartitions(java.lang.String db, java.lang.String table) List all the partitions in an hcat table.
Response	listTableProperties(java.lang.String db, java.lang.String table) List all the properties on an hcat table.
Response	listTables(java.lang.String db, java.lang.String tablePattern) List all the tables in an hcat database.
EnqueueBean	mapReduceJar(java.lang.String jar, java.lang.String mainClass, java.lang.String libjars, java.lang.String files, java.util.List<java.lang.String> args, java.util.List<java.lang.String> defines, java.lang.String statusdir, java.lang.String callback, boolean enablelog) Run a MapReduce Jar job.
EnqueueBean	mapReduceStreaming(java.util.List<java.lang.String> inputs, java.lang.String output, java.lang.String mapper, java.lang.String reducer, java.lang.String combiner, java.util.List<java.lang.String> fileList, java.lang.String files, java.util.List<java.lang.String> defines, java.util.List<java.lang.String> cmdenvs, java.util.List<java.lang.String> args, java.lang.String statusdir, java.lang.String callback, boolean enablelog) Run a MapReduce Streaming job.
EnqueueBean	pig(java.lang.String execute, java.lang.String srcFile, java.util.List<java.lang.String> pigArgs, java.lang.String otherFiles, java.lang.String statusdir, java.lang.String callback, boolean enablelog) Run a Pig job.
Response	renameTable(java.lang.String db, java.lang.String oldTable, java.lang.String newTable, java.lang.String group, java.lang.String permissions) Rename an hcat table.
java.util.Map<java.lang.String,java.lang.Object>	requestFormats() Check the supported request formats of this server.
QueueStatusBean	showJobId(java.lang.String jobid) Return the status of the jobid.
java.util.List<JobItemBean>	showJobList(java.lang.String fields, boolean showall) Return all the known job ids for this user.
QueueStatusBean	showQueueId(java.lang.String jobid) Deprecated. use GET jobs/{jobid} instead.
java.util.List<java.lang.String>	showQueueList(boolean showall) Deprecated. use GET jobs instead.
java.util.Map<java.lang.String,java.lang.String>	status() Check the status of this server.
void	verifyDdlParam(java.lang.String param, java.lang.String name) Verify that the parameter exists and is a simple DDL identifier name.
void	verifyParam(java.util.List<java.lang.String> param, java.lang.String name) Verify that the parameter exists.
void	verifyParam(java.lang.String param, java.lang.String name) Verify that the parameter exists.
void	verifyUser() Verify that we have a valid user.
java.util.Map<java.lang.String,java.lang.Object>	version() Check the version(s) supported by this server.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

DO_AS_PARAM

public static final java.lang.String DO_AS_PARAM

See Also:

Constant Field Values

STATUS_OK

public static final java.util.Map<java.lang.String,java.lang.String> STATUS_OK

The status message. Always "ok"

SUPPORTED_VERSIONS

public static final java.util.Map<java.lang.String,java.lang.Object> SUPPORTED_VERSIONS

The list of supported api versions.

SUPPORTED_FORMATS

public static final java.util.Map<java.lang.String,java.lang.Object> SUPPORTED_FORMATS

The list of supported return formats. Always json.

execService

protected static ExecService execService

DDL_ID

public static final java.util.regex.Pattern DDL_ID

Constructor Detail

Server

public Server()

Method Detail

status

public java.util.Map<java.lang.String,java.lang.String> status()

Check the status of this server. Always OK.

requestFormats

public java.util.Map<java.lang.String,java.lang.Object> requestFormats()

Check the supported request formats of this server.

version

public java.util.Map<java.lang.String,java.lang.Object> version()

Check the version(s) supported by this server.

ddl

public ExecBean ddl(java.lang.String exec,
                    java.lang.String group,
                    java.lang.String permissions)
             throws NotAuthorizedException,
                    BusyException,
                    BadParam,
                    ExecuteException,
                    java.io.IOException

Execute an hcat ddl expression on the local box. It is run as the authenticated user and rate limited.

Throws:

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

listTables

public Response listTables(java.lang.String db,
                           java.lang.String tablePattern)
                    throws HcatException,
                           NotAuthorizedException,
                           BusyException,
                           BadParam,
                           ExecuteException,
                           java.io.IOException

List all the tables in an hcat database.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

createTable

public Response createTable(java.lang.String db,
                            java.lang.String table,
                            TableDesc desc)
                     throws SimpleWebException,
                            NotAuthorizedException,
                            BusyException,
                            BadParam,
                            ExecuteException,
                            java.io.IOException

Create a new table.

Throws:

SimpleWebException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

createTableLike

public Response createTableLike(java.lang.String db,
                                java.lang.String existingTable,
                                java.lang.String newTable,
                                TableLikeDesc desc)
                         throws SimpleWebException,
                                NotAuthorizedException,
                                BusyException,
                                BadParam,
                                ExecuteException,
                                java.io.IOException

Create a new table like another table.

Throws:

SimpleWebException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

descTable

public Response descTable(java.lang.String db,
                          java.lang.String table,
                          java.lang.String format)
                   throws HcatException,
                          NotAuthorizedException,
                          BusyException,
                          BadParam,
                          ExecuteException,
                          java.io.IOException

Describe an hcat table. This is normally a simple list of columns (using "desc table"), but the extended format will show more information (using "show table extended like").

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

dropTable

public Response dropTable(java.lang.String db,
                          java.lang.String table,
                          boolean ifExists,
                          java.lang.String group,
                          java.lang.String permissions)
                   throws HcatException,
                          NotAuthorizedException,
                          BusyException,
                          BadParam,
                          ExecuteException,
                          java.io.IOException

Drop an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

renameTable

public Response renameTable(java.lang.String db,
                            java.lang.String oldTable,
                            java.lang.String newTable,
                            java.lang.String group,
                            java.lang.String permissions)
                     throws HcatException,
                            NotAuthorizedException,
                            BusyException,
                            BadParam,
                            ExecuteException,
                            java.io.IOException

Rename an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

descOneTableProperty

public Response descOneTableProperty(java.lang.String db,
                                     java.lang.String table,
                                     java.lang.String property)
                              throws HcatException,
                                     NotAuthorizedException,
                                     BusyException,
                                     BadParam,
                                     ExecuteException,
                                     java.io.IOException

Describe a single property on an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

listTableProperties

public Response listTableProperties(java.lang.String db,
                                    java.lang.String table)
                             throws HcatException,
                                    NotAuthorizedException,
                                    BusyException,
                                    BadParam,
                                    ExecuteException,
                                    java.io.IOException

List all the properties on an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

addOneTableProperty

public Response addOneTableProperty(java.lang.String db,
                                    java.lang.String table,
                                    java.lang.String property,
                                    TablePropertyDesc desc)
                             throws HcatException,
                                    NotAuthorizedException,
                                    BusyException,
                                    BadParam,
                                    ExecuteException,
                                    java.io.IOException

Add a single property on an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

listPartitions

public Response listPartitions(java.lang.String db,
                               java.lang.String table)
                        throws HcatException,
                               NotAuthorizedException,
                               BusyException,
                               BadParam,
                               ExecuteException,
                               java.io.IOException

List all the partitions in an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

descPartition

public Response descPartition(java.lang.String db,
                              java.lang.String table,
                              java.lang.String partition)
                       throws HcatException,
                              NotAuthorizedException,
                              BusyException,
                              BadParam,
                              ExecuteException,
                              java.io.IOException

Describe a single partition in an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

addOnePartition

public Response addOnePartition(java.lang.String db,
                                java.lang.String table,
                                java.lang.String partition,
                                PartitionDesc desc)
                         throws HcatException,
                                NotAuthorizedException,
                                BusyException,
                                BadParam,
                                ExecuteException,
                                java.io.IOException

Create a partition in an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

dropPartition

public Response dropPartition(java.lang.String db,
                              java.lang.String table,
                              java.lang.String partition,
                              boolean ifExists,
                              java.lang.String group,
                              java.lang.String permissions)
                       throws HcatException,
                              NotAuthorizedException,
                              BusyException,
                              BadParam,
                              ExecuteException,
                              java.io.IOException

Drop a partition in an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

listDatabases

public Response listDatabases(java.lang.String dbPattern)
                       throws HcatException,
                              NotAuthorizedException,
                              BusyException,
                              BadParam,
                              ExecuteException,
                              java.io.IOException

List all databases, or those that match a pattern.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

descDatabase

public Response descDatabase(java.lang.String db,
                             java.lang.String format)
                      throws HcatException,
                             NotAuthorizedException,
                             BusyException,
                             BadParam,
                             ExecuteException,
                             java.io.IOException

Describe a database

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

createDatabase

public Response createDatabase(java.lang.String db,
                               DatabaseDesc desc)
                        throws HcatException,
                               NotAuthorizedException,
                               BusyException,
                               BadParam,
                               ExecuteException,
                               java.io.IOException

Create a database

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

dropDatabase

public Response dropDatabase(java.lang.String db,
                             boolean ifExists,
                             java.lang.String option,
                             java.lang.String group,
                             java.lang.String permissions)
                      throws HcatException,
                             NotAuthorizedException,
                             BusyException,
                             BadParam,
                             ExecuteException,
                             java.io.IOException

Drop a database

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

listColumns

public Response listColumns(java.lang.String db,
                            java.lang.String table)
                     throws HcatException,
                            NotAuthorizedException,
                            BusyException,
                            BadParam,
                            ExecuteException,
                            java.io.IOException

List the columns in an hcat table. Currently the same as describe table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

descColumn

public Response descColumn(java.lang.String db,
                           java.lang.String table,
                           java.lang.String column)
                    throws SimpleWebException,
                           NotAuthorizedException,
                           BusyException,
                           BadParam,
                           ExecuteException,
                           java.io.IOException

Describe a single column in an hcat table.

Throws:

SimpleWebException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

addOneColumn

public Response addOneColumn(java.lang.String db,
                             java.lang.String table,
                             java.lang.String column,
                             ColumnDesc desc)
                      throws HcatException,
                             NotAuthorizedException,
                             BusyException,
                             BadParam,
                             ExecuteException,
                             java.io.IOException

Create a column in an hcat table.

Throws:

HcatException

NotAuthorizedException

BusyException

BadParam

ExecuteException

java.io.IOException

mapReduceStreaming

public EnqueueBean mapReduceStreaming(java.util.List<java.lang.String> inputs,
                                      java.lang.String output,
                                      java.lang.String mapper,
                                      java.lang.String reducer,
                                      java.lang.String combiner,
                                      java.util.List<java.lang.String> fileList,
                                      java.lang.String files,
                                      java.util.List<java.lang.String> defines,
                                      java.util.List<java.lang.String> cmdenvs,
                                      java.util.List<java.lang.String> args,
                                      java.lang.String statusdir,
                                      java.lang.String callback,
                                      boolean enablelog)
                               throws NotAuthorizedException,
                                      BusyException,
                                      BadParam,
                                      QueueException,
                                      ExecuteException,
                                      java.io.IOException,
                                      java.lang.InterruptedException

Run a MapReduce Streaming job.

Throws:

NotAuthorizedException

BusyException

BadParam

QueueException

ExecuteException

java.io.IOException

java.lang.InterruptedException

mapReduceJar

public EnqueueBean mapReduceJar(java.lang.String jar,
                                java.lang.String mainClass,
                                java.lang.String libjars,
                                java.lang.String files,
                                java.util.List<java.lang.String> args,
                                java.util.List<java.lang.String> defines,
                                java.lang.String statusdir,
                                java.lang.String callback,
                                boolean enablelog)
                         throws NotAuthorizedException,
                                BusyException,
                                BadParam,
                                QueueException,
                                ExecuteException,
                                java.io.IOException,
                                java.lang.InterruptedException

Run a MapReduce Jar job.

Throws:

NotAuthorizedException

BusyException

BadParam

QueueException

ExecuteException

java.io.IOException

java.lang.InterruptedException

pig

public EnqueueBean pig(java.lang.String execute,
                       java.lang.String srcFile,
                       java.util.List<java.lang.String> pigArgs,
                       java.lang.String otherFiles,
                       java.lang.String statusdir,
                       java.lang.String callback,
                       boolean enablelog)
                throws NotAuthorizedException,
                       BusyException,
                       BadParam,
                       QueueException,
                       ExecuteException,
                       java.io.IOException,
                       java.lang.InterruptedException

Run a Pig job.

Throws:

NotAuthorizedException

BusyException

BadParam

QueueException

ExecuteException

java.io.IOException

java.lang.InterruptedException

hive

public EnqueueBean hive(java.lang.String execute,
                        java.lang.String srcFile,
                        java.util.List<java.lang.String> hiveArgs,
                        java.lang.String otherFiles,
                        java.util.List<java.lang.String> defines,
                        java.lang.String statusdir,
                        java.lang.String callback,
                        boolean enablelog)
                 throws NotAuthorizedException,
                        BusyException,
                        BadParam,
                        QueueException,
                        ExecuteException,
                        java.io.IOException,
                        java.lang.InterruptedException

Run a Hive job.

Parameters:

execute - SQL statement to run, equivalent to "-e" from hive command line

srcFile - name of hive script file to run, equivalent to "-f" from hive command line

hiveArgs - additional command line argument passed to the hive command line. Please check https://cwiki.apache.org/Hive/languagemanual-cli.html for detailed explanation of command line arguments

otherFiles - additional files to be shipped to the launcher, such as the jars used in "add jar" statement in hive script

defines - shortcut for command line arguments "--define"

statusdir - where the stderr/stdout of templeton controller job goes

callback - callback url when the hive job finishes

enablelog - whether to collect mapreduce log into statusdir/logs

Throws:

NotAuthorizedException

BusyException

BadParam

QueueException

ExecuteException

java.io.IOException

java.lang.InterruptedException

showQueueId

@Deprecated
public QueueStatusBean showQueueId(java.lang.String jobid)
                                        throws NotAuthorizedException,
                                               BadParam,
                                               java.io.IOException,
                                               java.lang.InterruptedException

Deprecated. use GET jobs/{jobid} instead.

Return the status of the jobid.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

deleteQueueId

@Deprecated
public QueueStatusBean deleteQueueId(java.lang.String jobid)
                                          throws NotAuthorizedException,
                                                 BadParam,
                                                 java.io.IOException,
                                                 java.lang.InterruptedException

Deprecated. use DELETE jobs/{jobid} instead.

Kill a job in the queue.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

showQueueList

@Deprecated
public java.util.List<java.lang.String> showQueueList(boolean showall)
                                                           throws NotAuthorizedException,
                                                                  BadParam,
                                                                  java.io.IOException,
                                                                  java.lang.InterruptedException

Deprecated. use GET jobs instead.

Return all the known job ids for this user.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

showJobId

public QueueStatusBean showJobId(java.lang.String jobid)
                          throws NotAuthorizedException,
                                 BadParam,
                                 java.io.IOException,
                                 java.lang.InterruptedException

Return the status of the jobid.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

deleteJobId

public QueueStatusBean deleteJobId(java.lang.String jobid)
                            throws NotAuthorizedException,
                                   BadParam,
                                   java.io.IOException,
                                   java.lang.InterruptedException

Kill a job in the queue.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

showJobList

public java.util.List<JobItemBean> showJobList(java.lang.String fields,
                                               boolean showall)
                                        throws NotAuthorizedException,
                                               BadParam,
                                               java.io.IOException,
                                               java.lang.InterruptedException

Return all the known job ids for this user.

Throws:

NotAuthorizedException

BadParam

java.io.IOException

java.lang.InterruptedException

completeJob

public CompleteBean completeJob(java.lang.String jobid)
                         throws CallbackFailedException,
                                java.io.IOException

Notify on a completed job. Called by JobTracker.

Throws:

CallbackFailedException

java.io.IOException

verifyUser

public void verifyUser()
                throws NotAuthorizedException

Verify that we have a valid user. Throw an exception if invalid.

Throws:

NotAuthorizedException

verifyParam

public void verifyParam(java.lang.String param,
                        java.lang.String name)
                 throws BadParam

Verify that the parameter exists. Throw an exception if invalid.

Throws:

BadParam

verifyParam

public void verifyParam(java.util.List<java.lang.String> param,
                        java.lang.String name)
                 throws BadParam

Verify that the parameter exists. Throw an exception if invalid.

Throws:

BadParam

verifyDdlParam

public void verifyDdlParam(java.lang.String param,
                           java.lang.String name)
                    throws BadParam

Verify that the parameter exists and is a simple DDL identifier name. Throw an exception if invalid. Bug: This needs to allow for quoted ddl identifiers.

Throws:

BadParam

getCompletedUrl

public java.lang.String getCompletedUrl()

The callback url on this server when a task is completed.