Purpose
Registers specified database.
URL
/emrest/datadiscovery/databases/{database-name}
HTTP Method
PUT
Request Parameters
Path variable:database-name
Request body in JSON with the following parameters.
Name | Description | Data Type |
---|---|---|
database_name | Name of the database | String |
servers | Server details for the database | Any array of JSON (Parameters show in following table.) |
Name | Description | Data Type | Notes |
---|---|---|---|
server_name | Name of the server | String | Required. |
server_type | Type of server | String | Required. Possible values:
|
db_user | Database logon user | String | Relevant and optional for server_type TD and AST. Required if db_password is specified. |
db_password | Database logon password | String | Relevant and optional for server_type TD and AST. |
ast_port | Aster connectivity port | Integer | Relevant and required for server_type AST. |
ast_schema | Aster database schema | String | Relevant and required for server_type AST. |
hcatalog_server_name | Hadoop hcatalog server | String | Relevant and required for server_type HDP. |
hcatalog_port | Hadoop hcatalog port | Integer | Relevant and required for server_type HDP. |
hdp_user | Hadoop hdp user | String | Relevant and optional for server_type HDP. |
sqlh_server_name | SQL-H server | String | Relevant and required for server_type HDP. |
sqlh_db_user | SQL-H db user | String | Relevant and optional for server_type HDP. Required if sqlh_db_password is specified. |
sqlh_db_password | SQL-H db password | String | Relevant and optional for server_type HDP. |
webhcatalog_port | Hadoop webhcatalog port | Integer | Relevant and required for server_type HDP. |
Response
A JSON response indicates success or error.
Status
A status code of 200 is returned on a successful completion. A non-200 status code is returned if an error occurs.
Example: Registering a Database using the API
{ "database_name": "testdatabase_sd", "servers": [ { "server_name": "wario", "server_type": "td" } ] }
Example: Registering a Database (Multiple Servers) using the API
{ "database_name": "testdatabase_au", "servers": [ { "server_name": "wario", "server_type": "TD" }, { "server_name": "falco", "server_type": "TD" }, { "server_name": "sdlc5103.labs.teradata.com", "server_type": "AST", "ast_schema": "public", "ast_port": 2406 } ] }