DBMGetTableSchema

DBMGetTableSchema

Description
특정 테이블의 스키마를 알아낸다.

Syntax
DBMErr DBMGetTableSchema(TableId tableId, S32 numFieldInfos, FieldInfo* fieldInfo, FieldId* secondaryKeyFieldId);

Parameters

tableId	테이블 ID
numFieldInfos	테이블에 정의된 필드의 개수
fieldInfo	테이블의 스키마 정보. 각 필드에 대해 이름, ID, 타입을 저장하고 있다.
secondaryKeyFieldId	secondary key 필드의 ID. secondary key가 없는 경우 NULL_FIELD_ID

Returns

value	설명
DBM_OK	성공적으로 수행된 경우
DBM_INVALID_TABLE_ID	주어진 테이블 id를 갖는 테이블이 존재하지 않는 경우
DBM_INVALID_FIELD_INFO	numFieldInfo가 테이블 스키마의 필드 개수보다 작은 경우
DBM_DB_NOT_INITED	데이타베이스가 초기화되어 있지 않은 경우

Comments
fieldInfo의 메모리 공간은 응용 프로그램에서 할당해서, 매개변수로 넘긴다.
응용 프로그램은 일단 DBMGetNumFieldsInTable함수를 통해서 테이블에 정의된 필드의 개수를 구한 후, fieldInfo에 적절한 메모리 공간을 할당하여 매개변수로 사용하면 된다.

Example
#include "dbm.h"
void main(void)
{
   DBMErr ret;
   S32 numFields;
   TableId tableId = 1;
   FieldInfo *pFieldInfo;
   FieldId secondaryKeyId;

   ret = DBMGetNumFieldsInTable( tableId, &numFields);
   if (ret == DBM_OK)
   {
     pFieldInfo = (FieldInfo*)malloc(sizeof(FieldInfo)*numFields);
     ret = DBMGetTableSchema(tableId, numFields, pFieldInfo, &secondaryKeyId);
   }
   else
     // error handling
}