File cursor.h

FileList > cubrid > src > query > cursor.h

Go to the source code of this file

• #include "config.h"
• #include "error_manager.h"
• #include "query_list.h"
• #include "storage_common.h"

Classes

Type	Name
struct	cursor_id

Public Types

Type	Name
typedef struct cursor_id	CURSOR_ID
enum	CURSOR_POSITION
enum	cursor_8h_1a1e06e534e565b0e44afdf96c77951725

Public Functions

Type	Name
void	cursor_close (CURSOR_ID * cursor_id)
int	cursor_copy_list_id (QFILE_LIST_ID * dest_list_id, const QFILE_LIST_ID * src_list_id)
int	cursor_copy_vobj_to_dbvalue (struct or_buf * buf, DB_VALUE * db_value)
int	cursor_fetch_page_having_tuple (CURSOR_ID * cursor_id, VPID * vpid, int position, int offset)
int	cursor_first_tuple (CURSOR_ID * cursor_id)
void	cursor_free (CURSOR_ID * cursor_id)
int	cursor_get_current_oid (CURSOR_ID * cursor_id, DB_VALUE * crs_value)
int	cursor_get_tuple_value (CURSOR_ID * result, int index, DB_VALUE * value)
int	cursor_get_tuple_value_list (CURSOR_ID * cursor_id, int size, DB_VALUE * value_list)
int	cursor_last_tuple (CURSOR_ID * cursor_id)
int	cursor_next_tuple (CURSOR_ID * cursor_id)
bool	cursor_open (CURSOR_ID * cursor_id, QFILE_LIST_ID * list_id, bool updatable, bool oid_included)
int	cursor_prev_tuple (CURSOR_ID * cursor_id)
void	cursor_print_list (QUERY_ID query_id, QFILE_LIST_ID * list_id)
bool	cursor_set_copy_tuple_value (CURSOR_ID * cursor_id, bool copy)
int	cursor_set_oid_columns (CURSOR_ID * cursor_id, int * oid_col_no, int oid_col_no_cnt)
DB_FETCH_MODE	cursor_set_prefetch_lock_mode (CURSOR_ID * cursor_id, DB_FETCH_MODE mode)

Macros

Type	Name
define	cursor_free_list_id (list_id) /* multi line expression */
define	cursor_free_self_list_id (list_id) /* multi line expression */

Public Types Documentation

typedef CURSOR_ID

typedef struct cursor_id CURSOR_ID;

---

enum CURSOR_POSITION

enum CURSOR_POSITION {
    C_BEFORE = 1,
    C_ON,
    C_AFTER
};

---

enum cursor_8h_1a1e06e534e565b0e44afdf96c77951725

enum cursor_8h_1a1e06e534e565b0e44afdf96c77951725 {
    DB_CURSOR_SEEK_SET = 1,
    DB_CURSOR_SEEK_CUR,
    DB_CURSOR_SEEK_END
};

---

Public Functions Documentation

function cursor_close

void cursor_close (
    CURSOR_ID * cursor_id
) 

---

function cursor_copy_list_id

int cursor_copy_list_id (
    QFILE_LIST_ID * dest_list_id,
    const  QFILE_LIST_ID * src_list_id
) 

---

function cursor_copy_vobj_to_dbvalue

int cursor_copy_vobj_to_dbvalue (
    struct  or_buf * buf,
    DB_VALUE * db_value
) 

---

function cursor_fetch_page_having_tuple

int cursor_fetch_page_having_tuple (
    CURSOR_ID * cursor_id,
    VPID * vpid,
    int position,
    int offset
) 

---

function cursor_first_tuple

int cursor_first_tuple (
    CURSOR_ID * cursor_id
) 

---

function cursor_free

void cursor_free (
    CURSOR_ID * cursor_id
) 

---

function cursor_get_current_oid

int cursor_get_current_oid (
    CURSOR_ID * cursor_id,
    DB_VALUE * crs_value
) 

---

function cursor_get_tuple_value

int cursor_get_tuple_value (
    CURSOR_ID * result,
    int index,
    DB_VALUE * value
) 

---

function cursor_get_tuple_value_list

int cursor_get_tuple_value_list (
    CURSOR_ID * cursor_id,
    int size,
    DB_VALUE * value_list
) 

---

function cursor_last_tuple

int cursor_last_tuple (
    CURSOR_ID * cursor_id
) 

---

function cursor_next_tuple

int cursor_next_tuple (
    CURSOR_ID * cursor_id
) 

---

function cursor_open

bool cursor_open (
    CURSOR_ID * cursor_id,
    QFILE_LIST_ID * list_id,
    bool updatable,
    bool oid_included
) 

---

function cursor_prev_tuple

int cursor_prev_tuple (
    CURSOR_ID * cursor_id
) 

---

function cursor_print_list

void cursor_print_list (
    QUERY_ID query_id,
    QFILE_LIST_ID * list_id
) 

---

function cursor_set_copy_tuple_value

bool cursor_set_copy_tuple_value (
    CURSOR_ID * cursor_id,
    bool copy
) 

---

function cursor_set_oid_columns

int cursor_set_oid_columns (
    CURSOR_ID * cursor_id,
    int * oid_col_no,
    int oid_col_no_cnt
) 

---

function cursor_set_prefetch_lock_mode

DB_FETCH_MODE cursor_set_prefetch_lock_mode (
    CURSOR_ID * cursor_id,
    DB_FETCH_MODE mode
) 

---

Macro Definition Documentation

define cursor_free_list_id

#define cursor_free_list_id (
    list_id
) `/* multi line expression */`

---

define cursor_free_self_list_id

#define cursor_free_self_list_id (
    list_id
) `/* multi line expression */`

---

---

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