feat: support invisible indexes on MySQL 8.0+ and ignored indexes on MariaDB 10.6+

Refs #1388

Author: ansgarbecker

source/dbconnection.pas

@@ -88,7 +88,7 @@   TTableKey = class(TPersistent)
       Name, OldName: String;
       IndexType, OldIndexType, Algorithm, Comment: String;
       Columns, SubParts, Collations: TStringList;
-      Modified, Added: Boolean;
+      Modified, Added, Visible: Boolean;
       constructor Create(AOwner: TDBConnection);
       destructor Destroy; override;
       procedure Assign(Source: TPersistent); override;
@@ -431,7 +431,8 @@   TDBLogItem = class(TObject)
     frCreateTrigger,
     frCreateEvent,
     frInvisibleColumns,
-    frCompressedColumns
+    frCompressedColumns,
+    frInvisibleIndexes
     );
 
   TDBConnection = class(TComponent)
@@ -6215,6 +6216,10 @@ function TMySQLConnection.GetTableKeys(Table: TDBObject): TTableKeyList;
         if ExecRegExpr('(BTREE|HASH)', KeyQuery.Col('Index_type')) then
           NewKey.Algorithm := KeyQuery.Col('Index_type');
         NewKey.Comment := KeyQuery.Col('Index_comment', True);
+        if KeyQuery.ColumnExists('Visible') then // mysql 8
+          NewKey.Visible := SameText(KeyQuery.Col('Visible'), 'yes')
+        else if KeyQuery.ColumnExists('Ignored') then // mariadb 10.6
+          NewKey.Visible := SameText(KeyQuery.Col('Ignored'), 'NO');
       end;
       if KeyQuery.ColumnExists('Expression') and (not KeyQuery.IsNull('Expression')) then begin
         // Functional key part: enclose expression within parentheses to distinguish them from columns (issue #1777)
@@ -6723,6 +6728,8 @@ function TDBConnection.Has(Item: TFeatureOrRequirement): Boolean;
         frCreateEvent: Result := ServerVersionInt >= 50100;
         frInvisibleColumns: Result := (FParameters.IsMariaDB and (ServerVersionInt >= 100303)) or
           (FParameters.IsMySQL(True) and (ServerVersionInt >= 80023));
+        frInvisibleIndexes: Result := (FParameters.IsMariaDB and (ServerVersionInt >= 100600)) or
+          (FParameters.IsMySQL(True) and (ServerVersionInt >= 80000));
         frCompressedColumns: Result := (FParameters.IsMariaDB and (ServerVersionInt >= 100301));
       end;
     else Result := False;
@@ -11002,6 +11009,7 @@ constructor TTableKey.Create(AOwner: TDBConnection);
   Columns.OnChange := Modification;
   Subparts.OnChange := Modification;
   Collations.OnChange := Modification;
+  Visible := True;
 end;
 
 destructor TTableKey.Destroy;
@@ -11024,6 +11032,7 @@ procedure TTableKey.Assign(Source: TPersistent);
     OldIndexType := s.OldIndexType;
     Algorithm := s.Algorithm;
     Comment := s.Comment;
+    Visible := s.Visible;
     Columns.Assign(s.Columns);
     SubParts.Assign(s.SubParts);
     Collations.Assign(s.Collations);
@@ -11141,6 +11150,14 @@ function TTableKey.SQLCode(TableName: String=''): String;
 
     if not Comment.IsEmpty then
       Result := Result + ' COMMENT ' + FConnection.EscapeString(Comment);
+
+    if FConnection.Has(frInvisibleIndexes) then begin
+      if FConnection.Parameters.IsMySQL(True) then
+        Result := Result + ' ' + IfThen(Visible, 'VISIBLE', 'INVISIBLE')
+      else
+        Result := Result + ' ' + IfThen(Visible, 'NOT IGNORED', 'IGNORED');
+    end;
+
   end
   else begin
     // SQLite syntax:

source/table_editor.dfm

@@ -41,22 +41,22 @@ object frmTableEditor: TfrmTableEditor
       object lblName: TLabel
         Left = 4
         Top = 6
-        Width = 31
-        Height = 13
+        Width = 35
+        Height = 15
         Caption = 'Name:'
       end
       object lblComment: TLabel
         Left = 4
         Top = 33
-        Width = 49
-        Height = 13
+        Width = 57
+        Height = 15
         Caption = 'Comment:'
       end
       object editName: TEdit
         Left = 96
         Top = 3
         Width = 589
-        Height = 21
+        Height = 23
         Anchors = [akLeft, akTop, akRight]
         TabOrder = 0
         Text = 'editName'
@@ -112,7 +112,7 @@ object frmTableEditor: TfrmTableEditor
       object lblMaxRows: TLabel
         Left = 4
         Top = 52
-        Width = 115
+        Width = 114
         Height = 15
         Caption = 'Maximum row count:'
       end
@@ -133,7 +133,7 @@ object frmTableEditor: TfrmTableEditor
       object lblInsertMethod: TLabel
         Left = 358
         Top = 98
-        Width = 84
+        Width = 85
         Height = 15
         Caption = 'INSERT method:'
       end
