SQLTables 함수
규칙
버전 소개: ODBC 1.0 표준 준수: 오픈 그룹
요약
SQLTable은 특정 데이터 원본에 저장된 테이블, 카탈로그 또는 스키마 이름 및 테이블 형식 목록을 반환합니다. 드라이버는 결과 집합으로 정보를 반환합니다.
구문
SQLRETURN SQLTables(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * TableName,
SQLSMALLINT NameLength3,
SQLCHAR * TableType,
SQLSMALLINT NameLength4);
인수
StatementHandle
[입력] 검색된 결과에 대한 문 핸들입니다.
CatalogName
[입력] 카탈로그 이름입니다. CatalogName 인수는 SQL_ODBC_VERSION 환경 특성이 SQL_OV_ODBC3 경우 검색 패턴을 허용합니다. SQL_OV_ODBC2 설정된 경우 검색 패턴을 허용하지 않습니다. 드라이버가 다른 DBMS에서 데이터를 검색하는 경우와 같이 드라이버가 일부 테이블에 대해 카탈로그를 지원하지만 다른 테이블에 대해서는 지원하지 않는 경우 빈 문자열("")은 카탈로그가 없는 테이블을 나타냅니다.
SQL_ATTR_METADATA_ID 문 특성이 SQL_TRUE 설정된 경우 CatalogName 은 식별자로 처리되고 해당 사례는 중요하지 않습니다. SQL_FALSE 경우 CatalogName 은 패턴 값 인수이고, 문자 그대로 처리되며 대/소문자도 중요합니다. 자세한 내용은 카탈로그 함수의 인수를 참조 하세요.
NameLength1
[입력] *CatalogName 문자의 길이입니다.
SchemaName
[입력] 스키마 이름에 대한 문자열 검색 패턴입니다. 드라이버가 다른 DBMS에서 데이터를 검색하는 경우와 같이 일부 테이블에 대한 스키마를 지원하지만 다른 테이블에 대해서는 지원하지 않는 경우 빈 문자열("")은 스키마가 없는 테이블을 나타냅니다.
SQL_ATTR_METADATA_ID 문 특성이 SQL_TRUE 설정되면 SchemaName 은 식별자로 처리되고 해당 대/소문자는 중요하지 않습니다. SQL_FALSE 경우 SchemaName 은 패턴 값 인수이며 문자 그대로 처리되며 대/소문자도 중요합니다.
NameLength2
[입력] *SchemaName 문자의 길이입니다.
TableName
[입력] 테이블 이름에 대한 문자열 검색 패턴입니다.
SQL_ATTR_METADATA_ID 문 특성이 SQL_TRUE 설정되면 TableName 은 식별자로 처리되고 해당 대/소문자는 중요하지 않습니다. SQL_FALSE 경우 TableName 은 패턴 값 인수이며 문자 그대로 처리되며 대/소문자도 중요합니다.
NameLength3
[입력] *TableName 문자의 길이입니다.
TableType
[입력] 일치시킬 테이블 형식 목록입니다.
SQL_ATTR_METADATA_ID 문 특성은 TableType 인수에 영향을 주지 않습니다. TableType 은 SQL_ATTR_METADATA_ID 설정에 관계없이 값 목록 인수입니다.
NameLength4
[입력] *TableType 문자의 길이입니다.
반품
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR 또는 SQL_INVALID_HANDLE.
진단
SQLTables가 SQL_ERROR 또는 SQL_SUCCESS_WITH_INFO 반환하는 경우 SQL_HANDLE_STMT HandleType 및Handle of StatementHandle을 사용하여 SQLGetDiagRec 를 호출하여 관련 SQLSTATE 값을 가져올 수 있습니다. 다음 표에서는 일반적으로 SQLTables에서 반환되는 SQLSTATE 값을 나열하고 이 함수의 컨텍스트에서 각 값을 설명합니다. "(DM)" 표기법은 드라이버 관리자가 반환한 SQLSTATE에 대한 설명 앞에 나와 있습니다. 달리 명시되지 않는 한 각 SQLSTATE 값과 연결된 반환 코드는 SQL_ERROR.
SQLSTATE | Error | 설명 |
---|---|---|
01000 | 일반 경고 | 드라이버 관련 정보 메시지입니다. 함수는 SQL_SUCCESS_WITH_INFO 반환합니다. |
08S01 | 통신 링크 실패 | 드라이버와 드라이버가 연결된 데이터 원본 간의 통신 링크는 함수가 처리를 완료하기 전에 실패했습니다. |
24000 | 커서 상태가 잘못되었습니다. | StatementHandle에서 커서가 열려 있고 SQLFetch 또는 SQLFetchScroll이 호출되었습니다. SQLFetch 또는 SQLFetchScroll이 SQL_NO_DATA 반환하지 않고 SQLFetch 또는 SQLFetchScroll이 SQL_NO_DATA 반환한 경우 드라이버 관리자가 이 오류를 반환합니다. StatementHandle에서 커서가 열려 있지만 SQLFetch 또는 SQLFetchScroll이 호출되지 않았습니다. |
40001 | Serialization 실패 | 다른 트랜잭션과의 리소스 교착 상태 때문에 트랜잭션이 롤백되었습니다. |
40003 | 문 완성을 알 수 없음 | 이 함수를 실행하는 동안 연결된 연결이 실패했으며 트랜잭션 상태를 확인할 수 없습니다. |
HY000 | 일반 오류 | 특정 SQLSTATE가 없고 구현별 SQLSTATE가 정의되지 않은 오류가 발생했습니다. *MessageText 버퍼의 SQLGetDiagRec에서 반환된 오류 메시지는 오류와 그 원인을 설명합니다. |
HY001 | 메모리 할당 오류 | 드라이버가 함수 실행 또는 완료를 지원하는 데 필요한 메모리를 할당할 수 없습니다. |
HY008 | 작업이 취소됨 | StatementHandle에 대해 비동기 처리를 사용하도록 설정했습니다. 함수가 호출되었고 실행이 완료되기 전에 StatementHandle에서 SQLCancel 또는 SQLCancelHandle이 호출되었습니다. 그런 다음 StatementHandle에서 함수가 다시 호출되었습니다. 함수가 호출되었고 실행을 완료하기 전에 다중 스레드 애플리케이션의 다른 스레드에서 StatementHandle에서 SQLCancel 또는 SQLCancelHandle이 호출되었습니다. |
HY009 | null 포인터를 잘못 사용했습니다. | SQL_ATTR_METADATA_ID 문 특성이 SQL_TRUE 설정되었고, CatalogName 인수가 null 포인터이고, SQL_CATALOG_NAME InfoType이 지원되는 카탈로그 이름을 반환합니다. (DM) SQL_ATTR_METADATA_ID 문 특성이 SQL_TRUE 설정되었으며 SchemaName 또는 TableName 인수가 null 포인터였습니다. |
HY010 | 함수 시퀀스 오류 | (DM) StatementHandle과 연결된 연결 핸들에 대해 비동기적으로 실행되는 함수가 호출되었습니다. 이 비동기 함수는 SQLTable이 호출되었을 때 계속 실행되었습니다. (DM) SQLExecute, SQLExecDirect 또는 SQLMoreResults가 StatementHandle에 대해 호출되고 SQL_PARAM_DATA_AVAILABLE 반환되었습니다. 이 함수는 모든 스트리밍된 매개 변수에 대해 데이터를 검색하기 전에 호출되었습니다. (DM) 이 함수가 아닌 비동기 실행 함수가 StatementHandle에 대해 호출되었고 이 함수가 호출되었을 때 계속 실행되고 있었습니다. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations 또는 SQLSetPos가 StatementHandle에 대해 호출되고 SQL_NEED_DATA 반환되었습니다. 이 함수는 모든 실행 시 데이터 매개 변수 또는 열에 대한 데이터를 보내기 전에 호출되었습니다. |
HY013 | 메모리 관리 오류 | 메모리 조건이 낮기 때문에 기본 메모리 개체에 액세스할 수 없기 때문에 함수 호출을 처리할 수 없습니다. |
HY090 | 잘못된 문자열 또는 버퍼 길이 | (DM) 길이 인수 중 하나의 값이 0보다 작지만 SQL_NTS 같지 않았습니다. 이름 길이 인수 중 하나의 값이 해당 이름의 최대 길이 값을 초과했습니다. |
HY117 | 알 수 없는 트랜잭션 상태로 인해 연결이 일시 중단됩니다. 연결 끊기 및 읽기 전용 함수만 허용됩니다. | (DM) 일시 중단 상태에 대한 자세한 내용은 SQLEndTran 함수를 참조 하세요. |
HYC00 | 선택적 기능이 구현되지 않음 | 카탈로그가 지정되었으며 드라이버 또는 데이터 원본은 카탈로그를 지원하지 않습니다. 스키마가 지정되었으며 드라이버 또는 데이터 원본은 스키마를 지원하지 않습니다. 카탈로그 이름, 테이블 스키마 또는 테이블 이름에 대해 문자열 검색 패턴이 지정되었으며 데이터 원본은 하나 이상의 인수에 대한 검색 패턴을 지원하지 않습니다. SQL_ATTR_CONCURRENCY 및 SQL_ATTR_CURSOR_TYPE 문 특성의 현재 설정 조합은 드라이버 또는 데이터 원본에서 지원되지 않았습니다. SQL_ATTR_USE_BOOKMARKS 문 특성이 SQL_UB_VARIABLE 설정되었으며 SQL_ATTR_CURSOR_TYPE 문 특성은 드라이버가 책갈피를 지원하지 않는 커서 유형으로 설정되었습니다. |
HYT00 | 시간 제한 만료됨 | 데이터 원본이 요청된 결과 집합을 반환하기 전에 쿼리 제한 시간이 만료되었습니다. 시간 제한 기간은 SQL_ATTR_QUERY_TIMEOUT SQLSetStmtAttr를 통해 설정됩니다. |
HYT01 | 연결 제한 시간이 만료됨 | 데이터 원본이 요청에 응답하기 전에 연결 제한 시간이 만료되었습니다. 연결 제한 시간은 SQL_ATTR_CONNECTION_TIMEOUT SQLSetConnectAttr를 통해 설정됩니다. |
IM001 | 드라이버는 이 함수를 지원하지 않습니다. | (DM) StatementHandle과 연결된 드라이버는 함수를 지원하지 않습니다. |
IM017 | 비동기 알림 모드에서 폴링을 사용할 수 없습니다. | 알림 모델을 사용할 때마다 폴링이 비활성화됩니다. |
IM018 | 이 핸들에서 이전 비동기 작업을 완료하기 위해 SQLCompleteAsync 가 호출되지 않았습니다. | 핸들의 이전 함수 호출이 SQL_STILL_EXECUTING 반환하고 알림 모드가 활성화된 경우 사후 처리를 수행하고 작업을 완료하려면 핸들에서 SQLCompleteAsync 를 호출해야 합니다. |
주석
SQLTable은 요청된 범위의 모든 테이블을 나열합니다. 사용자가 이러한 테이블에 대한 SELECT 권한을 가질 수도 있고 없을 수도 있습니다. 접근성을 확인하기 위해 애플리케이션은 다음을 수행할 수 있습니다.
SQLGetInfo를 호출하고 SQL_ACCESSIBLE_TABLES 정보 유형을 확인합니다.
SQLTablePrivileges를 호출하여 각 테이블에 대한 권한을 확인합니다.
그렇지 않으면 애플리케이션에서 사용자가 SELECT 권한이 부여되지 않은 테이블을 선택하는 상황을 처리할 수 있어야 합니다.
SchemaName 및 TableName 인수는 검색 패턴을 허용합니다. CatalogName 인수는 SQL_ODBC_VERSION 환경 특성이 SQL_OV_ODBC3 경우 검색 패턴을 허용합니다. SQL_OV_ODBC2 설정된 경우 검색 패턴을 허용하지 않습니다. SQL_OV_ODBC3 설정되면 ODBC 3*.x* 드라이버는 CatalogName 인수의 와일드카드 문자를 문자 그대로 처리하도록 이스케이프해야 합니다. 유효한 검색 패턴에 대한 자세한 내용은 패턴 값 인수를 참조하세요.
참고 항목
ODBC 카탈로그 함수의 일반 사용, 인수 및 반환된 데이터에 대한 자세한 내용은 카탈로그 함수를 참조 하세요.
카탈로그, 스키마 및 테이블 형식의 열거를 지원하기 위해 SQLTables의 CatalogName, SchemaName, TableName 및 TableType 인수에 대해 다음과 같은 특수 의미 체계가 정의됩니다.
CatalogName이 SQL_ALL_CATALOGS SchemaName 및 TableName이 빈 문자열인 경우 결과 집합에는 데이터 원본에 대한 유효한 카탈로그 목록이 포함됩니다. (TABLE_CAT 열을 제외한 모든 열에는 NULL이 포함됩니다.)
SchemaName이 SQL_ALL_SCHEMAS CatalogName 및 TableName이 빈 문자열인 경우 결과 집합에는 데이터 원본에 대한 유효한 스키마 목록이 포함됩니다. (TABLE_SCHEM 열을 제외한 모든 열에는 NULL이 포함됩니다.)
TableType이 SQL_ALL_TABLE_TYPES CatalogName, SchemaName 및 TableName이 빈 문자열인 경우 결과 집합에는 데이터 원본에 대한 유효한 테이블 형식 목록이 포함됩니다. (TABLE_TYPE 열을 제외한 모든 열에는 NULL이 포함됩니다.)
TableType이 빈 문자열이 아닌 경우 관심 형식에 대한 쉼표로 구분된 값 목록을 포함해야 합니다. 각 값은 작은따옴표(')로 묶거나 따옴표를 묶지 않을 수 있습니다(예: 'TABLE', 'VIEW' 또는 TABLE, VIEW). 애플리케이션은 항상 테이블 형식을 대문자로 지정해야 합니다. 드라이버는 테이블 형식을 데이터 원본에 필요한 모든 사례로 변환해야 합니다. 데이터 원본이 지정된 테이블 형식 을 지원하지 않는 경우 SQLTable은 해당 형식에 대한 결과를 반환하지 않습니다.
SQLTable은 TABLE_TYPE, TABLE_CAT, TABLE_SCHEM 및 TABLE_NAME 따라 정렬된 표준 결과 집합으로 결과를 반환합니다 . 이 정보를 사용하는 방법에 대한 자세한 내용은 카탈로그 데이터 사용을 참조 하세요.
TABLE_CAT, TABLE_SCHEM 및 TABLE_NAME 열의 실제 길이를 확인하기 위해 애플리케이션은 SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN 및 SQL_MAX_TABLE_NAME_LEN 정보 유형을 사용하여 SQLGetInfo를 호출할 수 있습니다.
다음 열의 이름이 ODBC 3*.x*로 바뀌었습니다. 열 이름 변경은 애플리케이션이 열 번호로 바인딩되므로 이전 버전과의 호환성에 영향을 미치지 않습니다.
ODBC 2.0 열 | ODBC 3*.x* 열 |
---|---|
TABLE_QUALIFIER | TABLE_CAT |
TABLE_OWNER | TABLE_SCHEM |
다음 표에서는 결과 집합의 열을 나열합니다. 드라이버에서 5열(REMARKS) 이외의 추가 열을 정의할 수 있습니다. 애플리케이션은 명시적 서수 위치를 지정하는 대신 결과 집합의 끝에서 카운트다운하여 드라이버별 열에 액세스할 수 있어야 합니다. 자세한 내용은 카탈로그 함수에서 반환된 데이터를 참조 하세요.
열 이름 | Column number | 데이터 형식 | 주석 |
---|---|---|---|
TABLE_CAT(ODBC 1.0) | 6 | Varchar | 카탈로그 이름; 데이터 원본에 적용되지 않는 경우 NULL입니다. 드라이버가 다른 DBMS에서 데이터를 검색하는 경우와 같이 일부 테이블에 대해 카탈로그를 지원하지만 다른 테이블에 대해서는 지원하지 않는 경우 카탈로그가 없는 테이블에 대해 빈 문자열("")을 반환합니다. |
TABLE_SCHEM(ODBC 1.0) | 2 | Varchar | 스키마 이름; 데이터 원본에 적용되지 않는 경우 NULL입니다. 드라이버가 다른 DBMS에서 데이터를 검색하는 경우와 같이 일부 테이블에 대해 스키마를 지원하지만 다른 테이블에 대해서는 지원하지 않는 경우 스키마가 없는 테이블에 대해 빈 문자열("")을 반환합니다. |
TABLE_NAME(ODBC 1.0) | 3 | Varchar | 테이블 이름입니다. |
TABLE_TYPE(ODBC 1.0) | 4 | Varchar | 테이블 형식 이름; "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM" 또는 데이터 원본별 형식 이름 중 하나입니다. "ALIAS" 및 "SYNONYM"의 의미는 드라이버별로 다릅니다. |
설명(ODBC 1.0) | 5 | Varchar | 테이블에 대한 설명입니다. |
예
다음 샘플 코드는 핸들과 연결을 해제하지 않습니다. 핸들 및 문을 해제하는 코드 샘플은 SQLFreeHandle 함수 및 SQLFreeStmt 함수를 참조하세요.
// SQLTables.cpp
// compile with: user32.lib odbc32.lib
#include <windows.h>
#include <sqlext.h>
#include <strsafe.h>
// simple helper functions
int MySQLSuccess(SQLRETURN rc) {
return (rc == SQL_SUCCESS || rc == SQL_SUCCESS_WITH_INFO);
}
struct DataBinding {
SQLSMALLINT TargetType;
SQLPOINTER TargetValuePtr;
SQLINTEGER BufferLength;
SQLLEN StrLen_or_Ind;
};
void printCatalog(const struct DataBinding* catalogResult) {
if (catalogResult[0].StrLen_or_Ind != SQL_NULL_DATA)
printf("Catalog Name = %s\n", (char *)catalogResult[0].TargetValuePtr);
}
// remember to disconnect and free memory, and free statements and handles
int main() {
int bufferSize = 1024, i, numCols = 5;
struct DataBinding* catalogResult = (struct DataBinding*) malloc( numCols * sizeof(struct DataBinding) );
wchar_t* dbName = (wchar_t *)malloc( sizeof(wchar_t)*bufferSize );
wchar_t* userName = (wchar_t *)malloc( sizeof(wchar_t)*bufferSize );
// declare and initialize the environment, connection, statement handles
SQLHENV henv = NULL; // Environment
SQLHDBC hdbc = NULL; // Connection handle
SQLHSTMT hstmt = NULL; // Statement handle
SQLRETURN retCode;
HWND desktopHandle = GetDesktopWindow(); // desktop's window handle
SQLWCHAR connStrbuffer[1024];
SQLSMALLINT connStrBufferLen;
retCode = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &henv);
retCode = SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION, (void*)SQL_OV_ODBC3, -1);
retCode = SQLAllocHandle(SQL_HANDLE_DBC, henv, &hdbc);
retCode = SQLSetConnectAttr(hdbc, SQL_LOGIN_TIMEOUT, (SQLPOINTER)10, 0);
retCode = SQLDriverConnect(hdbc, desktopHandle, (SQLCHAR*)"Driver={SQL Server}", SQL_NTS, (SQLCHAR*)connStrbuffer, 1024 + 1, &connStrBufferLen, SQL_DRIVER_PROMPT);
retCode = SQLAllocHandle(SQL_HANDLE_STMT, hdbc, &hstmt);
retCode = SQLGetInfo(hdbc, SQL_DATABASE_NAME, dbName, (SQLSMALLINT)bufferSize, (SQLSMALLINT *)&bufferSize);
retCode = SQLGetInfo(hdbc, SQL_USER_NAME, userName, (SQLSMALLINT)bufferSize, (SQLSMALLINT *)&bufferSize);
bufferSize = 1024;
// allocate memory for the binding
// free this memory when done
for ( i = 0 ; i < numCols ; i++ ) {
catalogResult[i].TargetType = SQL_C_CHAR;
catalogResult[i].BufferLength = (bufferSize + 1);
catalogResult[i].TargetValuePtr = malloc( sizeof(unsigned char)*catalogResult[i].BufferLength );
}
// setup the binding (can be used even if the statement is closed by closeStatementHandle)
for ( i = 0 ; i < numCols ; i++ )
retCode = SQLBindCol(hstmt, (SQLUSMALLINT)i + 1, catalogResult[i].TargetType, catalogResult[i].TargetValuePtr, catalogResult[i].BufferLength, &(catalogResult[i].StrLen_or_Ind));
// all catalogs query
printf( "A list of names of all catalogs\n" );
retCode = SQLTables( hstmt, (SQLCHAR*)SQL_ALL_CATALOGS, SQL_NTS, (SQLCHAR*)"", SQL_NTS, (SQLCHAR*)"", SQL_NTS, (SQLCHAR*)"", SQL_NTS );
for ( retCode = SQLFetch(hstmt) ; MySQLSuccess(retCode) ; retCode = SQLFetch(hstmt) )
printCatalog( catalogResult );
}
관련 함수
추가 정보 | 참조 |
---|---|
결과 집합의 열에 버퍼 바인딩 | SQLBindCol 함수 |
문 처리 취소 | SQLCancel 함수 |
열 또는 열에 대한 권한 반환 | SQLColumnPrivileges 함수 |
테이블 또는 테이블의 열 반환 | SQLColumns 함수 |
단일 행 또는 데이터 블록을 정방향으로 가져오기 | SQLFetch 함수 |
데이터 블록을 가져오거나 결과 집합을 스크롤합니다. | SQLFetchScroll 함수 |
테이블 통계 및 인덱스 반환 | SQLStatistics 함수 |
테이블 또는 테이블에 대한 권한 반환 | SQLTablePrivileges 함수 |