feat: vector index parameters on Info tab

Author: astandrik

src/components/InfoViewer/formatters/schema.ts

@@ -13,5 +13,6 @@ export const formatTableIndexItem = createInfoFormatter<TIndexDescription>({
     labels: {
         KeyColumnNames: 'Columns',
         DataColumnNames: 'Includes',
+        DataSize: 'Data Size',
     },
 });

src/components/InfoViewer/schemaInfo/TableIndexInfo.tsx

@@ -1,16 +1,22 @@
 import type {InfoViewerItem} from '..';
 import {InfoViewer} from '..';
 import {getEntityName} from '../../../containers/Tenant/utils';
-import type {TEvDescribeSchemeResult, TIndexDescription} from '../../../types/api/schema';
+import type {TEvDescribeSchemeResult} from '../../../types/api/schema';
+import {formatNumber} from '../../../utils/dataFormatters/dataFormatters';
 import {formatTableIndexItem} from '../formatters';
+import {createInfoFormatter} from '../utils';
 
-const DISPLAYED_FIELDS: Set<keyof TIndexDescription> = new Set([
+import i18n from './i18n';
+
+const DISPLAYED_FIELDS_KEYS = [
     'Type',
     'State',
     'DataSize',
     'KeyColumnNames',
     'DataColumnNames',
-]);
+] as const;
+type DisplayedIndexField = (typeof DISPLAYED_FIELDS_KEYS)[number];
+const DISPLAYED_FIELDS = new Set<DisplayedIndexField>(DISPLAYED_FIELDS_KEYS);
 
 interface TableIndexInfoProps {
     data?: TEvDescribeSchemeResult;
@@ -26,12 +32,71 @@ export const TableIndexInfo = ({data}: TableIndexInfoProps) => {
     const TableIndex = data.PathDescription?.TableIndex;
     const info: Array<InfoViewerItem> = [];
 
-    let key: keyof TIndexDescription;
-    for (key in TableIndex) {
-        if (DISPLAYED_FIELDS.has(key)) {
-            info.push(formatTableIndexItem(key, TableIndex?.[key]));
+    if (TableIndex) {
+        DISPLAYED_FIELDS.forEach((key: DisplayedIndexField) => {
+            const value = TableIndex[key];
+            if (value !== undefined) {
+                info.push(formatTableIndexItem(key, value));
+            }
+        });
+    }
+
+    const vectorSettings = TableIndex?.VectorIndexKmeansTreeDescription?.Settings;
+
+    if (!vectorSettings) {
+        return <InfoViewer title={entityName} info={info} />;
+    }
+
+    const vectorFormatter = createInfoFormatter<{clusters?: number; levels?: number}>({
+        values: {
+            clusters: (v) => (typeof v === 'number' ? formatNumber(v) : v),
+            levels: (v) => (typeof v === 'number' ? formatNumber(v) : v),
+        },
+        labels: {
+            clusters: i18n('field_clusters'),
+            levels: i18n('field_levels'),
+        },
+    });
+
+    const vectorSettingsFormatter = createInfoFormatter<{
+        vector_dimension?: number;
+        vector_type?: string;
+        metric?: string;
+    }>({
+        values: {
+            vector_dimension: (v) => (typeof v === 'number' ? formatNumber(v) : v),
+        },
+        labels: {
+            vector_dimension: i18n('field_vector-dimension'),
+            vector_type: i18n('field_vector-type'),
+            metric: i18n('field_metric'),
+        },
+    });
+
+    const vectorInfo: Array<InfoViewerItem> = [];
+    if ('clusters' in vectorSettings) {
+        vectorInfo.push(vectorFormatter('clusters', vectorSettings.clusters));
+    }
+    if ('levels' in vectorSettings) {
+        vectorInfo.push(vectorFormatter('levels', vectorSettings.levels));
+    }
+    if (vectorSettings.settings) {
+        const settings = vectorSettings.settings;
+        if ('vector_dimension' in settings) {
+            vectorInfo.push(vectorSettingsFormatter('vector_dimension', settings.vector_dimension));
+        }
+        if ('vector_type' in settings) {
+            vectorInfo.push(vectorSettingsFormatter('vector_type', settings.vector_type));
+        }
+        if ('metric' in settings) {
+            vectorInfo.push(vectorSettingsFormatter('metric', settings.metric));
         }
     }
 
-    return <InfoViewer title={entityName} info={info} />;
+    return (
+        <>
+            <InfoViewer title={entityName} info={info} />
+            <InfoViewer title={i18n('title_vector-index')} info={vectorInfo} />
+        </>
+    );
 };

src/components/InfoViewer/schemaInfo/i18n/en.json

@@ -0,0 +1,8 @@
+{
+  "title_vector-index": "Vector Index",
+  "field_clusters": "Clusters",
+  "field_levels": "Levels",
+  "field_vector-dimension": "Vector Dimension",
+  "field_vector-type": "Vector Type",
+  "field_metric": "Metric"
+}

src/components/InfoViewer/schemaInfo/i18n/index.ts

@@ -0,0 +1,7 @@
+import {registerKeysets} from '../../../../utils/i18n';
+
+import en from './en.json';
+
+const COMPONENT = 'info-viewer-schema-index-info';
+
+export default registerKeysets(COMPONENT, {en});

src/types/api/schema/tableIndex.ts

@@ -19,12 +19,18 @@ export interface TIndexDescription {
     DataColumnNames?: string[];
     /** uint64 */
     DataSize?: string;
+
+    /**
+     * Present for vector indexes of type EIndexTypeGlobalVectorKmeansTree
+     */
+    VectorIndexKmeansTreeDescription?: TVectorIndexKmeansTreeDescription;
 }
 
 enum EIndexType {
     EIndexTypeInvalid = 'EIndexTypeInvalid',
     EIndexTypeGlobal = 'EIndexTypeGlobal',
     EIndexTypeGlobalAsync = 'EIndexTypeGlobalAsync',
+    EIndexTypeGlobalVectorKmeansTree = 'EIndexTypeGlobalVectorKmeansTree',
 }
 
 enum EIndexState {
@@ -33,3 +39,19 @@ enum EIndexState {
     EIndexStateNotReady = 'EIndexStateNotReady',
     EIndexStateWriteOnly = 'EIndexStateWriteOnly',
 }
+
+export interface TVectorIndexKmeansTreeDescriptionSettingsInner {
+    vector_dimension?: number;
+    vector_type?: string;
+    metric?: string;
+}
+
+export interface TVectorIndexKmeansTreeDescriptionSettings {
+    clusters?: number;
+    levels?: number;
+    settings?: TVectorIndexKmeansTreeDescriptionSettingsInner;
+}
+
+export interface TVectorIndexKmeansTreeDescription {
+    Settings?: TVectorIndexKmeansTreeDescriptionSettings;
+}