Persister Class Reference

Interface for persistent dynamic table metadata. More...

#include <dict0mem.h>

Inheritance diagram for Persister:

Public Member Functions
virtual	~Persister ()=default
	Virtual destructor. More...
virtual ulint	write (const PersistentTableMetadata &metadata, byte *buffer, ulint size) const =0
	Write the dynamic metadata of a table, we can pre-calculate the size by calling get_write_size() More...
virtual ulint	get_write_size (const PersistentTableMetadata &metadata) const =0
	Pre-calculate the size of metadata to be written. More...
virtual ulint	read (PersistentTableMetadata &metadata, const byte *buffer, ulint size, bool *corrupt) const =0
	Read the dynamic metadata from buffer, and store them to metadata object. More...
virtual void	aggregate (PersistentTableMetadata &metadata, const PersistentTableMetadata &new_entry) const =0
	Aggregate metadata entries into a single metadata instance, considering version numbers. More...
void	write_log (table_id_t id, const PersistentTableMetadata &metadata, mtr_t *mtr) const
	Write MLOG_TABLE_DYNAMIC_META for persistent dynamic metadata of table. More...

Detailed Description

Interface for persistent dynamic table metadata.

Constructor & Destructor Documentation

~Persister()

virtual Persister::~Persister ( )

virtualdefault

Virtual destructor.

Member Function Documentation

aggregate()

virtual void Persister::aggregate ( PersistentTableMetadata &  metadata, const PersistentTableMetadata &  new_entry  ) const

pure virtual

Aggregate metadata entries into a single metadata instance, considering version numbers.

Parameters

[in,out]	metadata	metadata object to be modified
[in]	new_entry	metadata entry from logs

Implemented in CorruptedIndexPersister, and AutoIncPersister.

get_write_size()

virtual ulint Persister::get_write_size ( const PersistentTableMetadata &  metadata ) const

pure virtual

Pre-calculate the size of metadata to be written.

Parameters

[in]

metadata

metadata to be written

Returns

the size of metadata

Implemented in CorruptedIndexPersister, and AutoIncPersister.

read()

virtual ulint Persister::read ( PersistentTableMetadata &  metadata, const byte *  buffer, ulint  size, bool *  corrupt  ) const

pure virtual

Read the dynamic metadata from buffer, and store them to metadata object.

Parameters

[out]	metadata	metadata where we store the read data
[in]	buffer	buffer to read
[in]	size	size of buffer
[out]	corrupt	true if we found something wrong in the buffer except incomplete buffer, otherwise false

Returns

the bytes we read from the buffer if the buffer data is complete and we get everything, 0 if the buffer is incompleted

Implemented in CorruptedIndexPersister, and AutoIncPersister.

write()

virtual ulint Persister::write ( const PersistentTableMetadata &  metadata, byte *  buffer, ulint  size  ) const

pure virtual

Write the dynamic metadata of a table, we can pre-calculate the size by calling get_write_size()

Parameters

[in]	metadata	persistent data
[out]	buffer	write buffer
[in]	size	size of write buffer, should be at least get_write_size()

Returns

the length of bytes written

Implemented in CorruptedIndexPersister, and AutoIncPersister.

write_log()

void Persister::write_log	(	table_id_t	id,
		const PersistentTableMetadata &	metadata,
		mtr_t *	mtr
	)		const

Write MLOG_TABLE_DYNAMIC_META for persistent dynamic metadata of table.

Parameters

[in]	id	Table id
[in]	metadata	Metadata used to write the log
[in,out]	mtr	Mini-transaction

---

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

• storage/innobase/include/dict0mem.h
• storage/innobase/dict/dict0dict.cc