File oid.h¶

FileList > cubrid > src > storage > oid.h

#include "storage_common.h"
#include "dbtype_def.h"
#include <functional>

Classes¶

Type	Name
struct	hash< OID > <>

Public Types¶

Type	Name
enum	oid_8h_1ac791b66a82093c303b1b2aaf4f185ede

Public Attributes¶

Type	Name
PAGEID	oid_Next_tempid
const OID	oid_Null_oid
OID *	oid_Root_class_oid
OID *	oid_Serial_class_oid
OID *	oid_Sp_code_class_oid
OID *	oid_User_class_oid

Public Functions¶

Type	Name
bool	oid_check_cached_class_oid (const int cache_id, const OID * oid)
int	oid_compare (const void * oid1, const void * oid2)
int	oid_compare_equals (const void * key_oid1, const void * key_oid2)
const char *	oid_get_cached_class_name (const int cache_id)
void	oid_get_partition_oid (OID * oid)
OID *	oid_get_rep_read_tran_oid (void)
void	oid_get_serial_oid (OID * oid)
unsigned int	oid_hash (const void * key_oid, unsigned int htsize)
bool	oid_is_cached_class_oid (const OID * class_oid)
bool	oid_is_db_attribute (const OID * oid)
bool	oid_is_db_class (const OID * oid)
bool	oid_is_partition (const OID * oid)
bool	oid_is_root (const OID * oid)
bool	oid_is_serial (const OID * oid)
bool	oid_is_system_class (const OID * class_oid)
void	oid_set_cached_class_oid (const int cache_id, const OID * oid)
void	oid_set_partition (const OID * oid)
void	oid_set_root (const OID * oid)
void	oid_set_serial (const OID * oid)
bool	operator!= (const OID & oid1, const OID & oid2)
bool	operator== (const OID & oid1, const OID & oid2)

Macros¶

Type	Name
define	COPY_OID (dest_oid_ptr, src_oid_ptr) `/* multi line expression */`
define	OID_AS_ARGS (oidp) `(oidp)->volid, (oidp)->pageid, (oidp)->slotid`
define	OID_EQ (oidp1, oidp2) `/* multi line expression */`
define	OID_GET_REAL_CLASS_OF_DIR_OID (virtual_oidp, class_oidp) `/* multi line expression */`
define	OID_GET_VIRTUAL_CLASS_OF_DIR_OID (class_oidp, virtual_oidp) `/* multi line expression */`
define	OID_GT (oidp1, oidp2) `/* multi line expression */`
define	OID_GTE (oidp1, oidp2) `/* multi line expression */`
define	OID_INITIALIZER `{[NULL\_PAGEID](storage__common_8h.md#define-null_pageid), [NULL\_SLOTID](storage__common_8h.md#define-null_slotid), [NULL\_VOLID](storage__common_8h.md#define-null_volid)}`
define	OID_ISNULL (oidp) `((oidp)->pageid == [NULL\_PAGEID](storage__common_8h.md#define-null_pageid))`
define	OID_ISTEMP (oidp) `((oidp)->pageid < [NULL\_PAGEID](storage__common_8h.md#define-null_pageid))`
define	OID_IS_PSEUDO_OID (oidp) `((oidp)->volid < [NULL\_VOLID](storage__common_8h.md#define-null_volid))`
define	OID_IS_ROOTOID (oidp) `([OID\_EQ](oid_8h.md#define-oid_eq)((oidp), [oid\_Root\_class\_oid](oid_8c.md#variable-oid_root_class_oid)))`
define	OID_IS_VIRTUAL_CLASS_OF_DIR_OID (oidp) `/* multi line expression */`
define	OID_LT (oidp1, oidp2) `/* multi line expression */`
define	OID_LTE (oidp1, oidp2) `/* multi line expression */`
define	OID_PSEUDO_KEY (oidp) `/* multi line expression */`
define	OID_SET_NULL (oidp) `/* multi line expression */`
define	ROOTCLASS_NAME `"Rootclass" /\* [Name](broker__monitor_8c.md#function-timeout) [of](broker__monitor_8c.md#function-timeout) [Rootclass](broker__monitor_8c.md#function-timeout) \*/`
define	SAFE_COPY_OID (dest_oid_ptr, src_oid_ptr) `/* multi line expression */`
define	SET_OID (dest_oid_ptr, vol_id, page_id, slot_id) `/* multi line expression */`
define	VIRTUAL_CLASS_DIR_OID_MASK `(1 << 15)`

