@@ -661,12 +661,7 @@ declare module 'azdata' {
661
661
type ?: ExtensionNodeType ;
662
662
}
663
663
664
- export interface AccountKey {
665
- /**
666
- * Auth Library used to add the account
667
- */
668
- authLibrary ?: string ;
669
- }
664
+ export interface Component extends vscode . Disposable { }
670
665
671
666
export namespace workspace {
672
667
/**
@@ -694,6 +689,25 @@ declare module 'azdata' {
694
689
headerFilter ?: boolean ,
695
690
}
696
691
692
+ export type ExecutionPlanData = executionPlan . ExecutionPlanGraphInfo | executionPlan . ExecutionPlanGraph [ ] ;
693
+
694
+ export interface ExecutionPlanComponentProperties extends ComponentProperties {
695
+ /**
696
+ * Provide the execution plan file to be displayed. In case of execution plan graph info, the file type will determine the provider to be used to generate execution plan graphs
697
+ */
698
+ data ?: ExecutionPlanData ;
699
+ }
700
+
701
+ /**
702
+ * Defines the executionPlan component
703
+ */
704
+ export interface ExecutionPlanComponent extends Component , ExecutionPlanComponentProperties {
705
+ }
706
+
707
+ export interface ModelBuilder {
708
+ executionPlan ( ) : ComponentBuilder < ExecutionPlanComponent , ExecutionPlanComponentProperties > ;
709
+ }
710
+
697
711
export interface ListViewOption {
698
712
/**
699
713
* The optional accessibility label for the column. Default is the label for the list view option.
@@ -853,18 +867,14 @@ declare module 'azdata' {
853
867
* Whether to include the column headers.
854
868
*/
855
869
includeHeaders : boolean
856
- /**
857
- * Whether to remove line breaks from the cell value.
858
- */
859
- removeNewLines : boolean ;
860
870
/**
861
871
* The selected ranges to be copied.
862
872
*/
863
873
selections : SelectionRange [ ] ;
864
874
}
865
875
866
876
export interface CopyResultsRequestResult {
867
- /**
877
+ /**
868
878
* Result string from copy operation
869
879
*/
870
880
results : string ;
@@ -886,12 +896,19 @@ declare module 'azdata' {
886
896
887
897
export enum DataProviderType {
888
898
TableDesignerProvider = 'TableDesignerProvider' ,
889
- ExecutionPlanProvider = 'ExecutionPlanProvider'
899
+ ExecutionPlanProvider = 'ExecutionPlanProvider' ,
900
+ ServerContextualizationProvider = 'ServerContextualizationProvider'
890
901
}
891
902
892
903
export namespace dataprotocol {
893
904
export function registerTableDesignerProvider ( provider : designers . TableDesignerProvider ) : vscode . Disposable ;
894
905
export function registerExecutionPlanProvider ( provider : executionPlan . ExecutionPlanProvider ) : vscode . Disposable ;
906
+ /**
907
+ * Registers a server contextualization provider, which can provide context about a server to extensions like GitHub
908
+ * Copilot for improved suggestions.
909
+ * @param provider The provider to register
910
+ */
911
+ export function registerServerContextualizationProvider ( provider : contextualization . ServerContextualizationProvider ) : vscode . Disposable ;
895
912
}
896
913
897
914
export namespace designers {
@@ -900,8 +917,9 @@ declare module 'azdata' {
900
917
* @param providerId The table designer provider Id.
901
918
* @param tableInfo The table information. The object will be passed back to the table designer provider as the unique identifier for the table.
902
919
* @param telemetryInfo Optional Key-value pair containing any extra information that needs to be sent via telemetry
920
+ * @param objectExplorerContext Optional The context used to refresh Object Explorer after the table is created or edited
903
921
*/
904
- export function openTableDesigner ( providerId : string , tableInfo : TableInfo , telemetryInfo ?: { [ key : string ] : string } ) : Thenable < void > ;
922
+ export function openTableDesigner ( providerId : string , tableInfo : TableInfo , telemetryInfo ?: { [ key : string ] : string } , objectExplorerContext ?: ObjectExplorerContext ) : Thenable < void > ;
905
923
906
924
/**
907
925
* Definition for the table designer provider.
@@ -1771,6 +1789,23 @@ declare module 'azdata' {
1771
1789
}
1772
1790
}
1773
1791
1792
+ export namespace contextualization {
1793
+ export interface GetServerContextualizationResult {
1794
+ /**
1795
+ * The retrieved server context.
1796
+ */
1797
+ context : string | undefined ;
1798
+ }
1799
+
1800
+ export interface ServerContextualizationProvider extends DataProvider {
1801
+ /**
1802
+ * Gets server context, which can be in the form of create scripts but is left up each provider.
1803
+ * @param ownerUri The URI of the connection to get context for.
1804
+ */
1805
+ getServerContextualization ( ownerUri : string ) : Thenable < GetServerContextualizationResult > ;
1806
+ }
1807
+ }
1808
+
1774
1809
/**
1775
1810
* Component to display text with an icon representing the severity
1776
1811
*/
@@ -1824,14 +1859,21 @@ declare module 'azdata' {
1824
1859
/**
1825
1860
* Corresponds to the aria-live accessibility attribute for this component
1826
1861
*/
1827
- ariaLive ?: AriaLiveValue
1862
+ ariaLive ?: AriaLiveValue ;
1828
1863
}
1829
1864
1830
1865
export interface ContainerProperties extends ComponentProperties {
1831
1866
/**
1832
1867
* Corresponds to the aria-live accessibility attribute for this component
1833
1868
*/
1834
- ariaLive ?: AriaLiveValue
1869
+ ariaLive ?: AriaLiveValue ;
1870
+ }
1871
+
1872
+ export interface DropDownProperties {
1873
+ /**
1874
+ * Whether or not an option in the list must be selected or a "new" option can be set. Only applicable when 'editable' is true. Default false.
1875
+ */
1876
+ strictSelection ?: boolean ;
1835
1877
}
1836
1878
1837
1879
export interface NodeInfo {
@@ -1926,16 +1968,24 @@ declare module 'azdata' {
1926
1968
NotBetween = 7 ,
1927
1969
Contains = 8 ,
1928
1970
NotContains = 9 ,
1929
- IsNull = 10 ,
1930
- IsNotNull = 11
1971
+ StartsWith = 10 ,
1972
+ NotStartsWith = 11 ,
1973
+ EndsWith = 12 ,
1974
+ NotEndsWith = 13
1931
1975
}
1932
1976
1977
+ export interface ModelView extends vscode . Disposable { }
1978
+
1979
+ export interface DeclarativeTableMenuCellValue extends vscode . Disposable { }
1980
+
1933
1981
export namespace window {
1934
- export interface Wizard extends LoadingComponentBase {
1935
- }
1982
+ export interface Wizard extends LoadingComponentBase { }
1936
1983
1937
- export interface Dialog extends LoadingComponentBase {
1938
- }
1984
+ export interface Dialog extends LoadingComponentBase , vscode . Disposable { }
1985
+
1986
+ export interface ModelViewPanel extends vscode . Disposable { }
1987
+
1988
+ export interface ModelViewDashboard extends vscode . Disposable { }
1939
1989
1940
1990
/**
1941
1991
* Opens the error dialog with customization options provided.
@@ -2000,6 +2050,32 @@ declare module 'azdata' {
2000
2050
*/
2001
2051
isPrimary : boolean ;
2002
2052
}
2053
+
2054
+ export interface FileFilters {
2055
+ /**
2056
+ * The label to display in the file filter field next to the list of filters.
2057
+ */
2058
+ label : string ;
2059
+ /**
2060
+ * The filters to limit what files are visible in the file browser (e.g. '*.sql' for SQL files).
2061
+ */
2062
+ filters : string [ ] ;
2063
+ }
2064
+
2065
+ /**
2066
+ * Opens a dialog to select a file path on the specified server's machine. Note: The dialog for just browsing local
2067
+ * files without any connection is opened via vscode.window.showOpenDialog.
2068
+ * @param connectionUri The URI of the connection to the target server
2069
+ * @param targetPath The file path on the server machine to open by default in the dialog
2070
+ * @param fileFilters The filters used to limit which files are displayed in the file browser
2071
+ * @param showFoldersOnly Optional argument to specify whether the browser should only show folders
2072
+ * @returns The path of the file chosen from the dialog, and undefined if the dialog is closed without selecting anything.
2073
+ */
2074
+ export function openServerFileBrowserDialog ( connectionUri : string , targetPath : string , fileFilters : FileFilters [ ] , showFoldersOnly ?: boolean ) : Thenable < string | undefined > ;
2075
+ }
2076
+
2077
+ export interface FileBrowserProvider extends DataProvider {
2078
+ openFileBrowser ( ownerUri : string , expandPath : string , fileFilters : string [ ] , changeFilter : boolean , showFoldersOnly ?: boolean ) : Thenable < boolean > ;
2003
2079
}
2004
2080
2005
2081
export interface TableComponent {
@@ -2008,4 +2084,21 @@ declare module 'azdata' {
2008
2084
*/
2009
2085
setActiveCell ( row : number , column : number ) : void ;
2010
2086
}
2087
+
2088
+ export interface ProfilerProvider {
2089
+ startSession ( sessionId : string , sessionName : string , sessionType ?: ProfilingSessionType ) : Thenable < boolean > ;
2090
+ }
2091
+
2092
+ export enum ProfilingSessionType {
2093
+ RemoteSession = 0 ,
2094
+ LocalFile = 1
2095
+ }
2096
+
2097
+ export interface SplitViewLayout extends FlexLayout {
2098
+ /**
2099
+ * SplitView size. Height if the orientation is vertical, width if the orientation is horizontal
2100
+ * If undefined, the size of the model view container is used
2101
+ */
2102
+ splitViewSize ?: number | string | undefined ;
2103
+ }
2011
2104
}
0 commit comments