tabledef 構造体

テーブル定義構造体 [詳解]

#include <tdapSchema.h>

公開メンバ関数
	tabledef ()
void	cleanup ()
const char *	fileName () const
const char *	fileNameA () const
uint_td	pack (char *ptr, size_t size) const
void	setFileName (const char *s)
void	setFileNameA (const char *s)
void	setTableName (const char *s)
void	setTableNameA (const char *s)
const char *	tableName () const
const char *	tableNameA () const
const char *	toChar (char *buf, const char *s, int size)
uint_td	unPack (char *ptr, size_t size) const

公開変数類
union {
ushort_td   pageSize
ushort_td   varSize
};
int	autoIncExSpace
uchar_td	charsetIndex
ushort_td	convertFileNum
ushort_td	ddfid
ushort_td	fieldCount
fielddef *	fieldDefs
uchar_td	filler0 [17]
ushort_td	fixedRecordLen
FLAGS	flags
uchar_td	iconIndex
uchar_td	iconIndex2
uchar_td	iconIndex3
ushort_td	id
uchar_td	keyCount
keydef *	keyDefs
ushort_td	maxRecordLen
FLAGS	optionFlags
client::dbdef *	parent
uchar_td	parentKeyNum
ushort_td	preAlloc
uchar_td	primaryKeyNum
uchar_td	replicaKeyNum
uchar_td	reserved [TABLEDEF_FILLER_SIZE]
uint_td	schemaCodePage
uchar_td	treeIndex
short	version

詳解

テーブル定義構造体

構築子と解体子

tabledef ( )

inline

コンストラクタ。すべてのフィールドを初期化します。

関数詳解

void cleanup ( )

inline

この構造体のメンバーを初期化します。

const char * fileName

(

)

const

ファイル名を返します。

const char * fileNameA ( ) const

inline

ファイル名を返します。

uint_td pack	(	char *	ptr,
		size_t	size
	)		const

ptrで指定されたレコードイメージを圧縮して圧縮後の長さを返します。

引数

[in,out]	ptr	レコードイメージのアドレスを指定します。
[in]	size	レコードイメージのバイト数を指定します。

戻り値

圧縮後の長さを返します。

void setFileName ( const char *  s )

inline

ファイル名をセットします。ファイル名は最大265バイトです。 transactdの場合、ファイル名の拡張子は取り除かれてテーブルが作成されます。 SQLでアクセスする際のテーブル名はこの名前でアクセスします。

void setFileNameA ( const char *  s )

inline

ファイル名をセットします。ファイル名は最大265バイトです。 transactdの場合、ファイル名の拡張子は取り除かれてテーブルが作成されます。 SQLでアクセスする際のテーブル名はこの名前でアクセスします。

void setTableName ( const char *  s )

inline

テーブル名をセットします。テーブル名は最大31バイトです。 通常ファイル名から拡張子を取り除いた名前を指定します。

void setTableNameA ( const char *  s )

inline

テーブル名をセットします。テーブル名は最大31バイトです。 通常ファイル名から拡張子を取り除いた名前を指定します。

const char * tableName

(

)

const

テーブル名を返します。

const char * tableNameA ( ) const

inline

テーブル名を返します。

const char * toChar	(	char *	buf,
		const char *	s,
		int	size
	)

sで指定された文字列(終端NULL)をbufで指定されたバッファにschemaCodePageの文字コードに 変換してコピーします。

引数

[in,out]	buf	コピー先バッファの先頭アドレス。
[in]	s	コピー元文字列の先頭アドレス。
[in]	size	コピー先バッファのサイズ。

戻り値

コピー先バッファの先頭アドレスを返します。

uint_td unPack	(	char *	ptr,
		size_t	size
	)		const

ptrで指定された圧縮されたレコードイメージを伸長して長さを返します。 ptrで指定されたメモリ領域は伸長後の長さを確保できる十分な長さが必要です。 確保された長さはsetBuflen()で指定します。

引数

[in,out]	ptr	packされたレコードイメージのアドレスを指定します。
[in]	size	packされたレコードイメージのバイト数を指定します。

戻り値

伸長後の長さを返します。伸長中に結果がbuflen()を超えると判断された場合は処理を中止しゼロを返します。

メンバ詳解

union { ... }

int autoIncExSpace

don't use. BizStation internal use only.

uchar_td charsetIndex

キャラクターセットをインデックス番号で指定します。 コードページからインデックスへの変換は mysql::charsetIndex(unsigned short codePage) で行えます。

ushort_td convertFileNum

don't use. BizStation internal use only.

ushort_td ddfid

DDFのフィールド番号を取得・設定します。 transactdでは使用しません。

ushort_td fieldCount

フィールド数を取得・設定します。

fielddef * fieldDefs

フィールド定義の先頭へのポインタを取得・設定します。

uchar_td filler0[17]

予約領域です。常に0x00で埋めてください。

ushort_td fixedRecordLen

テーブルの固定長部分の長さを取得・設定します。

FLAGS flags

ファイルフラグを取得・設定します。 PSQLのテーブルを作成する場合詳しい情報はPSQLのマニュアルを参照してください。
transactdの場合は以下の値を使用できます。

• bit0 = 1 可変長テーブル
  
• bit1 〜 bitF 未使用
  可変長テーブルの指定は、PSQL互換の可変長テーブルテーブルを作成したい場合のみ使用します。 その場合、フィールドの最後はft_varbinary型にします。また、可変長のフィールドはそれのみで それ以外は固定長のフィールドでなければなりません。

uchar_td iconIndex

don't use. BizStation internal use only.

uchar_td iconIndex2

don't use. BizStation internal use only.

uchar_td iconIndex3

don't use. BizStation internal use only.

ushort_td id

テーブル番号を取得・設定します。

uchar_td keyCount

インデックス数を取得・設定します。

keydef * keyDefs

キー定義の先頭へのポインタを取得・設定します。

ushort_td maxRecordLen

可変長テーブルでの最大レコードサイズを取得・設定します。

FLAGS optionFlags

don't use. BizStation internal use only.

ushort_td pageSize

ページサイズを取得・設定します。 transactdではこの値は無効です。

client::dbdef * parent

現在未使用です。

uchar_td parentKeyNum

don't use. BizStation internal use only.

ushort_td preAlloc

プリアロケートページ数を取得・設定します。 transactdではこの値は無効です。

uchar_td primaryKeyNum

プライマリキーのキー番号を取得・設定します。

uchar_td replicaKeyNum

don't use. BizStation internal use only.

uchar_td reserved[TABLEDEF_FILLER_SIZE]

予約領域です。常に0x00で埋めてください。

uint_td schemaCodePage

このスキーマで使用される、コードページを取得・設定します。

uchar_td treeIndex

don't use. BizStation internal use only.

ushort_td varSize

このテーブル定義のこのフィールド以降の長さを示します。テーブル定義の全長は varSize + 4です。通常この値は内部で使用されます。 transactd以外ではこの値は無効です。

short version

テーブル定義のバージョンを取得・設定します。 この値はシステムにより使用されます。変更は行わないでください。