Skip to content

Commit 447a516

Browse files
chenhuiyehchenhuiyeh
authored
Add visible field to schema Index (#1043)
* add visible to index * add visible field to index * use show index columns to determine visible index and linting * directly use isIndexInvisible to assign value of index.Visible
1 parent d942f1b commit 447a516

File tree

2 files changed

+214
-1
lines changed

2 files changed

+214
-1
lines changed

‎schema/schema.go‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ type Index struct {
6060
Columns []string
6161
Cardinality []uint64
6262
NoneUnique uint64
63+
Visible bool
6364
}
6465

6566
type Table struct {
@@ -210,7 +211,7 @@ func (ta *Table) AddIndex(name string) (index *Index) {
210211
}
211212

212213
func NewIndex(name string) *Index {
213-
return &Index{name, make([]string, 0, 8), make([]uint64, 0, 8), 0}
214+
return &Index{name, make([]string, 0, 8), make([]uint64, 0, 8), 0, true}
214215
}
215216

216217
func (idx *Index) AddColumn(name string, cardinality uint64) {
@@ -320,6 +321,30 @@ func (ta *Table) fetchColumnsViaSqlDB(conn *sql.DB) error {
320321
return r.Err()
321322
}
322323

324+
// hasInvisibleIndexSupportFromResult checks if the result from SHOW INDEX has Visible column
325+
func hasInvisibleIndexSupportFromResult(r *mysql.Result) bool {
326+
for name := range r.FieldNames {
327+
if strings.EqualFold(name, "Visible") {
328+
return true
329+
}
330+
}
331+
return false
332+
}
333+
334+
// hasInvisibleIndexSupportFromColumns checks if the columns from SHOW INDEX include Visible column
335+
func hasInvisibleIndexSupportFromColumns(cols []string) bool {
336+
for _, col := range cols {
337+
if strings.EqualFold(col, "Visible") {
338+
return true
339+
}
340+
}
341+
return false
342+
}
343+
344+
func isIndexInvisible(value string) bool {
345+
return strings.EqualFold(value, "NO")
346+
}
347+
323348
func (ta *Table) fetchIndexes(conn mysql.Executer) error {
324349
r, err := conn.Execute(fmt.Sprintf("show index from `%s`.`%s`", ta.Schema, ta.Name))
325350
if err != nil {
@@ -328,6 +353,8 @@ func (ta *Table) fetchIndexes(conn mysql.Executer) error {
328353
var currentIndex *Index
329354
currentName := ""
330355

356+
hasInvisibleIndex := hasInvisibleIndexSupportFromResult(r)
357+
331358
for i := 0; i < r.RowNumber(); i++ {
332359
indexName, _ := r.GetString(i, 2)
333360
if currentName != indexName {
@@ -338,6 +365,10 @@ func (ta *Table) fetchIndexes(conn mysql.Executer) error {
338365
colName, _ := r.GetString(i, 4)
339366
currentIndex.AddColumn(colName, cardinality)
340367
currentIndex.NoneUnique, _ = r.GetUint(i, 1)
368+
if hasInvisibleIndex {
369+
visible, _ := r.GetString(i, 13)
370+
currentIndex.Visible = !isIndexInvisible(visible)
371+
}
341372
}
342373

343374
return ta.fetchPrimaryKeyColumns()
@@ -361,10 +392,12 @@ func (ta *Table) fetchIndexesViaSqlDB(conn *sql.DB) error {
361392
var colName sql.NullString
362393
var noneUnique uint64
363394
var cardinality interface{}
395+
var visible sql.NullString
364396
cols, err := r.Columns()
365397
if err != nil {
366398
return errors.Trace(err)
367399
}
400+
hasInvisibleIndex := hasInvisibleIndexSupportFromColumns(cols)
368401
values := make([]interface{}, len(cols))
369402
for i := 0; i < len(cols); i++ {
370403
switch i {
@@ -376,6 +409,10 @@ func (ta *Table) fetchIndexesViaSqlDB(conn *sql.DB) error {
376409
values[i] = &colName
377410
case 6:
378411
values[i] = &cardinality
412+
case 13:
413+
if hasInvisibleIndex {
414+
values[i] = &visible
415+
}
379416
default:
380417
values[i] = &unusedVal
381418
}
@@ -398,6 +435,10 @@ func (ta *Table) fetchIndexesViaSqlDB(conn *sql.DB) error {
398435
currentIndex.AddColumn("", c)
399436
}
400437
currentIndex.NoneUnique = noneUnique
438+
439+
if hasInvisibleIndex && visible.Valid {
440+
currentIndex.Visible = !isIndexInvisible(visible.String)
441+
}
401442
}
402443

403444
return ta.fetchPrimaryKeyColumns()

‎schema/schema_test.go‎

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,3 +174,175 @@ func (s *schemaTestSuite) TestSchemaWithMultiValueIndex() {
174174

175175
require.Equal(s.T(), ta, taSqlDb)
176176
}
177+
178+
func (s *schemaTestSuite) TestSchemaWithInvisibleIndex() {
179+
_, err := s.conn.Execute(`DROP TABLE IF EXISTS invisible_idx_test`)
180+
require.NoError(s.T(), err)
181+
182+
// Create table first to check invisible index support via column presence
183+
str := `
184+
CREATE TABLE IF NOT EXISTS invisible_idx_test (
185+
id INT,
186+
name VARCHAR(256),
187+
email VARCHAR(256),
188+
PRIMARY KEY(id),
189+
INDEX name_idx (name),
190+
INDEX email_idx (email)
191+
) ENGINE = INNODB;
192+
`
193+
194+
_, err = s.conn.Execute(str)
195+
require.NoError(s.T(), err)
196+
197+
// Check if invisible index support exists by checking SHOW INDEX columns
198+
r, err := s.conn.Execute(fmt.Sprintf("SHOW INDEX FROM `%s`.`%s`", *schema, "invisible_idx_test"))
199+
require.NoError(s.T(), err)
200+
hasInvisibleIndex := hasInvisibleIndexSupportFromResult(r)
201+
202+
// Add INVISIBLE keyword only if database supports it
203+
if hasInvisibleIndex {
204+
_, err = s.conn.Execute(`ALTER TABLE invisible_idx_test ALTER INDEX name_idx INVISIBLE`)
205+
require.NoError(s.T(), err)
206+
}
207+
208+
ta, err := NewTable(s.conn, *schema, "invisible_idx_test")
209+
require.NoError(s.T(), err)
210+
211+
require.Len(s.T(), ta.Indexes, 3)
212+
213+
// PRIMARY key should always be visible
214+
require.Equal(s.T(), "PRIMARY", ta.Indexes[0].Name)
215+
require.True(s.T(), ta.Indexes[0].Visible)
216+
217+
// Find name_idx and email_idx (order may vary)
218+
var nameIdx, emailIdx *Index
219+
for _, idx := range ta.Indexes {
220+
switch idx.Name {
221+
case "name_idx":
222+
nameIdx = idx
223+
case "email_idx":
224+
emailIdx = idx
225+
}
226+
}
227+
228+
require.NotNil(s.T(), nameIdx)
229+
require.NotNil(s.T(), emailIdx)
230+
231+
// email_idx should always be visible (default)
232+
require.True(s.T(), emailIdx.Visible)
233+
234+
// name_idx visibility depends on database support for invisible indexes
235+
if hasInvisibleIndex {
236+
require.False(s.T(), nameIdx.Visible, "name_idx should be invisible when database supports invisible indexes")
237+
} else {
238+
require.True(s.T(), nameIdx.Visible, "name_idx should be visible when database doesn't support invisible indexes")
239+
}
240+
241+
taSqlDb, err := NewTableFromSqlDB(s.sqlDB, *schema, "invisible_idx_test")
242+
require.NoError(s.T(), err)
243+
244+
require.Equal(s.T(), ta, taSqlDb)
245+
}
246+
247+
func (s *schemaTestSuite) TestInvisibleIndexColumnDetection() {
248+
_, err := s.conn.Execute(`DROP TABLE IF EXISTS column_detection_test`)
249+
require.NoError(s.T(), err)
250+
251+
str := `
252+
CREATE TABLE IF NOT EXISTS column_detection_test (
253+
id INT PRIMARY KEY,
254+
name VARCHAR(256),
255+
INDEX name_idx (name)
256+
) ENGINE = INNODB;
257+
`
258+
259+
_, err = s.conn.Execute(str)
260+
require.NoError(s.T(), err)
261+
262+
// Test both detection functions work consistently
263+
r, err := s.conn.Execute(fmt.Sprintf("SHOW INDEX FROM `%s`.`%s`", *schema, "column_detection_test"))
264+
require.NoError(s.T(), err)
265+
266+
hasInvisibleFromResult := hasInvisibleIndexSupportFromResult(r)
267+
268+
// Get columns and test the other detection function
269+
cols, err := s.sqlDB.Query(fmt.Sprintf("SHOW INDEX FROM `%s`.`%s`", *schema, "column_detection_test"))
270+
require.NoError(s.T(), err)
271+
defer cols.Close()
272+
273+
columnNames, err := cols.Columns()
274+
require.NoError(s.T(), err)
275+
hasInvisibleFromColumns := hasInvisibleIndexSupportFromColumns(columnNames)
276+
277+
// Both detection methods should agree
278+
require.Equal(s.T(), hasInvisibleFromResult, hasInvisibleFromColumns, "Detection methods should be consistent")
279+
280+
// Test that both connection types work identically
281+
ta1, err := NewTable(s.conn, *schema, "column_detection_test")
282+
require.NoError(s.T(), err)
283+
284+
ta2, err := NewTableFromSqlDB(s.sqlDB, *schema, "column_detection_test")
285+
require.NoError(s.T(), err)
286+
287+
require.Equal(s.T(), ta1, ta2, "Both connection types should produce identical results")
288+
}
289+
290+
func TestInvisibleIndexLogic(t *testing.T) {
291+
// Test MySQL-style visibility logic
292+
require.True(t, isIndexInvisible("NO"), "Visible=NO should be invisible")
293+
require.False(t, isIndexInvisible("YES"), "Visible=YES should be visible")
294+
295+
// Test case insensitivity
296+
require.True(t, isIndexInvisible("no"), "Should be case insensitive")
297+
require.True(t, isIndexInvisible("No"), "Should be case insensitive")
298+
require.False(t, isIndexInvisible("yes"), "Should be case insensitive")
299+
require.False(t, isIndexInvisible("YES"), "Should be case insensitive")
300+
301+
// Test other values default to visible
302+
require.False(t, isIndexInvisible(""), "Empty string should default to visible")
303+
require.False(t, isIndexInvisible("UNKNOWN"), "Unknown value should default to visible")
304+
}
305+
306+
func TestIndexVisibilityDefault(t *testing.T) {
307+
// Test that NewIndex creates visible indexes by default
308+
idx := NewIndex("test_index")
309+
require.True(t, idx.Visible)
310+
311+
// Test AddIndex creates visible indexes by default
312+
ta := &Table{Schema: "test", Name: "test_table"}
313+
addedIdx := ta.AddIndex("added_index")
314+
require.True(t, addedIdx.Visible)
315+
}
316+
317+
func (s *schemaTestSuite) TestVisibleFieldInSchema() {
318+
_, err := s.conn.Execute(`DROP TABLE IF EXISTS visible_field_test`)
319+
require.NoError(s.T(), err)
320+
321+
str := `
322+
CREATE TABLE IF NOT EXISTS visible_field_test (
323+
id INT,
324+
name VARCHAR(256),
325+
PRIMARY KEY(id),
326+
INDEX name_idx (name)
327+
) ENGINE = INNODB;
328+
`
329+
330+
_, err = s.conn.Execute(str)
331+
require.NoError(s.T(), err)
332+
333+
ta, err := NewTable(s.conn, *schema, "visible_field_test")
334+
require.NoError(s.T(), err)
335+
336+
// All indexes should be visible by default
337+
for _, idx := range ta.Indexes {
338+
require.True(s.T(), idx.Visible, "Index %s should be visible by default", idx.Name)
339+
}
340+
341+
// Test with SQL DB connection as well
342+
taSqlDb, err := NewTableFromSqlDB(s.sqlDB, *schema, "visible_field_test")
343+
require.NoError(s.T(), err)
344+
345+
for _, idx := range taSqlDb.Indexes {
346+
require.True(s.T(), idx.Visible, "Index %s should be visible by default (SQL DB)", idx.Name)
347+
}
348+
}

0 commit comments

Comments
 (0)