Funzione SQLPrimaryKeys

Conformità
Versione introdotta: Conformità agli standard ODBC 1.0: ODBC

Sommario
SQLPrimaryKeys restituisce i nomi delle colonne che costituiscono la chiave primaria di una tabella. Il driver restituisce le informazioni come set di risultati. Questa funzione non supporta il ritorno di chiavi primarie da più tabelle in una singola chiamata.

Sintassi

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

Arguments

StatementHandle
[Input] Handle di istruzione.

CatalogName
[Input] Nome catalogo. Se un driver supporta cataloghi per alcune tabelle ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, una stringa vuota ("") indica quelle tabelle che non hanno cataloghi. CatalogName non può contenere un pattern di ricerca a stringhe.

Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, CatalogName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, CatalogName è un argomento ordinario; Viene trattato letteralmente, e il suo caso è significativo. Per altre informazioni, vedere Argomenti nelle Funzioni catalogo.

NameLength1
[Input] Lunghezza nei caratteri di *NomeCatalogo.

SchemaName
[Input] Nome schema. Se un driver supporta gli schemi per alcune tabelle ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, una stringa vuota ("") indica quelle tabelle che non hanno schemi. SchemaName non può contenere un pattern di ricerca a stringhe.

Se l'attributo dell'istruzione SQL_ATTR_METADATA_ID è impostato su SQL_TRUE, SchemaName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, SchemaName è un argomento ordinario; Viene trattato letteralmente e il suo caso non è significativo.

NameLength2
[Input] Lunghezza nei caratteri di *NomeSchema.

TableName
[Input] Nome tabella. Questo argomento non può essere un puntatore nullo. TableName non può contenere un pattern di ricerca stringa.

Se l'attributo della SQL_ATTR_METADATA_ID istruzione è impostato su SQL_TRUE, TableName viene trattato come un identificatore e il suo caso non è significativo. Se è SQL_FALSE, TableName è un argomento ordinario; Viene trattato letteralmente e il suo caso non è significativo.

NameLength3
[Input] Lunghezza nei caratteri di *NomeTabella.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR o SQL_INVALID_HANDLE.

Diagnostica

Quando SQLPrimaryKeys restituisce SQL_ERROR o SQL_SUCCESS_WITH_INFO, un valore SQLSTATE associato può essere ottenuto chiamando SQLGetDiagRec con un HandleType di SQL_HANDLE_STMT e un Handle di StatementHandle. La seguente tabella elenca i valori SQLSTATE comunemente restituiti da SQLPrimaryKeys e spiega ciascuno nel contesto di questa funzione; la notazione "(DM)" precede le descrizioni degli stati SQL restituite dal Driver Manager. Il codice restituito associato a ogni valore SQLSTATE è SQL_ERROR, a meno che non sia specificato diversamente.

