Get primary key information for a specified table

Hybrid Data Pipeline API reference : Management API : Schema API : Get primary key information for a specified table

Purpose

Retrieves the primary key for the specified table. If the table does not have a primary key assigned in the underlying data store, the schema may define a primary key consisting of one or more columns.

Important: When a schema has been specified for the Metadata Exposed Schemas option in the Web UI (or the HDPMetadataExposedSchemas property via the Data Sources API), the Schema API can only be used to query the specified schema. If the schema specifed for Metadata Exposed Schemas does not match the schema in the Schema API URL, then an empty result set will be returned. For details on Metadata Exposed Schemas, see the parameters topic for your data source type.

Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

Method

GET

URL

For data stores that support schemas

https://<myserver>:<port>/api/mgmt/datasources/<datasourceid>/schemas/
<schemaName>/tables/<tableName>/primarykeys

For data stores that do not support schemas

https://<myserver>:<port>/api/mgmt/datasources/<datasourceid>/schemas/-/
tables/<tableName>/primarykeys

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

Parameter	Description	Usage	Valid Values
"datasourceId"	The ID of the data source	Required	The ID is auto-generated when the data source is created and cannot be changed.
"schemaName"	For data stores that support schemas, the name of a schema associated with the data source. For data stores that do not support schemas, a dash (-) is returned.	Required	For data stores that support schemas, a valid schema name. For data stores that do not support schemas, a dash (-) is returned.
"tableName"	The name of the table for which information is being retrieved	Required	A table name can contain only alphanumeric characters and the underscore character.

Response definition

The response takes the following format. The properties of the response are described in the table that follows.

{
"primaryKeys": [
{
"name": "primaryKey1"
}
]
}

Property	Description	Valid Values
"name"	The name of a primary key column, or a comma separated list of columns that comprise the primary key	A column name can contain only alphanumeric characters and the underscore character.

Sample server success response

The following response is returned for a table with a primary key comprised of two columns.

{
"primaryKeys": [
{
"name": "ROWID"
},
{
"name": "MasterRecordId"
}
]
}

Sample server failure response

Error 404 is returned if the schema does not exist.

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.