Hive WebHCat APIs

:version

WebHCat version number. Currently, the version number must be v1.

responseTypes

List of response types supported by WebHCat

status

If the WebChat connection is normal, OK is returned.

version

Character string, including the version number, for example, v1

supportedVersions

All supported versions

version

WebHCat version of the server

module

hive

version

Hive version

module

hadoop

version

Hadoop version

exec

HCatalog DDL statement to be executed

group

User group used when DDL is used to create a table

permissions

Permission used when DDL is used to create a table. The format is rwxr-xr-x.

like

Regular expression used to match the database name

:db

Database name

:db

Database name

group

User group used for creating the database

permission

Permission used for creating the database

location

Database location

comment

Database remarks, for example, description

properties

Database properties

:db

Database name

ifExists

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

option

Set the parameter to cascade or restrict. If you set it to cascade, all data and definitions are cleared. If you set it to restrict, the table content is empty and the mode does not exist.

:db

Database name

like

Regular expression used to match a table name

:db

Database name

:table

Table name

format

Set "format=extended" to view more information about the table. (The function is equivalent to "show table extended like tableName" of HiveQL.)

columns

Column name and type

database

Database name

table

Table name

partitioned

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

location

Table location. 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

Table owner. 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

Database name

:table

New table name

group

User group used for creating the table

permissions

Permission used for creating the table

external

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

ifNotExists

If this parameter is set to true, no error is reported if a table exists.

comment

Remarks

columns

Column description, including the column name, type, and optional remarks.

partitionedBy

Partition column description, which is used to partition tables. The columns parameter is used to list the column name, type, and optional remarks.

clusteredBy

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

format

Storage format. The parameters include rowFormat, storedAs, and storedBy.

location

Path in HDFS

tableProperties

Table property names and values (name-value pairs)

:db

Database name

:table

Existing table name

rename

New table name

:db

Database name

:table

Table name

ifExists

If this parameter is set to true, no error is reported.

:db

Database name

:existingtable

Existing table name

:newtable

New table name

group

User group used for creating the table

permissions

Permission used for creating the table

external

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

ifNotExists

If this parameter is set to true, the Hive does not report an error if a table already exists.

location

Path in HDFS

:db

Database name

:table

Table name

:db

Database name

:table

Table name

:partition

Partition name. Exercise caution when decoding HTTP quote, for example, country=%27algeria%27.

:db

Database name

:table

Table name

group

User group used for creating a partition

permissions

User permission used for creating a partition

location

Storage location of the new partition

ifNotExists

If this parameter is set to true, the system reports an error when the partition already exists.

:db

Database name

:table

Table name

group

User group used for deleting a new partition

permissions

User permission used for deleting a new partition. The format is rwxrw-r-x.

ifExists

If the specified partition does not exist, the Hive reports an error, unless this parameter is set to true.

:db

Database name

:table

Table name

:db

Database name

:table

Table name

:column

Column Name

:db

Database name

:table

Table name

:column

Column Name

type

Column type, for example, string and int.

comment

Column remarks, for example, description.

:db

Database name

:table

Table name

:db

Database name

:table

Table name

:property

Property

:db

Database name

:table

Table name

:property

Property name

value

Property value

jar

JAR file of the MapReduce job to be executed

class

Class of the MapReduce job to be executed

libjars

JAR file names of classpath to be added, separated by commas (,)

files

Names of files to be copied to the MapReduce cluster, separated by commas (,)

arg

Input parameter received by the Main class

define

This parameter is used to configure Hadoop in the define=NAME=VALUE format.

statusdir

WebHCat writes the status of the MapReduce job to statusdir. If this parameter is set, you need to manually delete it.

enablelog

If statusdir is set and enablelog is set to true, Hadoop task configurations and logs are collected to $statusdir/logs. Then, successful and failed attempts are recorded in the logs. The layout of the subdirectories in $statusdir/logs is as follows:

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

Only Hadoop 1.X is supported.

callback

Callback address after MapReduce job execution. Use $jobId to embed the job ID in the callback address. In the callback address, replace the $jobId with the job ID.

input

Input path of Hadoop

output

Output save path. If this parameter is not specified, WebChat will store the output in a path that can be found by using queue resources.

mapper

Location of the mapper program

reducer

Location of the reducer program

files

Add HDFS files to the distributed cache.

arg

Set argument.

define

Set Hadoop configuration variables in the define=NAME=VALUE format.

cmdenv

Set environment variables in the cmdenv=NAME=VALUE format.

statusdir

WebHCat writes the status of the MapReduce job to statusdir. If this parameter is set, you need to manually delete it.

enablelog

If statusdir is set and enablelog is set to true, Hadoop task configurations and logs are collected to $statusdir/logs. Then, successful and failed attempts are recorded in the logs. The layout of the subdirectories in $statusdir/logs is as follows:

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

Only Hadoop 1.X is supported.

callback

Callback address after MapReduce job execution. Use $jobId to embed the job ID in the callback address. In the callback address, replace the $jobId with the job ID.

execute

Hive commands, including entire and short Hive commands

file

HDFS file containing Hive commands

files

Names of files to be copied to the MapReduce cluster, separated by commas (,)

arg

Set argument.

define

This parameter is used to configure Hadoop in the define=key=value format.

statusdir

WebHCat writes the status of the MapReduce job to statusdir. If this parameter is set, you need to manually delete it.

enablelog

If statusdir is set and enablelog is set to true, Hadoop task configurations and logs are collected to $statusdir/logs. Then, successful and failed attempts are recorded in the logs. The layout of the subdirectories in $statusdir/logs is as follows:

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

callback

Callback address after MapReduce job execution. Use $jobId to embed the job ID in the callback address. In the callback address, replace the $jobId with the job ID.

fields

If this parameter is set to *, details about each job are returned. If this parameter is not set, only a job ID is returned. The parameter can only be set to *. If the parameter is set to another value, an exception occurs.

jobid

If jobid is set, only jobs whose lexicographic order is greater than jobid are returned. For example, if the value of jobid is job_201312091733_0001, only the job whose value is greater than the value can be returned. The number of returned jobs depends on the value of numrecords.

numrecords

If numrecords and jobid are set, the jobid list is sorted lexicographically. After jobid is returned, the maximum value of numrecords can be obtained. If jobid is not set but numrecords is set, the maximum value of numrecords can be obtained after the jobid list is sorted lexicographically. In contrast, if numrecords is not set but jobid is set, all jobs whose lexicographic orders are greater than jobid will be 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. The default value is false.

jobid

Job ID, received after a job is created