WebHCat

:version

WebHCat version number (Currently this must be v1.)

responseTypes

A list of all supported response types

status

OK is returned if the WebHCat server was contacted.

version

String containing the version number similar to "v1"

supportedVersions

A list of all supported versions

version

The current version

module

hive

version

Hive version

module

hadoop

version

Hadoop version

exec

The HCatalog ddl string to execute

group

The user group to use when creating a table

permissions

The permissions string to use when creating a table. The format is "rwxrw-r-x".

stdout

A string containing the result HCatalog sent to standard out (possibly empty)

stderr

A string containing the result HCatalog sent to standard error (possibly empty)

exitcode

The exitcode HCatalog returned

like

List only databases whose names match the specified pattern.

databases

A list of database names

:db

The database name

location

The database location

comment

The database comment. If there is no database comment, the value is null.

database

The database name

owner

The database owner

owertype

The type of the database owner

:db

The database name

group

The user group to use

permission

The permissions string to use

location

The database location

comment

A comment for the database, like a description

properties

The database properties

database

The database name

:db

The database name

ifExists

Hive returns an error if the database specified does not exist, unless ifExists is set to true.

option

Parameter set to either cascade or restrict. restrict will remove the schema if all the tables are empty. cascade removes everything including data and definitions.

database

The database name

:db

The database name

like

List only tables whose names match the specified pattern.

database

A list of table names

tables

The database name

:db

The database name

:table

The table name

format

Set "format=extended" to see additional information (using "show table extended like").

columns

A list of column names and types

database

The database name

table

The table name

partitioned

Indicates whether a table is a partition table. This parameter is available only when the table format is extended.

location

Location of a table. This parameter is available only when the table format is extended.

outputformat

Output format. This parameter is available only when the table format is extended.

inputformat

Input format. This parameter is available only when the table format is extended.

owner

Owner of a table. This parameter is available only when the table format is extended.

partitionColumns

Partition column. This parameter is available only when the table format is extended.

:db

The database name

:table

The new table name

group

The user group to use when creating a table

permissions

The permissions string to use when creating a table

external

Allows you to specify a location so that Hive does not use the default location for this table.

ifNotExists

If the value true, you will not receive an error if the table already exists.

comment

Comment for the table

columns

A list of column descriptions, including name, type, and an optional comment

partitionedBy

A list of column descriptions used to partition the table. Like the columns parameter this is a list of name, type, and comment fie.

clusteredBy

Bucket column description, including the columnNames, sortedBy, and numberOfBuckets parameters. The columnNames parameter includes columnName and sorting sequence (ASC for ascending or DESC for descending).

format

Storage format description including parameters for rowFormat, storedAs, and storedBy.

location

The HDFS path

tableProperties

A list of table property names and values (key/value pairs).

database

The new table name

table

The database name

:db

The database name

:table

The existing (old) table name

rename

The new table name

database

The database name

table

The new table name

:db

The database name

:table

The table name

ifExists

If the value is true, you will not receive an error.

database

The database name

table

The table name

:db

The database name

:existingtable

The existing table name

:newtable

The new table name

group

The user group to use when creating a table

permissions

The permissions string to use when creating a table

external

Allows you to specify a location so that Hive does not use the default location for this table.

ifNotExists

If the value is true, you will not receive an error if the table already exists.

location

The HDFS path

database

The database name

table

The new table name

:db

The database name

:table

The table name

database

The database name

table

The table name

partitions

A list of partition values and of partition names

:db

The database name

:table

The table name

:partition

The partition name, col_name='value' list. Be careful to properly encode the quote for http, for example, "country=%27algeria%27".

database

The database name

table

The table name

partition

The partition name

partitioned

True if the table is partitioned

location

Location of table

outputFormat

Output format

columns

List of column names, types, and comments

owner

The owner's user name

partitionColumns

List of the partition columns

inputFormat

Input format

totalNumberFiles

Number of files in a partition

totalFileSize

Total file size in a partition

maxFileSize

Maximum file size

minFileSize

Minimum file size

lastAccessTime

Last access time

lastUpdateTime

Last update time

:db

The database name

:table

The table name

group

The user group to use

permissions

The permissions string to use

location

The location for partition creation

ifNotExists

If the value is true, return an error if the partition already exists.

database

The database name

table

The table name

partitions

The partition name

:db

The database name

:table

The table name

group

The user group to use

permissions

The permissions string to use. The format is "rwxrw-r-x".

ifExists

Hive returns an error if the partition specified does not exist, unless ifExists is set to true.

database

The database name

table

The table name

partitions

The partition name

:db

The database name

:table

The table name

database

The database name

table

The table name

columns

A list of column names and types

:db

The database name

:table

The table name

:column

The column name

database

The database name

table

The table name

column

Column name and type

:db

The database name

:table

The table name

:column

The column name

type

The type of column to add, like "string" or "int"

comment

The column comment, like a description

database

The database name

table

The table name

column

The column name

:db

The database name

:table

The table name

database

The database name

table

The table name

properties

Property list

:db

The database name

:table

The table name

:property

The property name

database

The database name

table

The table name

property

Property list

:db

The database name

:table

The table name

:property

The property name

value

The property value

database

The database name

table

The table name

property

The property name

jar

Name of the jar file for Map Reduce to use

class

Name of the class for Map Reduce to use

libjars

Comma-separated jar files to include in the classpath

files

Comma-separated files to be copied to the map reduce cluster

arg

Main class input parameter

define

