Função SQLStatistics

SQLStatistics recupera uma lista de estatísticas sobre uma única tabela e os índices associados à tabela. O driver retorna as informações como um conjunto de resultados.

Compatibilidade

Versão introduzida: ODBC 1.0 Standards Compliance: ISO 92

Sintaxe

SQLRETURN SQLStatistics(
     SQLHSTMT        StatementHandle ,
     SQLCHAR *       CatalogName ,
     SQLSMALLINT     NameLength1 ,
     SQLCHAR *       SchemaName ,
     SQLSMALLINT     NameLength2 ,
     SQLCHAR *       TableName ,
     SQLSMALLINT     NameLength3 ,
     SQLUSMALLINT    Unique ,
     SQLUSMALLINT    Reserved);

Arguments

StatementHandle

[Entrada] Identificador de instrução.

Catalogname

[Entrada] Nome do catálogo. Se um driver dá suporte a catálogos para algumas tabelas, mas não para outras, como quando o driver recupera dados de DBMSs diferentes, uma cadeia de caracteres vazia ("") indica as tabelas que não têm catálogos. CatalogName não pode conter um padrão de pesquisa de cadeia de caracteres.

Se o atributo de SQL_ATTR_METADATA_ID instrução estiver definido comoSQL_TRUE, CatalogName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, CatalogName é um argumento comum; é tratado literalmente e seu caso é significativo. Para obter mais informações, consulte Argumentos em funções de catálogo.

NameLength1

[Entrada] Comprimento em caracteres de CatalogName.

SchemaName

[Entrada] Nome do esquema. Se um driver der suporte a esquemas para algumas tabelas, mas não para outras, como quando o driver recupera dados de DBMSs diferentes, uma cadeia de caracteres vazia ("") indica as tabelas que não têm esquemas. SchemaName não pode conter um padrão de pesquisa de cadeia de caracteres.

Se o atributo de SQL_ATTR_METADATA_ID instrução estiver definido comoSQL_TRUE, SchemaName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, SchemaName é um argumento comum; é tratado literalmente e seu caso é significativo.

NameLength2

[Entrada] Comprimento em caracteres de SchemaName.

TableName

[Entrada] Nome da tabela. Esse argumento não pode ser um ponteiro nulo. TableName não pode conter um padrão de pesquisa de cadeia de caracteres.

Se o atributo de SQL_ATTR_METADATA_ID instrução estiver definido comoSQL_TRUE, TableName será tratado como um identificador e seu caso não será significativo. Se for SQL_FALSE, TableName é um argumento comum; é tratado literalmente e seu caso é significativo.

NameLength3

[Entrada] Comprimento em caracteres de TableName.

Único

[Entrada] Tipo de índice: SQL_INDEX_UNIQUE ou SQL_INDEX_ALL.

Reserved

[Entrada] Indica a importância da coluna e PAGES do CARDINALITY conjunto de resultados. As opções a seguir afetam apenas o retorno do e PAGES das CARDINALITY colunas; as informações de índice são retornadas mesmo se CARDINALITY e PAGES não forem retornadas.

SQL_ENSURE solicita que o driver recupere incondicionalmente as estatísticas. (Os drivers que estão em conformidade apenas com o padrão open group e não dão suporte a extensões ODBC não poderão dar suporte SQL_ENSUREa .)

SQL_QUICK solicita que o driver recupere e CARDINALITYPAGES somente se estiver prontamente disponível no servidor. Nesse caso, o driver não garante que os valores sejam atuais. (Os aplicativos gravados no padrão Open Group sempre receberão SQL_QUICK o comportamento de drivers compatíveis com ODBC 3.x.)

Devoluções

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERRORou SQL_INVALID_HANDLE.

Diagnostics

Quando SQLStatistics retorna SQL_ERROR ou SQL_SUCCESS_WITH_INFO, um valor associado SQLSTATE pode ser obtido chamando SQLGetDiagRec com um HandleType de SQL_HANDLE_STMT e um Identificador de StatementHandle. A tabela a seguir lista os SQLSTATE valores normalmente retornados SQLStatistics e explica cada um deles no contexto dessa função; a notação (DM) precede as descrições de cada SQLSTATE um retornado pelo Gerenciador de Driver. O código de retorno associado a cada SQLSTATE valor é SQL_ERROR, a menos que observado o contrário.

Comments

SQLStatisticsretorna informações sobre uma única tabela como um conjunto de resultados padrão, ordenado por NON_UNIQUE, , TYPE, INDEX_QUALIFIERe ORDINAL_POSITIONINDEX_NAME. O conjunto de resultados combina informações de estatísticas (nas CARDINALITY colunas do PAGES conjunto de resultados) para a tabela com informações sobre cada índice. Para obter informações sobre como essas informações podem ser usadas, consulte Usos de dados de catálogo.

Para determinar os comprimentos reais de TABLE_CAT, TABLE_SCHEMe TABLE_NAMECOLUMN_NAME colunas, um aplicativo pode chamar SQLGetInfo com o SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LENe SQL_MAX_TABLE_NAME_LENSQL_MAX_COLUMN_NAME_LEN opções.

As colunas a seguir foram renomeada para ODBC 3.x. As alterações de nome da coluna não afetam a compatibilidade com versões anteriores porque os aplicativos são associados por número de coluna.

A tabela a seguir lista as colunas no conjunto de resultados. Colunas adicionais além da coluna 13 (FILTER_CONDITION) podem ser definidas pelo driver. Um aplicativo deve obter acesso a colunas específicas do driver contando o final do conjunto de resultados em vez de especificar uma posição ordinal explícita. Para obter mais informações, consulte Dados Retornados por Funções de Catálogo.

Se a linha no conjunto de resultados corresponder a uma tabela, o driver definirá TYPESQL_TABLE_STAT como e definirá NON_UNIQUE, INDEX_QUALIFIER, , INDEX_NAME, ORDINAL_POSITIONe ASC_OR_DESCCOLUMN_NAMEpara NULL. Se CARDINALITY ou PAGES não estiverem disponíveis na fonte de dados, o driver os definirá como NULL.

Exemplo de código

Para obter um exemplo de código de uma função semelhante, consulte a Função SQLColumns.

Funções relacionadas

Conteúdo relacionado

• Referência da API ODBC
• Arquivos de cabeçalho ODBC