dd::Index_element Class Reference

#include <index_element.h>

Inheritance diagram for dd::Index_element:

Public Types
enum	enum_index_element_order { ORDER_UNDEF = 1 , ORDER_ASC , ORDER_DESC }
typedef Index_element_impl	Impl
typedef tables::Index_column_usage	DD_table

Public Member Functions
	~Index_element () override=default
virtual const Index &	index () const =0
virtual Index &	index ()=0
virtual const Column &	column () const =0
virtual Column &	column ()=0
virtual uint	ordinal_position () const =0
virtual uint	length () const =0
virtual void	set_length (uint length)=0
virtual void	set_length_null (bool is_null)=0
virtual bool	is_length_null () const =0
virtual enum_index_element_order	order () const =0
virtual void	set_order (enum_index_element_order order)=0
virtual bool	is_hidden () const =0
virtual void	set_hidden (bool hidden)=0
virtual void	serialize (Sdi_wcontext *wctx, Sdi_writer *w) const =0
	Converts *this into json. More...
virtual bool	deserialize (Sdi_rcontext *rctx, const RJ_Value &val)=0
	Re-establishes the state of *this by reading sdi information from the rapidjson DOM subobject provided. More...
virtual bool	is_prefix () const =0
	Check if index element (a.k.a. More...
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::Index_column_usage dd::Index_element::DD_table

Impl

typedef Index_element_impl dd::Index_element::Impl

Member Enumeration Documentation

enum_index_element_order

enum dd::Index_element::enum_index_element_order

Enumerator
ORDER_UNDEF
ORDER_ASC
ORDER_DESC

Constructor & Destructor Documentation

~Index_element()

dd::Index_element::~Index_element ( )

overridedefault

Member Function Documentation

column() [1/2]

virtual const Column & dd::Index_element::column ( ) const

pure virtual

Implemented in dd::Index_element_impl.

column() [2/2]

virtual Column & dd::Index_element::column ( )

pure virtual

Implemented in dd::Index_element_impl.

deserialize()

virtual bool dd::Index_element::deserialize ( Sdi_rcontext *  rctx, const RJ_Value &  val  )

pure virtual

Re-establishes the state of *this by reading sdi information from the rapidjson DOM subobject provided.

Cross-references encountered within this object are tracked in sdictx, so that they can be updated when the entire object graph has been established.

Parameters

rctx	stores book-keeping information for the deserialization process
val	subobject of rapidjson DOM containing json representation of this object

Implemented in dd::Index_element_impl.

index() [1/2]

virtual const Index & dd::Index_element::index ( ) const

pure virtual

Implemented in dd::Index_element_impl.

index() [2/2]

virtual Index & dd::Index_element::index ( )

pure virtual

Implemented in dd::Index_element_impl.

is_hidden()

virtual bool dd::Index_element::is_hidden ( ) const

pure virtual

Implemented in dd::Index_element_impl.

is_length_null()

virtual bool dd::Index_element::is_length_null ( ) const

pure virtual

Implemented in dd::Index_element_impl.

is_prefix()

virtual bool dd::Index_element::is_prefix ( ) const

pure virtual

Check if index element (a.k.a.

key part) is a prefix of the column used.

Implemented in dd::Index_element_impl.

length()

virtual uint dd::Index_element::length ( ) const

pure virtual

Implemented in dd::Index_element_impl.

order()

virtual enum_index_element_order dd::Index_element::order ( ) const

pure virtual

Implemented in dd::Index_element_impl.

ordinal_position()

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

pure virtual

Implemented in dd::Index_element_impl.

serialize()

virtual void dd::Index_element::serialize ( Sdi_wcontext *  wctx, Sdi_writer *  w  ) const

pure virtual

Converts *this into json.

Converts all member variables that are to be included in the sdi into json by transforming them appropriately and passing them to the rapidjson writer provided.

Parameters

wctx	opaque context for data needed by serialization
w	rapidjson writer which will perform conversion to json

Implemented in dd::Index_element_impl.

set_hidden()

virtual void dd::Index_element::set_hidden ( bool  hidden )

pure virtual

Implemented in dd::Index_element_impl.

set_length()

virtual void dd::Index_element::set_length ( uint  length )

pure virtual

Implemented in dd::Index_element_impl.

set_length_null()

virtual void dd::Index_element::set_length_null ( bool  is_null )

pure virtual

Implemented in dd::Index_element_impl.

set_order()

virtual void dd::Index_element::set_order ( enum_index_element_order  order )

pure virtual

Implemented in dd::Index_element_impl.

---

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

• sql/dd/types/index_element.h