@@ -275,7 +275,7 @@ object frmTableEditor: TfrmTableEditor
             Options = [coEnabled, coParentBidiMode, coParentColor, coResizable, coShowDropMark, coVisible, coAllowFocus]
             Position = 0
             Text = 'Name'
-            Width = 226
+            Width = 176
           end
           item
             Options = [coEnabled, coParentBidiMode, coParentColor, coResizable, coShowDropMark, coVisible, coAllowFocus]
@@ -297,6 +297,10 @@ object frmTableEditor: TfrmTableEditor
             Position = 4
             Text = 'Direction'
             Width = 80
+          end
+          item
+            Position = 5
+            Text = 'Visibility'
           end>
       end
       object tlbIndexes: TToolBar
@@ -512,8 +516,10 @@ object frmTableEditor: TfrmTableEditor
             Caption = 'Table'
           end>
         ColumnClick = False
+        HotTrack = True
         ReadOnly = True
         RowSelect = True
+        SmallImages = MainForm.VirtualImageListMain
         TabOrder = 2
         ViewStyle = vsReport
         Visible = False

source/table_editor.pas

@@ -236,6 +236,13 @@   TfrmTableEditor = class(TFrame)
     const ColNumInvisible = 13;
     const ColNumCompressed = 14;
     const ColNumsCheckboxes = [ColNumUnsigned, ColNumAllownull, ColNumZerofill, ColNumInvisible, ColNumCompressed];
+    // Columns in index tree
+    const IndexColNumName = 0;
+    const IndexColNumType = 1;
+    const IndexColNumAlgorithm = 2;
+    const IndexColNumComment = 3;
+    const IndexColNumDirection = 4;
+    const IndexColNumVisibility = 5;
     procedure ValidateColumnControls;
     procedure ValidateIndexControls;
     procedure MoveFocusedIndexPart(NewIdx: Cardinal);
