Función SQLStatistics

SQLStatistics recupera una lista de estadísticas sobre una sola tabla y los índices asociados a la tabla. El controlador devuelve la información como un conjunto de resultados.

Conformidad

Versión introducida: Cumplimiento de estándares ODBC 1.0: ISO 92

Syntax

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 instrucciones.

CatalogName

[Entrada] Nombre del catálogo. Si un controlador admite catálogos para algunas tablas pero no para otras, como cuando el controlador recupera datos de diferentes DBMS, una cadena vacía ("") indica esas tablas que no tienen catálogos. CatalogName no puede contener un patrón de búsqueda de cadenas.

Si el SQL_ATTR_METADATA_ID atributo de instrucción se establece SQL_TRUEen , CatalogName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, CatalogName es un argumento normal; se trata literalmente y su caso es significativo. Para obtener más información, vea Argumentos en funciones de catálogo.

NameLength1

[Entrada] Longitud en caracteres de CatalogName.

SchemaName

[Entrada] Nombre del esquema. Si un controlador admite esquemas para algunas tablas, pero no para otras, como cuando el controlador recupera datos de diferentes DBMS, una cadena vacía ("") indica las tablas que no tienen esquemas. SchemaName no puede contener un patrón de búsqueda de cadenas.

Si el SQL_ATTR_METADATA_ID atributo de instrucción se establece SQL_TRUEen , SchemaName se trata como identificador y su caso no es significativo. Si es SQL_FALSE, SchemaName es un argumento normal; se trata literalmente y su caso es significativo.

NameLength2

[Entrada] Longitud en caracteres de SchemaName.

TableName

[Entrada] Nombre de la tabla. Este argumento no puede ser un puntero nulo. TableName no puede contener un patrón de búsqueda de cadenas.

Si el SQL_ATTR_METADATA_ID atributo de instrucción se establece SQL_TRUEen , TableName se trata como un identificador y su caso no es significativo. Si es SQL_FALSE, TableName es un argumento ordinario; se trata literalmente y su caso es significativo.

NameLength3

[Entrada] Longitud en caracteres de TableName.

Único

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

Reserved

[Entrada] Indica la importancia de las CARDINALITY columnas y PAGES del conjunto de resultados. Las siguientes opciones afectan solo a la devolución de las CARDINALITY columnas y PAGES ; la información de índice se devuelve incluso si CARDINALITY no se devuelven y PAGES .

SQL_ENSURE solicita que el controlador recupere incondicionalmente las estadísticas. (Los controladores que solo se ajustan al estándar Open Group y no admiten extensiones ODBC no podrán admitir SQL_ENSURE).

SQL_QUICK solicita que el controlador recupere y CARDINALITYPAGES solo si están disponibles fácilmente desde el servidor. En este caso, el controlador no garantiza que los valores estén actualizados. (Las aplicaciones escritas en el estándar Open Group siempre obtendrán SQL_QUICK el comportamiento de los controladores compatibles con ODBC 3.x).

Devoluciones

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERRORo SQL_INVALID_HANDLE.

Diagnostics

Cuando SQLStatistics devuelve SQL_ERROR o SQL_SUCCESS_WITH_INFO, se puede obtener un valor asociado SQLSTATE llamando a SQLGetDiagRec con un HandleType de SQL_HANDLE_STMT y un identificador de StatementHandle. En la tabla siguiente se enumeran los SQLSTATE valores devueltos por SQLStatistics y se explica cada uno en el contexto de esta función; la notación (DM) precede a las descripciones de cada SQLSTATE una de las devueltas por el Administrador de controladores. El código devuelto asociado a cada SQLSTATE valor es SQL_ERROR, a menos que se indique lo contrario.

