Altibase CLI API

Altibase CLI API

API 분류

Altibase CLI의 API는 애플리케이션 작성에 필요한 환경 정의, 연결 관리, SQL문 처리, 트랜잭션 처리 등에 관련된 기능을 제공하는 함수들로 구성된다. 각 함수들은 제공하는 기능에 따라 다음과 같은 그룹으로 구분할 수 있다.

• 환경/연결 관리

• SQL 처리

• 속성 처리

• 메타정보 처리

환경/연결 관리

데이터베이스 서버 연결에 필요한 환경 설정과 연결에 관련된 기능 등을 제공하는 API로 구성된다. 또한 모든 작업이 종료된 후 할당된 메모리 등을 해제한다.

SQL 처리

SQL 처리를 위한 명령문 할당과 준비, 실행 요청과 결괏값 처리 기능 등을 제공하는 API로 구성된다.

속성 처리

SQL 처리를 위한 환경 설정, 연결 설정, 명령문 속성 설정 기능 등을 제공하는 API로 구성된다.

메타정보 처리

테이블 정의, 열 정의 등 메타 정보 검색을 위한 기능 등을 제공하는 API로 구성된다.

API 목록

Altibase CLI 함수 목록은 아래의 표와 같다. 각 함수에 대한 보다 자세한 내용은 아래에서 설명한다.

작업		함수명	목적
연결관리		SQLAllocConnect	자원과 연결 핸들 초기화 및 할당
		SQLAllocEnv	환경 핸들 초기화 및 메모리 할당
		SQLAllocStmt	명령문 핸들 초기화 및 메모리 할당
		SQLAllocHandle	자원, 환경, 명령문 핸들 초기화 및 메모리 할당
		SQLCloseCursor	열려진 커서를 닫고 보류중인 결과들을 폐기
		SQLConnect	목표 데이터베이스와 연결설정
		SQLDisconnect	연결 핸들과 연관된 연결을 종료
		SQLDriverConnect	연결 스트링을 이용해 목표데이터베이스와 연결설정
		SQLEndTran	현재 트랜잭션을 반영하거나 철회 실행
		SQLFreeConnect	연결 핸들을 무효화하고 할당된 메모리 해제
		SQLFreeEnv	환경 핸들을 무효화하고 할당된 메모리 해제
		SQLFreeHandle	연결, 핸들, 명령문에 할당된 메모리 해제
		SQLFreeStmt	명령문 핸들을 무효화하고 할당된 메모리 해제
		SQLTransact	데이터베이스에 대한 모든 변경을 반영하거나 철회
SQL 실행	요청	SQLBindParameter	SQL문장에 매개변수(parameter)를 바인드
		SQLExecDirect	SQL문장을 직접 실행
		SQLExecute	준비된 SQL문장을 실행
		SQLNativeSql	SQL 구문을 Altibase가 지원하는 문장으로 변환
		SQLParamData	SQL 구문을 Altibase가 지원하는 문장으로 변환
		SQLPrepare	실행할 SQL문을 준비
		SQLPutData	수행중인 명령문에 데이터를 넣을 때 사용
	검색	SQLBindCol	결과 집합의 열을 받아올 버퍼와 데이터형 지정
		SQLColAttribute	결과 집합의 열에 대한 속성을 확인
		SQLDescribeCol	결과 집합에서 한 개의 행에 대한 정보 확인
		SQLDescribeParam	결과 집합에서 매개변수 마커(?)와 연관된 정보 확인
		SQLError	가장 최근에 호출된 함수와 연관된 진단 정보 확인
		SQLFetch	결과 집합의 바인드된 열에 대한 정보 확인
		SQLFetchScroll	결과 집합에서 커서를 원하는 방향으로 진행시키고, 바인드 된 열을 가져옴
		SQLGetConnectAttr	특정 연결에 설정된 속성값 검색
		SQLGetData	결과 집합의 현재 행에서 단일 열에 대한 자료검색
		SQLGetInfo	애플리케이션에 접속한 DBMS 정보를 검색
		SQLGetStmtAttr	설정된 명령문 핸들 관련 속성값 검색
		SQLGetTypeInfo	데이터베이스에서 지원되는 데이터 타입에 관한 정보 반환
		SQLNumParams	SQL 문에서의 매개변수 개수를 반환
		SQLNumResultCols	결과 집합의 열의 숫자를 반환
		SQLRowCount	테이블에 대해 실행한 SQL문에 의해 나타난 결과 집합의 행의 숫자를 반환
		SQLMoreResults	Multiple result가 생성된 execution 일 경우, 다음 result로 관심 result를 변경한다
속성처리		SQLGetEnvAttr	환경 핸들의 속성 값을 설정
		SQLGetFunctions	Altibase CLI 드라이버가 지원하는 함수 목록 설정
		SQLSetConnectAttr	연결 속성값을 설정
		SQLSetEnvAttr	환경 속성값을 설정
		SQLSetStmtAttr	명령문 속성값을 설정
메타 정보 처리		SQLColumns	특정 테이블의 행에 대한 정보 검색
		SQLForeignKeys	특정 테이블의 외래 키에 대한 정보 검색
		SQLGetDescField	descriptor의 속성을 한 개 검색
		SQLGetDescRec	descriptor의 속성을 여러 개 검색
		SQLGetDiagField	함수 사용 후 결과 진단 검색
		SQLGetDiagRec	함수 사용 후 결과 진단을 여러 개 검색
		SQLPrimaryKeys	특정 테이블의 기본 키에 대한 정보 검색
		SQLProcedureColumns	프로시저에 대한 입력/출력 매개변수 정보를 검색
		SQLProcedures	프로시저 이름 목록 검색
		SQLSetDescField	descriptor의 속성을 한 개 지정
		SQLSpecialColumns	특정 열들을 검색
		SQLStatistics	테이블에 대한 색인 정보 검색
		SQLTablePrivileges	테이블의 목록과 각 테이블과 관련 된 권한들을 검색
		SQLTables	테이블 목록 검색