0.9.8.10
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
Hypertable::Lib::Master::Request::Parameters::AlterTable Class Reference

Request parameters for alter table operation. More...

#include <AlterTable.h>

Inheritance diagram for Hypertable::Lib::Master::Request::Parameters::AlterTable:
Inheritance graph
[legend]
Collaboration diagram for Hypertable::Lib::Master::Request::Parameters::AlterTable:
Collaboration graph
[legend]

Public Member Functions

 AlterTable ()
 Constructor. More...
 
 AlterTable (const std::string &name, const std::string &schema, bool force)
 Constructor. More...
 
const string & name () const
 Gets name of table to alter. More...
 
const string & schema () const
 Gets table schema. More...
 
bool force ()
 Gets force flag. More...
 
- Public Member Functions inherited from Hypertable::Serializable
virtual size_t encoded_length () const
 Returns serialized object length. More...
 
virtual void encode (uint8_t **bufp) const
 Writes serialized representation of object to a buffer. More...
 
virtual void decode (const uint8_t **bufp, size_t *remainp)
 Reads serialized representation of object from a buffer. More...
 

Private Member Functions

uint8_t encoding_version () const override
 Returns encoding version. More...
 
size_t encoded_length_internal () const override
 Returns internal serialized length. More...
 
void encode_internal (uint8_t **bufp) const override
 Writes serialized representation of object to a buffer. More...
 
void decode_internal (uint8_t version, const uint8_t **bufp, size_t *remainp) override
 Reads serialized representation of object from a buffer. More...
 

Private Attributes

std::string m_name
 Table name. More...
 
std::string m_schema
 New schema. More...
 
bool m_force {}
 Force schema alteration even if generation does not match original. More...
 

Additional Inherited Members

Detailed Description

Request parameters for alter table operation.

Definition at line 46 of file AlterTable.h.

Constructor & Destructor Documentation

Hypertable::Lib::Master::Request::Parameters::AlterTable::AlterTable ( )
inline

Constructor.

Empty initialization for decoding.

Definition at line 51 of file AlterTable.h.

AlterTable::AlterTable ( const std::string &  name,
const std::string &  schema,
bool  force 
)

Constructor.

Initializes with parameters for encoding. Sets m_name to name and m_schema to schema.

Parameters
nameTable name
schemaTable schema
forceForce schema alteration even if generation does not match original

Definition at line 39 of file AlterTable.cc.

Member Function Documentation

void AlterTable::decode_internal ( uint8_t  version,
const uint8_t **  bufp,
size_t *  remainp 
)
overrideprivatevirtual

Reads serialized representation of object from a buffer.

Parameters
versionEncoding version
bufpAddress of destination buffer pointer (advanced by call)
remainpAddress of integer holding amount of serialized object remaining
See also
encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 80 of file AlterTable.cc.

void AlterTable::encode_internal ( uint8_t **  bufp) const
overrideprivatevirtual

Writes serialized representation of object to a buffer.

Parameters
bufpAddress of destination buffer pointer (advanced by call)

Encoding is as follows:

Encoding Description
vstr Table name
vstr New schema
bool Force alter flag

Implements Hypertable::Serializable.

Definition at line 74 of file AlterTable.cc.

size_t AlterTable::encoded_length_internal ( ) const
overrideprivatevirtual

Returns internal serialized length.

Returns
Internal serialized length
See also
encode_internal() for encoding format

Implements Hypertable::Serializable.

Definition at line 49 of file AlterTable.cc.

uint8_t AlterTable::encoding_version ( ) const
overrideprivatevirtual

Returns encoding version.

Returns
Encoding version

Implements Hypertable::Serializable.

Definition at line 45 of file AlterTable.cc.

bool Hypertable::Lib::Master::Request::Parameters::AlterTable::force ( )
inline

Gets force flag.

Returns
Force flag

Definition at line 72 of file AlterTable.h.

const string& Hypertable::Lib::Master::Request::Parameters::AlterTable::name ( ) const
inline

Gets name of table to alter.

Returns
Name of table to alter

Definition at line 64 of file AlterTable.h.

const string& Hypertable::Lib::Master::Request::Parameters::AlterTable::schema ( ) const
inline

Gets table schema.

Returns
Table schema

Definition at line 68 of file AlterTable.h.

Member Data Documentation

bool Hypertable::Lib::Master::Request::Parameters::AlterTable::m_force {}
private

Force schema alteration even if generation does not match original.

Definition at line 105 of file AlterTable.h.

std::string Hypertable::Lib::Master::Request::Parameters::AlterTable::m_name
private

Table name.

Definition at line 99 of file AlterTable.h.

std::string Hypertable::Lib::Master::Request::Parameters::AlterTable::m_schema
private

New schema.

Definition at line 102 of file AlterTable.h.


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