dd::Parameter Class Reference

#include <parameter.h>

Inheritance diagram for dd::Parameter:

Public Types
enum	enum_parameter_mode { PM_IN = 1 , PM_OUT , PM_INOUT }
typedef Collection< Parameter_type_element * >	Parameter_type_element_collection
typedef Parameter_impl	Impl
typedef tables::Parameters	DD_table

Public Member Functions
	~Parameter () override=default
virtual void	set_name_null (bool is_null)=0
virtual bool	is_name_null () const =0
virtual const Routine &	routine () const =0
virtual Routine &	routine ()=0
virtual uint	ordinal_position () const =0
virtual enum_parameter_mode	mode () const =0
virtual void	set_mode (enum_parameter_mode mode)=0
virtual void	set_parameter_mode_null (bool is_null)=0
virtual bool	is_parameter_mode_null () const =0
virtual enum_column_types	data_type () const =0
virtual void	set_data_type (enum_column_types type)=0
virtual const String_type &	data_type_utf8 () const =0
virtual void	set_data_type_utf8 (const String_type &data_type_utf8)=0
virtual bool	is_zerofill () const =0
virtual void	set_zerofill (bool zerofill)=0
virtual bool	is_unsigned () const =0
virtual void	set_unsigned (bool unsigned_flag)=0
virtual size_t	char_length () const =0
virtual void	set_char_length (size_t char_length)=0
virtual uint	numeric_precision () const =0
virtual void	set_numeric_precision (uint numeric_precision)=0
virtual uint	numeric_scale () const =0
virtual void	set_numeric_scale (uint numeric_scale)=0
virtual void	set_numeric_scale_null (bool is_null)=0
virtual bool	is_numeric_scale_null () const =0
virtual uint	datetime_precision () const =0
virtual void	set_datetime_precision (uint datetime_precision)=0
virtual Object_id	collation_id () const =0
virtual void	set_collation_id (Object_id collation_id)=0
virtual const Properties &	options () const =0
virtual Properties &	options ()=0
virtual bool	set_options (const String_type &options_raw)=0
virtual Parameter_type_element *	add_element ()=0
virtual const Parameter_type_element_collection &	elements () const =0
virtual size_t	elements_count () const =0
Public Member Functions inherited from dd::Entity_object
virtual Object_id	id () const =0
	The unique dictionary object id. More...
virtual bool	is_persistent () const =0
	Is dictionary object persistent in dictionary tables ? More...
virtual const String_type &	name () const =0
virtual void	set_name (const String_type &name)=0
Public Member Functions inherited from dd::Weak_object
virtual void	debug_print (String_type &outb) const =0
	Weak_object ()=default
	Weak_object (const Weak_object &)=default
virtual	~Weak_object ()=default

Member Typedef Documentation

DD_table

typedef tables::Parameters dd::Parameter::DD_table

Impl

typedef Parameter_impl dd::Parameter::Impl

Parameter_type_element_collection

typedef Collection<Parameter_type_element *> dd::Parameter::Parameter_type_element_collection

Member Enumeration Documentation

enum_parameter_mode

enum dd::Parameter::enum_parameter_mode

Enumerator
PM_IN
PM_OUT
PM_INOUT

Constructor & Destructor Documentation

~Parameter()

dd::Parameter::~Parameter ( )

overridedefault

Member Function Documentation

add_element()

virtual Parameter_type_element * dd::Parameter::add_element ( )

pure virtual

Implemented in dd::Parameter_impl.

char_length()

virtual size_t dd::Parameter::char_length ( ) const

pure virtual

Implemented in dd::Parameter_impl.

collation_id()

virtual Object_id dd::Parameter::collation_id ( ) const

pure virtual

Implemented in dd::Parameter_impl.

data_type()

virtual enum_column_types dd::Parameter::data_type ( ) const

pure virtual

Implemented in dd::Parameter_impl.

data_type_utf8()

virtual const String_type & dd::Parameter::data_type_utf8 ( ) const

pure virtual

Implemented in dd::Parameter_impl.

datetime_precision()

virtual uint dd::Parameter::datetime_precision ( ) const

pure virtual

Implemented in dd::Parameter_impl.

elements()

virtual const Parameter_type_element_collection & dd::Parameter::elements ( ) const

pure virtual

Implemented in dd::Parameter_impl.

