getPrimaryKeys Method (SQLServerDatabaseMetaData)

Article
11/18/2022

Retrieves a description of the primary key columns of the given table.

Syntax

  
public java.sql.ResultSet getPrimaryKeys(java.lang.String cat,  
                                         java.lang.String schema,  
                                         java.lang.String table)

Parameters

cat

A String that contains the catalog name.

schema

A String that contains the schema name.

table

A String that contains the table name.

Return Value

A SQLServerResultSet object.

Exceptions

SQLServerException

Remarks

This getPrimaryKeys method is specified by the getPrimaryKeys method in the java.sql.DatabaseMetaData interface.

The result set returned by the getPrimaryKeys method will contain the following information:

Name	Type	Description
TABLE_CAT	String	The name of the database in which the specified table resides.
TABLE_SCHEM	String	The schema for the table.
TABLE_NAME	String	The name of the table.
COLUMN_NAME	String	The name of the column.
KEY_SEQ	short	The sequence number of the column in a multicolumn primary key.
PK_NAME	String	The name of the primary key.

Note

For more information about the data returned by the getPrimaryKeys method, see "sp_pkeys (Transact-SQL)" in SQL Server Books Online.

Example

The following example demonstrates how to use the getPrimaryKeys method to return information about the primary keys of the Person.Contact table in the AdventureWorks2022 sample database.

public static void executeGetPrimaryKeys(Connection con) {  
   try {  
      DatabaseMetaData dbmd = con.getMetaData();  
      ResultSet rs = dbmd.getPrimaryKeys("AdventureWorks", "Person", "Contact");  
      ResultSetMetaData rsmd = rs.getMetaData();  
  
      // Display the result set data.  
      int cols = rsmd.getColumnCount();  
      while(rs.next()) {  
         for (int i = 1; i <= cols; i++) {  
            System.out.println(rs.getString(i));  
         }  
      }  
      rs.close();  
   }   
  
   catch (Exception e) {  
      e.printStackTrace();  
   }  
}