Column Class Reference

Represents the a Column definition on a result. More...

Methods
str	get_schema_name ()
	Retrieves the name of the Schema where the column is defined. More...
str	get_table_name ()
	Retrieves table name where the column is defined. More...
str	get_table_label ()
	Retrieves table alias where the column is defined. More...
str	get_column_name ()
	Retrieves column name. More...
str	get_column_label ()
	Retrieves column alias. More...
Type	get_type ()
	Retrieves column Type. More...
int	get_length ()
	Retrieves column length. More...
int	get_fractional_digits ()
	Retrieves the fractional digits if applicable. More...
bool	is_number_signed ()
	Indicates if a numeric column is signed. More...
str	get_collation_name ()
	Retrieves the collation name. More...
str	get_character_setName ()
	Retrieves the character set name. More...
bool	is_zero_fill ()
	Indicates if zerofill is set for the column. More...
str	get_flags ()
	Retrieves a space separated list of database flags. More...

Properties
	schema_name
	Same as get_schema_name()
	table_name
	Same as get_table_name()
	table_label
	Same as get_table_label()
	column_name
	Same as get_column_name()
	column_label
	Same as get_column_label()
	type
	Same as get_type()
	length
	Same as get_length()
	fractional_digits
	Same as get_fractional_digits()
	number_signed
	Same as is_number_signed()
	collation_name
	Same as get_collation_name()
	character_set_name
	Same as get_character_set_name()
	zero_fill
	Same as is_zero_fill()
	flags
	Same as get_flags()

Detailed Description

Represents the a Column definition on a result.

Member Function Documentation

get_schema_name()

str get_schema_name ( )

inline

Retrieves the name of the Schema where the column is defined.

Returns

a string value representing the owner schema.

get_table_name()

str get_table_name ( )

inline

Retrieves table name where the column is defined.

Returns

a string value representing the table name.

get_table_label()

str get_table_label ( )

inline

Retrieves table alias where the column is defined.

Returns

a string value representing the table alias or the table name if no alias is defined.

get_column_name()

str get_column_name ( )

inline

Retrieves column name.

Returns

a string value representing the column name.

get_column_label()

str get_column_label ( )

inline

Retrieves column alias.

Returns

a string value representing the column alias or the column name if no alias is defined.

get_type()

Type get_type ( )

inline

Retrieves column Type.

Returns

a constant value for the supported column types.

get_length()

int get_length ( )

inline

Retrieves column length.

Returns

the column length.

get_fractional_digits()

int get_fractional_digits ( )

inline

Retrieves the fractional digits if applicable.

Returns

the number of fractional digits, this only applies to specific data types.

is_number_signed()

bool is_number_signed ( )

inline

Indicates if a numeric column is signed.

Returns

a boolean indicating whether a numeric column is signed or not.

get_collation_name()

str get_collation_name ( )

inline

Retrieves the collation name.

Returns

a String representing the collation name, aplicable only to specific data types.

get_character_setName()

str get_character_setName ( )

inline

Retrieves the character set name.

Returns

a String representing the character set name, aplicable only to specific data types.

is_zero_fill()

bool is_zero_fill ( )

inline

Indicates if zerofill is set for the column.

Returns

a boolean indicating if zerofill flag is set for the column.

get_flags()

str get_flags ( )

inline

Retrieves a space separated list of database flags.

Returns

a space separated list of database flags set for the column.