elements_count()

virtual size_t dd::Parameter::elements_count ( ) const

pure virtual

Implemented in dd::Parameter_impl.

is_name_null()

virtual bool dd::Parameter::is_name_null ( ) const

pure virtual

Implemented in dd::Parameter_impl.

is_numeric_scale_null()

virtual bool dd::Parameter::is_numeric_scale_null ( ) const

pure virtual

Implemented in dd::Parameter_impl.

is_parameter_mode_null()

virtual bool dd::Parameter::is_parameter_mode_null ( ) const

pure virtual

Implemented in dd::Parameter_impl.

is_unsigned()

virtual bool dd::Parameter::is_unsigned ( ) const

pure virtual

Implemented in dd::Parameter_impl.

is_zerofill()

virtual bool dd::Parameter::is_zerofill ( ) const

pure virtual

Implemented in dd::Parameter_impl.

mode()

virtual enum_parameter_mode dd::Parameter::mode ( ) const

pure virtual

Implemented in dd::Parameter_impl.

numeric_precision()

virtual uint dd::Parameter::numeric_precision ( ) const

pure virtual

Implemented in dd::Parameter_impl.

numeric_scale()

virtual uint dd::Parameter::numeric_scale ( ) const

pure virtual

Implemented in dd::Parameter_impl.

options() [1/2]

virtual const Properties & dd::Parameter::options ( ) const

pure virtual

Implemented in dd::Parameter_impl.

options() [2/2]

virtual Properties & dd::Parameter::options ( )

pure virtual

Implemented in dd::Parameter_impl.

ordinal_position()

virtual uint dd::Parameter::ordinal_position ( ) const

pure virtual

Implemented in dd::Parameter_impl.

routine() [1/2]

virtual const Routine & dd::Parameter::routine ( ) const

pure virtual

Implemented in dd::Parameter_impl.

routine() [2/2]

virtual Routine & dd::Parameter::routine ( )

pure virtual

Implemented in dd::Parameter_impl.

set_char_length()

virtual void dd::Parameter::set_char_length ( size_t  char_length )

pure virtual

Implemented in dd::Parameter_impl.

set_collation_id()

virtual void dd::Parameter::set_collation_id ( Object_id  collation_id )

pure virtual

Implemented in dd::Parameter_impl.

set_data_type()

virtual void dd::Parameter::set_data_type ( enum_column_types  type )

pure virtual

Implemented in dd::Parameter_impl.

set_data_type_utf8()

virtual void dd::Parameter::set_data_type_utf8 ( const String_type &  data_type_utf8 )

pure virtual

Implemented in dd::Parameter_impl.

set_datetime_precision()

virtual void dd::Parameter::set_datetime_precision ( uint  datetime_precision )

pure virtual

Implemented in dd::Parameter_impl.

set_mode()

virtual void dd::Parameter::set_mode ( enum_parameter_mode  mode )

pure virtual

Implemented in dd::Parameter_impl.

set_name_null()

virtual void dd::Parameter::set_name_null ( bool  is_null )

pure virtual

Implemented in dd::Parameter_impl.

set_numeric_precision()

virtual void dd::Parameter::set_numeric_precision ( uint  numeric_precision )

pure virtual

Implemented in dd::Parameter_impl.

set_numeric_scale()

virtual void dd::Parameter::set_numeric_scale ( uint  numeric_scale )

pure virtual

Implemented in dd::Parameter_impl.

set_numeric_scale_null()

virtual void dd::Parameter::set_numeric_scale_null ( bool  is_null )

pure virtual

Implemented in dd::Parameter_impl.

set_options()

virtual bool dd::Parameter::set_options ( const String_type &  options_raw )

pure virtual

Implemented in dd::Parameter_impl.

set_parameter_mode_null()

virtual void dd::Parameter::set_parameter_mode_null ( bool  is_null )

pure virtual

Implemented in dd::Parameter_impl.

set_unsigned()

virtual void dd::Parameter::set_unsigned ( bool  unsigned_flag )

pure virtual

Implemented in dd::Parameter_impl.

set_zerofill()

virtual void dd::Parameter::set_zerofill ( bool  zerofill )

pure virtual

Implemented in dd::Parameter_impl.

---

The documentation for this class was generated from the following file:

• sql/dd/types/parameter.h