Documentation Home
MySQL Internals Manual
Download this Manual
EPUB - 1.2Mb


23.18.10 index_init

Purpose

Signals the storage engine that an index scan is about to occur. Storage engine should allocate any resources needed.

Synopsis

virtual int index_init (

idx,

sorted);

uint

idx ;

bool

sorted ;

Description

This is the index_init method. This method is called before an index scan, allowing the storage engine to allocate resources and make preparations.

Parameters

  • idx

  • sorted

Return Values

Usage

This method can typically just return 0 if there is no preparation needed.

Default Implementation

 { active_index=idx; return 0; } 

User Comments
Sign Up Login You must be logged in to post a comment.