MySQL 8.4.3
Source Code Documentation
dd::Tablespace Class Referenceabstract

#include <tablespace.h>

Inheritance diagram for dd::Tablespace:
[legend]

Public Types

typedef Tablespace_impl Impl
 
typedef Tablespace Cache_partition
 
typedef tables::Tablespaces DD_table
 
typedef Primary_id_key Id_key
 
typedef Global_name_key Name_key
 
typedef Void_key Aux_key
 
typedef Collection< Tablespace_file * > Tablespace_file_collection
 

Public Member Functions

virtual bool update_id_key (Id_key *key) const
 
virtual bool update_name_key (Name_key *key) const
 
virtual bool update_aux_key (Aux_key *) const
 
 ~Tablespace () override=default
 
virtual bool is_empty (THD *thd, bool *empty) const =0
 Check if the tablespace is empty, i.e., whether it has any tables. More...
 
virtual const String_typecomment () const =0
 
virtual void set_comment (const String_type &comment)=0
 
virtual const Propertiesoptions () const =0
 
virtual Propertiesoptions ()=0
 
virtual bool set_options (const String_type &options_raw)=0
 
virtual const Propertiesse_private_data () const =0
 
virtual Propertiesse_private_data ()=0
 
virtual bool set_se_private_data (const String_type &se_private_data_raw)=0
 
virtual const String_typeengine () const =0
 
virtual void set_engine (const String_type &engine)=0
 
virtual LEX_CSTRING engine_attribute () const =0
 
virtual void set_engine_attribute (LEX_CSTRING a)=0
 
virtual Tablespace_fileadd_file ()=0
 
virtual bool remove_file (String_type data_file)=0
 
virtual const Tablespace_file_collectionfiles () const =0
 
virtual Tablespaceclone () const =0
 Allocate a new object graph and invoke the copy constructor for each object. More...
 
virtual Tablespaceclone_dropped_object_placeholder () const =0
 Allocate a new object which can serve as a placeholder for the original object in the Dictionary_client's dropped registry. More...
 
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...
 
- 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_typename () 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
 

Static Public Member Functions

static bool update_id_key (Id_key *key, Object_id id)
 
static bool update_name_key (Name_key *key, const String_type &name)
 

Member Typedef Documentation

◆ Aux_key

◆ Cache_partition

◆ DD_table

◆ Id_key

◆ Impl

◆ Name_key

◆ Tablespace_file_collection

Constructor & Destructor Documentation

◆ ~Tablespace()

dd::Tablespace::~Tablespace ( )
overridedefault

Member Function Documentation

◆ add_file()

virtual Tablespace_file * dd::Tablespace::add_file ( )
pure virtual

Implemented in dd::Tablespace_impl.

◆ clone()

virtual Tablespace * dd::Tablespace::clone ( ) const
pure virtual

Allocate a new object graph and invoke the copy constructor for each object.

Returns
pointer to dynamically allocated copy

Implemented in dd::Tablespace_impl.

◆ clone_dropped_object_placeholder()

virtual Tablespace * dd::Tablespace::clone_dropped_object_placeholder ( ) const
pure virtual

Allocate a new object which can serve as a placeholder for the original object in the Dictionary_client's dropped registry.

Such object has the same keys as the original but has no other info and as result occupies less memory.

Implemented in dd::Tablespace_impl.

◆ comment()

virtual const String_type & dd::Tablespace::comment ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ deserialize()

virtual bool dd::Tablespace::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
rctxstores book-keeping information for the deserialization process
valsubobject of rapidjson DOM containing json representation of this object

Implemented in dd::Tablespace_impl.

◆ engine()

virtual const String_type & dd::Tablespace::engine ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ engine_attribute()

virtual LEX_CSTRING dd::Tablespace::engine_attribute ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ files()

virtual const Tablespace_file_collection & dd::Tablespace::files ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ is_empty()

virtual bool dd::Tablespace::is_empty ( THD thd,
bool *  empty 
) const
pure virtual

Check if the tablespace is empty, i.e., whether it has any tables.

Parameters
thdThread context.
[out]emptyWhether the tablespace is empty.
Returns
true if error, false if success.

Implemented in dd::Tablespace_impl.

◆ options() [1/2]

virtual const Properties & dd::Tablespace::options ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ options() [2/2]

virtual Properties & dd::Tablespace::options ( )
pure virtual

Implemented in dd::Tablespace_impl.

◆ remove_file()

virtual bool dd::Tablespace::remove_file ( String_type  data_file)
pure virtual

Implemented in dd::Tablespace_impl.

◆ se_private_data() [1/2]

virtual const Properties & dd::Tablespace::se_private_data ( ) const
pure virtual

Implemented in dd::Tablespace_impl.

◆ se_private_data() [2/2]

virtual Properties & dd::Tablespace::se_private_data ( )
pure virtual

Implemented in dd::Tablespace_impl.

◆ serialize()

virtual void dd::Tablespace::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
wctxopaque context for data needed by serialization
wrapidjson writer which will perform conversion to json

Implemented in dd::Tablespace_impl.

◆ set_comment()

virtual void dd::Tablespace::set_comment ( const String_type comment)
pure virtual

Implemented in dd::Tablespace_impl.

◆ set_engine()

virtual void dd::Tablespace::set_engine ( const String_type engine)
pure virtual

Implemented in dd::Tablespace_impl.

◆ set_engine_attribute()

virtual void dd::Tablespace::set_engine_attribute ( LEX_CSTRING  a)
pure virtual

Implemented in dd::Tablespace_impl.

◆ set_options()

virtual bool dd::Tablespace::set_options ( const String_type options_raw)
pure virtual

Implemented in dd::Tablespace_impl.

◆ set_se_private_data()

virtual bool dd::Tablespace::set_se_private_data ( const String_type se_private_data_raw)
pure virtual

Implemented in dd::Tablespace_impl.

◆ update_aux_key()

virtual bool dd::Tablespace::update_aux_key ( Aux_key ) const
inlinevirtual

◆ update_id_key() [1/2]

virtual bool dd::Tablespace::update_id_key ( Id_key key) const
inlinevirtual

◆ update_id_key() [2/2]

bool Tablespace::update_id_key ( Id_key key,
Object_id  id 
)
static

◆ update_name_key() [1/2]

virtual bool dd::Tablespace::update_name_key ( Name_key key) const
inlinevirtual

◆ update_name_key() [2/2]

bool Tablespace::update_name_key ( Name_key key,
const String_type name 
)
static

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