Public Types Documentation¶

enum oid_8h_1ac791b66a82093c303b1b2aaf4f185ede¶

enum oid_8h_1ac791b66a82093c303b1b2aaf4f185ede {
    OID_CACHE_ROOT_CLASS_ID = 0,
    OID_CACHE_CLASS_CLASS_ID,
    OID_CACHE_ATTRIBUTE_CLASS_ID,
    OID_CACHE_DOMAIN_CLASS_ID,
    OID_CACHE_METHOD_CLASS_ID,
    OID_CACHE_METHSIG_CLASS_ID,
    OID_CACHE_METHARG_CLASS_ID,
    OID_CACHE_METHFILE_CLASS_ID,
    OID_CACHE_QUERYSPEC_CLASS_ID,
    OID_CACHE_INDEX_CLASS_ID,
    OID_CACHE_INDEXKEY_CLASS_ID,
    OID_CACHE_DATATYPE_CLASS_ID,
    OID_CACHE_CLASSAUTH_CLASS_ID,
    OID_CACHE_PARTITION_CLASS_ID,
    OID_CACHE_STORED_PROC_CLASS_ID,
    OID_CACHE_STORED_PROC_ARGS_CLASS_ID,
    OID_CACHE_SERIAL_CLASS_ID,
    OID_CACHE_HA_APPLY_INFO_CLASS_ID,
    OID_CACHE_COLLATION_CLASS_ID,
    OID_CACHE_CHARSET_CLASS_ID,
    OID_CACHE_TRIGGER_CLASS_ID,
    OID_CACHE_USER_CLASS_ID,
    OID_CACHE_PASSWORD_CLASS_ID,
    OID_CACHE_AUTH_CLASS_ID,
    OID_CACHE_DB_ROOT_CLASS_ID,
    OID_CACHE_DB_SERVER_CLASS_ID,
    OID_CACHE_SYNONYM_CLASS_ID,
    OID_CACHE_STORED_PROC_CODE_CLASS_ID,
    OID_CACHE_SIZE
};

Public Attributes Documentation¶

variable oid_Next_tempid¶

PAGEID oid_Next_tempid;

variable oid_Null_oid¶

const OID oid_Null_oid;

variable oid_Root_class_oid¶

OID* oid_Root_class_oid;

variable oid_Serial_class_oid¶

OID* oid_Serial_class_oid;

variable oid_Sp_code_class_oid¶

OID* oid_Sp_code_class_oid;

variable oid_User_class_oid¶

OID* oid_User_class_oid;

Public Functions Documentation¶

function oid_check_cached_class_oid¶

bool oid_check_cached_class_oid (
    const  int cache_id,
    const  OID * oid
)

function oid_compare¶

int oid_compare (
    const  void * oid1,
    const  void * oid2
)

function oid_compare_equals¶

int oid_compare_equals (
    const  void * key_oid1,
    const  void * key_oid2
)

function oid_get_cached_class_name¶

const  char * oid_get_cached_class_name (
    const  int cache_id
)

function oid_get_partition_oid¶

void oid_get_partition_oid (
    OID * oid
)

function oid_get_rep_read_tran_oid¶

OID * oid_get_rep_read_tran_oid (
    void
)

function oid_get_serial_oid¶

void oid_get_serial_oid (
    OID * oid
)

function oid_hash¶

unsigned  int oid_hash (
    const  void * key_oid,
    unsigned  int htsize
)

function oid_is_cached_class_oid¶

bool oid_is_cached_class_oid (
    const  OID * class_oid
)

function oid_is_db_attribute¶

bool oid_is_db_attribute (
    const  OID * oid
)

function oid_is_db_class¶

bool oid_is_db_class (
    const  OID * oid
)

