Documentation Home
MySQL Internals Manual


23.18.15 index_read_idx

Purpose

Find a row based on a key and return.

Synopsis

virtual int index_read_idx (

buf,

index,

key,

keypart_map,

find_flag);

byte *

buf ;

uint

index ;

const byte *

key ;

ulonglong

keypart_map ;

enum ha_rkey_function

find_flag ;

Description

This is the index_read_idx method.

Positions an index cursor to the index specified in key. Fetches the row if any. This is only used to read whole keys.

Parameters

  • buf

  • index

  • key

  • keypart_map

  • find_flag

Return Values

This method has no return values.

Usage

Locate the row that matches the key passed and return it in the buffer provided.