@@ -2079,8 +2086,10 @@ procedure TfrmTableEditor.treeIndexesGetImageIndex(Sender: TBaseVirtualTree;
 begin
   // Icon image showing type of index
   VT := Sender as TVirtualStringTree;
-  if Column <> 0 then Exit;
-  if not (Kind in [ikNormal, ikSelected]) then Exit;
+  if Column <> IndexColNumName then
+    Exit;
+  if not (Kind in [ikNormal, ikSelected]) then
+    Exit;
   case VT.GetNodeLevel(Node) of
     0: ImageIndex := FKeys[Node.Index].ImageIndex;
     1: begin
@@ -2105,27 +2114,29 @@ procedure TfrmTableEditor.treeIndexesGetText(Sender: TBaseVirtualTree;
     0: begin
       TblKey := FKeys[Node.Index];
       case Column of
-        0: if TblKey.IsPrimary then
+        IndexColNumName: if TblKey.IsPrimary then
              CellText := TblKey.IndexType + ' KEY' // Fixed name "PRIMARY KEY", cannot be changed
            else
              CellText := TblKey.Name;
-        1: CellText := TblKey.IndexType;
-        2: CellText := TblKey.Algorithm;
-        3: CellText := TblKey.Comment;
-        4: CellText := ''; // Column collation
+        IndexColNumType: CellText := TblKey.IndexType;
+        IndexColNumAlgorithm: CellText := TblKey.Algorithm;
+        IndexColNumComment: CellText := TblKey.Comment;
+        IndexColNumDirection: CellText := ''; // Column collation
+        IndexColNumVisibility: CellText := IfThen(TblKey.Visible, 'Visible', 'Invisible');
       end;
     end;
     1: begin
       TblKey := FKeys[Node.Parent.Index];
       case Column of
-        0: CellText := TblKey.Columns[Node.Index];
-        1: CellText := TblKey.SubParts[Node.Index];
-        2: CellText := ''; // Index algorithm
-        3: CellText := ''; // Index comment
-        4: begin
+        IndexColNumName: CellText := TblKey.Columns[Node.Index];
+        IndexColNumType: CellText := TblKey.SubParts[Node.Index];
+        IndexColNumAlgorithm: CellText := ''; // Index algorithm
+        IndexColNumComment: CellText := ''; // Index comment
+        IndexColNumDirection: begin
           CellText := TblKey.Collations[Node.Index];
           CellText := IfThen(CellText.ToLower = 'a', 'ASC', 'DESC');
         end;
+        IndexColNumVisibility: CellText := '';
       end;
     end;
   end;
@@ -2344,13 +2355,17 @@ procedure TfrmTableEditor.treeIndexesEditing(Sender: TBaseVirtualTree;
   Allowed := False;
   if VT.GetNodeLevel(Node) = 0 then begin
     // Disallow renaming primary key, and direction/collation of key node level
-    if (Column = 0) and (VT.Text[Node, 1] <> TTableKey.PRIMARY) then
-      Allowed := True
-    else
-      Allowed := Column in [1,2,3];
-  end else case Column of
-    0: Allowed := True;
-    1: begin
+    case Column of
+      IndexColNumName: Allowed := (VT.Text[Node, 1] <> TTableKey.PRIMARY);
+      IndexColNumType: Allowed := True;
+      IndexColNumAlgorithm: Allowed := True;
+      IndexColNumComment: Allowed := True;
+      IndexColNumVisibility: Allowed := DBObject.Connection.Has(frInvisibleIndexes);
+    end;
+  end
+  else case Column of
+    IndexColNumName: Allowed := True;
+    IndexColNumType: begin
       // Column length is allowed for (var)char/text types only, even mandantory for text and blobs
       IndexedColName := VT.Text[Node, 0];
       for i:=0 to FColumns.Count-1 do begin
@@ -2360,7 +2375,7 @@ procedure TfrmTableEditor.treeIndexesEditing(Sender: TBaseVirtualTree;
         end;
       end;
     end;
-    4: Allowed := True; // Collation
+    IndexColNumDirection: Allowed := True; // Collation
   end;
 end;
 
@@ -2377,18 +2392,23 @@ procedure TfrmTableEditor.treeIndexesCreateEditor(Sender: TBaseVirtualTree;
   // Start cell editor
   VT := Sender as TVirtualStringTree;
   Level := (Sender as TVirtualStringtree).GetNodeLevel(Node);
-  if (Level = 0) and (Column = 1) then begin
+  if (Level = 0) and (Column = IndexColNumType) then begin
     // Index type pulldown
     EnumEditor := TEnumEditorLink.Create(VT, True, nil);
     EnumEditor.ValueList := TStringList.Create;
     EnumEditor.ValueList.CommaText := TTableKey.PRIMARY +','+ TTableKey.KEY +','+ TTableKey.UNIQUE +','+ TTableKey.FULLTEXT +','+ TTableKey.SPATIAL;
     EditLink := EnumEditor;
-  end else if (Level = 0) and (Column = 2) then begin
+  end else if (Level = 0) and (Column = IndexColNumAlgorithm) then begin
     // Algorithm pulldown
     EnumEditor := TEnumEditorLink.Create(VT, True, nil);
     EnumEditor.ValueList := Explode(',', ',BTREE,HASH,RTREE');
     EditLink := EnumEditor;
-  end else if (Level = 1) and (Column = 0) then begin
+  end else if (Level = 0) and (Column = IndexColNumVisibility) then begin
+    // Visibility pulldown
+    EnumEditor := TEnumEditorLink.Create(VT, True, nil);
+    EnumEditor.ValueList := Explode(',', 'Visible,Invisible');
+    EditLink := EnumEditor;
+  end else if (Level = 1) and (Column = IndexColNumName) then begin
     // Column names pulldown
     EnumEditor := TEnumEditorLink.Create(VT, True, nil);
     ColNode := listColumns.GetFirst;
@@ -2399,7 +2419,7 @@ procedure TfrmTableEditor.treeIndexesCreateEditor(Sender: TBaseVirtualTree;
     end;
     EnumEditor.AllowCustomText := True; // Allows adding a subpart in index parts: "TextCol(20)"
     EditLink := EnumEditor;
-  end else if (Level = 1) and (Column = 4) then begin
+  end else if (Level = 1) and (Column = IndexColNumDirection) then begin
     EnumEditor := TEnumEditorLink.Create(VT, True, nil);
     EnumEditor.ValueList := Explode(',', ',ASC,DESC');
     EditLink := EnumEditor;
@@ -2421,22 +2441,23 @@ procedure TfrmTableEditor.treeIndexesNewText(Sender: TBaseVirtualTree;
     0: begin
        TblKey := FKeys[Node.Index];
        case Column of
-         0: TblKey.Name := NewText;
-         1: begin
+         IndexColNumName: TblKey.Name := NewText;
+         IndexColNumType: begin
              TblKey.IndexType := NewText;
              if NewText = TTableKey.PRIMARY then
                TblKey.Name := TTableKey.PRIMARY;
            end;
-         2: TblKey.Algorithm := NewText;
-         3: TblKey.Comment := NewText;
+         IndexColNumAlgorithm: TblKey.Algorithm := NewText;
+         IndexColNumComment: TblKey.Comment := NewText;
+         IndexColNumVisibility: TblKey.Visible := SameText(NewText, 'Visible');
        end;
        // Needs to be called manually for Name and IndexType properties:
        TblKey.Modification(Sender);
     end;
     1: begin
        TblKey := FKeys[Node.Parent.Index];
        case Column of
-         0: begin
+         IndexColNumName: begin
            // Detect input of "col(123)" and move "123" into subpart
            rx := TRegExpr.Create;
            rx.Expression := '.+\((\d+)\)';
@@ -2446,8 +2467,8 @@ procedure TfrmTableEditor.treeIndexesNewText(Sender: TBaseVirtualTree;
            end else
              TblKey.Columns[Node.Index] := NewText;
          end;
-         1: TblKey.SubParts[Node.Index] := NewText;
-         4: begin
+         IndexColNumType: TblKey.SubParts[Node.Index] := NewText;
+         IndexColNumDirection: begin
            if NewText.ToLower = 'asc' then
              TblKey.Collations[Node.Index] := 'A'
            else