This page aims to catalogue and describe the various public facing APIs exposed by Hive in order to inform developers wishing to integrate their applications and frameworks with the Hive ecosystem. To date the following APIs have been identified in the Hive project that are either considered public, or widely used in the public domain:
...
| Note | ||||
|---|---|---|---|---|
| ||||
Requires overview. |
HiveServer2 API
Query based Java API.
| Note | ||||
|---|---|---|---|---|
| ||||
Describe. |
HCatalog CLI (Command Line)
Query based API. This is well documented on the wiki.
...
| icon | false |
|---|---|
| title | TODO |
...
Hive community has been working deprecating Hive Cli. Hcatalog Cli is similar to Hive Cli and will be deprecated.
Metastore (Java)
A Thrift operation based API with Java bindings, described by the IMetaStoreClient interface. The API decouples the metastore storage layer from other Hive internals. Because Hive itself uses this internally, it is required to implement a comprehensive feature set which makes it attractive to developers who might find the other APIs lacking. It was not originally intended to be a public API although it became public in version 1.0.0 (HIVE-3280) and there is a proposal that it be documented more fully (HIVE-9363). Anecdotally, its use outside of the Hive project is not currently recommended.
| Note | ||||
|---|---|---|---|---|
| ||||
There are numerous ways of instantiating the metastore API including: |
Hive (Java)
Refers to the org.apache.hadoop.hive.ql.metadata.Hive class. Appears to be a distinct concrete implementation of a variation of the metastore API. Delegates to the metastore API but does not directly extend/implement it.
| Note | ||||
|---|---|---|---|---|
| ||||
I suspect its use is not encouraged. Seeking clarification on the motivations behind this class and thoughts on its use outside of Hive. |
Driver (Java)
...
. |
...
| Note | ||||
|---|---|---|---|---|
| ||||
Describe the role of |
WebHCat (REST)
WebHCat is a REST operation based API for HCatalog. This is well documented on the wiki.
...
| icon | false |
|---|---|
| title | TODO |
...
This not actively maintained and likely not be supported in future releases. For job submission, consider using Oozie or similar tools. For DDL, use JDBC.
Streaming Data Ingest (Java)
...
Operation based Java API focused on mutating (insert/update/delete) records into transactional tables using Hive’s ACID feature. Large volumes of mutations are applied atomically in a single long-lived transaction. Documented on the wiki. Scheduled for release in Hive version 2.0.0 (HIVE-10165).
hive-jdbc (JDBC)
Query based JDBC API .
...
| icon | false |
|---|---|
| title | TODO |
...
supported by Hive. It supports most of the functionality in JDBC spec.