SQLSTATE	Error	Description
01000	Avviso generale	Messaggio informativo specifico del driver. (La funzione restituisce SQL_SUCCESS_WITH_INFO.
08S01	Errore del collegamento di comunicazione	Collegamento di comunicazione tra il driver e l'origine dati a cui è stato connesso il driver non è riuscito prima del completamento dell'elaborazione della funzione.
24000	Stato del cursore non valido	(DM) È stato aperto un cursore in StatementHandle e SQLFetch o SQLFetchScroll è stato chiamato. Un cursore era aperto sull'InstructionHandle, ma SQLFetch o SQLFetchScroll non erano stati chiamati.
40001	Errore di serializzazione	È stato eseguito il rollback della transazione a causa di un deadlock della risorsa con un'altra transazione.
40003	Completamento istruzione sconosciuto	La connessione associata non è riuscita durante l'esecuzione di questa funzione e non è possibile determinare lo stato della transazione.
HY000	Errore generale	Si è verificato un errore per il quale non è stato specificato SQLSTATE e per il quale non è stato definito alcun SQLSTATE specifico dell'implementazione. Il messaggio di errore restituito da SQLGetDiagRec nel buffer MessageText* descrive l'errore e la relativa causa.
HY001	Errore di allocazione della memoria	Il driver non è riuscito ad allocare memoria necessaria per supportare l'esecuzione o il completamento della funzione.
HY008	Operazione annullata	L'elaborazione asincrona è stata abilitata per StatementHandle. La funzione è stata chiamata e prima di completare l'esecuzione, SQLCancel o SQLCancelHandle è stata chiamata in StatementHandle. La funzione è stata quindi chiamata di nuovo in StatementHandle. La funzione è stata chiamata e prima del completamento dell'esecuzione, SQLCancel o SQLCancelHandle è stato chiamato su StatementHandle da un thread diverso in un'applicazione multithread.
HY009	Uso non valido del puntatore Null	(DM) L'argomento TableName era un puntatore nullo. L'attributo dell'istruzione SQL_ATTR_METADATA_ID era impostato su SQL_TRUE, l'argomento CatalogName era un puntatore nullo, e SQLGetInfo con il tipo di informazione SQL_CATALOG_NAME restituisce che i nomi dei cataloghi sono supportati. (DM) L'attributo di istruzione SQL_ATTR_METADATA_ID era impostato su SQL_TRUE, e l'argomento SchemaName era un puntatore nullo.
HY010	Errore della sequenza di funzioni	(DM) È stata chiamata una funzione in esecuzione asincrona per l'handle di connessione associato a StatementHandle. Questa funzione asincrona era ancora in esecuzione quando veniva chiamata la funzione SQLPrimaryKeys . (DM) SQLExecute, SQLExecDirect o SQLMoreResults è stato chiamato per StatementHandle e restituito SQL_PARAM_DATA_AVAILABLE. Questa funzione è stata chiamata prima del recupero dei dati per tutti i parametri trasmessi. (DM) Una funzione in esecuzione asincrona (non questa) è stata chiamata per StatementHandle ed è ancora in esecuzione quando questa funzione è stata chiamata. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations o SQLSetPos è stato chiamato per StatementHandle e restituito SQL_NEED_DATA. Questa funzione è stata chiamata prima dell'invio dei dati per tutti i parametri o le colonne data-at-execution.
HY013	Errore di gestione della memoria	Impossibile elaborare la chiamata di funzione perché non è stato possibile accedere agli oggetti di memoria sottostanti, probabilmente a causa di condizioni di memoria insufficiente.
HY090	Lunghezza della stringa o del buffer non valida	(DM) Il valore di uno degli argomenti della lunghezza del nome era inferiore a 0 ma non uguale a SQL_NTS, e l'argomento associato al nome non è un puntatore nullo. Il valore di uno degli argomenti lunghezza nome ha superato il valore di lunghezza massima per il nome corrispondente.
HY117	La connessione viene sospesa a causa dello stato sconosciuto della transazione. Sono consentite solo funzioni disconnesse e di sola lettura.	(DM) Per altre informazioni sullo stato sospeso, vedere Funzione SQLEndTran.
HYC00	Funzionalità facoltativa non implementata	È stato specificato un catalogo, e il driver o la sorgente dati non supportano i cataloghi. È stato specificato uno schema e il driver o la sorgente dati non supportano gli schemi. La combinazione delle impostazioni correnti degli attributi delle istruzioni SQL_ATTR_CONCURRENCY e SQL_ATTR_CURSOR_TYPE non è supportata dal driver o dall'origine dati. L'attributo di istruzione SQL_ATTR_USE_BOOKMARKS è stato impostato su SQL_UB_VARIABLE e l'attributo dell'istruzione SQL_ATTR_CURSOR_TYPE è stato impostato su un tipo di cursore per cui il driver non supporta i segnalibri.
HYT00	Il timeout è scaduto	Il periodo di timeout è scaduto prima che la sorgente dati restituisse il set di risultati richiesto. Il periodo di timeout viene impostato tramite SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT.
HYT01	Il timeout della connessione è scaduto	Periodo di timeout della connessione scaduto prima che l'origine dati rispondesse alla richiesta. Il periodo di timeout della connessione viene impostato tramite SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT.
IM001	Il driver non supporta questa funzione	(DM) Il driver associato a StatementHandle non supporta la funzione.
IM017	Il polling è disabilitato in modalità di notifica asincrona	Ogni volta che viene usato il modello di notifica, il polling è disabilitato.
IM018	SQLCompleteAsync non è stato chiamato per completare l'operazione asincrona precedente su questo handle.	Se la chiamata di funzione precedente sull'handle restituisce SQL_STILL_EXECUTING e se la modalità di notifica è abilitata, è necessario chiamare SQLCompleteAsync sull'handle per eseguire la post-elaborazione e completare l'operazione.

Comments

SQLPrimaryKeys restituisce i risultati come un insieme di risultati standard, ordinato da TABLE_CAT, TABLE_SCHEM, TABLE_NAME e KEY_SEQ. Per informazioni su come usare queste informazioni, vedere Uses of Catalog Data.For information about how this information might be used, see Uses of Catalog Data.

Le seguenti colonne sono state rinominate in ODBC 3. x. I cambiamenti nel nome delle colonne non influiscono sulla retrocompatibilità perché le applicazioni si assegnano per numero di colonna.

Colonna ODBC 2.0	ODBC 3. Colonna X
TABLE_QUALIFIER	TABLE_CAT
PROPRIETARIO_TABELLA	TABLE_SCHEM

Per determinare la lunghezza effettiva delle colonne TABLE_CAT, TABLE_SCHEM, TABLE_NAME e COLUMN_NAME, chiama SQLGetInfo con le opzioni SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN e SQL_MAX_COLUMN_NAME_LEN.

Note

Per altre informazioni sull'utilizzo generale, gli argomenti e i dati restituiti delle funzioni del catalogo ODBC, vedere Funzioni del catalogo.

Nella tabella seguente sono elencate le colonne nel set di risultati. Colonne aggiuntive oltre la colonna 6 (PK_NAME) possono essere definite dal driver. Un'applicazione dovrebbe accedere alle colonne specifiche del driver contando alla rovescia dalla fine del set di risultati invece di specificare una posizione ordinale esplicita. Per altre informazioni, vedere Dati restituiti dalle funzioni del catalogo.

Nome della colonna	Numero di colonna	Tipo di dati	Comments
TABLE_CAT (ODBC 1.0)	1	Varchar	Nome del catalogo della tabella chiave primaria; NULL se non applicabile alla fonte dati. Se un driver supporta cataloghi per alcune tabelle ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, restituisce una stringa vuota ("") per quelle tabelle che non hanno cataloghi.
TABLE_SCHEM (ODBC 1.0)	2	Varchar	Nome dello schema della tabella chiave primaria; NULL se non applicabile alla fonte dati. Se un driver supporta gli schemi per alcune tabelle ma non per altre, ad esempio quando il driver recupera dati da diversi DBMS, restituisce una stringa vuota ("") per quelle tabelle che non hanno schemi.
TABLE_NAME (ODBC 1.0)	3	Varchar non NULL	Nome della tabella della chiave primaria.
COLUMN_NAME (ODBC 1.0)	4	Varchar non NULL	Nome della colonna chiave primaria. Il driver restituisce una stringa vuota per una colonna che non ha un nome.
KEY_SEQ (ODBC 1.0)	5	Smallint non NULL	Numero di sequenza della colonna in chiave (a partire da 1).
PK_NAME (ODBC 2.0)	6	Varchar	Nome chiave principale. NULL se non applicabile alla fonte dati.

Esempio di codice

Vedi SQLForeignKeys.

Per informazioni su	Vedi
Associazione di un buffer a una colonna in un set di risultati	Funzione SQLBindCol
Annullamento dell'elaborazione delle istruzioni	Funzione SQLCancel
Recupero di un blocco di dati o scorrimento di un set di risultati	Funzione SQLFetchScroll
Recupero di una singola riga o di un blocco di dati in direzione solo in avanti	Funzione SQLFetch
Restituzione delle colonne di chiavi esterne	Funzione SQLForeignKeys
Restituzione delle statistiche e indici delle tabelle	Funzione SQLStatistics

Commenti e suggerimenti

Questa pagina è stata utile?

Last updated on 2026-08-24