WIP version of table/column stats process & supporting aggregate changes

This commit is contained in:
2023-02-27 10:34:07 -06:00
parent c812dea8ea
commit 968397bcc9
3 changed files with 259 additions and 84 deletions

View File

@ -0,0 +1,121 @@
/*
* QQQ - Low-code Application Framework for Engineers.
* Copyright (C) 2021-2023. Kingsrook, LLC
* 651 N Broad St Ste 205 # 6917 | Middletown DE 19709 | United States
* contact@kingsrook.com
* https://github.com/Kingsrook/
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {QFieldMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QFieldMetaData";
import {QTableMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QTableMetaData";
import {QJobComplete} from "@kingsrook/qqq-frontend-core/lib/model/processes/QJobComplete";
import {QJobError} from "@kingsrook/qqq-frontend-core/lib/model/processes/QJobError";
import {QRecord} from "@kingsrook/qqq-frontend-core/lib/model/QRecord";
import Box from "@mui/material/Box";
import Typography from "@mui/material/Typography";
import {DataGridPro} from "@mui/x-data-grid-pro";
import {columnsStateInitializer} from "@mui/x-data-grid/internals";
import React, {useEffect, useState} from "react";
import DataGridUtils from "qqq/utils/DataGridUtils";
import Client from "qqq/utils/qqq/Client";
interface Props
{
tableMetaData: QTableMetaData;
fieldMetaData: QFieldMetaData;
closeModalHandler?: (event: object, reason: string) => void;
}
ColumnStats.defaultProps = {
closeModalHandler: null,
};
const qController = Client.getInstance();
function ColumnStats({tableMetaData, fieldMetaData, closeModalHandler}: Props): JSX.Element
{
const [statusString, setStatusString] = useState("Calculating statistics...");
const [isLoaded, setIsLoaded] = useState(false);
const [valueCounts, setValueCounts] = useState(null as QRecord[]);
const [countDistinct, setCountDistinct] = useState(null as number);
const [rows, setRows] = useState([]);
const [columns, setColumns] = useState([]);
useEffect(() =>
{
(async () =>
{
const processResult = await qController.processRun("tableStats", `tableName=${tableMetaData.name}&fieldName=${fieldMetaData.name}`);
setStatusString(null)
if (processResult instanceof QJobError)
{
const jobError = processResult as QJobError;
// todo setErrorAlert();
console.error("Error fetching column stats" + jobError.error);
}
else
{
const result = processResult as QJobComplete;
setCountDistinct(result.values.countDistinct);
const valueCounts = [] as QRecord[];
result.values.valueCounts.forEach((object: any) =>
{
valueCounts.push(new QRecord(object));
})
setValueCounts(valueCounts);
const fakeTableMetaData = new QTableMetaData({primaryKeyField: "value", fields: {value: fieldMetaData, count: {label: "Count", type: "INTEGER"}}});
const {rows, columnsToRender} = DataGridUtils.makeRows(valueCounts, fakeTableMetaData);
const columns = DataGridUtils.setupGridColumns(fakeTableMetaData, columnsToRender);
setRows(rows);
setColumns(columns);
setIsLoaded(true);
}
})();
}, []);
return (
<Box>
<Box p={3} display="flex" flexDirection="row" justifyContent="space-between" alignItems="flex-start">
<Typography variant="h5" pb={3}>
Column Statistics for {tableMetaData.label} : {fieldMetaData.label}
<Typography fontSize={14}>
{statusString}
</Typography>
</Typography>
</Box>
{
isLoaded && <>
<Box sx={{overflow: "auto", height: "calc( 100vh - 19rem )", position: "relative"}} px={3}>
<b>Distinct Values: </b> {countDistinct.toLocaleString()}
<DataGridPro
autoHeight
rows={rows}
disableSelectionOnClick
columns={columns}
rowBuffer={10}
getRowClassName={(params) => (params.indexRelativeToCurrentPage % 2 === 0 ? "even" : "odd")}
/>
</Box>
</>
}
</Box>);
}
export default ColumnStats;

View File

@ -49,10 +49,11 @@ import FormData from "form-data";
import React, {forwardRef, useContext, useEffect, useReducer, useRef, useState} from "react"; import React, {forwardRef, useContext, useEffect, useReducer, useRef, useState} from "react";
import {useLocation, useNavigate, useSearchParams} from "react-router-dom"; import {useLocation, useNavigate, useSearchParams} from "react-router-dom";
import QContext from "QContext"; import QContext from "QContext";
import {QActionsMenuButton, QCreateNewButton} from "qqq/components/buttons/DefaultButtons"; import {QActionsMenuButton, QCancelButton, QCreateNewButton} from "qqq/components/buttons/DefaultButtons";
import SavedFilters from "qqq/components/misc/SavedFilters"; import SavedFilters from "qqq/components/misc/SavedFilters";
import BaseLayout from "qqq/layouts/BaseLayout"; import BaseLayout from "qqq/layouts/BaseLayout";
import ProcessRun from "qqq/pages/processes/ProcessRun"; import ProcessRun from "qqq/pages/processes/ProcessRun";
import ColumnStats from "qqq/pages/records/query/ColumnStats";
import DataGridUtils from "qqq/utils/DataGridUtils"; import DataGridUtils from "qqq/utils/DataGridUtils";
import Client from "qqq/utils/qqq/Client"; import Client from "qqq/utils/qqq/Client";
import FilterUtils from "qqq/utils/qqq/FilterUtils"; import FilterUtils from "qqq/utils/qqq/FilterUtils";
@ -167,6 +168,7 @@ function RecordQuery({table, launchProcess}: Props): JSX.Element
const [activeModalProcess, setActiveModalProcess] = useState(null as QProcessMetaData); const [activeModalProcess, setActiveModalProcess] = useState(null as QProcessMetaData);
const [launchingProcess, setLaunchingProcess] = useState(launchProcess); const [launchingProcess, setLaunchingProcess] = useState(launchProcess);
const [recordIdsForProcess, setRecordIdsForProcess] = useState(null as string | QQueryFilter); const [recordIdsForProcess, setRecordIdsForProcess] = useState(null as string | QQueryFilter);
const [columnStatsFieldName, setColumnStatsFieldName] = useState(null as string)
const instance = useRef({timer: null}); const instance = useRef({timer: null});
@ -779,6 +781,16 @@ function RecordQuery({table, launchProcess}: Props): JSX.Element
closeActionsMenu(); closeActionsMenu();
}; };
const closeColumnStats = (event: object, reason: string) =>
{
if (reason === "backdropClick" || reason === "escapeKeyDown")
{
return;
}
setColumnStatsFieldName(null);
};
const closeModalProcess = (event: object, reason: string) => const closeModalProcess = (event: object, reason: string) =>
{ {
if (reason === "backdropClick" || reason === "escapeKeyDown") if (reason === "backdropClick" || reason === "escapeKeyDown")
@ -981,6 +993,11 @@ function RecordQuery({table, launchProcess}: Props): JSX.Element
} }
} }
const openColumnStatistics = async (column: GridColDef) =>
{
setColumnStatsFieldName(column.field);
}
const CustomColumnMenu = forwardRef<HTMLUListElement, GridColumnMenuProps>( const CustomColumnMenu = forwardRef<HTMLUListElement, GridColumnMenuProps>(
function GridColumnMenu(props: GridColumnMenuProps, ref) function GridColumnMenu(props: GridColumnMenuProps, ref)
{ {
@ -1023,6 +1040,14 @@ function RecordQuery({table, launchProcess}: Props): JSX.Element
*/} */}
</MenuItem> </MenuItem>
<MenuItem onClick={(e) =>
{
hideMenu(e);
openColumnStatistics(currentColumn);
}}>
Column statistics
</MenuItem>
</GridColumnMenuContainer> </GridColumnMenuContainer>
); );
}); });
@ -1358,6 +1383,24 @@ function RecordQuery({table, launchProcess}: Props): JSX.Element
</div> </div>
</Modal> </Modal>
} }
{
columnStatsFieldName &&
<Modal open={columnStatsFieldName !== null} onClose={(event, reason) => closeColumnStats(event, reason)}>
<div className="columnStatsModal">
<Box sx={{position: "absolute", overflowY: "auto", maxHeight: "100%", width: "100%"}}>
<Card sx={{my: 5, mx: "auto", pb: 0, maxWidth: "1024px"}}>
<Box component="div">
<ColumnStats tableMetaData={tableMetaData} fieldMetaData={tableMetaData?.fields.get(columnStatsFieldName)} closeModalHandler={closeColumnStats} />
<Box p={3} display="flex" flexDirection="row" justifyContent="flex-end">
<QCancelButton label="Close" onClickHandler={() => closeColumnStats(null, null)} disabled={false} />
</Box>
</Box>
</Card>
</Box>
</div>
</Modal>
}
</div> </div>
</BaseLayout> </BaseLayout>
); );

