ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-06 09:35:41 -05:00
Code Issues Packages Projects Releases Wiki Activity

Split up NotebookProvider into separate providers for handling file serialization and cell execution. (#17176)

Browse Source
This commit is contained in:
Cory Rivera
2021-09-29 16:15:28 -07:00
committed by GitHub
parent dfc2635aa7
commit 14904bb671
51 changed files with 1426 additions and 971 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -4919,23 +4919,8 @@ declare module 'azdata' {
deleteCell(index: number): void;
}
/**
* Register a notebook provider. The supported file types handled by this
* provider are defined in the `package.json:
* ```json
* {
* "contributes": {
* "notebook.providers": [{
* "provider": "providername",
* "fileExtensions": ["FILEEXT"]
* }]
* }
* }
* ```
* @param notebook provider
* @returns disposable
*/
export function registerNotebookProvider(provider: NotebookProvider): vscode.Disposable;
export function registerSerializationProvider(provider: NotebookSerializationProvider): vscode.Disposable;
export function registerExecuteProvider(provider: NotebookExecuteProvider): vscode.Disposable;
export interface IStandardKernel {
readonly name: string;
@@ -4943,24 +4928,27 @@ declare module 'azdata' {
readonly connectionProviderIds: string[];
}
export interface NotebookProvider {
export interface NotebookSerializationProvider {
readonly providerId: string;
/**
* @deprecated standardKernels will be removed in an upcoming release. Standard kernel contribution
* should happen via JSON for extensions. Until this is removed, notebook providers can safely return an empty array.
*/
readonly standardKernels: IStandardKernel[];
getNotebookManager(notebookUri: vscode.Uri): Thenable<NotebookManager>;
getSerializationManager(notebookUri: vscode.Uri): Thenable<SerializationManager>;
}
export interface NotebookExecuteProvider {
readonly providerId: string;
getExecuteManager(notebookUri: vscode.Uri): Thenable<ExecuteManager>;
handleNotebookClosed(notebookUri: vscode.Uri): void;
}
export interface NotebookManager {
export interface SerializationManager {
/**
* Manages reading and writing contents to/from files.
* Files may be local or remote, with this manager giving them a chance to convert and migrate
* from specific notebook file types to and from a standard type for this UI
*/
readonly contentManager: ContentManager;
}
export interface ExecuteManager {
/**
* A SessionManager that handles starting, stopping and handling notifications around sessions.
* Each notebook has 1 session associated with it, and the session is responsible
@@ -5009,7 +4997,7 @@ declare module 'azdata' {
/* Reads contents from a Uri representing a local or remote notebook and returns a
* JSON object containing the cells and metadata about the notebook
*/
getNotebookContents(notebookUri: vscode.Uri): Thenable<INotebookContents>;
deserializeNotebook(contents: string): Thenable<INotebookContents>;
/**
* Save a file.
@@ -5021,7 +5009,7 @@ declare module 'azdata' {
* @returns A thenable which resolves with the file content model when the
* file is saved.
*/
save(notebookUri: vscode.Uri, notebook: INotebookContents): Thenable<INotebookContents>;
serializeNotebook(notebook: INotebookContents): Thenable<string>;
}
/**