-
Notifications
You must be signed in to change notification settings - Fork 899
/
azdata.d.ts
6664 lines (5791 loc) · 186 KB
/
azdata.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for license information.
*--------------------------------------------------------------------------------------------*/
declare module 'azdata' {
import * as vscode from 'vscode';
/**
* The version of the application.
*/
export const version: string;
export namespace env {
/**
* Well-known app quality values
*/
export enum AppQuality {
stable = 'stable',
insider = 'insider',
dev = 'dev'
}
/**
* The version of Azure Data Studio this is currently running as - such as `stable`, or `insider`
*/
export const quality: AppQuality | string | undefined;
}
// EXPORTED NAMESPACES /////////////////////////////////////////////////
/**
* Namespace for Data Management Protocol global methods
*/
export namespace dataprotocol {
export function registerConnectionProvider(provider: ConnectionProvider): vscode.Disposable;
export function registerBackupProvider(provider: BackupProvider): vscode.Disposable;
export function registerRestoreProvider(provider: RestoreProvider): vscode.Disposable;
export function registerScriptingProvider(provider: ScriptingProvider): vscode.Disposable;
export function registerObjectExplorerProvider(provider: ObjectExplorerProvider): vscode.Disposable;
export function registerObjectExplorerNodeProvider(provider: ObjectExplorerNodeProvider): vscode.Disposable;
export function registerIconProvider(provider: IconProvider): vscode.Disposable;
export function registerTaskServicesProvider(provider: TaskServicesProvider): vscode.Disposable;
export function registerFileBrowserProvider(provider: FileBrowserProvider): vscode.Disposable;
export function registerProfilerProvider(provider: ProfilerProvider): vscode.Disposable;
export function registerMetadataProvider(provider: MetadataProvider): vscode.Disposable;
export function registerQueryProvider(provider: QueryProvider, isLiveShare?: boolean): vscode.Disposable;
export function registerAdminServicesProvider(provider: AdminServicesProvider): vscode.Disposable;
export function registerAgentServicesProvider(provider: AgentServicesProvider): vscode.Disposable;
export function registerCapabilitiesServiceProvider(provider: CapabilitiesProvider): vscode.Disposable;
/**
* Get the provider corresponding to the given provider ID and type
* @param providerId The ID that the provider was registered with
* @param providerType The type of the provider
*/
export function getProvider<T extends DataProvider>(providerId: string, providerType: DataProviderType): T;
/**
* Get all registered providers of the given type
* @param providerType The type of the providers
*/
export function getProvidersByType<T extends DataProvider>(providerType: DataProviderType): T[];
/**
* An {@link vscode.Event} which fires when the specific flavor of a language used in DMP
* connections has changed. And example is for a SQL connection, the flavor changes
* to MSSQL
*/
export const onDidChangeLanguageFlavor: vscode.Event<DidChangeLanguageFlavorParams>;
}
/**
* Namespace for credentials management global methods, available to all extensions
*/
export namespace credentials {
/**
* Register a credential provider to handle credential requests.
* @param provider The provider to register
* @return Handle to the provider for disposal
*/
export function registerProvider(provider: CredentialProvider): vscode.Disposable;
/**
* Retrieves a provider from the extension host if one has been registered. Any credentials
* accessed with the returned provider will have the namespaceId appended to credential ID
* to prevent extensions from trampling over each others' credentials.
* @param namespaceId ID that will be appended to credential IDs.
* @return Promise that returns the namespaced provider
*/
export function getProvider(namespaceId: string): Thenable<CredentialProvider>;
}
/**
* Namespace for connection management
*/
export namespace connection {
/**
* Well-known Authentication types commonly supported by connection providers.
*/
export enum AuthenticationType {
/**
* Username and password
*/
SqlLogin = 'SqlLogin',
/**
* Windows Authentication
*/
Integrated = 'Integrated',
/**
* Microsoft Entra ID - Universal with MFA support
*/
AzureMFA = 'AzureMFA',
/**
* Microsoft Entra ID - Password
*/
AzureMFAAndUser = 'AzureMFAAndUser',
/**
* Datacenter Security Token Service Authentication
*/
DSTSAuth = 'dstsAuth',
/**
* No authentication required
*/
None = 'None'
}
/**
* Connection profile primary class
*/
export class ConnectionProfile {
providerId: string;
connectionId: string;
connectionName: string;
serverName: string;
databaseName: string;
userName: string;
password: string;
authenticationType: string | AuthenticationType;
savePassword: boolean;
groupFullName: string;
groupId: string;
saveProfile: boolean;
azureTenantId?: string | undefined;
options: { [name: string]: any };
static createFrom(options: { [key: string]: any }): ConnectionProfile;
}
/**
* Get the current connection based on the active editor or Object Explorer selection
*/
export function getCurrentConnection(): Thenable<ConnectionProfile>;
/**
* Get known connection profiles including active connections, recent connections and saved connections.
* @param activeConnectionsOnly Indicates whether only get the active connections, default value is false.
* @returns array of connections
*/
export function getConnections(activeConnectionsOnly?: boolean): Thenable<ConnectionProfile[]>;
/**
* Get all active connections
*/
export function getActiveConnections(): Thenable<Connection[]>;
/**
* Get connection string
*/
export function getConnectionString(connectionId: string, includePassword: boolean): Thenable<string>;
/**
* Get the credentials for a connection
* @param connectionId The id of the connection
* @returns A dictionary containing the credentials as they would be included in the connection's options dictionary
*/
export function getCredentials(connectionId: string): Thenable<{ [name: string]: string }>;
/**
* Get ServerInfo for a connectionId
* @param connectionId The id of the connection
* @returns ServerInfo
*/
export function getServerInfo(connectionId: string): Thenable<ServerInfo>;
/**
* Interface for representing a connection when working with connection APIs
*/
export interface Connection extends ConnectionInfo {
/**
* The name of the provider managing the connection (e.g. MSSQL)
*/
providerName: string;
/**
* A unique identifier for the connection
*/
connectionId: string;
}
/**
* List the databases that can be accessed from the given connection
* @param connectionId The ID of the connection
* @returns An list of names of databases
*/
export function listDatabases(connectionId: string): Thenable<string[]>;
/**
* Get a URI corresponding to the given connection so that it can be used with data
* providers and other APIs that require a connection API.
* Note: If the given connection corresponds to multiple URIs this may return any of them
* @param connectionId The ID of the connection
*/
export function getUriForConnection(connectionId: string): Thenable<string>;
/**
* Opens the connection dialog, calls the callback with the result. If connection was successful
* returns the connection otherwise returns undefined
*/
export function openConnectionDialog(
providers?: string[],
initialConnectionProfile?: IConnectionProfile,
connectionCompletionOptions?: IConnectionCompletionOptions): Thenable<Connection>;
/**
* Attempts to open a new connection with the options from the given connection profile.
* @param connectionProfile The {@link IConnectionProfile} containing the information for the connection
* @param saveConnection Whether to save the connection in the saved connections list of the Servers view. Default is true
* @param showDashboard Whether to show the dashboard for the connection upon success. Default is true
*/
export function connect(connectionProfile: IConnectionProfile, saveConnection?: boolean, showDashboard?: boolean): Thenable<ConnectionResult>;
/**
* Supported connection event types
*/
export type ConnectionEventType =
| 'onConnect'
| 'onDisconnect'
| 'onConnectionChanged';
/**
* Connection Event Lister
*/
export interface ConnectionEventListener {
/**
* Connection event handler
* @param type Connection event type
* @param ownerUri Connection's owner uri
* @param args Connection profile
*/
onConnectionEvent(type: ConnectionEventType, ownerUri: string, args: IConnectionProfile): void;
}
/**
* Register a connection event listener
* @param listener The connection event listener
*/
export function registerConnectionEventListener(listener: ConnectionEventListener): vscode.Disposable;
/**
* Get connection profile by its owner uri
* @param ownerUri The owner uri of the connection
* @returns Thenable to return the connection profile matching the ownerUri
*/
export function getConnection(ownerUri: string): Thenable<ConnectionProfile>;
}
/**
* Namespace for interacting with Object Explorer
*/
export namespace objectexplorer {
/**
* Get an Object Explorer node corresponding to the given connection and path. If no path
* is given, it returns the top-level node for the given connection. If there is no node at
* the given path, it returns undefined.
* @param connectionId The id of the connection that the node exists on
* @param nodePath The path of the node to get
* @returns The node corresponding to the given connection and path,
* or undefined if no such node exists.
*/
export function getNode(connectionId: string, nodePath?: string): Thenable<ObjectExplorerNode>;
/**
* Get all active Object Explorer connection nodes
* @returns The Object Explorer nodes for each saved connection
*/
export function getActiveConnectionNodes(): Thenable<ObjectExplorerNode[]>;
/**
* Find Object Explorer nodes that match the given information
* @param connectionId The id of the connection that the node exists on
* @param type The type of the object to retrieve
* @param schema The schema of the object, if applicable
* @param name The name of the object
* @param database The database the object exists under, if applicable
* @param parentObjectNames A list of names of parent objects in the tree, ordered from highest to lowest level
* (for example when searching for a table's column, provide the name of its parent table for this argument)
*/
export function findNodes(connectionId: string, type: string, schema: string, name: string, database: string, parentObjectNames: string[]): Thenable<ObjectExplorerNode[]>;
/**
* Get connectionProfile from sessionId
* @param sessionId The id of the session that the node exists on
* @returns The IConnectionProfile for the session
*/
export function getSessionConnectionProfile(sessionId: string): Thenable<IConnectionProfile>;
/**
* Interface for representing and interacting with items in Object Explorer
*/
export interface ObjectExplorerNode extends NodeInfo {
/**
* The id of the connection that the node exists under
*/
connectionId: string;
/**
* Whether the node is currently expanded in Object Explorer
*/
isExpanded(): Thenable<boolean>;
/**
* Set whether the node is expanded or collapsed
* @param expandedState The new state of the node. If 'None', the node will not be changed
*/
setExpandedState(expandedState: vscode.TreeItemCollapsibleState): Thenable<void>;
/**
* Set whether the node is selected
* @param selected Whether the node should be selected
* @param clearOtherSelections If true, clear any other selections. If false, leave any existing selections.
* Defaults to true when selected is true and false when selected is false.
*/
setSelected(selected: boolean, clearOtherSelections?: boolean): Thenable<void>;
/**
* Get all the child nodes. Returns an empty list if there are no children.
*/
getChildren(): Thenable<ObjectExplorerNode[]>;
/**
* Get the parent node. Returns undefined if there is none.
*/
getParent(): Thenable<ObjectExplorerNode | undefined>;
/**
* Refresh the node, expanding it if it has children
*/
refresh(): Thenable<void>;
}
}
// EXPORTED INTERFACES /////////////////////////////////////////////////
export interface ConnectionInfo {
options: { [name: string]: any };
}
// Object Explorer interfaces -----------------------------------------------------------------------
export interface ObjectExplorerSession {
success: boolean;
sessionId?: string | undefined;
rootNode: NodeInfo;
errorMessage?: string | undefined;
}
/**
* A NodeInfo object represents an element in the Object Explorer tree under
* a connection.
*/
export interface NodeInfo {
nodePath: string;
nodeType: string;
nodeSubType?: string | undefined;
nodeStatus?: string | undefined;
label: string;
isLeaf: boolean;
metadata?: ObjectMetadata | undefined;
errorMessage?: string | undefined;
/**
* Optional iconType for the object in the tree. Currently this only supports
* an icon name or SqlThemeIcon name, rather than a path to an icon.
* If not defined, the nodeType + nodeStatus / nodeSubType values
* will be used instead.
*/
iconType?: string | SqlThemeIcon | undefined;
/**
* Informs who provides the children to a node, used by data explorer tree view api
*/
childProvider?: string | undefined;
/**
* Holds the connection profile for nodes, used by data explorer tree view api
*/
payload?: any;
/**
* Specify the icon for the node. The value could the path to the icon or and ADS icon defined in {@link SqlThemeIcon}.
*/
icon?: IconPath | SqlThemeIcon;
}
export interface IConnectionProfile extends ConnectionInfo {
connectionName?: string | undefined;
serverName: string;
databaseName?: string | undefined;
userName: string;
password: string;
/**
* The type of authentication to use when connecting
*/
authenticationType: string | connection.AuthenticationType;
savePassword: boolean;
groupFullName?: string | undefined;
groupId?: string | undefined;
providerName: string;
saveProfile: boolean;
id: string;
azureTenantId?: string | undefined;
}
/**
* Options for the actions that could happen after connecting is complete
*/
export interface IConnectionCompletionOptions {
/**
* Save the connection to MRU and settings (only save to setting if profile.saveProfile is set to true)
* Default is true.
*/
saveConnection: boolean;
/**
* If true, open the dashboard after connection is complete.
* If undefined / false, dashboard won't be opened after connection completes.
* Default is false.
*/
showDashboard?: boolean | undefined;
/**
* If undefined / true, open the connection dialog if connection fails.
* If false, connection dialog won't be opened even if connection fails.
* Default is true.
*/
showConnectionDialogOnError?: boolean | undefined;
/**
* If undefined / true, open the connection firewall rule dialog if connection fails.
* If false, connection firewall rule dialog won't be opened even if connection fails.
* Default is true.
*/
showFirewallRuleOnError?: boolean | undefined;
}
export interface ConnectionInfoSummary {
/**
* URI identifying the owner of the connection
*/
ownerUri: string;
/**
* Connection id returned from service host, if the connection was successful.
*/
connectionId?: string | undefined;
/**
* Additional optional detailed error messages from the engine or service host, if an error occurred.
*/
messages?: string | undefined;
/**
* Error message returned from the engine or service host, if an error occurred.
*/
errorMessage?: string | undefined;
/**
* Error number returned from the engine or server host, if an error occurred.
*/
errorNumber?: number | undefined;
/**
* Information about the connected server, if the connection was successful.
*/
serverInfo?: ServerInfo | undefined;
/**
* Information about the actual connection established, if the connection was successful.
*/
connectionSummary?: ConnectionSummary | undefined;
/**
* Whether the server version is supported by the provider. Default is to assume true. If the value is false, Azure Data Studio
* will show a warning message.
*/
isSupportedVersion?: boolean | undefined;
/**
* Additional optional message with details about why the version isn't supported. This will be appended to the warning message Azure Data Studio
* displays about unsupported versions.
*/
unsupportedVersionMessage?: string | undefined;
}
/**
* Summary that identifies a unique database connection.
*/
export interface ConnectionSummary {
/**
* server name
*/
serverName: string;
/**
* database name
*/
databaseName?: string | undefined;
/**
* user name
*/
userName: string;
}
/**
* Information about a Server instance.
*/
export interface ServerInfo {
/**
* The major version of the instance.
*/
serverMajorVersion?: number | undefined;
/**
* The minor version of the instance.
*/
serverMinorVersion?: number | undefined;
/**
* The build of the instance.
*/
serverReleaseVersion: number;
/**
* The ID of the engine edition of the instance.
*/
engineEditionId: number;
/**
* String containing the full server version text.
*/
serverVersion: string;
/**
* String describing the product level of the server.
*/
serverLevel: string;
/**
* The edition of the instance.
*/
serverEdition: string;
/**
* Whether the instance is running in the cloud (Azure) or not.
*/
isCloud: boolean;
/**
* The version of Azure that the instance is running on, if applicable.
*/
azureVersion: number;
/**
* The Operating System version string of the machine running the instance.
*/
osVersion: string;
/**
* The CPU count of the host running the server.
*/
cpuCount?: number;
/**
* The physical memory of the host running the server.
*/
physicalMemoryInMb?: number;
/**
* options for all new server properties.
*/
options: { [key: string]: any };
}
/**
* The possible values of the server engine edition
*/
export enum DatabaseEngineEdition {
Unknown = 0,
Personal = 1,
Standard = 2,
Enterprise = 3,
Express = 4,
SqlDatabase = 5,
SqlDataWarehouse = 6,
SqlStretchDatabase = 7,
SqlManagedInstance = 8,
SqlOnDemand = 11,
SqlDbFabric = 12
}
export interface DataProvider {
handle?: number | undefined;
readonly providerId: string;
}
export interface ConnectionProvider extends DataProvider {
connect(connectionUri: string, connectionInfo: ConnectionInfo): Thenable<boolean>;
disconnect(connectionUri: string): Thenable<boolean>;
cancelConnect(connectionUri: string): Thenable<boolean>;
listDatabases(connectionUri: string): Thenable<ListDatabasesResult>;
changeDatabase(connectionUri: string, newDatabase: string): Thenable<boolean>;
rebuildIntelliSenseCache(connectionUri: string): Thenable<void>;
getConnectionString(connectionUri: string, includePassword: boolean): Thenable<string>;
buildConnectionInfo?(connectionString: string): Thenable<ConnectionInfo>;
/**
* Registers a handler for ConnectionComplete events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnConnectionComplete(handler: (connSummary: ConnectionInfoSummary) => any): vscode.Disposable;
/**
* Registers a handler for IntellisenseCacheComplete events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnIntelliSenseCacheComplete(handler: (connectionUri: string) => any): vscode.Disposable;
/**
* Registers a handler for ConnectionChanged events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnConnectionChanged(handler: (changedConnInfo: ChangedConnectionInfo) => any): vscode.Disposable;
}
export enum ServiceOptionType {
string = 'string',
multistring = 'multistring',
password = 'password',
number = 'number',
category = 'category',
boolean = 'boolean',
object = 'object'
}
export enum ConnectionOptionSpecialType {
connectionName = 'connectionName',
serverName = 'serverName',
databaseName = 'databaseName',
authType = 'authType',
userName = 'userName',
password = 'password',
appName = 'appName'
}
export interface CategoryValue {
displayName: string;
name: string;
}
export interface ConnectionOption {
name: string;
displayName: string;
description: string;
groupName: string;
valueType: ServiceOptionType;
specialValueType: ConnectionOptionSpecialType;
defaultValue: string;
categoryValues: CategoryValue[];
isIdentity: boolean;
isRequired: boolean;
}
export interface ConnectionProviderOptions {
options: ConnectionOption[];
}
export interface ServiceOption {
name: string;
displayName: string;
description: string;
groupName: string;
valueType: ServiceOptionType;
defaultValue: string;
objectType: string;
categoryValues: CategoryValue[];
isRequired: boolean;
isArray: boolean;
}
export interface AdminServicesOptions {
databaseInfoOptions: ServiceOption[];
databaseFileInfoOptions: ServiceOption[];
fileGroupInfoOptions: ServiceOption[];
}
// List Databases Request ----------------------------------------------------------------------
export interface ListDatabasesResult {
databaseNames: Array<string>;
databases?: Array<DatabaseInfo> | undefined;
}
/**
* Information about a connection changed event for a resource represented by a URI
*/
export interface ChangedConnectionInfo {
/**
* Owner URI of the connection that changed.
*/
connectionUri: string;
/**
* Summary of details containing any connection changes.
*/
connection: ConnectionSummary;
}
export interface FeatureMetadataProvider {
enabled: boolean;
featureName: string;
optionsMetadata: ServiceOption[];
}
export interface DataProtocolServerCapabilities {
protocolVersion: string;
providerName: string;
providerDisplayName: string;
connectionProvider: ConnectionProviderOptions;
adminServicesProvider: AdminServicesOptions;
features: FeatureMetadataProvider[];
}
export interface DataProtocolClientCapabilities {
hostName: string;
hostVersion: string;
}
export interface CapabilitiesProvider extends DataProvider {
getServerCapabilities(client: DataProtocolClientCapabilities): Thenable<DataProtocolServerCapabilities>;
}
export enum MetadataType {
Table = 0,
View = 1,
SProc = 2,
Function = 3
}
export interface ObjectMetadata {
metadataType: MetadataType;
metadataTypeName: string;
urn: string;
name: string;
schema: string;
}
export interface ColumnMetadata {
hasExtendedProperties: boolean;
defaultValue: string;
/**
* Escaped identifier for the name of the column
*/
escapedName: string;
/**
* Whether or not the column is computed
*/
isComputed: boolean;
/**
* Whether or not the column is deterministically computed
*/
isDeterministic: boolean;
/**
* Whether or not the column is an identity column
*/
isIdentity: boolean;
/**
* The ordinal ID of the column
*/
ordinal: number;
/**
* Whether or not the column is calculated on the server side. This could be a computed
* column or a identity column.
*/
isCalculated: boolean;
/**
* Whether or not the column is used in a key to uniquely identify a row
*/
isKey: boolean;
/**
* Whether or not the column can be trusted for uniqueness
*/
isTrustworthyForUniqueness: boolean;
}
export interface TableMetadata {
columns: ColumnMetadata;
}
export interface ProviderMetadata {
objectMetadata: ObjectMetadata[];
}
export interface MetadataProvider extends DataProvider {
getMetadata(connectionUri: string): Thenable<ProviderMetadata>;
getDatabases(connectionUri: string): Thenable<string[] | DatabaseInfo[]>;
getTableInfo(connectionUri: string, metadata: ObjectMetadata): Thenable<ColumnMetadata[]>;
getViewInfo(connectionUri: string, metadata: ObjectMetadata): Thenable<ColumnMetadata[]>;
}
export enum ScriptOperation {
Select = 0,
Create = 1,
Insert = 2,
Update = 3,
Delete = 4,
Execute = 5,
Alter = 6
}
export interface ScriptingResult {
operationId: string;
script: string;
}
export interface ScriptingParamDetails {
filePath?: string | undefined;
scriptCompatibilityOption: string;
targetDatabaseEngineEdition: string;
targetDatabaseEngineType: string;
}
export interface ScriptingProvider extends DataProvider {
scriptAsOperation(connectionUri: string, operation: ScriptOperation, metadata: ObjectMetadata, paramDetails: ScriptingParamDetails): Thenable<ScriptingResult>;
/**
* Registers a handler for ScriptingComplete events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnScriptingComplete(handler: (scriptingCompleteResult: ScriptingCompleteResult) => any): vscode.Disposable;
}
export interface ScriptingCompleteResult {
errorDetails: string;
errorMessage: string;
hasError: boolean;
canceled: boolean;
success: boolean;
operationId: string;
}
/**
* Parameters to initialize a connection to a database
*/
export interface Credential {
/**
* Unique ID identifying the credential
*/
credentialId: string;
/**
* password
*/
password: string;
}
export interface CredentialProvider {
handle: number;
saveCredential(credentialId: string, password: string): Thenable<boolean>;
readCredential(credentialId: string): Thenable<Credential>;
deleteCredential(credentialId: string): Thenable<boolean>;
}
export interface DidChangeLanguageFlavorParams {
uri: string;
language: string;
flavor: string;
}
export interface QueryExecutionOptions {
options: { [option: string]: any; };
}
export interface QueryProvider extends DataProvider {
cancelQuery(ownerUri: string): Thenable<QueryCancelResult>;
runQuery(ownerUri: string, selection: ISelectionData, runOptions?: ExecutionPlanOptions): Thenable<void>;
runQueryStatement(ownerUri: string, line: number, column: number): Thenable<void>;
runQueryString(ownerUri: string, queryString: string): Thenable<void>;
runQueryAndReturn(ownerUri: string, queryString: string): Thenable<SimpleExecuteResult>;
parseSyntax(ownerUri: string, query: string): Thenable<SyntaxParseResult>;
getQueryRows(rowData: QueryExecuteSubsetParams): Thenable<QueryExecuteSubsetResult>;
disposeQuery(ownerUri: string): Thenable<void>;
saveResults(requestParams: SaveResultsRequestParams): Thenable<SaveResultRequestResult>;
setQueryExecutionOptions(ownerUri: string, options: QueryExecutionOptions): Thenable<void>;
// Notifications
/**
* Registers a handler for QueryComplete events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnQueryComplete(handler: (result: QueryExecuteCompleteNotificationResult) => any): vscode.Disposable;
/**
* Registers a handler for BatchStart events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnBatchStart(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): vscode.Disposable;
/**
* Registers a handler for BatchComplete events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnBatchComplete(handler: (batchInfo: QueryExecuteBatchNotificationParams) => any): vscode.Disposable;
/**
* Registers a handler for ResultSetAvailable events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnResultSetAvailable(handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any): vscode.Disposable;
/**
* Registers a handler for ResultSetUpdated events.
*
* @param handler The function that will be called when this event is triggered
* @returns A disposable that will unregister the handler when disposed
*/
registerOnResultSetUpdated(handler: (resultSetInfo: QueryExecuteResultSetNotificationParams) => any): vscode.Disposable;
/**
* Registers a handler for Message events.
*