IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

DataFrame: Add optional unique row id definition as frame.meta.uniqueRowIdFields (#80428)

Browse Source 
* Define an unique id for a row in dataframe

* Update comment

* Rename attribute

* Add comment about plugin sdk

* Fix comment
This commit is contained in:
Andrej Ocenas 2024-01-18 18:51:25 +01:00 committed by GitHub
parent 5800e40fba
commit 5b122a25b3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
packages/grafana-data/src/dataframe/index.ts
View File

@ -13,5 +13,6 @@ export {
isTimeSeriesFrame,
isTimeSeriesFrames,
isTimeSeriesField,
getRowUniqueId,
} from './utils';
export { StreamingDataFrame, StreamingFrameAction, type StreamingFrameOptions, closestIdx } from './StreamingDataFrame';

12
packages/grafana-data/src/dataframe/utils.ts
View File

@ -86,3 +86,15 @@ export function anySeriesWithTimeField(data: DataFrame[]) {
export function hasTimeField(data: DataFrame): boolean {
return data.fields.some((field) => field.type === FieldType.time);
}
/**
* Get row id based on the meta.uniqueRowIdFields attribute.
* @param dataFrame
* @param rowIndex
*/
export function getRowUniqueId(dataFrame: DataFrame, rowIndex: number) {
if (dataFrame.meta?.uniqueRowIdFields === undefined) {
return undefined;
}
return dataFrame.meta.uniqueRowIdFields.map((fieldIndex) => dataFrame.fields[fieldIndex].values[rowIndex]).join('-');
}

9
packages/grafana-data/src/types/data.ts
View File

@ -33,6 +33,7 @@ export const preferredVisualizationTypes = [
export type PreferredVisualisationType = (typeof preferredVisualizationTypes)[number];
/**
* Should be kept in sync with https://github.com/grafana/grafana-plugin-sdk-go/blob/main/data/frame_meta.go
* @public
*/
export interface QueryResultMeta {
@ -107,6 +108,14 @@ export interface QueryResultMeta {
limit?: number; // used by log models and loki
json?: boolean; // used to keep track of old json doc values
instant?: boolean;
/**
* Array of field indices which values create a unique id for each row. Ideally this should be globally unique ID
* but that isn't guarantied. Should help with keeping track and deduplicating rows in visualizations, especially
* with streaming data with frequent updates.
* Example: TraceID in Tempo, table name + primary key in SQL
*/
uniqueRowIdFields?: number[];
}
export interface QueryResultMetaStat extends FieldConfig {