> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # gpudb::RecordKey > gpudb::RecordKey — Kinetica C++ API

#include \<gpudb/utils/GPUdbMultiHeadIOUtils.h>

Public Member Functions
  RecordKey ()
 
  RecordKey (size\_t buffer\_size)
 
  RecordKey (const RecordKey \&other)
 
  \~RecordKey ()
 
bool  is\_valid () const
 
int32\_t  get\_hash\_code () const
 
int64\_t  get\_routing\_hash () const
 
void  reset (size\_t buffer\_size)
 
void  add\_boolean (bool value, bool is\_null)
 
void  add\_char1 (const std::string \&value, bool is\_null)
 
void  add\_char2 (const std::string \&value, bool is\_null)
 
void  add\_char4 (const std::string \&value, bool is\_null)
 
void  add\_char8 (const std::string \&value, bool is\_null)
 
void  add\_char16 (const std::string \&value, bool is\_null)
 
void  add\_char32 (const std::string \&value, bool is\_null)
 
void  add\_char64 (const std::string \&value, bool is\_null)
 
void  add\_char128 (const std::string \&value, bool is\_null)
 
void  add\_char256 (const std::string \&value, bool is\_null)
 
void  add\_date (const std::string \&value, bool is\_null)
 
void  add\_datetime (const std::string \&value, bool is\_null)
 
void  add\_decimal (const std::string \&value, bool is\_null)
 
void  add\_double (double value, bool is\_null)
 
void  add\_float (float value, bool is\_null)
 
void  add\_int8 (int8\_t value, bool is\_null)
 
void  add\_int16 (int16\_t value, bool is\_null)
 
void  add\_int (int32\_t value, bool is\_null)
 
void  add\_ipv4 (const std::string \&value, bool is\_null)
 
void  add\_long (int64\_t value, bool is\_null)
 
void  add\_time (const std::string \&value, bool is\_null)
 
void  add\_timestamp (int64\_t value, bool is\_null)
 
void  add\_string (const std::string \&value, bool is\_null)
 
void  add\_ulong (const std::string \&value, bool is\_null)
 
void  add\_uuid (const std::string \&value, bool is\_null)
 
void  compute\_hash ()
  Compute the hash of the key in the buffer.
 
size\_t  route (const std::vector\< int32\_t > \&routing\_table) const
  Given a routing table consisting of worker rank indices, choose a worker rank based on the hash of the record key.
 
RecordKey &  operator= (const RecordKey \&other)
  The assignment operator.
 
bool  operator== (const RecordKey \&rhs) const
  Returns true if the other RecordKey is equivalent to this key.
 
bool  operator!= (const RecordKey \&rhs) const
 
bool  operator\< (const RecordKey \&rhs) const
  Returns true if this RecordKey is less than the other key.
 
bool  operator> (const RecordKey \&rhs) const
 
std::string  toString (const std::string \&separator=" ") const
 

Static Public Member Functions
static bool  verify\_ulong\_value (const std::string \&value)
  A static utility function for verifying if a given string is a valid.
 

Detailed Description

Definition at line 106 of file GPUdbMultiHeadIOUtils.h.

Constructor & Destructor Documentation

◆ RecordKey() \[1/3]

gpudb::RecordKey::RecordKey ( )

◆ RecordKey() \[2/3]

gpudb::RecordKey::RecordKey ( size\_t buffer\_size )

◆ RecordKey() \[3/3]

gpudb::RecordKey::RecordKey ( const RecordKey & other )

◆ \~RecordKey()

gpudb::RecordKey::\~RecordKey ( )

Member Function Documentation

◆ add\_boolean()

void gpudb::RecordKey::add\_boolean ( bool value,
bool is\_null )

◆ add\_char1()

void gpudb::RecordKey::add\_char1 ( const std::string & value,
bool is\_null )

◆ add\_char128()

void gpudb::RecordKey::add\_char128 ( const std::string & value,
bool is\_null )

◆ add\_char16()

void gpudb::RecordKey::add\_char16 ( const std::string & value,
bool is\_null )

◆ add\_char2()

void gpudb::RecordKey::add\_char2 ( const std::string & value,
bool is\_null )

◆ add\_char256()

void gpudb::RecordKey::add\_char256 ( const std::string & value,
bool is\_null )

