SQLPrimaryKeys-funktion

Överensstämmelse
Version introducerad: ODBC 1.0 Standardefterlevnad: ODBC

Summary
SQLPrimaryKeys returnerar kolumnnamnen som utgör primärnyckeln för en tabell. Drivrutinen returnerar informationen som en resultatuppsättning. Denna funktion stöder inte att returnera primärnycklar från flera tabeller i ett enda anrop.

Syntax

  
SQLRETURN SQLPrimaryKeys(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      CatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      SchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      TableName,  
     SQLSMALLINT    NameLength3);  

Arguments

StatementHandle
[Indata] Instruktionshandtag.

CatalogName
[Indata] Katalognamn. Om en drivrutin stödjer kataloger för vissa tabeller men inte för andra, till exempel när drivrutinen hämtar data från olika databaser, betecknar en tom sträng ("") de tabeller som inte har kataloger. CatalogName kan inte innehålla ett strängsökningsmönster.

Om attributet SQL_ATTR_METADATA_ID sats sätts till SQL_TRUE behandlas CatalogName som en identifierare och dess fall är inte signifikant. Om det är SQL_FALSE är CatalogName ett vanligt argument; Den behandlas bokstavligt, och dess fall är betydelsefullt. Mer information finns i Argument i Katalogfunktioner.

NameLength1
[Input] Längd i tecken i *CatalogName.

Schema-namn
[Indata] Schemanamn. Om en drivrutin stöder scheman för vissa tabeller men inte för andra, till exempel när drivrutinen hämtar data från olika databassystem, betecknar en tom sträng ("") de tabeller som inte har scheman. SchemaName kan inte innehålla ett strängsökningsmönster.

Om attributet SQL_ATTR_METADATA_ID är satt till SQL_TRUE behandlas SchemaName som en identifierare och dess fall är inte signifikant. Om det är SQL_FALSE är SchemaName ett vanligt argument; Det behandlas bokstavligt, och dess fall är inte betydelsefullt.

NameLength2
[Input] Längd i tecken i *SchemaName.

TableName
[Indata] Tabellnamn. Detta argument kan inte vara en nollpekare. TableName kan inte innehålla ett strängsökningsmönster.

Om attributet SQL_ATTR_METADATA_ID sats sätts till SQL_TRUE behandlas TableName som en identifierare och dess fall är inte signifikant. Om det är SQL_FALSE är TableName ett vanligt argument; Det behandlas bokstavligt, och dess fall är inte betydelsefullt.

NameLength3
[Input] Längd i tecken av *TableName.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR eller SQL_INVALID_HANDLE.

Diagnostics

När SQLPrimaryKeys returnerar SQL_ERROR eller SQL_SUCCESS_WITH_INFO kan ett associerat SQLSTATE-värde erhållas genom att anropa SQLGetDiagRec med en HandleType av SQL_HANDLE_STMT och ett Handle av StatementHandle. Följande tabell listar de SQLSTATE-värden som vanligtvis returneras av SQLPrimaryKeys och förklarar var och en i kontexten av denna funktion; notationen "(DM)" föregår beskrivningarna av SQLSTATE som returneras av Driver Manager. Returkoden som är associerad med varje SQLSTATE-värde är SQL_ERROR, om inget annat anges.

Comments

SQLPrimaryKeys returnerar resultaten som en standardmängd resultat, ordnade efter TABLE_CAT, TABLE_SCHEM, TABLE_NAME och KEY_SEQ. Information om hur den här informationen kan användas finns i Användning av katalogdata.

Följande kolumner har bytt namn till ODBC 3. x. Kolumnnamnsändringarna påverkar inte bakåtkompatibilitet eftersom applikationer binds efter kolumnnummer.

För att bestämma de faktiska längderna på kolumnerna TABLE_CAT, TABLE_SCHEM, TABLE_NAME och COLUMN_NAME, anropa SQLGetInfo med alternativen SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN och SQL_MAX_COLUMN_NAME_LEN.

I följande tabell visas kolumnerna i resultatuppsättningen. Ytterligare kolumner bortom kolumn 6 (PK_NAME) kan definieras av drivrutinen. En applikation bör få tillgång till drivrutinsspecifika kolumner genom att räkna ner från slutet av resultatuppsättningen istället för att specificera en explicit ordinal position. Mer information finns i Data som returneras av katalogfunktioner.

Kodexempel

Se SQLForeignKeys.

Relaterade funktioner

Relaterat innehåll

• ODBC API-referens
• ODBC-huvudfiler