Documentation Home
MySQL Internals Manual


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
User comments in this section are, as the name implies, provided by MySQL users. The MySQL documentation team is not responsible for, nor do they endorse, any of the information provided here.
Sign Up Login You must be logged in to post a comment.