function oid_is_partition¶

bool oid_is_partition (
    const  OID * oid
)

function oid_is_root¶

bool oid_is_root (
    const  OID * oid
)

function oid_is_serial¶

bool oid_is_serial (
    const  OID * oid
)

function oid_is_system_class¶

bool oid_is_system_class (
    const  OID * class_oid
)

function oid_set_cached_class_oid¶

void oid_set_cached_class_oid (
    const  int cache_id,
    const  OID * oid
)

function oid_set_partition¶

void oid_set_partition (
    const  OID * oid
)

function oid_set_root¶

void oid_set_root (
    const  OID * oid
)

function oid_set_serial¶

void oid_set_serial (
    const  OID * oid
)

function operator!=¶

inline bool operator!= (
    const  OID & oid1,
    const  OID & oid2
)

function operator==¶

inline bool operator== (
    const  OID & oid1,
    const  OID & oid2
)

Macro Definition Documentation¶

define COPY_OID¶

#define COPY_OID (
    dest_oid_ptr,
    src_oid_ptr
) `/* multi line expression */`

define OID_AS_ARGS¶

#define OID_AS_ARGS (
    oidp
) `(oidp)->volid, (oidp)->pageid, (oidp)->slotid`

define OID_EQ¶

#define OID_EQ (
    oidp1,
    oidp2
) `/* multi line expression */`

define OID_GET_REAL_CLASS_OF_DIR_OID¶

#define OID_GET_REAL_CLASS_OF_DIR_OID (
    virtual_oidp,
    class_oidp
) `/* multi line expression */`

define OID_GET_VIRTUAL_CLASS_OF_DIR_OID¶

#define OID_GET_VIRTUAL_CLASS_OF_DIR_OID (
    class_oidp,
    virtual_oidp
) `/* multi line expression */`

define OID_GT¶

#define OID_GT (
    oidp1,
    oidp2
) `/* multi line expression */`

define OID_GTE¶

#define OID_GTE (
    oidp1,
    oidp2
) `/* multi line expression */`

define OID_INITIALIZER¶

#define OID_INITIALIZER `{ NULL_PAGEID , NULL_SLOTID , NULL_VOLID }`

define OID_ISNULL¶

#define OID_ISNULL (
    oidp
) `((oidp)->pageid == NULL_PAGEID )`

define OID_ISTEMP¶

#define OID_ISTEMP (
    oidp
) `((oidp)->pageid < NULL_PAGEID )`

define OID_IS_PSEUDO_OID¶

#define OID_IS_PSEUDO_OID (
    oidp
) `((oidp)->volid < NULL_VOLID )`

define OID_IS_ROOTOID¶

#define OID_IS_ROOTOID (
    oidp
) `( OID_EQ ((oidp), oid_Root_class_oid ))`

define OID_IS_VIRTUAL_CLASS_OF_DIR_OID¶

#define OID_IS_VIRTUAL_CLASS_OF_DIR_OID (
    oidp
) `/* multi line expression */`

define OID_LT¶

#define OID_LT (
    oidp1,
    oidp2
) `/* multi line expression */`

define OID_LTE¶

#define OID_LTE (
    oidp1,
    oidp2
) `/* multi line expression */`

define OID_PSEUDO_KEY¶

#define OID_PSEUDO_KEY (
    oidp
) `/* multi line expression */`

define OID_SET_NULL¶

#define OID_SET_NULL (
    oidp
) `/* multi line expression */`

define ROOTCLASS_NAME¶

#define ROOTCLASS_NAME `"Rootclass" /* Name  of  Rootclass */`

define SAFE_COPY_OID¶

#define SAFE_COPY_OID (
    dest_oid_ptr,
    src_oid_ptr
) `/* multi line expression */`

define SET_OID¶

#define SET_OID (
    dest_oid_ptr,
    vol_id,
    page_id,
    slot_id
) `/* multi line expression */`

define VIRTUAL_CLASS_DIR_OID_MASK¶

#define VIRTUAL_CLASS_DIR_OID_MASK `(1 << 15)`

The documentation for this class was generated from the following file cubrid/src/storage/oid.h