query results filtering and sorting (#14833)

* query results filtering and sorting (#14589)

* enable filter

* attach button style

* add hybrid data provider

* make filter and sort work

* fix editor switch issue

* configuration

* fix sort and filter

* add more specific selector

* fix hidden items issue

* update text

* revert text change

* fix copy results issue

* put feature behind preview flag

* comments

* fix tslint error
This commit is contained in:
Alan Ren
2021-03-23 11:30:41 -07:00
committed by GitHub
parent 5c67f3dbed
commit 6c54059f89
22 changed files with 554 additions and 132 deletions

View File

@@ -36,7 +36,7 @@ export interface IView {
readonly element: HTMLElement; readonly element: HTMLElement;
readonly minimumSize: number; readonly minimumSize: number;
readonly maximumSize: number; readonly maximumSize: number;
onDidInsert?(): void; onDidInsert?(): Promise<void>;
onDidRemove?(): void; onDidRemove?(): void;
} }
@@ -276,10 +276,10 @@ export class ScrollableView extends Disposable {
this.updateItemInDOM(item, index, false); this.updateItemInDOM(item, index, false);
item.onDidRemoveDisposable?.dispose(); item.onDidRemoveDisposable?.dispose();
item.onDidInsertDisposable = DOM.scheduleAtNextAnimationFrame(() => { item.onDidInsertDisposable = DOM.scheduleAtNextAnimationFrame(async () => {
// we don't trust the items to be performant so don't interrupt our operations // we don't trust the items to be performant so don't interrupt our operations
if (item.view.onDidInsert) { if (item.view.onDidInsert) {
item.view.onDidInsert(); await item.view.onDidInsert();
} }
item.view.layout(item.size, this.width); item.view.layout(item.size, this.width);
}); });

View File

@@ -3,8 +3,9 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { IDisposableDataProvider } from 'sql/base/browser/ui/table/interfaces'; import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
import { CancellationTokenSource } from 'vs/base/common/cancellation'; import { CancellationTokenSource } from 'vs/base/common/cancellation';
import { Emitter, Event } from 'vs/base/common/event';
export interface IObservableCollection<T> { export interface IObservableCollection<T> {
getLength(): number; getLength(): number;
@@ -201,8 +202,38 @@ export class VirtualizedCollection<T extends Slick.SlickData> implements IObserv
export class AsyncDataProvider<T extends Slick.SlickData> implements IDisposableDataProvider<T> { export class AsyncDataProvider<T extends Slick.SlickData> implements IDisposableDataProvider<T> {
private _onFilterStateChange = new Emitter<void>();
get onFilterStateChange(): Event<void> { return this._onFilterStateChange.event; }
private _onSortComplete = new Emitter<Slick.OnSortEventArgs<T>>();
get onSortComplete(): Event<Slick.OnSortEventArgs<T>> { return this._onSortComplete.event; }
constructor(public dataRows: IObservableCollection<T>) { } constructor(public dataRows: IObservableCollection<T>) { }
public get isDataInMemory(): boolean {
return false;
}
getRangeAsync(startIndex: number, length: number): Promise<T[]> {
throw new Error('Method not implemented.');
}
getFilteredColumnValues(column: Slick.Column<T>): Promise<string[]> {
throw new Error('Method not implemented.');
}
getColumnValues(column: Slick.Column<T>): Promise<string[]> {
throw new Error('Method not implemented.');
}
sort(options: Slick.OnSortEventArgs<T>): Promise<void> {
throw new Error('Method not implemented.');
}
filter(columns?: Slick.Column<T>[]): Promise<void> {
throw new Error('Method not implemented.');
}
public getLength(): number { public getLength(): number {
return this.dataRows.getLength(); return this.dataRows.getLength();
} }

View File

@@ -0,0 +1,139 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { AsyncDataProvider, IObservableCollection } from 'sql/base/browser/ui/table/asyncDataView';
import { FilterableColumn } from 'sql/base/browser/ui/table/interfaces';
import { CellValueGetter, TableDataView, TableFilterFunc, TableSortFunc } from 'sql/base/browser/ui/table/tableDataView';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
import { Event, Emitter } from 'vs/base/common/event';
import { DisposableStore } from 'vs/base/common/lifecycle';
export interface HybridDataProviderOptions {
inMemoryDataProcessing: boolean;
inMemoryDataCountThreshold?: number;
}
/**
* Used to abstract the underlying data provider, based on the options, if we are allowing in-memory data processing and the threshold is not reached the
* a TableDataView will be used to provide in memory data source, otherwise it will be using the async data provider.
*/
export class HybridDataProvider<T extends Slick.SlickData> implements IDisposableDataProvider<T> {
private _asyncDataProvider: AsyncDataProvider<T>;
private _tableDataProvider: TableDataView<T>;
private _dataCached: boolean = false;
private _disposableStore = new DisposableStore();
private _onFilterStateChange = new Emitter<void>();
get onFilterStateChange(): Event<void> { return this._onFilterStateChange.event; }
private _onSortComplete = new Emitter<Slick.OnSortEventArgs<T>>();
get onSortComplete(): Event<Slick.OnSortEventArgs<T>> { return this._onSortComplete.event; }
constructor(dataRows: IObservableCollection<T>,
private _loadDataFn: (offset: number, count: number) => Thenable<T[]>,
filterFn: TableFilterFunc<T>,
sortFn: TableSortFunc<T>,
valueGetter: CellValueGetter,
private readonly _options: HybridDataProviderOptions) {
this._asyncDataProvider = new AsyncDataProvider<T>(dataRows);
this._tableDataProvider = new TableDataView<T>(undefined, undefined, sortFn, filterFn, valueGetter);
this._disposableStore.add(this._asyncDataProvider.onFilterStateChange(() => {
this._onFilterStateChange.fire();
}));
this._disposableStore.add(this._asyncDataProvider.onSortComplete((args) => {
this._onSortComplete.fire(args);
}));
this._disposableStore.add(this._tableDataProvider.onFilterStateChange(() => {
this._onFilterStateChange.fire();
}));
this._disposableStore.add(this._tableDataProvider.onSortComplete((args) => {
this._onSortComplete.fire(args);
}));
this._disposableStore.add(this._asyncDataProvider);
this._disposableStore.add(this._tableDataProvider);
}
public get isDataInMemory(): boolean {
return this._dataCached;
}
async getRangeAsync(startIndex: number, length: number): Promise<T[]> {
return this.provider.getRangeAsync(startIndex, length);
}
public async getColumnValues(column: Slick.Column<T>): Promise<string[]> {
await this.initializeCacheIfNeeded();
return this.provider.getColumnValues(column);
}
public async getFilteredColumnValues(column: Slick.Column<T>): Promise<string[]> {
await this.initializeCacheIfNeeded();
return this.provider.getFilteredColumnValues(column);
}
public get dataRows(): IObservableCollection<T> {
return this._asyncDataProvider.dataRows;
}
public set dataRows(value: IObservableCollection<T>) {
this._asyncDataProvider.dataRows = value;
}
public dispose(): void {
this._disposableStore.dispose();
}
public getLength(): number {
return this.provider.getLength();
}
public getItem(index: number): T {
return this.provider.getItem(index);
}
public getItems(): T[] {
throw new Error('Method not implemented.');
}
public get length(): number {
return this.provider.getLength();
}
public set length(value: number) {
this._asyncDataProvider.length = value;
}
public async filter(columns: FilterableColumn<T>[]) {
await this.initializeCacheIfNeeded();
this.provider.filter(columns);
}
public async sort(options: Slick.OnSortEventArgs<T>) {
await this.initializeCacheIfNeeded();
this.provider.sort(options);
}
private get thresholdReached(): boolean {
return this._options.inMemoryDataCountThreshold !== undefined && this.length > this._options.inMemoryDataCountThreshold;
}
private get provider(): IDisposableDataProvider<T> {
return this._dataCached ? this._tableDataProvider : this._asyncDataProvider;
}
private async initializeCacheIfNeeded() {
if (!this._options.inMemoryDataProcessing) {
return;
}
if (this.thresholdReached) {
return;
}
if (!this._dataCached) {
const data = await this._loadDataFn(0, this.length);
this._dataCached = true;
this._tableDataProvider.push(data);
}
}
}

View File

@@ -3,13 +3,10 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
import { IListStyles } from 'vs/base/browser/ui/list/listWidget'; import { IListStyles } from 'vs/base/browser/ui/list/listWidget';
import { Color } from 'vs/base/common/color'; import { Color } from 'vs/base/common/color';
export interface IDisposableDataProvider<T> extends Slick.DataProvider<T> {
dispose(): void;
}
export interface ITableMouseEvent { export interface ITableMouseEvent {
anchor: HTMLElement | { x: number, y: number }; anchor: HTMLElement | { x: number, y: number };
cell?: { row: number, cell: number }; cell?: { row: number, cell: number };
@@ -32,4 +29,5 @@ export interface ITableConfiguration<T> {
export interface FilterableColumn<T> extends Slick.Column<T> { export interface FilterableColumn<T> extends Slick.Column<T> {
filterable?: boolean; filterable?: boolean;
filterValues?: Array<string>;
} }

View File

@@ -18,15 +18,15 @@
height: 100%; height: 100%;
} }
.slick-sort-indicator-asc { .monaco-table .slick-sort-indicator-asc {
background: url('sort-asc.gif'); background: url('sort-asc.gif');
} }
.slick-sort-indicator-desc { .monaco-table .slick-sort-indicator-desc {
background: url('sort-desc.gif'); background: url('sort-desc.gif');
} }
.slick-sort-indicator { .monaco-table .slick-sort-indicator {
display: inline-block; display: inline-block;
width: 8px; width: 8px;
height: 5px; height: 5px;
@@ -98,7 +98,6 @@
padding: 4px; padding: 4px;
white-space: nowrap; white-space: nowrap;
width: 200px; width: 200px;
display: grid;
align-content: flex-start; align-content: flex-start;
} }

View File

@@ -10,28 +10,20 @@ import { escape } from 'sql/base/common/strings';
import { addDisposableListener } from 'vs/base/browser/dom'; import { addDisposableListener } from 'vs/base/browser/dom';
import { DisposableStore } from 'vs/base/common/lifecycle'; import { DisposableStore } from 'vs/base/common/lifecycle';
import { withNullAsUndefined } from 'vs/base/common/types'; import { withNullAsUndefined } from 'vs/base/common/types';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
export interface IExtendedColumn<T> extends Slick.Column<T> { export type HeaderFilterCommands = 'sort-asc' | 'sort-desc';
filterValues?: Array<string>;
}
export interface CommandEventArgs<T extends Slick.SlickData> { export interface CommandEventArgs<T extends Slick.SlickData> {
grid: Slick.Grid<T>, grid: Slick.Grid<T>,
column: Slick.Column<T>, column: Slick.Column<T>,
command: string command: HeaderFilterCommands
}
export type CellValueGetter = (data: any) => string;
function GetCellValue(data: any): string {
return data?.toString();
} }
const ShowFilterText: string = localize('headerFilter.showFilter', "Show Filter"); const ShowFilterText: string = localize('headerFilter.showFilter', "Show Filter");
export class HeaderFilter<T extends Slick.SlickData> { export class HeaderFilter<T extends Slick.SlickData> {
public onFilterApplied = new Slick.Event<{ grid: Slick.Grid<T>, column: IExtendedColumn<T> }>(); public onFilterApplied = new Slick.Event<{ grid: Slick.Grid<T>, column: FilterableColumn<T> }>();
public onCommand = new Slick.Event<CommandEventArgs<T>>(); public onCommand = new Slick.Event<CommandEventArgs<T>>();
private grid!: Slick.Grid<T>; private grid!: Slick.Grid<T>;
@@ -42,12 +34,12 @@ export class HeaderFilter<T extends Slick.SlickData> {
private clearButton?: Button; private clearButton?: Button;
private cancelButton?: Button; private cancelButton?: Button;
private workingFilters!: Array<string>; private workingFilters!: Array<string>;
private columnDef!: IExtendedColumn<T>; private columnDef!: FilterableColumn<T>;
private buttonStyles?: IButtonStyles; private buttonStyles?: IButtonStyles;
private disposableStore = new DisposableStore(); private disposableStore = new DisposableStore();
public enabled: boolean = true;
constructor(private cellValueExtrator: CellValueGetter = GetCellValue) { constructor() {
} }
public init(grid: Slick.Grid<T>): void { public init(grid: Slick.Grid<T>): void {
@@ -92,7 +84,10 @@ export class HeaderFilter<T extends Slick.SlickData> {
} }
private handleHeaderCellRendered(e: Event, args: Slick.OnHeaderCellRenderedEventArgs<T>) { private handleHeaderCellRendered(e: Event, args: Slick.OnHeaderCellRenderedEventArgs<T>) {
const column = args.column; if (!this.enabled) {
return;
}
const column = args.column as FilterableColumn<T>;
if (column.id === '_detail_selector') { if (column.id === '_detail_selector') {
return; return;
} }
@@ -107,11 +102,12 @@ export class HeaderFilter<T extends Slick.SlickData> {
const $el = jQuery(`<button aria-label="${ShowFilterText}" title="${ShowFilterText}"></button>`) const $el = jQuery(`<button aria-label="${ShowFilterText}" title="${ShowFilterText}"></button>`)
.addClass('slick-header-menubutton') .addClass('slick-header-menubutton')
.data('column', column); .data('column', column);
this.setButtonImage($el, column.filterValues?.length > 0);
$el.click((e: JQuery.Event) => { $el.click(async (e: JQuery.Event) => {
e.stopPropagation(); e.stopPropagation();
e.preventDefault(); e.preventDefault();
this.showFilter($el[0]); await this.showFilter($el[0]);
}); });
$el.appendTo(args.node); $el.appendTo(args.node);
} }
@@ -122,11 +118,11 @@ export class HeaderFilter<T extends Slick.SlickData> {
.remove(); .remove();
} }
private addMenuItem(menu: JQuery<HTMLElement>, columnDef: Slick.Column<T>, title: string, command: string) { private addMenuItem(menu: JQuery<HTMLElement>, columnDef: Slick.Column<T>, title: string, command: HeaderFilterCommands) {
const $item = jQuery('<div class="slick-header-menuitem">') const $item = jQuery('<div class="slick-header-menuitem">')
.data('command', command) .data('command', command)
.data('column', columnDef) .data('column', columnDef)
.bind('click', (e) => this.handleMenuItemClick(e, command, columnDef)) .bind('click', async (e) => await this.handleMenuItemClick(e, command, columnDef))
.appendTo(menu); .appendTo(menu);
const $icon = jQuery('<div class="slick-header-menuicon">') const $icon = jQuery('<div class="slick-header-menuicon">')
@@ -154,7 +150,7 @@ export class HeaderFilter<T extends Slick.SlickData> {
.appendTo(menu); .appendTo(menu);
} }
private updateFilterInputs(menu: JQuery<HTMLElement>, columnDef: IExtendedColumn<T>, filterItems: Array<string>) { private updateFilterInputs(menu: JQuery<HTMLElement>, columnDef: FilterableColumn<T>, filterItems: Array<string>) {
let filterOptions = '<label><input type="checkbox" value="-1" />(Select All)</label>'; let filterOptions = '<label><input type="checkbox" value="-1" />(Select All)</label>';
columnDef.filterValues = columnDef.filterValues || []; columnDef.filterValues = columnDef.filterValues || [];
@@ -176,7 +172,7 @@ export class HeaderFilter<T extends Slick.SlickData> {
}); });
} }
private showFilter(element: HTMLElement) { private async showFilter(element: HTMLElement) {
const target = withNullAsUndefined(element); const target = withNullAsUndefined(element);
const $menuButton = jQuery(target); const $menuButton = jQuery(target);
this.columnDef = $menuButton.data('column'); this.columnDef = $menuButton.data('column');
@@ -188,13 +184,23 @@ export class HeaderFilter<T extends Slick.SlickData> {
let filterItems: Array<string>; let filterItems: Array<string>;
if (this.workingFilters.length === 0) { const provider = this.grid.getData() as IDisposableDataProvider<T>;
// Filter based all available values
filterItems = this.getFilterValues(this.grid.getData() as Slick.DataProvider<T>, this.columnDef); if (provider.getColumnValues) {
} if (this.workingFilters.length === 0) {
else { filterItems = await provider.getColumnValues(this.columnDef);
// Filter based on current dataView subset } else {
filterItems = this.getAllFilterValues((this.grid.getData() as Slick.DataProvider<T>).getItems(), this.columnDef); filterItems = await provider.getFilteredColumnValues(this.columnDef);
}
} else {
if (this.workingFilters.length === 0) {
// Filter based all available values
filterItems = this.getFilterValues(this.grid.getData() as Slick.DataProvider<T>, this.columnDef);
}
else {
// Filter based on current dataView subset
filterItems = this.getAllFilterValues((this.grid.getData() as Slick.DataProvider<T>).getItems(), this.columnDef);
}
} }
if (!this.$menu) { if (!this.$menu) {
@@ -203,8 +209,8 @@ export class HeaderFilter<T extends Slick.SlickData> {
this.$menu.empty(); this.$menu.empty();
this.addMenuItem(this.$menu, this.columnDef, 'Sort Ascending', 'sort-asc'); this.addMenuItem(this.$menu, this.columnDef, localize('table.sortAscending', "Sort Ascending"), 'sort-asc');
this.addMenuItem(this.$menu, this.columnDef, 'Sort Descending', 'sort-desc'); this.addMenuItem(this.$menu, this.columnDef, localize('table.sortDescending', "Sort Descending"), 'sort-desc');
this.addMenuInput(this.$menu, this.columnDef); this.addMenuInput(this.$menu, this.columnDef);
let filterOptions = '<label><input type="checkbox" value="-1" />(Select All)</label>'; let filterOptions = '<label><input type="checkbox" value="-1" />(Select All)</label>';
@@ -345,7 +351,14 @@ export class HeaderFilter<T extends Slick.SlickData> {
private handleApply(e: JQuery.Event<HTMLElement, null>, columnDef: Slick.Column<T>) { private handleApply(e: JQuery.Event<HTMLElement, null>, columnDef: Slick.Column<T>) {
this.hideMenu(); this.hideMenu();
const provider = this.grid.getData() as IDisposableDataProvider<T>;
if (provider.filter) {
provider.filter(this.grid.getColumns());
this.grid.invalidateAllRows();
this.grid.updateRowCount();
this.grid.render();
}
this.onFilterApplied.notify({ grid: this.grid, column: columnDef }, e, self); this.onFilterApplied.notify({ grid: this.grid, column: columnDef }, e, self);
e.preventDefault(); e.preventDefault();
e.stopPropagation(); e.stopPropagation();
@@ -356,7 +369,7 @@ export class HeaderFilter<T extends Slick.SlickData> {
dataView.getItems().forEach(items => { dataView.getItems().forEach(items => {
const value = items[column.field!]; const value = items[column.field!];
const valueArr = value instanceof Array ? value : [value]; const valueArr = value instanceof Array ? value : [value];
valueArr.forEach(v => seen.add(this.cellValueExtrator(v))); valueArr.forEach(v => seen.add(v));
}); });
return Array.from(seen); return Array.from(seen);
@@ -398,9 +411,21 @@ export class HeaderFilter<T extends Slick.SlickData> {
return Array.from(seen).sort((v) => { return v; }); return Array.from(seen).sort((v) => { return v; });
} }
private handleMenuItemClick(e: JQuery.Event<HTMLElement, null>, command: string, columnDef: Slick.Column<T>) { private async handleMenuItemClick(e: JQuery.Event<HTMLElement, null>, command: HeaderFilterCommands, columnDef: Slick.Column<T>) {
this.hideMenu(); this.hideMenu();
const provider = this.grid.getData() as IDisposableDataProvider<T>;
if (provider.sort && (command === 'sort-asc' || command === 'sort-desc')) {
await provider.sort({
grid: this.grid,
multiColumnSort: false,
sortCol: this.columnDef,
sortAsc: command === 'sort-asc'
});
this.grid.invalidateAllRows();
this.grid.updateRowCount();
this.grid.render();
}
this.onCommand.notify({ this.onCommand.notify({
grid: this.grid, grid: this.grid,
column: columnDef, column: columnDef,

View File

@@ -3,6 +3,8 @@
* Licensed under the Source EULA. See License.txt in the project root for license information. * Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/ *--------------------------------------------------------------------------------------------*/
import { FilterableColumn } from 'sql/base/browser/ui/table/interfaces';
export interface IRowNumberColumnOptions { export interface IRowNumberColumnOptions {
numberOfRows: number; numberOfRows: number;
cssClass?: string; cssClass?: string;
@@ -45,7 +47,7 @@ export class RowNumberColumn<T> implements Slick.Plugin<T> {
} }
} }
public getColumnDefinition(): Slick.Column<T> { public getColumnDefinition(): FilterableColumn<T> {
// that smallest we can make it is 22 due to padding and margins in the cells // that smallest we can make it is 22 due to padding and margins in the cells
return { return {
id: 'rowNumber', id: 'rowNumber',
@@ -56,6 +58,7 @@ export class RowNumberColumn<T> implements Slick.Plugin<T> {
cssClass: this.options.cssClass, cssClass: this.options.cssClass,
focusable: false, focusable: false,
selectable: false, selectable: false,
filterable: false,
formatter: r => this.formatter(r) formatter: r => this.formatter(r)
}; };
} }

View File

@@ -8,7 +8,7 @@ import 'vs/css!./media/slick.grid';
import 'vs/css!./media/slickColorTheme'; import 'vs/css!./media/slickColorTheme';
import { TableDataView } from './tableDataView'; import { TableDataView } from './tableDataView';
import { IDisposableDataProvider, ITableSorter, ITableMouseEvent, ITableConfiguration, ITableStyles } from 'sql/base/browser/ui/table/interfaces'; import { ITableSorter, ITableMouseEvent, ITableConfiguration, ITableStyles } from 'sql/base/browser/ui/table/interfaces';
import * as DOM from 'vs/base/browser/dom'; import * as DOM from 'vs/base/browser/dom';
import { mixin } from 'vs/base/common/objects'; import { mixin } from 'vs/base/common/objects';
@@ -19,6 +19,7 @@ import { isArray, isBoolean } from 'vs/base/common/types';
import { Event, Emitter } from 'vs/base/common/event'; import { Event, Emitter } from 'vs/base/common/event';
import { range } from 'vs/base/common/arrays'; import { range } from 'vs/base/common/arrays';
import { AsyncDataProvider } from 'sql/base/browser/ui/table/asyncDataView'; import { AsyncDataProvider } from 'sql/base/browser/ui/table/asyncDataView';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
function getDefaultOptions<T>(): Slick.GridOptions<T> { function getDefaultOptions<T>(): Slick.GridOptions<T> {
return <Slick.GridOptions<T>>{ return <Slick.GridOptions<T>>{
@@ -122,7 +123,7 @@ export class Table<T extends Slick.SlickData> extends Widget implements IDisposa
this._grid.onColumnsResized.subscribe(() => this._onColumnResize.fire()); this._grid.onColumnsResized.subscribe(() => this._onColumnResize.fire());
} }
public rerenderGrid(start: number, end: number) { public rerenderGrid() {
this._grid.updateRowCount(); this._grid.updateRowCount();
this._grid.setColumns(this._grid.getColumns()); this._grid.setColumns(this._grid.getColumns());
this._grid.invalidateAllRows(); this._grid.invalidateAllRows();

View File

@@ -7,40 +7,58 @@ import { Event, Emitter } from 'vs/base/common/event';
import * as types from 'vs/base/common/types'; import * as types from 'vs/base/common/types';
import { compare as stringCompare } from 'vs/base/common/strings'; import { compare as stringCompare } from 'vs/base/common/strings';
import { IDisposableDataProvider } from 'sql/base/browser/ui/table/interfaces'; import { FilterableColumn } from 'sql/base/browser/ui/table/interfaces';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
export interface IFindPosition { export interface IFindPosition {
col: number; col: number;
row: number; row: number;
} }
function defaultSort<T extends { [key: string]: any }>(args: Slick.OnSortEventArgs<T>, data: Array<T>): Array<T> { export type CellValueGetter = (data: any) => any;
export type TableFilterFunc<T extends Slick.SlickData> = (data: Array<T>, columns: Slick.Column<T>[]) => Array<T>;
export type TableSortFunc<T extends Slick.SlickData> = (args: Slick.OnSortEventArgs<T>, data: Array<T>) => Array<T>;
export type TableFindFunc<T extends Slick.SlickData> = (val: T, exp: string) => Array<number>;
function defaultCellValueGetter(data: any): any {
return data;
}
function defaultSort<T extends Slick.SlickData>(args: Slick.OnSortEventArgs<T>, data: Array<T>, cellValueGetter: CellValueGetter = defaultCellValueGetter): Array<T> {
if (!args.sortCol || !args.sortCol.field || data.length === 0) { if (!args.sortCol || !args.sortCol.field || data.length === 0) {
return data; return data;
} }
const field = args.sortCol.field; const field = args.sortCol.field;
const sign = args.sortAsc ? 1 : -1; const sign = args.sortAsc ? 1 : -1;
let sampleData = data[0][field];
sampleData = types.isObject(sampleData) ? cellValueGetter(sampleData) : sampleData;
let comparer: (a: T, b: T) => number; let comparer: (a: T, b: T) => number;
if (types.isString(data[0][field])) { if (!isNaN(Number(sampleData))) {
if (!isNaN(Number(data[0][field]))) { comparer = (a: T, b: T) => {
comparer = (a: T, b: T) => { let anum = Number(cellValueGetter(a[field]));
let anum = Number(a[field]); let bnum = Number(cellValueGetter(b[field]));
let bnum = Number(b[field]); return anum === bnum ? 0 : anum > bnum ? 1 : -1;
return anum === bnum ? 0 : anum > bnum ? 1 : -1; };
};
} else {
comparer = (a: T, b: T) => {
return stringCompare(a[field], b[field]);
};
}
} else { } else {
comparer = (a: T, b: T) => { comparer = (a: T, b: T) => {
return a[field] === b[field] ? 0 : (a[field] > b[field] ? 1 : -1); return stringCompare(cellValueGetter(a[field]), cellValueGetter(b[field]));
}; };
} }
return data.sort((a, b) => comparer(a, b) * sign); return data.sort((a, b) => comparer(a, b) * sign);
} }
function defaultFilter<T extends Slick.SlickData>(data: T[], columns: FilterableColumn<T>[], cellValueGetter: CellValueGetter = defaultCellValueGetter): T[] {
let filteredData = data;
columns?.forEach(column => {
if (column.filterValues?.length > 0 && column.field) {
filteredData = filteredData.filter((item) => {
return column.filterValues.includes(cellValueGetter(item[column.field!]));
});
}
});
return filteredData;
}
export class TableDataView<T extends Slick.SlickData> implements IDisposableDataProvider<T> { export class TableDataView<T extends Slick.SlickData> implements IDisposableDataProvider<T> {
//The data exposed publicly, when filter is enabled, _data holds the filtered data. //The data exposed publicly, when filter is enabled, _data holds the filtered data.
private _data: Array<T>; private _data: Array<T>;
@@ -49,6 +67,7 @@ export class TableDataView<T extends Slick.SlickData> implements IDisposableData
private _findArray?: Array<IFindPosition>; private _findArray?: Array<IFindPosition>;
private _findIndex?: number; private _findIndex?: number;
private _filterEnabled: boolean; private _filterEnabled: boolean;
private _currentColumnFilters: FilterableColumn<T>[];
private _onRowCountChange = new Emitter<number>(); private _onRowCountChange = new Emitter<number>();
get onRowCountChange(): Event<number> { return this._onRowCountChange.event; } get onRowCountChange(): Event<number> { return this._onRowCountChange.event; }
@@ -59,14 +78,15 @@ export class TableDataView<T extends Slick.SlickData> implements IDisposableData
private _onFilterStateChange = new Emitter<void>(); private _onFilterStateChange = new Emitter<void>();
get onFilterStateChange(): Event<void> { return this._onFilterStateChange.event; } get onFilterStateChange(): Event<void> { return this._onFilterStateChange.event; }
private _filterFn: (data: Array<T>) => Array<T>; private _onSortComplete = new Emitter<Slick.OnSortEventArgs<T>>();
private _sortFn: (args: Slick.OnSortEventArgs<T>, data: Array<T>) => Array<T>; get onSortComplete(): Event<Slick.OnSortEventArgs<T>> { return this._onSortComplete.event; }
constructor( constructor(
data?: Array<T>, data?: Array<T>,
private _findFn?: (val: T, exp: string) => Array<number>, private _findFn?: TableFindFunc<T>,
_sortFn?: (args: Slick.OnSortEventArgs<T>, data: Array<T>) => Array<T>, private _sortFn?: TableSortFunc<T>,
_filterFn?: (data: Array<T>) => Array<T> private _filterFn?: TableFilterFunc<T>,
private _cellValueGetter: CellValueGetter = defaultCellValueGetter
) { ) {
if (data) { if (data) {
this._data = data; this._data = data;
@@ -75,25 +95,59 @@ export class TableDataView<T extends Slick.SlickData> implements IDisposableData
} }
// @todo @anthonydresser 5/1/19 theres a lot we could do by just accepting a regex as a exp rather than accepting a full find function // @todo @anthonydresser 5/1/19 theres a lot we could do by just accepting a regex as a exp rather than accepting a full find function
this._sortFn = _sortFn ? _sortFn : defaultSort; this._sortFn = _sortFn ? _sortFn : (args, data) => {
return defaultSort(args, data, _cellValueGetter);
this._filterFn = _filterFn ? _filterFn : (dataToFilter) => dataToFilter; };
this._filterFn = _filterFn ? _filterFn : (data, columns) => {
return defaultFilter(data, columns, _cellValueGetter);
};
this._filterEnabled = false; this._filterEnabled = false;
this._cellValueGetter = this._cellValueGetter ? this._cellValueGetter : (cellValue) => cellValue?.toString();
}
public get isDataInMemory(): boolean {
return true;
}
async getRangeAsync(startIndex: number, length: number): Promise<T[]> {
return this._data.slice(startIndex, startIndex + length);
}
public async getFilteredColumnValues(column: Slick.Column<T>): Promise<string[]> {
return this.getDistinctColumnValues(this._data, column);
}
public async getColumnValues(column: Slick.Column<T>): Promise<string[]> {
return this.getDistinctColumnValues(this.filterEnabled ? this._allData : this._data, column);
}
private getDistinctColumnValues(source: T[], column: Slick.Column<T>): string[] {
const distinctValues: Set<string> = new Set();
source.forEach(items => {
const value = items[column.field!];
const valueArr = value instanceof Array ? value : [value];
valueArr.forEach(v => distinctValues.add(this._cellValueGetter(v)));
});
return Array.from(distinctValues);
} }
public get filterEnabled(): boolean { public get filterEnabled(): boolean {
return this._filterEnabled; return this._filterEnabled;
} }
public filter() { public async filter(columns?: Slick.Column<T>[]) {
if (!this.filterEnabled) { if (!this.filterEnabled) {
this._allData = new Array(...this._data); this._allData = new Array(...this._data);
this._data = this._filterFn(this._allData);
this._filterEnabled = true; this._filterEnabled = true;
} }
this._currentColumnFilters = columns;
this._data = this._filterFn(this._allData); this._data = this._filterFn(this._allData, columns);
this._onFilterStateChange.fire(); if (this._data.length === this._allData.length) {
this.clearFilter();
} else {
this._onFilterStateChange.fire();
}
} }
public clearFilter() { public clearFilter() {
@@ -105,8 +159,9 @@ export class TableDataView<T extends Slick.SlickData> implements IDisposableData
} }
} }
sort(args: Slick.OnSortEventArgs<T>) { async sort(args: Slick.OnSortEventArgs<T>): Promise<void> {
this._data = this._sortFn(args, this._data); this._data = this._sortFn(args, this._data);
this._onSortComplete.fire(args);
} }
getLength(): number { getLength(): number {
@@ -137,7 +192,7 @@ export class TableDataView<T extends Slick.SlickData> implements IDisposableData
if (this._filterEnabled) { if (this._filterEnabled) {
this._allData.push(...inputArray); this._allData.push(...inputArray);
let filteredArray = this._filterFn(inputArray); let filteredArray = this._filterFn(inputArray, this._currentColumnFilters);
if (filteredArray.length !== 0) { if (filteredArray.length !== 0) {
this._data.push(...filteredArray); this._data.push(...filteredArray);
} }

View File

@@ -0,0 +1,61 @@
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the Source EULA. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
import { Event } from 'vs/base/common/event';
/**
* Interface for table data providers
*/
export interface IDisposableDataProvider<T> extends Slick.DataProvider<T> {
/**
* Disposes the data provider object
*/
dispose(): void;
/**
* Gets the rows of the giving range
* @param startIndex Start index of the range
* @param length Length of the rows to retrieve
*/
getRangeAsync(startIndex: number, length: number): Promise<T[]>;
/**
* Gets unique values of all the cells in the given column
* @param column the column information
*/
getColumnValues(column: Slick.Column<T>): Promise<string[]>;
/**
* Gets the unique values of the filtered cells in the given column
* @param column
*/
getFilteredColumnValues(column: Slick.Column<T>): Promise<string[]>;
/**
* Filters the data
* @param columns columns to be filtered, the
*/
filter(columns?: Slick.Column<T>[]): Promise<void>;
/**
* Sorts the data
* @param args sort arguments
*/
sort(args: Slick.OnSortEventArgs<T>): Promise<void>;
/**
* Event fired when the filters changed
*/
readonly onFilterStateChange: Event<void>;
/**
* Event fired when the sorting is completed
*/
readonly onSortComplete: Event<Slick.OnSortEventArgs<T>>;
/**
* Gets a boolean value indicating whether the data is current in memory
*/
readonly isDataInMemory: boolean;
}

View File

@@ -33,7 +33,7 @@ class TestView extends Disposable implements IView {
private readonly _onDidInsertEmitter = this._register(new Emitter<void>()); private readonly _onDidInsertEmitter = this._register(new Emitter<void>());
public readonly onDidInsertEvent = this._onDidInsertEmitter.event; public readonly onDidInsertEvent = this._onDidInsertEmitter.event;
onDidInsert?(): void { async onDidInsert?(): Promise<void> {
this._onDidInsertEmitter.fire(); this._onDidInsertEmitter.fire();
} }

View File

@@ -19,7 +19,8 @@ export interface IQueryEditorConfiguration {
readonly streaming: boolean, readonly streaming: boolean,
readonly copyIncludeHeaders: boolean, readonly copyIncludeHeaders: boolean,
readonly copyRemoveNewLine: boolean, readonly copyRemoveNewLine: boolean,
readonly optimizedTable: boolean readonly optimizedTable: boolean,
readonly inMemoryDataProcessingThreshold: number
}, },
readonly messages: { readonly messages: {
readonly showBatchTime: boolean, readonly showBatchTime: boolean,

View File

@@ -16,6 +16,16 @@ export class GridPanelState {
} }
} }
export interface GridColumnFilter {
field: string;
filterValues: string[];
}
export interface GridSortState {
field: string;
sortAsc: boolean;
}
export class GridTableState extends Disposable { export class GridTableState extends Disposable {
private _maximized?: boolean; private _maximized?: boolean;
@@ -28,6 +38,9 @@ export class GridTableState extends Disposable {
private _canBeMaximized?: boolean; private _canBeMaximized?: boolean;
private _columnFilters: GridColumnFilter[] | undefined;
private _sortState: GridSortState | undefined;
/* The top row of the current scroll */ /* The top row of the current scroll */
public scrollPositionY = 0; public scrollPositionY = 0;
public scrollPositionX = 0; public scrollPositionX = 0;
@@ -62,4 +75,20 @@ export class GridTableState extends Disposable {
this._maximized = val; this._maximized = val;
this._onMaximizedChange.fire(val); this._onMaximizedChange.fire(val);
} }
public get columnFilters(): GridColumnFilter[] | undefined {
return this._columnFilters;
}
public set columnFilters(value: GridColumnFilter[] | undefined) {
this._columnFilters = value;
}
public get sortState(): GridSortState | undefined {
return this._sortState;
}
public set sortState(value: GridSortState | undefined) {
this._sortState = value;
}
} }

View File

@@ -981,7 +981,7 @@ export class EditDataGridPanel extends GridParentComponent {
|| (changes['blurredColumns'] && !equals(changes['blurredColumns'].currentValue, changes['blurredColumns'].previousValue)) || (changes['blurredColumns'] && !equals(changes['blurredColumns'].currentValue, changes['blurredColumns'].previousValue))
|| (changes['columnsLoading'] && !equals(changes['columnsLoading'].currentValue, changes['columnsLoading'].previousValue))) { || (changes['columnsLoading'] && !equals(changes['columnsLoading'].currentValue, changes['columnsLoading'].previousValue))) {
this.setCallbackOnDataRowsChanged(); this.setCallbackOnDataRowsChanged();
this.table.rerenderGrid(0, this.dataSet.dataRows.getLength()); this.table.rerenderGrid();
hasGridStructureChanges = true; hasGridStructureChanges = true;
} }

View File

@@ -27,7 +27,7 @@ import { ICellModel } from 'sql/workbench/services/notebook/browser/models/model
import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel'; import { MimeModel } from 'sql/workbench/services/notebook/browser/outputs/mimemodel';
import { GridTableState } from 'sql/workbench/common/editor/query/gridTableState'; import { GridTableState } from 'sql/workbench/common/editor/query/gridTableState';
import { GridTableBase } from 'sql/workbench/contrib/query/browser/gridPanel'; import { GridTableBase } from 'sql/workbench/contrib/query/browser/gridPanel';
import { getErrorMessage } from 'vs/base/common/errors'; import { getErrorMessage, onUnexpectedError } from 'vs/base/common/errors';
import { ISerializationService, SerializeDataParams } from 'sql/platform/serialization/common/serializationService'; import { ISerializationService, SerializeDataParams } from 'sql/platform/serialization/common/serializationService';
import { SaveResultAction, IGridActionContext } from 'sql/workbench/contrib/query/browser/actions'; import { SaveResultAction, IGridActionContext } from 'sql/workbench/contrib/query/browser/actions';
import { SaveFormat, ResultSerializer, SaveResultsResponse } from 'sql/workbench/services/query/common/resultSerializer'; import { SaveFormat, ResultSerializer, SaveResultsResponse } from 'sql/workbench/services/query/common/resultSerializer';
@@ -43,6 +43,7 @@ import { URI } from 'vs/base/common/uri';
import { assign } from 'vs/base/common/objects'; import { assign } from 'vs/base/common/objects';
import { QueryResultId } from 'sql/workbench/services/notebook/browser/models/cell'; import { QueryResultId } from 'sql/workbench/services/notebook/browser/models/cell';
import { equals } from 'vs/base/common/arrays'; import { equals } from 'vs/base/common/arrays';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
@Component({ @Component({
selector: GridOutputComponent.SELECTOR, selector: GridOutputComponent.SELECTOR,
template: `<div #output class="notebook-cellTable"></div>` template: `<div #output class="notebook-cellTable"></div>`
@@ -71,7 +72,7 @@ export class GridOutputComponent extends AngularDisposable implements IMimeCompo
@Input() set bundleOptions(value: MimeModel.IOptions) { @Input() set bundleOptions(value: MimeModel.IOptions) {
this._bundleOptions = value; this._bundleOptions = value;
if (this._initialized) { if (this._initialized) {
this.renderGrid(); this.renderGrid().catch(onUnexpectedError);
} }
} }
@@ -84,7 +85,7 @@ export class GridOutputComponent extends AngularDisposable implements IMimeCompo
@Input() set cellModel(value: ICellModel) { @Input() set cellModel(value: ICellModel) {
this._cellModel = value; this._cellModel = value;
if (this._initialized) { if (this._initialized) {
this.renderGrid(); this.renderGrid().catch(onUnexpectedError);
} }
} }
@@ -96,7 +97,7 @@ export class GridOutputComponent extends AngularDisposable implements IMimeCompo
this._cellOutput = value; this._cellOutput = value;
} }
ngOnInit() { async ngOnInit() {
if (this.cellModel) { if (this.cellModel) {
let outputId: QueryResultId = this.cellModel.getOutputId(this._cellOutput); let outputId: QueryResultId = this.cellModel.getOutputId(this._cellOutput);
if (outputId) { if (outputId) {
@@ -109,10 +110,10 @@ export class GridOutputComponent extends AngularDisposable implements IMimeCompo
} }
})); }));
} }
this.renderGrid(); await this.renderGrid();
} }
renderGrid(): void { async renderGrid(): Promise<void> {
if (!this._bundleOptions || !this._cellModel || !this.mimeType) { if (!this._bundleOptions || !this._cellModel || !this.mimeType) {
return; return;
} }
@@ -124,7 +125,7 @@ export class GridOutputComponent extends AngularDisposable implements IMimeCompo
let outputElement = <HTMLElement>this.output.nativeElement; let outputElement = <HTMLElement>this.output.nativeElement;
outputElement.appendChild(this._table.element); outputElement.appendChild(this._table.element);
this._register(attachTableStyler(this._table, this.themeService)); this._register(attachTableStyler(this._table, this.themeService));
this._table.onDidInsert(); await this._table.onDidInsert();
this.layout(); this.layout();
this._initialized = true; this._initialized = true;
} }
@@ -200,9 +201,13 @@ class DataResourceTable extends GridTableBase<any> {
@IEditorService editorService: IEditorService, @IEditorService editorService: IEditorService,
@IUntitledTextEditorService untitledEditorService: IUntitledTextEditorService, @IUntitledTextEditorService untitledEditorService: IUntitledTextEditorService,
@IConfigurationService configurationService: IConfigurationService, @IConfigurationService configurationService: IConfigurationService,
@IQueryModelService queryModelService: IQueryModelService @IQueryModelService queryModelService: IQueryModelService,
@IThemeService themeService: IThemeService
) { ) {
super(state, createResultSet(source), { actionOrientation: ActionsOrientation.HORIZONTAL }, contextMenuService, instantiationService, editorService, untitledEditorService, configurationService, queryModelService); super(state, createResultSet(source), {
actionOrientation: ActionsOrientation.HORIZONTAL,
inMemoryDataProcessing: true
}, contextMenuService, instantiationService, editorService, untitledEditorService, configurationService, queryModelService, themeService);
this._gridDataProvider = this.instantiationService.createInstance(DataResourceDataProvider, source, this.resultSet, this.cellModel); this._gridDataProvider = this.instantiationService.createInstance(DataResourceDataProvider, source, this.resultSet, this.cellModel);
this._chart = this.instantiationService.createInstance(ChartView, false); this._chart = this.instantiationService.createInstance(ChartView, false);
@@ -352,13 +357,13 @@ export class DataResourceDataProvider implements IGridDataProvider {
return Promise.resolve(resultSubset); return Promise.resolve(resultSubset);
} }
async copyResults(selection: Slick.Range[], includeHeaders?: boolean): Promise<void> { async copyResults(selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<void> {
return this.copyResultsAsync(selection, includeHeaders); return this.copyResultsAsync(selection, includeHeaders, tableView);
} }
private async copyResultsAsync(selection: Slick.Range[], includeHeaders?: boolean): Promise<void> { private async copyResultsAsync(selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<void> {
try { try {
let results = await getResultsString(this, selection, includeHeaders); let results = await getResultsString(this, selection, includeHeaders, tableView);
this._clipboardService.writeText(results); this._clipboardService.writeText(results);
} catch (error) { } catch (error) {
this._notificationService.error(localize('copyFailed', "Copy failed with error {0}", getErrorMessage(error))); this._notificationService.error(localize('copyFailed', "Copy failed with error {0}", getErrorMessage(error)));

View File

@@ -110,15 +110,10 @@ export class CopyResultAction extends Action {
super(id, label); super(id, label);
} }
public run(context: IGridActionContext): Promise<boolean> { public async run(context: IGridActionContext): Promise<boolean> {
if (this.accountForNumberColumn) { const selection = this.accountForNumberColumn ? mapForNumberColumn(context.selection) : context.selection;
context.gridDataProvider.copyResults( context.gridDataProvider.copyResults(selection, this.copyHeader, context.table.getData());
mapForNumberColumn(context.selection), return true;
this.copyHeader);
} else {
context.gridDataProvider.copyResults(context.selection, this.copyHeader);
}
return Promise.resolve(true);
} }
} }

View File

@@ -5,11 +5,11 @@
import 'vs/css!./media/gridPanel'; import 'vs/css!./media/gridPanel';
import { ITableStyles, ITableMouseEvent } from 'sql/base/browser/ui/table/interfaces'; import { ITableStyles, ITableMouseEvent, FilterableColumn } from 'sql/base/browser/ui/table/interfaces';
import { attachTableStyler } from 'sql/platform/theme/common/styler'; import { attachTableStyler } from 'sql/platform/theme/common/styler';
import QueryRunner, { QueryGridDataProvider } from 'sql/workbench/services/query/common/queryRunner'; import QueryRunner, { QueryGridDataProvider } from 'sql/workbench/services/query/common/queryRunner';
import { ResultSetSummary, IColumn } from 'sql/workbench/services/query/common/query'; import { ResultSetSummary, IColumn, ICellValue } from 'sql/workbench/services/query/common/query';
import { VirtualizedCollection, AsyncDataProvider } from 'sql/base/browser/ui/table/asyncDataView'; import { VirtualizedCollection } from 'sql/base/browser/ui/table/asyncDataView';
import { Table } from 'sql/base/browser/ui/table/table'; import { Table } from 'sql/base/browser/ui/table/table';
import { MouseWheelSupport } from 'sql/base/browser/ui/table/plugins/mousewheelTableScroll.plugin'; import { MouseWheelSupport } from 'sql/base/browser/ui/table/plugins/mousewheelTableScroll.plugin';
import { AutoColumnSize } from 'sql/base/browser/ui/table/plugins/autoSizeColumns.plugin'; import { AutoColumnSize } from 'sql/base/browser/ui/table/plugins/autoSizeColumns.plugin';
@@ -49,6 +49,9 @@ import { ScrollableView, IView } from 'sql/base/browser/ui/scrollableView/scroll
import { IQueryEditorConfiguration } from 'sql/platform/query/common/query'; import { IQueryEditorConfiguration } from 'sql/platform/query/common/query';
import { Orientation } from 'vs/base/browser/ui/splitview/splitview'; import { Orientation } from 'vs/base/browser/ui/splitview/splitview';
import { IQueryModelService } from 'sql/workbench/services/query/common/queryModel'; import { IQueryModelService } from 'sql/workbench/services/query/common/queryModel';
import { HeaderFilter } from 'sql/base/browser/ui/table/plugins/headerFilter.plugin';
import { attachButtonStyler } from 'vs/platform/theme/common/styler';
import { HybridDataProvider } from 'sql/base/browser/ui/table/hybridDataProvider';
const ROW_HEIGHT = 29; const ROW_HEIGHT = 29;
const HEADER_HEIGHT = 26; const HEADER_HEIGHT = 26;
@@ -322,6 +325,8 @@ export interface IDataSet {
export interface IGridTableOptions { export interface IGridTableOptions {
actionOrientation: ActionsOrientation; actionOrientation: ActionsOrientation;
inMemoryDataProcessing: boolean;
inMemoryDataCountThreshold?: number;
} }
export abstract class GridTableBase<T> extends Disposable implements IView { export abstract class GridTableBase<T> extends Disposable implements IView {
@@ -331,7 +336,8 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
private selectionModel = new CellSelectionModel<T>(); private selectionModel = new CellSelectionModel<T>();
private styles: ITableStyles; private styles: ITableStyles;
private currentHeight: number; private currentHeight: number;
private dataProvider: AsyncDataProvider<T>; private dataProvider: HybridDataProvider<T>;
private filterPlugin: HeaderFilter<T>;
private columns: Slick.Column<T>[]; private columns: Slick.Column<T>[];
@@ -369,13 +375,17 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
constructor( constructor(
state: GridTableState, state: GridTableState,
protected _resultSet: ResultSetSummary, protected _resultSet: ResultSetSummary,
private readonly options: IGridTableOptions = { actionOrientation: ActionsOrientation.VERTICAL }, private readonly options: IGridTableOptions = {
inMemoryDataProcessing: false,
actionOrientation: ActionsOrientation.VERTICAL
},
@IContextMenuService private readonly contextMenuService: IContextMenuService, @IContextMenuService private readonly contextMenuService: IContextMenuService,
@IInstantiationService protected readonly instantiationService: IInstantiationService, @IInstantiationService protected readonly instantiationService: IInstantiationService,
@IEditorService private readonly editorService: IEditorService, @IEditorService private readonly editorService: IEditorService,
@IUntitledTextEditorService private readonly untitledEditorService: IUntitledTextEditorService, @IUntitledTextEditorService private readonly untitledEditorService: IUntitledTextEditorService,
@IConfigurationService private readonly configurationService: IConfigurationService, @IConfigurationService private readonly configurationService: IConfigurationService,
@IQueryModelService private readonly queryModelService: IQueryModelService @IQueryModelService private readonly queryModelService: IQueryModelService,
@IThemeService private readonly themeService: IThemeService
) { ) {
super(); super();
let config = this.configurationService.getValue<{ rowHeight: number }>('resultsGrid'); let config = this.configurationService.getValue<{ rowHeight: number }>('resultsGrid');
@@ -405,7 +415,7 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
return this._resultSet; return this._resultSet;
} }
public onDidInsert() { public async onDidInsert() {
if (!this.table) { if (!this.table) {
this.build(); this.build();
} }
@@ -421,7 +431,7 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
}); });
this.dataProvider.dataRows = collection; this.dataProvider.dataRows = collection;
this.table.updateRowCount(); this.table.updateRowCount();
this.setupState(); await this.setupState();
} }
public onDidRemove() { public onDidRemove() {
@@ -476,7 +486,15 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
forceFitColumns: false, forceFitColumns: false,
defaultColumnWidth: 120 defaultColumnWidth: 120
}; };
this.dataProvider = new AsyncDataProvider(collection); this.dataProvider = new HybridDataProvider(collection,
(offset, count) => { return this.loadData(offset, count); },
undefined,
undefined,
(data: ICellValue) => { return data?.displayValue; },
{
inMemoryDataProcessing: this.options.inMemoryDataProcessing,
inMemoryDataCountThreshold: this.options.inMemoryDataCountThreshold
});
this.table = this._register(new Table(this.tableContainer, { dataProvider: this.dataProvider, columns: this.columns }, tableOptions)); this.table = this._register(new Table(this.tableContainer, { dataProvider: this.dataProvider, columns: this.columns }, tableOptions));
this.table.setTableTitle(localize('resultsGrid', "Results grid")); this.table.setTableTitle(localize('resultsGrid', "Results grid"));
this.table.setSelectionModel(this.selectionModel); this.table.setSelectionModel(this.selectionModel);
@@ -485,11 +503,33 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
this.table.registerPlugin(copyHandler); this.table.registerPlugin(copyHandler);
this.table.registerPlugin(this.rowNumberColumn); this.table.registerPlugin(this.rowNumberColumn);
this.table.registerPlugin(new AdditionalKeyBindings()); this.table.registerPlugin(new AdditionalKeyBindings());
this._register(this.dataProvider.onFilterStateChange(() => { this.layout(); }));
this._register(this.table.onContextMenu(this.contextMenu, this)); this._register(this.table.onContextMenu(this.contextMenu, this));
this._register(this.table.onClick(this.onTableClick, this)); this._register(this.table.onClick(this.onTableClick, this));
//This listener is used for correcting auto-scroling when clicking on the header for reszing. //This listener is used for correcting auto-scroling when clicking on the header for reszing.
this._register(this.table.onHeaderClick(this.onHeaderClick, this)); this._register(this.table.onHeaderClick(this.onHeaderClick, this));
this._register(this.dataProvider.onFilterStateChange(() => {
const columns = this.table.columns as FilterableColumn<T>[];
this.state.columnFilters = columns.filter((column) => column.filterValues?.length > 0).map(column => {
return {
filterValues: column.filterValues,
field: column.field
};
});
this.table.rerenderGrid();
}));
this._register(this.dataProvider.onSortComplete((args: Slick.OnSortEventArgs<T>) => {
this.state.sortState = {
field: args.sortCol.field,
sortAsc: args.sortAsc
};
this.table.rerenderGrid();
}));
if (this.configurationService.getValue<boolean>('workbench')['enablePreviewFeatures']) {
this.filterPlugin = new HeaderFilter();
attachButtonStyler(this.filterPlugin, this.themeService);
this.table.registerPlugin(this.filterPlugin);
}
if (this.styles) { if (this.styles) {
this.table.style(this.styles); this.table.style(this.styles);
} }
@@ -558,7 +598,7 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
} }
} }
private setupState() { private async setupState() {
// change actionbar on maximize change // change actionbar on maximize change
this._register(this.state.onMaximizedChange(this.rebuildActionBar, this)); this._register(this.state.onMaximizedChange(this.rebuildActionBar, this));
@@ -578,6 +618,25 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
if (savedSelection) { if (savedSelection) {
this.selectionModel.setSelectedRanges(savedSelection); this.selectionModel.setSelectedRanges(savedSelection);
} }
if (this.state.sortState) {
await this.dataProvider.sort({
multiColumnSort: false,
grid: this.table.grid,
sortAsc: this.state.sortState.sortAsc,
sortCol: this.columns.find((column) => column.field === this.state.sortState.field)
});
}
if (this.state.columnFilters) {
this.columns.forEach(column => {
const idx = this.state.columnFilters.findIndex(filter => filter.field === column.field);
if (idx !== -1) {
(<FilterableColumn<T>>column).filterValues = this.state.columnFilters[idx].filterValues;
}
});
await this.dataProvider.filter(this.columns);
}
} }
public get state(): GridTableState { public get state(): GridTableState {
@@ -627,6 +686,9 @@ export abstract class GridTableBase<T> extends Disposable implements IView {
public updateResult(resultSet: ResultSetSummary) { public updateResult(resultSet: ResultSetSummary) {
this._resultSet = resultSet; this._resultSet = resultSet;
if (this.table && this.visible) { if (this.table && this.visible) {
if (this.configurationService.getValue<boolean>('workbench')['enablePreviewFeatures'] && this.options.inMemoryDataProcessing && this.options.inMemoryDataCountThreshold < resultSet.rowCount) {
this.filterPlugin.enabled = false;
}
this.dataProvider.length = resultSet.rowCount; this.dataProvider.length = resultSet.rowCount;
this.table.updateRowCount(); this.table.updateRowCount();
} }
@@ -787,9 +849,14 @@ class GridTable<T> extends GridTableBase<T> {
@IEditorService editorService: IEditorService, @IEditorService editorService: IEditorService,
@IUntitledTextEditorService untitledEditorService: IUntitledTextEditorService, @IUntitledTextEditorService untitledEditorService: IUntitledTextEditorService,
@IConfigurationService configurationService: IConfigurationService, @IConfigurationService configurationService: IConfigurationService,
@IQueryModelService queryModelService: IQueryModelService @IQueryModelService queryModelService: IQueryModelService,
@IThemeService themeService: IThemeService
) { ) {
super(state, resultSet, undefined, contextMenuService, instantiationService, editorService, untitledEditorService, configurationService, queryModelService); super(state, resultSet, {
actionOrientation: ActionsOrientation.VERTICAL,
inMemoryDataProcessing: true,
inMemoryDataCountThreshold: configurationService.getValue<IQueryEditorConfiguration>('queryEditor').results.inMemoryDataProcessingThreshold,
}, contextMenuService, instantiationService, editorService, untitledEditorService, configurationService, queryModelService, themeService);
this._gridDataProvider = this.instantiationService.createInstance(QueryGridDataProvider, this._runner, resultSet.batchId, resultSet.id); this._gridDataProvider = this.instantiationService.createInstance(QueryGridDataProvider, this._runner, resultSet.batchId, resultSet.id);
} }

View File

@@ -391,6 +391,11 @@ const queryEditorConfiguration: IConfigurationNode = {
'description': localize('queryEditor.results.optimizedTable', "(Experimental) Use a optimized table in the results out. Some functionality might be missing and in the works."), 'description': localize('queryEditor.results.optimizedTable', "(Experimental) Use a optimized table in the results out. Some functionality might be missing and in the works."),
'default': false 'default': false
}, },
'queryEditor.results.inMemoryDataProcessingThreshold': {
'type': 'number',
'default': 2000,
'description': localize('queryEditor.inMemoryDataProcessingThreshold', "Controls the max number of rows allowed to do filtering and sorting in memory. If the number is exceeded, sorting and filtering will be disabled.")
},
'queryEditor.messages.showBatchTime': { 'queryEditor.messages.showBatchTime': {
'type': 'boolean', 'type': 'boolean',
'description': localize('queryEditor.messages.showBatchTime', "Should execution time be shown for individual batches"), 'description': localize('queryEditor.messages.showBatchTime', "Should execution time be shown for individual batches"),

View File

@@ -11,10 +11,10 @@ import { RowSelectionModel } from 'sql/base/browser/ui/table/plugins/rowSelectio
import { IWorkbenchThemeService } from 'vs/workbench/services/themes/common/workbenchThemeService'; import { IWorkbenchThemeService } from 'vs/workbench/services/themes/common/workbenchThemeService';
import { HyperlinkCellValue, isHyperlinkCellValue, TextCellValue } from 'sql/base/browser/ui/table/formatters'; import { HyperlinkCellValue, isHyperlinkCellValue, TextCellValue } from 'sql/base/browser/ui/table/formatters';
import { HeaderFilter, CommandEventArgs, IExtendedColumn } from 'sql/base/browser/ui/table/plugins/headerFilter.plugin'; import { HeaderFilter, CommandEventArgs } from 'sql/base/browser/ui/table/plugins/headerFilter.plugin';
import { Disposable } from 'vs/base/common/lifecycle'; import { Disposable } from 'vs/base/common/lifecycle';
import { TableDataView } from 'sql/base/browser/ui/table/tableDataView'; import { TableDataView } from 'sql/base/browser/ui/table/tableDataView';
import { ITableMouseEvent } from 'sql/base/browser/ui/table/interfaces'; import { FilterableColumn, ITableMouseEvent } from 'sql/base/browser/ui/table/interfaces';
import { IOpenerService } from 'vs/platform/opener/common/opener'; import { IOpenerService } from 'vs/platform/opener/common/opener';
import { isString } from 'vs/base/common/types'; import { isString } from 'vs/base/common/types';
import { ICommandService } from 'vs/platform/commands/common/commands'; import { ICommandService } from 'vs/platform/commands/common/commands';
@@ -127,7 +127,7 @@ export class ResourceViewerTable extends Disposable {
const columns = this._resourceViewerTable.grid.getColumns(); const columns = this._resourceViewerTable.grid.getColumns();
let value = true; let value = true;
for (let i = 0; i < columns.length; i++) { for (let i = 0; i < columns.length; i++) {
const col: IExtendedColumn<Slick.SlickData> = columns[i]; const col: FilterableColumn<Slick.SlickData> = columns[i];
if (!col.field) { if (!col.field) {
continue; continue;
} }

View File

@@ -17,7 +17,6 @@ import { Table } from 'sql/base/browser/ui/table/table';
import { CopyInsightDialogSelectionAction } from 'sql/workbench/services/insights/browser/insightDialogActions'; import { CopyInsightDialogSelectionAction } from 'sql/workbench/services/insights/browser/insightDialogActions';
import { ICapabilitiesService } from 'sql/platform/capabilities/common/capabilitiesService'; import { ICapabilitiesService } from 'sql/platform/capabilities/common/capabilitiesService';
import { IClipboardService } from 'sql/platform/clipboard/common/clipboardService'; import { IClipboardService } from 'sql/platform/clipboard/common/clipboardService';
import { IDisposableDataProvider } from 'sql/base/browser/ui/table/interfaces';
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation'; import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
import * as DOM from 'vs/base/browser/dom'; import * as DOM from 'vs/base/browser/dom';
@@ -50,6 +49,7 @@ import { Registry } from 'vs/platform/registry/common/platform';
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors'; import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors';
import { IInsightsConfigDetails } from 'sql/platform/extensions/common/extensions'; import { IInsightsConfigDetails } from 'sql/platform/extensions/common/extensions';
import { attachButtonStyler } from 'vs/platform/theme/common/styler'; import { attachButtonStyler } from 'vs/platform/theme/common/styler';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
const labelDisplay = nls.localize("insights.item", "Item"); const labelDisplay = nls.localize("insights.item", "Item");
const valueDisplay = nls.localize("insights.value", "Value"); const valueDisplay = nls.localize("insights.value", "Value");

View File

@@ -6,6 +6,7 @@
import * as types from 'vs/base/common/types'; import * as types from 'vs/base/common/types';
import { SaveFormat } from 'sql/workbench/services/query/common/resultSerializer'; import { SaveFormat } from 'sql/workbench/services/query/common/resultSerializer';
import { ResultSetSubset } from 'sql/workbench/services/query/common/query'; import { ResultSetSubset } from 'sql/workbench/services/query/common/query';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
export interface IGridDataProvider { export interface IGridDataProvider {
@@ -19,11 +20,10 @@ export interface IGridDataProvider {
/** /**
* Sends a copy request to copy data to the clipboard * Sends a copy request to copy data to the clipboard
* @param selection The selection range to copy * @param selection The selection range to copy
* @param batchId The batch id of the result to copy from
* @param resultId The result id of the result to copy from
* @param includeHeaders [Optional]: Should column headers be included in the copy selection * @param includeHeaders [Optional]: Should column headers be included in the copy selection
* @param tableView [Optional]: The data view associated with the table component
*/ */
copyResults(selection: Slick.Range[], includeHeaders?: boolean): Promise<void>; copyResults(selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<void>;
/** /**
* Gets the EOL terminator to use for this data type. * Gets the EOL terminator to use for this data type.
@@ -42,7 +42,7 @@ export interface IGridDataProvider {
} }
export async function getResultsString(provider: IGridDataProvider, selection: Slick.Range[], includeHeaders?: boolean): Promise<string> { export async function getResultsString(provider: IGridDataProvider, selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<string> {
let headers: Map<number, string> = new Map(); // Maps a column index -> header let headers: Map<number, string> = new Map(); // Maps a column index -> header
let rows: Map<number, Map<number, string>> = new Map(); // Maps row index -> column index -> actual row value let rows: Map<number, Map<number, string>> = new Map(); // Maps row index -> column index -> actual row value
const eol = provider.getEolString(); const eol = provider.getEolString();
@@ -52,8 +52,14 @@ export async function getResultsString(provider: IGridDataProvider, selection: S
return async (): Promise<void> => { return async (): Promise<void> => {
let startCol = range.fromCell; let startCol = range.fromCell;
let startRow = range.fromRow; let startRow = range.fromRow;
let result;
const result = await provider.getRowData(range.fromRow, range.toRow - range.fromRow + 1); if (tableView && tableView.isDataInMemory) {
// If the data is sorted/filtered in memory, we need to get the data that is currently being displayed
const tableData = await tableView.getRangeAsync(range.fromRow, range.toRow - range.fromRow + 1);
result = tableData.map(item => Object.keys(item).map(key => item[key]));
} else {
result = (await provider.getRowData(range.fromRow, range.toRow - range.fromRow + 1)).rows;
}
// If there was a previous selection separate it with a line break. Currently // If there was a previous selection separate it with a line break. Currently
// when there are multiple selections they are never on the same line // when there are multiple selections they are never on the same line
let columnHeaders = provider.getColumnHeaders(range); let columnHeaders = provider.getColumnHeaders(range);
@@ -65,8 +71,8 @@ export async function getResultsString(provider: IGridDataProvider, selection: S
} }
} }
// Iterate over the rows to paste into the copy string // Iterate over the rows to paste into the copy string
for (let rowIndex: number = 0; rowIndex < result.rows.length; rowIndex++) { for (let rowIndex: number = 0; rowIndex < result.length; rowIndex++) {
let row = result.rows[rowIndex]; let row = result[rowIndex];
let cellObjects = row.slice(range.fromCell, (range.toCell + 1)); let cellObjects = row.slice(range.fromCell, (range.toCell + 1));
// Remove newlines if requested // Remove newlines if requested
let cells = provider.shouldRemoveNewLines() let cells = provider.shouldRemoveNewLines()

View File

@@ -26,6 +26,7 @@ import { ILogService } from 'vs/platform/log/common/log';
import { IRange, Range } from 'vs/editor/common/core/range'; import { IRange, Range } from 'vs/editor/common/core/range';
import { BatchSummary, IQueryMessage, ResultSetSummary, QueryExecuteSubsetParams, CompleteBatchSummary, IResultMessage, ResultSetSubset, BatchStartSummary } from './query'; import { BatchSummary, IQueryMessage, ResultSetSummary, QueryExecuteSubsetParams, CompleteBatchSummary, IResultMessage, ResultSetSubset, BatchStartSummary } from './query';
import { IQueryEditorConfiguration } from 'sql/platform/query/common/query'; import { IQueryEditorConfiguration } from 'sql/platform/query/common/query';
import { IDisposableDataProvider } from 'sql/base/common/dataProvider';
/* /*
* Query Runner class which handles running a query, reports the results to the content manager, * Query Runner class which handles running a query, reports the results to the content manager,
@@ -501,18 +502,19 @@ export class QueryGridDataProvider implements IGridDataProvider {
return this.queryRunner.getQueryRows(rowStart, numberOfRows, this.batchId, this.resultSetId); return this.queryRunner.getQueryRows(rowStart, numberOfRows, this.batchId, this.resultSetId);
} }
copyResults(selection: Slick.Range[], includeHeaders?: boolean): Promise<void> { copyResults(selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<void> {
return this.copyResultsAsync(selection, includeHeaders); return this.copyResultsAsync(selection, includeHeaders, tableView);
} }
private async copyResultsAsync(selection: Slick.Range[], includeHeaders?: boolean): Promise<void> { private async copyResultsAsync(selection: Slick.Range[], includeHeaders?: boolean, tableView?: IDisposableDataProvider<Slick.SlickData>): Promise<void> {
try { try {
let results = await getResultsString(this, selection, includeHeaders); const results = await getResultsString(this, selection, includeHeaders, tableView);
await this._clipboardService.writeText(results); await this._clipboardService.writeText(results);
} catch (error) { } catch (error) {
this._notificationService.error(nls.localize('copyFailed', "Copy failed with error {0}", getErrorMessage(error))); this._notificationService.error(nls.localize('copyFailed', "Copy failed with error {0}", getErrorMessage(error)));
} }
} }
getEolString(): string { getEolString(): string {
return getEolString(this._textResourcePropertiesService, this.queryRunner.uri); return getEolString(this._textResourcePropertiesService, this.queryRunner.uri);
} }