◆ add\_char32()

void gpudb::RecordKey::add\_char32 ( const std::string & value,
bool is\_null )

◆ add\_char4()

void gpudb::RecordKey::add\_char4 ( const std::string & value,
bool is\_null )

◆ add\_char64()

void gpudb::RecordKey::add\_char64 ( const std::string & value,
bool is\_null )

◆ add\_char8()

void gpudb::RecordKey::add\_char8 ( const std::string & value,
bool is\_null )

◆ add\_date()

void gpudb::RecordKey::add\_date ( const std::string & value,
bool is\_null )

◆ add\_datetime()

void gpudb::RecordKey::add\_datetime ( const std::string & value,
bool is\_null )

◆ add\_decimal()

void gpudb::RecordKey::add\_decimal ( const std::string & value,
bool is\_null )

◆ add\_double()

void gpudb::RecordKey::add\_double ( double value,
bool is\_null )

◆ add\_float()

void gpudb::RecordKey::add\_float ( float value,
bool is\_null )

◆ add\_int()

void gpudb::RecordKey::add\_int ( int32\_t value,
bool is\_null )

◆ add\_int16()

void gpudb::RecordKey::add\_int16 ( int16\_t value,
bool is\_null )

◆ add\_int8()

void gpudb::RecordKey::add\_int8 ( int8\_t value,
bool is\_null )

◆ add\_ipv4()

void gpudb::RecordKey::add\_ipv4 ( const std::string & value,
bool is\_null )

◆ add\_long()

void gpudb::RecordKey::add\_long ( int64\_t value,
bool is\_null )

◆ add\_string()

void gpudb::RecordKey::add\_string ( const std::string & value,
bool is\_null )

◆ add\_time()

void gpudb::RecordKey::add\_time ( const std::string & value,
bool is\_null )

◆ add\_timestamp()

void gpudb::RecordKey::add\_timestamp ( int64\_t value,
bool is\_null )

◆ add\_ulong()

void gpudb::RecordKey::add\_ulong ( const std::string & value,
bool is\_null )

◆ add\_uuid()

void gpudb::RecordKey::add\_uuid ( const std::string & value,
bool is\_null )

◆ compute\_hash()

void gpudb::RecordKey::compute\_hash ( )

Compute the hash of the key in the buffer.

◆ get\_hash\_code()

int32\_t gpudb::RecordKey::get\_hash\_code ( ) const
inline

Definition at line 119 of file GPUdbMultiHeadIOUtils.h.

◆ get\_routing\_hash()

int64\_t gpudb::RecordKey::get\_routing\_hash ( ) const
inline

Definition at line 122 of file GPUdbMultiHeadIOUtils.h.

◆ is\_valid()

bool gpudb::RecordKey::is\_valid ( ) const
inline

Definition at line 116 of file GPUdbMultiHeadIOUtils.h.

◆ operator!=()

bool gpudb::RecordKey::operator!= ( const RecordKey & rhs ) const
inline

Definition at line 220 of file GPUdbMultiHeadIOUtils.h.

◆ operator\<()

bool gpudb::RecordKey::operator\< ( const RecordKey & rhs ) const

Returns true if this RecordKey is less than the other key.

◆ operator=()

RecordKey & gpudb::RecordKey::operator= ( const RecordKey & other )

The assignment operator.

◆ operator==()

bool gpudb::RecordKey::operator== ( const RecordKey & rhs ) const

Returns true if the other RecordKey is equivalent to this key.

◆ operator>()

bool gpudb::RecordKey::operator> ( const RecordKey & rhs ) const
inline

Definition at line 224 of file GPUdbMultiHeadIOUtils.h.

◆ reset()

void gpudb::RecordKey::reset ( size\_t buffer\_size )

◆ route()

size\_t gpudb::RecordKey::route ( const std::vector\< int32\_t > & routing\_table ) const

Given a routing table consisting of worker rank indices, choose a worker rank based on the hash of the record key.

◆ toString()

std::string gpudb::RecordKey::toString ( const std::string & separator = " " ) const

◆ verify\_ulong\_value()

static bool gpudb::RecordKey::verify\_ulong\_value ( const std::string & value )
static

A static utility function for verifying if a given string is a valid.

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