SQLSTATE	Error	Description
`01000`	Advertencia general	Mensaje informativo específico del controlador. (Function devuelve `SQL_SUCCESS_WITH_INFO`.)
`08S01`	Error de vínculo de comunicación	Se produjo un error en el vínculo de comunicación entre el controlador y el origen de datos al que se conectó el controlador antes de que la función completara el procesamiento.
`24000`	Estado de cursor no válido	Se ha abierto un cursor en StatementHandle y `SQLFetch` se ha llamado a o `SQLFetchScroll` . El Administrador de controladores devuelve este error si `SQLFetch` el controlador devuelve o `SQLFetchScroll` no lo ha devuelto `SQL_NO_DATA` y lo devuelve el controlador si `SQLFetch` o `SQLFetchScroll` ha devuelto `SQL_NO_DATA`. Se abrió un cursor en StatementHandle, pero `SQLFetch` o `SQLFetchScroll` no se había llamado.
`40001`	Error de serialización	La transacción se revierte debido a un interbloqueo de recursos con otra transacción.
`40003`	Finalización de instrucciones desconocida	Error en la conexión asociada durante la ejecución de esta función y no se puede determinar el estado de la transacción.
`HY000`	Error general	Se produjo un error para el que no había ningún específico `SQLSTATE` y para el que no se definió ningún específico `SQLSTATE` de la implementación. El mensaje de error devuelto por `SQLGetDiagRec` en el búfer *MessageText describe el error y su causa.
`HY001`	Error de asignación de memoria	El controlador no pudo asignar memoria necesaria para admitir la ejecución o finalización de la función.
`HY008`	Operación cancelada	El procesamiento asincrónico se ha habilitado para StatementHandle. Se llamó a la función y antes de completar la ejecución, `SQLCancel` o `SQLCancelHandle` se llamó a en StatementHandle y, a continuación, se llamó a la función de nuevo en StatementHandle. Se llamó a la función y antes de completar la ejecución, `SQLCancel` o `SQLCancelHandle` se llamó a en StatementHandle desde un subproceso diferente en una aplicación multithread.
`HY009`	Uso no válido del puntero nulo	El argumento TableName era un puntero nulo. El `SQL_ATTR_METADATA_ID` atributo de instrucción se estableció `SQL_TRUE`en , el argumento CatalogName era un puntero nulo y InfoType`SQL_CATALOG_NAME` devuelve que se admiten los nombres de catálogo. (DM) El `SQL_ATTR_METADATA_ID` atributo de instrucción se estableció `SQL_TRUE`en y el argumento SchemaName era un puntero nulo.
`HY010`	Error de secuencia de funciones	(DM) Se llamó a una función de ejecución asincrónica para el identificador de conexión asociado a StatementHandle. Esta función asincrónica todavía se estaba ejecutando cuando se llamó a la `SQLStatistics` función. (DM) `SQLExecute`, `SQLExecDirect`o `SQLMoreResults` se llamó a para statementHandle y devolvió `SQL_PARAM_DATA_AVAILABLE`. Se llamó a esta función antes de recuperar los datos para todos los parámetros transmitidos. (DM) Se llamó a una función que ejecuta de forma asincrónica (no esta) para statementHandle y todavía se estaba ejecutando cuando se llamó a esta función. (DM) `SQLExecute`, `SQLExecDirect`, `SQLBulkOperations`o `SQLSetPos` se llamó a para statementHandle y devolvió `SQL_NEED_DATA`. Se llamó a esta función antes de enviar datos para todos los parámetros o columnas de datos en ejecución.
`HY013`	Error de administración de memoria	No se pudo procesar la llamada de función porque no se pudo tener acceso a los objetos de memoria subyacentes, posiblemente debido a condiciones de memoria baja.
`HY090`	Longitud de búfer o cadena no válida	(DM) El valor de uno de los argumentos de longitud de nombre era menor que 0, pero no igual a `SQL_NTS`. El valor de uno de los argumentos de longitud de nombre superó el valor de longitud máxima para el nombre correspondiente.
`HY100`	Tipo de opción de unicidad fuera del intervalo	(DM) Se especificó un valor único no válido.
`HY101`	Tipo de opción de precisión fuera del intervalo	(DM) Se especificó un valor reservado no válido.
`HY117`	La conexión se suspende debido al estado de transacción desconocido. Solo se permiten las funciones de desconexión y solo lectura.	(DM) Para obtener más información sobre el estado suspendido, vea Función SQLEndTran.
`HYC00`	Característica opcional no implementada	Se especificó un catálogo y el controlador o el origen de datos no admite catálogos. Se especificó un esquema y el controlador o el origen de datos no admite esquemas. La combinación de la configuración actual de los atributos de instrucción `SQL_ATTR_CONCURRENCY` y `SQL_ATTR_CURSOR_TYPE` no era compatible con el controlador o el origen de datos. El `SQL_ATTR_USE_BOOKMARKS` atributo de instrucción se estableció `SQL_UB_VARIABLE`en y el `SQL_ATTR_CURSOR_TYPE` atributo de instrucción se estableció en un tipo de cursor para el que el controlador no admite marcadores.
`HYT00`	Tiempo de espera expirado	El período de tiempo de espera de la consulta expiró antes de que el origen de datos devolviera el conjunto de resultados solicitado. El período de tiempo de espera se establece mediante `SQLSetStmtAttr`, `SQL_ATTR_QUERY_TIMEOUT`.
`HYT01`	Se ha agotado el tiempo de espera de la conexión.	El período de tiempo de espera de conexión expiró antes de que el origen de datos respondiera a la solicitud. El período de tiempo de espera de conexión se establece mediante `SQLSetConnectAttr`, `SQL_ATTR_CONNECTION_TIMEOUT`.
`IM001`	El controlador no admite esta función	(DM) El controlador asociado a StatementHandle no admite la función .
`IM017`	El sondeo está deshabilitado en modo de notificación asincrónica	Cada vez que se usa el modelo de notificación, el sondeo está deshabilitado.
`IM018`	`SQLCompleteAsync` no se ha llamado a para completar la operación asincrónica anterior en este identificador.	Si la llamada de función anterior en el identificador devuelve `SQL_STILL_EXECUTING` y si el modo de notificación está habilitado, `SQLCompleteAsync` se debe llamar a en el identificador para realizar el posprocesamiento y completar la operación.

