Drizzled Public API Documentation

drizzled::StoredKey Class Referenceabstract

#include <stored_key.h>

Inheritance diagram for drizzled::StoredKey:
drizzled::memory::SqlAlloc drizzled::store_key_field drizzled::store_key_item drizzled::store_key_const_item

Public Types

enum  store_key_result { STORE_KEY_OK, STORE_KEY_FATAL, STORE_KEY_CONV }
 

Public Member Functions

 StoredKey (Session *session, Field *field_arg, unsigned char *ptr, unsigned char *null, uint32_t length)
 
virtual const char * name () const =0
 
enum store_key_result copy ()
 sets ignore truncation warnings mode and calls the real copy method More...
 

Static Public Member Functions

static void * operator new (size_t size)
 
static void * operator new (size_t size, Root &root)
 
static void * operator new (size_t size, Root *root)
 
static void * operator new[] (size_t size)
 
static void * operator new[] (size_t size, Root &root)
 
static void * operator new[] (size_t size, Root *root)
 
static void operator delete (void *)
 
static void operator delete (void *, Root &)
 
static void operator delete (void *, Root *)
 
static void operator delete[] (void *)
 
static void operator delete[] (void *, Root &)
 
static void operator delete[] (void *, Root *)
 

Public Attributes

bool null_key
 

Protected Member Functions

virtual enum store_key_result copy_inner ()=0
 

Protected Attributes

Fieldto_field
 
unsigned char * null_ptr
 
unsigned char err
 

Detailed Description

class to store an field/item as a key struct

Definition at line 29 of file stored_key.h.

Member Function Documentation

StoredKey::store_key_result drizzled::StoredKey::copy ( )

sets ignore truncation warnings mode and calls the real copy method

this function makes sure truncation warnings when preparing the key buffers don't end up as errors (because of an enclosing INSERT/UPDATE).

Definition at line 62 of file stored_key.cc.

References drizzled::Table::in_use.

virtual const char* drizzled::StoredKey::name ( ) const
pure virtual

Member Data Documentation

bool drizzled::StoredKey::null_key

If true, the value of the key has a null part

Definition at line 32 of file stored_key.h.


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