Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Describe Database — GET ddl/database/:db

Table of Contents

Description

Describe a database. (Note: This resource has a "format=extended" parameter however the output structure does not change if it is used.)

URL

http://www.myserver.com/templeton/v1/ddl/database/:db

Parameters

Name

Description

Required?

Default

:db

The database name

Required

None

The standard parameters are also supported.

Results

Name

Description

location

The database location

params

The database parameters

comment

The database comment

database

The database name

Example

Curl Command

No Format
% curl -s 'http://localhost:50111/templeton/v1/ddl/database/newdb?user.name=ctdean'

JSON Output

No Format
{
 "location":"hdfs://localhost:9000/warehouse/newdb.db",
 "params":"{a=b}",
 "comment":"Hello there",
 "database":"newdb"
}

JSON Output (error)

No Format
{
  "error": "No such database: newdb",
  "errorCode": 404
}


Panel
titleColorindigo
titleBGColorsilver
titleNavigation Links

Previous: GET ddl/database
Next: PUT ddl/database/:db

General: DDL ResourcesWebHCat ReferenceWebHCat ManualHCatalog ManualHive Wiki HomeHive Project Site
Old version of this document (HCatalog 0.5.0): GET ddl/database/:db