MySQL  8.0.19
Source Code Documentation
my_icp.h
Go to the documentation of this file.
1 /* Copyright (c) 2013, 2017, Oracle and/or its affiliates. All rights reserved.
2 
3  This program is free software; you can redistribute it and/or modify
4  it under the terms of the GNU General Public License, version 2.0,
5  as published by the Free Software Foundation.
6 
7  This program is also distributed with certain software (including
8  but not limited to OpenSSL) that is licensed under separate terms,
9  as designated in a particular file or component or in included license
10  documentation. The authors of MySQL hereby grant you an additional
11  permission to link the program and your derivative works with the
12  separately licensed software that they have included with MySQL.
13 
14  This program is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License, version 2.0, for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with this program; if not, write to the Free Software
21  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
22 
23 #ifndef _my_icp_h
24 #define _my_icp_h
25 
26 /**
27  @file include/my_icp.h
28 */
29 
30 /**
31  Values returned by index_cond_func_xxx functions.
32 */
33 
34 typedef enum icp_result {
35  /** Index tuple doesn't satisfy the pushed index condition (the engine
36  should discard the tuple and go to the next one) */
38 
39  /** Index tuple satisfies the pushed index condition (the engine should
40  fetch and return the record) */
42 
43  /** Index tuple is out of the range that we're scanning, e.g. if we're
44  scanning "t.key BETWEEN 10 AND 20" and got a "t.key=21" tuple (the engine
45  should stop scanning and return HA_ERR_END_OF_FILE right away). */
47 
48 } ICP_RESULT;
49 
50 #endif /* _my_icp_h */
ICP_MATCH
@ ICP_MATCH
Index tuple satisfies the pushed index condition (the engine should fetch and return the record)
Definition: my_icp.h:41
ICP_NO_MATCH
@ ICP_NO_MATCH
Index tuple doesn't satisfy the pushed index condition (the engine should discard the tuple and go to...
Definition: my_icp.h:37
ICP_OUT_OF_RANGE
@ ICP_OUT_OF_RANGE
Index tuple is out of the range that we're scanning, e.g.
Definition: my_icp.h:46
ICP_RESULT
enum icp_result ICP_RESULT
Values returned by index_cond_func_xxx functions.
icp_result
icp_result
Values returned by index_cond_func_xxx functions.
Definition: my_icp.h:34