MySQL  8.0.22
Source Code Documentation
btr0types.h
Go to the documentation of this file.
1 /*****************************************************************************
2 
3 Copyright (c) 1996, 2018, Oracle and/or its affiliates. All Rights Reserved.
4 
5 This program is free software; you can redistribute it and/or modify it under
6 the terms of the GNU General Public License, version 2.0, as published by the
7 Free Software Foundation.
8 
9 This program is also distributed with certain software (including but not
10 limited to OpenSSL) that is licensed under separate terms, as designated in a
11 particular file or component or in included license documentation. The authors
12 of MySQL hereby grant you an additional permission to link the program and
13 your derivative works with the separately licensed software that they have
14 included with MySQL.
15 
16 This program is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18 FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
19 for more details.
20 
21 You should have received a copy of the GNU General Public License along with
22 this program; if not, write to the Free Software Foundation, Inc.,
23 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 
25 *****************************************************************************/
26 
27 /** @file include/btr0types.h
28  The index tree general types
29 
30  Created 2/17/1996 Heikki Tuuri
31  *************************************************************************/
32 
33 #ifndef btr0types_h
34 #define btr0types_h
35 
36 #include "univ.i"
37 
38 #include "page0size.h"
39 #include "page0types.h"
40 #include "rem0types.h"
41 #include "sync0rw.h"
42 
43 /** Persistent cursor */
44 struct btr_pcur_t;
45 /** B-tree cursor */
46 struct btr_cur_t;
47 /** B-tree search information for the adaptive hash index */
48 struct btr_search_t;
49 
50 /** Is search system enabled.
51 Search system is protected by array of latches. */
52 extern bool btr_search_enabled;
53 
54 /** Number of adaptive hash index partition. */
55 extern ulong btr_ahi_parts;
56 
57 /** The size of a reference to data stored on a different page.
58 The reference is stored at the end of the prefix of the field
59 in the index record. */
60 #define BTR_EXTERN_FIELD_REF_SIZE FIELD_REF_SIZE
61 
62 /** If the data don't exceed the size, the data are stored locally. */
63 #define BTR_EXTERN_LOCAL_STORED_MAX_SIZE (BTR_EXTERN_FIELD_REF_SIZE * 2)
64 
65 #endif
Record manager global types.
ulong btr_ahi_parts
Number of adaptive hash index partition.
Definition: btr0sea.cc:60
bool btr_search_enabled
Is search system enabled.
Definition: btr0sea.cc:57
The tree cursor: the definition appears here only for the compiler to know struct size! ...
Definition: btr0cur.h:698
The search info struct in an index.
Definition: btr0sea.h:233
Index page routines.
Definition: btr0pcur.h:178
The read-write lock (for threads, not for database transactions)
A class describing a page size.