Kudu C++ client API
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
kudu::client::KuduColumnSchema Class Reference

Representation of the column schema. More...

#include <schema.h>

Public Types

enum  DataType {
  INT8 = 0, INT16 = 1, INT32 = 2, INT64 = 3,
  STRING = 4, BOOL = 5, FLOAT = 6, DOUBLE = 7,
  BINARY = 8, TIMESTAMP = 9
}
 Supported data types for columns.
 

Public Member Functions

 KuduColumnSchema (const std::string &name, DataType type, bool is_nullable=false, const void *default_value=NULL, KuduColumnStorageAttributes attributes=KuduColumnStorageAttributes())
 
 KuduColumnSchema (const KuduColumnSchema &other)
 
KuduColumnSchemaoperator= (const KuduColumnSchema &other)
 
void CopyFrom (const KuduColumnSchema &other)
 
bool Equals (const KuduColumnSchema &other) const
 
Getters to expose column schema information.
Todo:
Expose default column value and attributes?
Returns
Name of the column schema.
const std::string & name () const
 
DataType type () const
 
bool is_nullable () const
 

Static Public Member Functions

static std::string DataTypeToString (DataType type)
 

Friends

class KuduColumnSpec
 
class KuduSchema
 
class KuduSchemaBuilder
 
class KuduTableAlterer
 

Detailed Description

Representation of the column schema.

Constructor & Destructor Documentation

kudu::client::KuduColumnSchema::KuduColumnSchema ( const std::string &  name,
DataType  type,
bool  is_nullable = false,
const void *  default_value = NULL,
KuduColumnStorageAttributes  attributes = KuduColumnStorageAttributes() 
)
Deprecated:
Use KuduSchemaBuilder instead.
Todo:
KUDU-809: make this hard-to-use constructor private. Clients should use the Builder API. Currently only the Python API uses this old API.
Parameters
[in]nameThe name of the column.
[in]typeThe type of the column.
[in]is_nullableWhether the column is nullable.
[in]default_valueDefault value for the column.
[in]attributesColumn storage attributes.
kudu::client::KuduColumnSchema::KuduColumnSchema ( const KuduColumnSchema other)

Construct KuduColumnSchema object as a copy of another object.

Parameters
[in]otherThe reference object to copy from.

Member Function Documentation

void kudu::client::KuduColumnSchema::CopyFrom ( const KuduColumnSchema other)

Make this object an identical copy of the other one.

Parameters
[in]otherThe reference object to copy from.
static std::string kudu::client::KuduColumnSchema::DataTypeToString ( DataType  type)
static
Parameters
[in]typeColumn data type.
Returns
String representation of the column data type.
bool kudu::client::KuduColumnSchema::Equals ( const KuduColumnSchema other) const

Check whether the object is identical to the other one.

Parameters
[in]otherThe reference object to compare with.
Returns
true iff the object is identical to the specified one.
bool kudu::client::KuduColumnSchema::is_nullable ( ) const
Returns
true iff the column schema has the nullable attribute set.
KuduColumnSchema& kudu::client::KuduColumnSchema::operator= ( const KuduColumnSchema other)

The assignment operator.

Parameters
[in]otherThe reference object to assign from.
Returns
The updated object.
DataType kudu::client::KuduColumnSchema::type ( ) const
Returns
Type of the column schema.

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