View File

@ -20,6 +20,7 @@
*/ */
import {AdornmentType} from "@kingsrook/qqq-frontend-core/lib/model/metaData/AdornmentType"; import {AdornmentType} from "@kingsrook/qqq-frontend-core/lib/model/metaData/AdornmentType";
import {QFieldMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QFieldMetaData";
import {QFieldType} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QFieldType"; import {QFieldType} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QFieldType";
import {QTableMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QTableMetaData"; import {QTableMetaData} from "@kingsrook/qqq-frontend-core/lib/model/metaData/QTableMetaData";
import {QRecord} from "@kingsrook/qqq-frontend-core/lib/model/QRecord"; import {QRecord} from "@kingsrook/qqq-frontend-core/lib/model/QRecord";
@ -101,7 +102,31 @@ export default class DataGridUtils
sortedKeys.forEach((key) => sortedKeys.forEach((key) =>
{ {
const field = tableMetaData.fields.get(key); const field = tableMetaData.fields.get(key);
const column = this.makeColumnFromField(field, tableMetaData, columnsToRender);
if (key === tableMetaData.primaryKeyField && linkBase)
{
columns.splice(0, 0, column);
column.renderCell = (cellValues: any) => (
<Link to={`${linkBase}${cellValues.value}`}>{cellValues.value}</Link>
);
}
else
{
columns.push(column);
}
});
return (columns);
};
/*******************************************************************************
**
*******************************************************************************/
public static makeColumnFromField = (field: QFieldMetaData, tableMetaData: QTableMetaData, columnsToRender: any): GridColDef =>
{
let columnType = "string"; let columnType = "string";
let columnWidth = 200; let columnWidth = 200;
let filterOperators: GridFilterOperator<any>[] = QGridStringOperators; let filterOperators: GridFilterOperator<any>[] = QGridStringOperators;
@ -119,7 +144,7 @@ export default class DataGridUtils
columnType = "number"; columnType = "number";
columnWidth = 100; columnWidth = 100;
if (key === tableMetaData.primaryKeyField && field.label.length < 3) if (field.name === tableMetaData.primaryKeyField && field.label.length < 3)
{ {
columnWidth = 75; columnWidth = 75;
} }
@ -185,21 +210,7 @@ export default class DataGridUtils
); );
} }
if (key === tableMetaData.primaryKeyField && linkBase) return (column);
{
columns.splice(0, 0, column);
column.renderCell = (cellValues: any) => (
<Link to={`${linkBase}${cellValues.value}`}>{cellValues.value}</Link>
);
} }
else
{
columns.push(column);
}
});
return (columns);
};
} }