Comentarios

SQLStatisticsdevuelve información sobre una sola tabla como un conjunto de resultados estándar, ordenado por , , , y ORDINAL_POSITIONINDEX_NAME. INDEX_QUALIFIERTYPENON_UNIQUE El conjunto de resultados combina información de estadísticas (en las CARDINALITY columnas y PAGES del conjunto de resultados) de la tabla con información sobre cada índice. Para obtener información sobre cómo se puede usar esta información, vea Usos de datos de catálogo.

Para determinar las longitudes reales de las TABLE_CATcolumnas , TABLE_SCHEM, TABLE_NAMEy COLUMN_NAME , una aplicación puede llamar a SQLGetInfo con las SQL_MAX_CATALOG_NAME_LENopciones , SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LENy SQL_MAX_COLUMN_NAME_LEN .

Nota:

Para obtener más información sobre el uso general, los argumentos y los datos devueltos de funciones de catálogo ODBC, vea Funciones de catálogo.

Se ha cambiado el nombre de las columnas siguientes para ODBC 3.x. Los cambios de nombre de columna no afectan a la compatibilidad con versiones anteriores porque las aplicaciones enlazan por número de columna.

Columna ODBC 2.0	Columna ODBC 3.x
`TABLE_QUALIFIER`	`TABLE_CAT`
`TABLE_OWNER`	`TABLE_SCHEM`
`SEQ_IN_INDEX`	`ORDINAL_POSITION`
`COLLATION`	`ASC_OR_DESC`

En la tabla siguiente se enumeran las columnas del conjunto de resultados. El controlador puede definir columnas adicionales más allá de la columna 13 (FILTER_CONDITION). Una aplicación debe obtener acceso a columnas específicas del controlador contando desde el final del conjunto de resultados en lugar de especificar una posición ordinal explícita. Para obtener más información, vea Datos devueltos por funciones de catálogo.

