ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-17 02:51:36 -05:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup azdata api docs (#19824)

Browse Source
This commit is contained in:
Charles Gagnon
2022-06-24 11:30:41 -07:00
committed by GitHub
parent 7c50925c33
commit 34f32e6564
1 changed files with 58 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

92
src/sql/azdata.d.ts vendored
View File

@@ -734,45 +734,45 @@ declare module 'azdata' {
defaultValue: string; defaultValue: string;
/// <summary> /**
/// Escaped identifier for the name of the column * Escaped identifier for the name of the column
/// </summary> */
escapedName: string; escapedName: string;
/// <summary> /**
/// Whether or not the column is computed * Whether or not the column is computed
/// </summary> */
isComputed: boolean; isComputed: boolean;
/// <summary> /**
/// Whether or not the column is deterministically computed * Whether or not the column is deterministically computed
/// </summary> */
isDeterministic: boolean; isDeterministic: boolean;
/// <summary> /**
/// Whether or not the column is an identity column * Whether or not the column is an identity column
/// </summary> */
isIdentity: boolean; isIdentity: boolean;
/// <summary> /**
/// The ordinal ID of the column * The ordinal ID of the column
/// </summary> */
ordinal: number; ordinal: number;
/// <summary> /**
/// Whether or not the column is calculated on the server side. This could be a computed * Whether or not the column is calculated on the server side. This could be a computed
/// column or a identity column. * column or a identity column.
/// </summary> */
isCalculated: boolean; isCalculated: boolean;
/// <summary> /**
/// Whether or not the column is used in a key to uniquely identify a row * Whether or not the column is used in a key to uniquely identify a row
/// </summary> */
isKey: boolean; isKey: boolean;
/// <summary> /**
/// Whether or not the column can be trusted for uniqueness * Whether or not the column can be trusted for uniqueness
/// </summary> */
isTrustworthyForUniqueness: boolean; isTrustworthyForUniqueness: boolean;
} }
@@ -2364,7 +2364,9 @@ declare module 'azdata' {
} }
export interface DidChangeAccountsParams { export interface DidChangeAccountsParams {
// Updated accounts /**
* Updated accounts
*/
accounts: Account[]; accounts: Account[];
} }
@@ -3429,9 +3431,18 @@ declare module 'azdata' {
} }
export enum ColumnSizingMode { export enum ColumnSizingMode {
ForceFit = 0, // all columns will be sized to fit in viewable space, no horizontal scroll bar /**
AutoFit = 1, // columns will be ForceFit up to a certain number; currently 3. At 4 or more the behavior will switch to NO force fit * All columns will be sized to fit in viewable space, no horizontal scroll bar
DataFit = 2 // columns use sizing based on cell data, horizontal scroll bar present if more cells than visible in view area */
ForceFit = 0,
/**
* Columns will be ForceFit up to a certain number; currently 3. At 4 or more the behavior will switch to NO force fit
*/
AutoFit = 1,
/**
* Columns use sizing based on cell data, horizontal scroll bar present if more cells than visible in view area
*/
DataFit = 2
} }
export interface TableComponentProperties extends ComponentProperties { export interface TableComponentProperties extends ComponentProperties {
@@ -5014,20 +5025,33 @@ declare module 'azdata' {
onQueryEvent(type: QueryEventType, document: QueryDocument, args: ResultSetSummary | string | undefined): void; onQueryEvent(type: QueryEventType, document: QueryDocument, args: ResultSetSummary | string | undefined): void;
} }
// new extensibility interfaces
export interface QueryDocument { export interface QueryDocument {
/**
* The ID of the connection provider for this query document
*/
providerId: string; providerId: string;
/**
* The URI identifying this document
*/
uri: string; uri: string;
// set the document's execution options /**
* Set the document's execution options, which will be used whenever a query is executed.
* @param options The execution options
*/
setExecutionOptions(options: Map<string, any>): Thenable<void>; setExecutionOptions(options: Map<string, any>): Thenable<void>;
// tab content is build using the modelview UI builder APIs /**
// probably should rename DialogTab class since it is useful outside dialogs * Adds a custom tab to the query editor results view
* @param tab The tab to add
*/
createQueryTab(tab: window.DialogTab): void; createQueryTab(tab: window.DialogTab): void;
// connect the query document using the given connection profile /**
* Connect the query document using the given connection profile
* @param connectionProfile The profile to use as the connection
*/
connect(connectionProfile: connection.ConnectionProfile): Thenable<void>; connect(connectionProfile: connection.ConnectionProfile): Thenable<void>;
} }