feat: display size of each index and paint a color bar behind it

Refs #1500

Author: ansgarbecker

source/dbconnection.pas

@@ -89,6 +89,7 @@   TTableKey = class(TPersistent)
     public
       Name, OldName: String;
       IndexType, OldIndexType, Algorithm, Comment: String;
+      Size: Int64;
       Columns, SubParts, Collations: TStringList;
       Modified, Added, Visible: Boolean;
       constructor Create(AOwner: TDBConnection);
@@ -110,6 +111,7 @@   TTableKey = class(TPersistent)
   TTableKeyList = class(TObjectList<TTableKey>)
     public
       procedure Assign(Source: TTableKeyList);
+      function MaxSize: Int64;
   end;
   TKeyCache = TDictionary<String,TTableKeyList>;
 
@@ -6174,6 +6176,7 @@ function TMySQLConnection.GetTableKeys(Table: TDBObject): TTableKeyList;
 var
   KeyQuery, ColQuery: TDBQuery;
   NewKey: TTableKey;
+  SizeQuery: String;
 begin
   Result := TTableKeyList.Create(True);
 
@@ -6252,7 +6255,20 @@ function TMySQLConnection.GetTableKeys(Table: TDBObject): TTableKeyList;
           NewKey.Visible := SameText(KeyQuery.Col('Visible'), 'yes')
         else if KeyQuery.ColumnExists('Ignored') then // mariadb 10.6
           NewKey.Visible := SameText(KeyQuery.Col('Ignored'), 'NO');
+
+        if FSqlProvider.Has(qIndexSize) then begin
+          try
+            SizeQuery := FSqlProvider.GetSql(qIndexSize, [
+              EscapeString(Table.Database),
+              EscapeString(Table.Name),
+              EscapeString(NewKey.Name)
+              ]);
+            NewKey.Size := StrToInt64Def(GetVar(SizeQuery), NewKey.Size);
+          except
+          end;
+        end;
       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)
         NewKey.Columns.Add('('+KeyQuery.Col('Expression')+')');
@@ -11092,6 +11108,7 @@ constructor TTableKey.Create(AOwner: TDBConnection);
   Subparts.OnChange := Modification;
   Collations.OnChange := Modification;
   Visible := True;
+  Size := -1
 end;
 
 destructor TTableKey.Destroy;
@@ -11115,6 +11132,7 @@ procedure TTableKey.Assign(Source: TPersistent);
     Algorithm := s.Algorithm;
     Comment := s.Comment;
     Visible := s.Visible;
+    Size := s.Size;
     Columns.Assign(s.Columns);
     SubParts.Assign(s.SubParts);
     Collations.Assign(s.Collations);
@@ -11264,6 +11282,15 @@ procedure TTableKeyList.Assign(Source: TTableKeyList);
   end;
 end;
 
+function TTableKeyList.MaxSize: Int64;
+var
+  Item: TTableKey;
+begin
+  Result := -1;
+  for Item in Self do begin
+    Result := Max(Result, Item.Size);
+  end;
+end;
 
 
 

source/dbstructures.mysql.pas

@@ -3428,6 +3428,13 @@ function TMySqlProvider.GetSql(AId: TQueryId): string;
       'CAST(%s AS CHAR)',
       ''
       );
+    qIndexSize: Result := IfThen(
+      (IsMySQL and (FServerVersion >= 50600)) or IsMariaDB,
+      'SELECT stat_value * @@innodb_page_size' +
+      ' FROM mysql.innodb_index_stats'+
+      ' WHERE database_name=%s AND table_name=%s AND index_name=%s AND stat_name=''size''',
+      ''
+      );
     else Result := inherited;
   end;
 end;

source/dbstructures.pas

@@ -52,7 +52,7 @@ interface
     qShowFunctionStatus, qShowProcedureStatus, qShowTriggers, qShowEvents, qShowCreateTrigger,
     qHelpKeyword, qShowWarnings, qGetEnumTypes,
     qDropUser, qCreateRole, qDropRole, qReloadPrivileges, qGrantRole, qRevokeRole, qSetDefaultRole,
-    qAutoInc, qIndexVisible, qIndexInvisible, qGetAuthPlugins, qCastAsText);
+    qAutoInc, qIndexVisible, qIndexInvisible, qGetAuthPlugins, qCastAsText, qIndexSize);
   TSqlProvider = class
     strict protected
       FNetType: TNetType;

source/table_editor.dfm