Nombre de la columna	Número de columna	Tipo de dato	Comentarios
`TABLE_CAT` (ODBC 1.0)	1	varchar	Nombre de catálogo de la tabla a la que se aplica la estadística o el índice; `NULL` si no es aplicable al origen de datos. Si un controlador admite catálogos para algunas tablas pero no para otras, como cuando el controlador recupera datos de dbMS diferentes, devuelve una cadena vacía (`""`) para esas tablas que no tienen catálogos.
`TABLE_SCHEM` (ODBC 1.0)	2	varchar	Nombre de esquema de la tabla a la que se aplica la estadística o el índice; `NULL` si no es aplicable al origen de datos. Si un controlador admite esquemas para algunas tablas pero no para otras, como cuando el controlador recupera datos de dbMS diferentes, devuelve una cadena vacía (`""`) para esas tablas que no tienen esquemas.
`TABLE_NAME` (ODBC 1.0)	3	varchar no `NULL`	Nombre de tabla de la tabla a la que se aplica la estadística o el índice.
`NON_UNIQUE` (ODBC 1.0)	4	smallint	Indica si el índice no permite valores duplicados: `SQL_TRUE` si los valores de índice pueden ser no únicos. `SQL_FALSE` si los valores de índice deben ser únicos. `NULL` se devuelve si `TYPE` es `SQL_TABLE_STAT`.
`INDEX_QUALIFIER` (ODBC 1.0)	5	varchar	El identificador que se usa para calificar el nombre del índice que realiza un `DROP INDEX`; `NULL` se devuelve si el origen de datos no admite un calificador de índice o si `TYPE` es `SQL_TABLE_STAT`. Si se devuelve un valor distinto de null en esta columna, se debe usar para calificar el nombre del índice en una `DROP INDEX` instrucción; de lo contrario, `TABLE_SCHEM` se debe usar para calificar el nombre del índice.
`INDEX_NAME` (ODBC 1.0)	6	varchar	Nombre del índice; `NULL` se devuelve si `TYPE` es `SQL_TABLE_STAT`.
`TYPE` (ODBC 1.0)	7	smallint no `NULL`	Tipo de información que se devuelve: `SQL_TABLE_STAT` indica una estadística para la tabla (en la `CARDINALITY` columna o `PAGES` ). `SQL_INDEX_BTREE` indica un índice de árbol B. `SQL_INDEX_CLUSTERED` indica un índice agrupado. `SQL_INDEX_CONTENT` indica un índice de contenido. `SQL_INDEX_HASHED` indica un índice hash. `SQL_INDEX_OTHER` indica otro tipo de índice.
`ORDINAL_POSITION` (ODBC 1.0)	8	smallint	Número de secuencia de columna en el índice (a partir de 1); `NULL` se devuelve si `TYPE` es `SQL_TABLE_STAT`.
`COLUMN_NAME` (ODBC 1.0)	9	varchar	Nombre de la columna. Si la columna se basa en una expresión, como `SALARY + BENEFITS`, se devuelve la expresión; si no se puede determinar la expresión, se devuelve una cadena vacía. `NULL` se devuelve si `TYPE` es `SQL_TABLE_STAT`.
`ASC_OR_DESC` (ODBC 1.0)	10	char(1)	Secuencia de ordenación de la columna: "A" para ascendente; "D" para descendente; `NULL` se devuelve si el origen de datos no admite la secuencia de ordenación de columnas o si `TYPE` es `SQL_TABLE_STAT`.
`CARDINALITY` (ODBC 1.0)	11	integer	Cardinalidad de tabla o índice; número de filas de la tabla si `TYPE` es `SQL_TABLE_STAT`; número de valores únicos en el índice si `TYPE` no `SQL_TABLE_STAT`es ; `NULL` se devuelve si el valor no está disponible en el origen de datos.
`PAGES` (ODBC 1.0)	12	integer	Número de páginas usadas para almacenar el índice o la tabla; número de páginas de la tabla si `TYPE` es `SQL_TABLE_STAT`; número de páginas para el índice si `TYPE` no `SQL_TABLE_STAT`es ; `NULL` se devuelve si el valor no está disponible desde el origen de datos o si no es aplicable al origen de datos.
`FILTER_CONDITION` (ODBC 2.0)	13	varchar	Si el índice es un índice filtrado, esta es la condición de filtro, como `SALARY > 30000`; si no se puede determinar la condición de filtro, se trata de una cadena vacía. `NULL` Si el índice no es un índice filtrado, no se puede determinar si el índice es un índice filtrado o `TYPE` es `SQL_TABLE_STAT`.

Si la fila del conjunto de resultados corresponde a una tabla, el controlador establece TYPESQL_TABLE_STAT en y establece NON_UNIQUE, , INDEX_NAMEINDEX_QUALIFIER, ORDINAL_POSITION, COLUMN_NAMEy ASC_OR_DESC en NULL. Si CARDINALITY o PAGES no están disponibles en el origen de datos, el controlador los establece en NULL.

Ejemplo de código

Para obtener un ejemplo de código de una función similar, vea Función SQLColumns.

Para obtener información sobre	Artículo
Enlazar un búfer a una columna de un conjunto de resultados	Función SQLBindCol
Cancelación del procesamiento de instrucciones	Función SQLCancel
Capturar una sola fila o un bloque de datos en una dirección de solo avance.	Función SQLFetch
Capturar un bloque de datos o desplazarse por un conjunto de resultados	Función SQLFetchScroll
Devolver las columnas de claves externas	Función SQLForeignKeys
Devolver las columnas de una clave principal	Función SQLPrimaryKeys

Ohar-bidaltzea

Lagungarria izan al da orrialde hau?

Last updated on 2025-12-29