Resumo da API de parâmetro com valor de tabela ODBC

Aplica-se a:SQL ServerBanco de Dados SQL do AzureInstância Gerenciada de SQL do AzureAzure Synapse Analytics

O ODBC suporta parâmetros de tabela (parâmetros de tabela com valores) por meio de aprimoramentos em várias funções de API existentes. Essas funções trabalham juntas para descrever esquemas de parâmetros com valores em tabelas, vincular e transmitir conjuntos de linhas, buscar metadados e gerenciar registros de descritores.
As seções a seguir organizam as funções ODBC relevantes em grupos lógicos para ajudar você a entender como cada parte do pipeline de parâmetros de valores de tabela opera.

Descoberta de esquemas de parâmetros com valores de tabela e funções de metadados

Essas funções ajudam um aplicativo a descobrir a estrutura de parâmetros com valor de tabela, incluindo metadados de coluna, definições de parâmetro e tipos de dados SQL disponíveis.

Função Propósito
SQLColumns Recupera metadados de colunas para um parâmetro ou tipo de tabela com valores de tabela
SQLDescribeParam Retorna metadados para um parâmetro de valor de tabela, incluindo tipo, precisão e escala
SQLGetTypeInfo Recupera os tipos de dados SQL suportados pelo driver para colunas de parâmetros com valores de tabela
SQLPrimaryKeys Fornece informações sobre colunas-chave em tipos de tabela usados com parâmetros de tabela
SQLProcedureColumns Recupera metadados para parâmetros de procedimentos armazenados relacionados a parâmetros de tabela
SQLTables Lista tabelas e tipos de tabelas disponíveis como fontes para declarações de parâmetros com valores de tabela

Vinculação de parâmetros com valores de tabela e transmissão de dados

Essas funções lidam com a associação de dados estruturados a parâmetros, passando os dados para o servidor ou linhas de streaming durante a execução.

Função Propósito
SQLBindParameter Associa um parâmetro com valor de tabela a um buffer de aplicativo ou conjunto de linhas
SQLParamData Recupera a próxima parte de um parâmetro de tabela transmitido ao usar dados na execução
SQLPutData Envia dados de parâmetros com valores de tabela em blocos durante operações de dados na execução

Execução de instruções para parâmetros de valores de tabela

Essas funções executam instruções SQL que referenciam parâmetros de tabela e gerenciam o ciclo de vida da execução.

Função Propósito
SQLExecDirect Executa uma instrução SQL que usa parâmetros de tabela sem prepará-la antes
SQLExecute Executa uma instrução SQL previamente preparada que inclui parâmetros de parâmetros com valores de tabela

Gerenciamento de descritores e atributos para parâmetros com valores de tabela

Use essas funções para gerenciar os campos de descritor e os atributos de instrução necessários para descrever os conjuntos de linhas e os parâmetros estruturados corretamente.

Função Propósito
SQLGetDescField Recupera metadados de descritores para colunas de parâmetros ou conjuntos de linhas com valores de tabela
SQLSetDescField Metadados de descritores de conjuntos para colunas de parâmetros com valores de tabela ou conjuntos de linhas
SQLSetDescRec Estabelece um registro descritor completo para dados estruturados de parâmetros com valores em tabela
SQLGetStmtAttr Recupera atributos da instrução que afetam o comportamento de execução de parâmetros com valores de tabela
SQLSetStmtAttr Define atributos de instruções, como tamanhos de linhas ou flags de streaming, para operações de parâmetros com valores de tabela

Diagnóstico e tratamento de erros para parâmetros de tabela

Use essas funções para ajudar suas aplicações a detectar erros, avisos ou mensagens de status durante a vinculação e execução de parâmetros com valores de tabela.

Função Propósito
SQLGetDiagField Recupera informações diagnósticas geradas durante o processamento de parâmetros com valores de tabela

Conteúdo relacionado

  • Última atualização em