Set a Hadoop configuration variable using the syntax define=NAME=VALUE.

statusdir

A directory where WebHCat will write the status of the Map Reduce job. If provided, it is the caller's responsibility to remove this directory when done.

enablelog

If statusdir is set and enablelog is true, collect Hadoop job configuration and logs in to a directory named $statusdir/logs after the job finishes. Both completed and failed attempts are logged. The layout of subdirectories in $statusdir/logs is:

logs/$job_id (directory for $job_id)

logs/$job_id/job.xml.html

logs/$job_id/$attempt_id (directory for $attempt_id)

logs/$job_id/$attempt_id/stderr

logs/$job_id/$attempt_id/stdout

logs/$job_id/$attempt_id/syslog

This parameter supports only Hadoop 1.X.

callback

Define a URL to be called upon job completion. You may embed a specific job ID into this URL using $jobId. This tag will be replaced in the callback URL with this job's job ID.

id

A string containing the job ID similar to "job_201110132141_0001"

input

Location of the input data in Hadoop

output

Location in which to store the output data. If not specified, WebHCat will store the output in a location that can be discovered using the queue resource.

mapper

Location of the mapper program in Hadoop

reducer

Location of the reducer program in Hadoop

files

Add an HDFS file to the distributed cache.

arg

Set a program argument.

define

Set a Hadoop configuration variable using the syntax define=NAME=VALUE.

cmdenv

Set an environment variable using the syntax cmdenv=NAME=VALUE.

statusdir

A directory where WebHCat will write the status of the Map Reduce job. If provided, it is the caller's responsibility to remove this directory when done.

enablelog

If statusdir is set and enablelog is true, collect Hadoop job configuration and logs in to a directory named $statusdir/logs after the job finishes. Both completed and failed attempts are logged. The layout of subdirectories in $statusdir/logs is:

logs/$job_id (directory for $job_id)

logs/$job_id/job.xml.html

logs/$job_id/$attempt_id (directory for $attempt_id)

logs/$job_id/$attempt_id/stderr

logs/$job_id/$attempt_id/stdout

logs/$job_id/$attempt_id/syslog

This parameter supports only Hadoop 1.X.

callback

Define a URL to be called upon job completion. You may embed a specific job ID into this URL using $jobId. This tag will be replaced in the callback URL with this job's job ID.

id

A string containing the job ID similar to "job_201110132141_0001"

execute

String containing an entire, short Hive program to run

file

HDFS file name of a Hive program to run

files

Comma-separated files to be copied to the map reduce cluster

arg

Set a program argument.

define

Hive configuration. The format is define=key=value. If multiple instances are used, you need to configure the scratch dir for them. For example, the WebHCat instance uses define=hive.exec.scratchdir=/tmp/hive-scratch. The WebHCat1 instance uses define=hive.exec.scratchdir=/tmp/hive1-scratch. The same rule applies to other instances.

statusdir

A directory where WebHCat will write the status of the Hive job. If provided, it is the caller's responsibility to remove this directory when done.

enablelog

If statusdir is set and enablelog is true, collect Hadoop job configuration and logs in to a directory named $statusdir/logs after the job finishes. Both completed and failed attempts are logged. The layout of subdirectories in $statusdir/logs is:

logs/$job_id (directory for $job_id)

logs/$job_id/job.xml.html

logs/$job_id/$attempt_id (directory for $attempt_id)

logs/$job_id/$attempt_id/stderr

logs/$job_id/$attempt_id/stdout

logs/$job_id/$attempt_id/syslog

This parameter supports only Hadoop 1.X.

callback

Define a URL to be called upon job completion. You may embed a specific job ID into this URL using $jobId. This tag will be replaced in the callback URL with this job's job ID.

id

A string containing the job ID similar to "job_201110132141_0001"

fields

If fields set to *, the request will return full details of the job. If fields is missing, will only return the job ID. Currently the value can only be *, other values are not allowed and will throw exception.

jobid

If jobid is present, only the records whose job ID is lexicographically greater than jobid are returned. For example, if jobid = "job_201312091733_0001", the jobs whose job ID is greater than "job_201312091733_0001" are returned. The number of records returned depends on the value of numrecords.

numrecords

If the jobid and numrecords parameters are present, the top numrecords records appearing after jobid will be returned after sorting the job ID list lexicographically. If the jobid parameter is missing and numrecords is present, the top numrecords will be returned after lexicographically sorting the job ID list. If the jobid parameter is present and numrecords is missing, all the records whose job ID is greater than jobid are returned.

showall

If this parameter is set to true, all jobs can be obtained. If this parameter is set to false, only jobs submitted by the current user can be obtained. This parameter is set to false by default.

id

Job id

detail

Job details if showall is set to true; otherwise null.

jobid

The job ID to check. This is the ID received when the job was created.

status

A JSON object containing the job status information

profile

A JSON object containing the job profile information. WebHCat passes along the information in the JobProfile object, which is subject to change from one Hadoop version to another.

id

The job ID

percentComplete

The job completion percentage, for example "75% complete". If the job is completed, the value is null.

user

User name of the job creator

callback

The callback URL, if any

userargs

A JSON object representing the argument names and values for the job submission request

exitValue

The job's exit value

user

Indicates the user that submits jobs.

status

A JSON object containing the job status information

profile

A JSON object containing the job profile information. WebHCat passes along the information in the JobProfile object, which is subject to change from one Hadoop version to another.

id

The job ID

callback

The callback URL, if any