1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
use super::{IndexHint, IndexHintScope, IndexHintType};
use crate::{IntoIden, IntoTableRef, SelectStatement};
macro_rules! get_or_insert_index {
($self:ident, $table:expr, $index:expr, $ty:expr, $scope:expr) => {
let key = $table.into();
match $self.index_hints.get_mut(&key) {
Some(value) => value.push(IndexHint {
index: $index,
r#type: $ty,
scope: $scope,
}),
None => {
$self.index_hints.insert(
key,
vec![IndexHint {
index: $index,
r#type: $ty,
scope: $scope,
}],
);
}
};
};
}
pub trait MySqlSelectStatementExt {
fn use_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden;
fn use_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden;
fn force_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden;
fn force_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden;
fn ignore_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden;
fn ignore_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden;
}
const PANIC_MSG: &str =
"No table in from clause, you should specify the table before using index hint";
impl MySqlSelectStatementExt for SelectStatement {
/// USE INDEX hint on the last table in the from clause for MySQL
///
/// Give the optimizer information about how to choose indexes during query processing.
/// See [MySQL reference manual for Index Hints](https://dev.mysql.com/doc/refman/8.0/en/index-hints.html)
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Char::Table)
/// .use_index(IndexName::new("IDX_123456"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `character` USE INDEX (`IDX_123456`)"#
/// );
/// ```
fn use_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden,
{
let table_ref = self.from.last().expect(PANIC_MSG);
get_or_insert_index!(
self,
table_ref,
index.into_iden(),
IndexHintType::Use,
scope
);
self
}
/// USE INDEX hint on the specified in the from clause for MySQL
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Font::Table)
/// .from(Char::Table)
/// .use_index_on(Char::Table, IndexName::new("IDX_123456"), IndexHintScope::All)
/// .use_index_on(Font::Table, IndexName::new("IDX_654321"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `font` USE INDEX (`IDX_654321`), `character` USE INDEX (`IDX_123456`)"#
/// );
/// ```
fn use_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden,
{
get_or_insert_index!(
self,
table.into_table_ref(),
index.into_iden(),
IndexHintType::Use,
scope
);
self
}
/// FORCE INDEX hint on the last table in from clause for MySQL
///
/// Give the optimizer information about how to choose indexes during query processing.
/// See [MySQL reference manual for Index Hints](https://dev.mysql.com/doc/refman/8.0/en/index-hints.html)
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Char::Table)
/// .force_index(IndexName::new("IDX_123456"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `character` FORCE INDEX (`IDX_123456`)"#
/// );
/// ```
fn force_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden,
{
let table_ref = self.from.last().expect(PANIC_MSG);
get_or_insert_index!(
self,
table_ref,
index.into_iden(),
IndexHintType::Force,
scope
);
self
}
/// FORCE INDEX hint on the specified in the from clause for MySQL
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Font::Table)
/// .from(Char::Table)
/// .force_index_on(Char::Table, IndexName::new("IDX_123456"), IndexHintScope::All)
/// .force_index_on(Font::Table, IndexName::new("IDX_654321"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `font` FORCE INDEX (`IDX_654321`), `character` FORCE INDEX (`IDX_123456`)"#
/// );
/// ```
fn force_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden,
{
get_or_insert_index!(
self,
table.into_table_ref(),
index.into_iden(),
IndexHintType::Force,
scope
);
self
}
/// Ignore index hint on the last table in the from clause for MySQL
///
/// Give the optimizer information about how to choose indexes during query processing.
/// See [MySQL reference manual for Index Hints](https://dev.mysql.com/doc/refman/8.0/en/index-hints.html)
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Char::Table)
/// .ignore_index(IndexName::new("IDX_123456"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `character` IGNORE INDEX (`IDX_123456`)"#
/// )
/// ```
fn ignore_index<I>(&mut self, index: I, scope: IndexHintScope) -> &mut Self
where
I: IntoIden,
{
let table_ref = self.from.last().expect(PANIC_MSG);
get_or_insert_index!(
self,
table_ref,
index.into_iden(),
IndexHintType::Ignore,
scope
);
self
}
/// IGNORE INDEX hint on the specified in the from clause for MySQL
///
/// # Examples
///
/// ```
/// use sea_query::{extension::mysql::*, tests_cfg::*, *};
///
/// let query = Query::select()
/// .from(Font::Table)
/// .from(Char::Table)
/// .ignore_index_on(Char::Table, IndexName::new("IDX_123456"), IndexHintScope::All)
/// .ignore_index_on(Font::Table, IndexName::new("IDX_654321"), IndexHintScope::All)
/// .column(Char::SizeW)
/// .to_owned();
///
/// assert_eq!(
/// query.to_string(MysqlQueryBuilder),
/// r#"SELECT `size_w` FROM `font` IGNORE INDEX (`IDX_654321`), `character` IGNORE INDEX (`IDX_123456`)"#
/// );
/// ```
fn ignore_index_on<T, I>(&mut self, table: T, index: I, scope: IndexHintScope) -> &mut Self
where
T: IntoTableRef,
I: IntoIden,
{
get_or_insert_index!(
self,
table.into_table_ref(),
index.into_iden(),
IndexHintType::Ignore,
scope
);
self
}
}