API-Zusammenfassung des ODBC-Tabellenwertparameters

Gilt für:SQL ServerAzure SQL-DatenbankAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

ODBC unterstützt tabellenwertige Parameter (tabellenwertige Parameter) durch Erweiterungen mehrerer bestehender API-Funktionen. Diese Funktionen arbeiten zusammen, um tabellenwertige Parameterschemata zu beschreiben, Zeilensätze zu binden und zu übertragen, Metadaten abzurufen und Deskriptordatensätze zu verwalten.
Die folgenden Abschnitte ordnen die relevanten ODBC-Funktionen in logische Gruppen, um Ihnen zu helfen, zu verstehen, wie jeder Teil der tabellenwertigen Parameterpipeline funktioniert.

Tabellenwertige Parameterschema-Entdeckung und Metadatenfunktionen

Diese Funktionen helfen einer Anwendung, die Struktur von Tabellenwertparametern zu ermitteln, einschließlich Spaltenmetadaten, Parameterdefinitionen und verfügbaren SQL-Datentypen.

Funktion Zweck
SQLColumns Ruft Spaltenmetadaten für einen tabellenwertigen Parameter oder Tabellentyp ab
SQLDescribeParam Gibt Metadaten für einen tabellenwertigen Parameterparameter zurück, einschließlich Typ, Präzision und Skalierung
SQLGetTypeInfo Ruft die vom Treiber unterstützten SQL-Datentypen für tabellenwertige Parameterspalten ab
SQLPrimaryKeys Liefert Informationen über Schlüsselspalten in Tabellentypen, die mit tabellenwertigen Parametern verwendet werden
SQLProcedureColumns Ruft Metadaten für tabellenwertige, parameterbezogene gespeicherte Prozedurparameter ab
SQLTables Listet Tabellen und Tabellentypen auf, die als Quellen für tabellenwertige Parameterdeklarationen verfügbar sind

Tabellenwertige Parameterbindung und Datenübertragung

Diese Funktionen verarbeiten die Bindung strukturierter Daten an Parameter, übergeben die Daten während der Ausführung an den Server oder Streamingzeilen.

Funktion Zweck
SQLBindParameter Bindet einen Tabellenwertparameter an einen Anwendungspuffer oder Rowset.
SQLParamData Ruft den nächsten Teil eines gestreamten, tabellenwertigen Parameterparameters ab, wenn Daten-at-Execution verwendet wird
SQLPutData Sendet tabellenwertige Parameterdaten in Chunks während der Datenausführungsoperationen

Anweisungsausführung für tabellenwertige Parameter

Diese Funktionen führen SQL-Anweisungen aus, die tabellenwertige Parameter referenzieren und den Ausführungszyklus verwalten.

Funktion Zweck
SQLExecDirect Führt eine SQL-Anweisung aus, die tabellenwertige Parameter verwendet, ohne sie vorher vorzubereiten
SQLExecute Führt eine zuvor vorbereitete SQL-Anweisung aus, die tabellenwertige Parameterparameter enthält

Deskriptor- und Attributverwaltung für tabellenwertige Parameter

Verwenden Sie diese Funktionen, um Deskriptorfelder und Anweisungsattribute zu verwalten, die zum ordnungsgemäßen Beschreiben von Rowsets und strukturierten Parametern erforderlich sind.

Funktion Zweck
SQLGetDescField Ruft Metadaten des Deskriptors für tabellenwertige Parameterspalten oder -reihensätze ab
SQLSetDescField Setzt Deskriptor-Metadaten für tabellenwertige Parameterspalten oder Zeilensätze
SQLSetDescRec Legt einen vollständigen Deskriptor-Datensatz für strukturierte tabellenwertige Parameterdaten fest
SQLGetStmtAttr Ruft Ausweisungsattribute ab, die das Verhalten der tabellenwertigen Parameterausführung beeinflussen
SQLSetStmtAttr Setzt Anweisungsattribute wie Zeilengrößen oder Streaming-Flags für tabellenwertige Parameteroperationen

Diagnostik und Fehlerbehandlung für tabellenwertige Parameter

Nutzen Sie diese Funktionen, um Ihren Anwendungen zu helfen, Fehler, Warnungen oder Statusmeldungen während der tabellenwertigen Parameterbindung und Ausführung zu erkennen.

Funktion Zweck
SQLGetDiagField Ruft diagnostische Informationen ab, die während der tabellenwertigen Parameterverarbeitung generiert werden