@@ -242,6 +242,7 @@ object frmTableEditor: TfrmTableEditor
         Margins.Top = 0
         Margins.Bottom = 0
         Align = alClient
+        Alignment = taRightJustify
         DefaultNodeHeight = 19
         DragMode = dmAutomatic
         EditDelay = 0
@@ -255,6 +256,7 @@ object frmTableEditor: TfrmTableEditor
         TreeOptions.MiscOptions = [toAcceptOLEDrop, toEditable, toFullRepaintOnResize, toGridExtensions, toInitOnSave, toToggleOnDblClick, toWheelPanning, toEditOnClick]
         TreeOptions.PaintOptions = [toHotTrack, toShowButtons, toShowDropmark, toShowRoot, toShowTreeLines, toShowVertGridLines, toThemeAware, toUseBlendedImages, toGhostedIfUnfocused, toFullVertGridLines, toUseExplorerTheme, toHideTreeLinesIfThemed]
         TreeOptions.SelectionOptions = [toExtendedFocus, toRightClickSelect]
+        OnBeforeCellPaint = treeIndexesBeforeCellPaint
         OnBeforePaint = treeIndexesBeforePaint
         OnClick = AnyTreeClick
         OnCreateEditor = treeIndexesCreateEditor
@@ -301,6 +303,12 @@ object frmTableEditor: TfrmTableEditor
           item
             Position = 5
             Text = 'Visibility'
+          end
+          item
+            Alignment = taRightJustify
+            Position = 6
+            Text = 'Size'
+            Width = 10
           end>
       end
       object tlbIndexes: TToolBar

source/table_editor.pas

@@ -117,6 +117,9 @@   TfrmTableEditor = class(TFrame)
     procedure listColumnsPaintText(Sender: TBaseVirtualTree; const TargetCanvas: TCanvas; Node: PVirtualNode;
 		  Column: TColumnIndex; TextType: TVSTTextType);
     procedure listColumnsCreateEditor(Sender: TBaseVirtualTree; Node: PVirtualNode; Column: TColumnIndex; out EditLink: IVTEditLink);
+    procedure treeIndexesBeforeCellPaint(Sender: TBaseVirtualTree;
+      TargetCanvas: TCanvas; Node: PVirtualNode; Column: TColumnIndex;
+      CellPaintMode: TVTCellPaintMode; CellRect: TRect; var ContentRect: TRect);
     procedure treeIndexesInitNode(Sender: TBaseVirtualTree; ParentNode, Node: PVirtualNode; var InitialStates: TVirtualNodeInitStates);
     procedure treeIndexesGetText(Sender: TBaseVirtualTree; Node: PVirtualNode; Column: TColumnIndex; TextType: TVSTTextType;
 		  var CellText: String);
@@ -243,6 +246,7 @@   TfrmTableEditor = class(TFrame)
     const IndexColNumComment = 3;
     const IndexColNumDirection = 4;
     const IndexColNumVisibility = 5;
+    const IndexColNumSize = 6;
     procedure ValidateColumnControls;
     procedure ValidateIndexControls;
     procedure MoveFocusedIndexPart(NewIdx: Cardinal);
@@ -1935,6 +1939,19 @@ procedure TfrmTableEditor.listColumnsCreateEditor(Sender: TBaseVirtualTree;
   end;
 end;
 
+procedure TfrmTableEditor.treeIndexesBeforeCellPaint(Sender: TBaseVirtualTree;
+  TargetCanvas: TCanvas; Node: PVirtualNode; Column: TColumnIndex;
+  CellPaintMode: TVTCellPaintMode; CellRect: TRect; var ContentRect: TRect);
+var
+  Key: TTableKey;
+begin
+  // Only paint bar in size column
+  if Column in [IndexColNumSize] then begin
+    Key := FKeys[Node.Index];
+    MainForm.PaintColorBar(Key.Size, FKeys.MaxSize, TargetCanvas, CellRect);
+  end;
+end;
+
 
 procedure TfrmTableEditor.editNumEditChange(Sender: TObject);
 var
@@ -2147,6 +2164,10 @@ procedure TfrmTableEditor.treeIndexesGetText(Sender: TBaseVirtualTree;
             DBObject.Connection.SqlProvider.GetSql(qIndexVisible),
             DBObject.Connection.SqlProvider.GetSql(qIndexInvisible)
           );
+        IndexColNumSize: if TblKey.Size >= 0 then
+            CellText := FormatByteNumber(TblKey.Size)
+          else
+            CellText := '';
       end;
     end;
     1: begin