JDBC Driver for Azure Cosmos DB

Build 24.0.9060

Primary Keys

You can use the getPrimaryKeys method to return information about the primary keys for Azure Cosmos DB tables. You can restrict the results by the table name.

The following code example outputs the column or columns composing the primary key for the [CData].[Entities].Customers table:

String connectionString = "jdbc:cosmosdb:AccountEndpoint=myAccountEndpoint;AccountKey=myAccountKey;";

Connection conn = DriverManager.getConnection(connectionString);
ResultSet rs = conn.getMetaData().getPrimaryKeys("CData","Entities","Customers");
while(rs.next()){
  System.out.println(rs.getString("COLUMN_NAME"));
}

The getPrimaryKeys method returns the following columns:

Column NameData TypeDescription
TABLE_CATStringThe table catalog
TABLE_SCHEMStringThe table schema.
TABLE_NAMEStringThe table name.
COLUMN_NAMEStringThe column name.
KEY_SEQshortThe sequence number, or column index starting from 1, within the foreign key.
PK_NAMEStringThe primary key name.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060