Skip to content

feat: added support for .sql and .sqlseal files #184

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kulak-at merged 3 commits into from
Aug 15, 2025
Merged

feat: added support for .sql and .sqlseal files #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47aaf6c
feat: added support for .sql and .sqlseal files
kulak-at Aug 14, 2025
a82863b
chore: adding changeset
kulak-at Aug 15, 2025
3871798
feat: adding ability turn off .sql / .sqlite / .sqlseal / .db file view
kulak-at Aug 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/chilly-dodos-attend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"sqlseal": major
---

adding support for .sql and .sqlseal files
17 changes: 17 additions & 0 deletions src/modules/explorer/Editor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,4 +129,21 @@ export class Editor {
// }
}
}

getCurrentQuery(): string {
return this.editor?.state.doc.toString() || this.query;
}

setQuery(newQuery: string) {
this.query = newQuery;
if (this.editor) {
this.editor.dispatch({
changes: {
from: 0,
to: this.editor.state.doc.length,
insert: newQuery
}
});
}
}
}
105 changes: 0 additions & 105 deletions src/modules/explorer/FileDatabaseExplorerView.ts
View file
Open in desktop

This file was deleted.

11 changes: 5 additions & 6 deletions src/modules/explorer/InitFactory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { Settings } from "../settings/Settings";
import { ExplorerView } from "./explorer/ExplorerView";
import { ViewPlugin } from "@codemirror/view";
import { ViewPluginGeneratorType } from "../syntaxHighlight/viewPluginGenerator";
import { FILE_DATABASE_VIEW, FileDatabaseExplorerView } from "./FileDatabaseExplorerView";
import { SQLSEAL_FILE_VIEW, SQLSealFileView } from "./SQLSealFileView";
import { DatabaseManager } from "./database/databaseManager";
import { activateView } from "./activateView";

Expand Down Expand Up @@ -59,13 +59,12 @@ export class InitFactory {
activateView(plugin.app, "sqlseal-explorer-view"),
);


// Register for extenion
plugin.registerView(FILE_DATABASE_VIEW, (leaf) => {
return new FileDatabaseExplorerView(leaf, dbManager, viewPluginGenerator, rendererRegistry, cellParser, settings, sync)
// Register unified SQLSeal file view for both SQL and database files
plugin.registerView(SQLSEAL_FILE_VIEW, (leaf) => {
return new SQLSealFileView(leaf, dbManager, viewPluginGenerator, rendererRegistry, cellParser, settings, sync, db)
})

plugin.registerExtensions(['sqlite'], FILE_DATABASE_VIEW)
// Extensions for SQLSeal file view are registered by SettingsSQLControls

plugin.addCommand({
id: 'sqlseal-command-explorer',
Expand Down
217 changes: 217 additions & 0 deletions src/modules/explorer/SQLSealFileView.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
import { FileView, IconName, MarkdownPostProcessorContext, Menu, TextFileView, TFile, WorkspaceLeaf } from "obsidian";
import { GridApi } from "ag-grid-community";
import { MemoryDatabase } from "./database/memoryDatabase";
import { DatabaseManager } from "./database/databaseManager";
import { TableInfo } from "./schemaVisualiser/TableVisualiser";
import { Editor } from "./Editor";
import { ViewPluginGeneratorType } from "../syntaxHighlight/viewPluginGenerator";
import { CodeblockProcessor } from "../editor/codeblockHandler/CodeblockProcessor";
import { RendererRegistry } from "../editor/renderer/rendererRegistry";
import { ModernCellParser } from "../syntaxHighlight/cellParser/ModernCellParser";
import { Settings } from "../settings/Settings";
import { Sync } from "../sync/sync/sync";
import { SqlSealDatabase } from "../database/database";

export const SQLSEAL_FILE_VIEW = 'sqlseal-file-view';

const DEFAULT_SQLITE_QUERY = "SELECT name\nFROM sqlite_master\nWHERE type='table'";
const DEFAULT_SQL_QUERY = "SELECT *\nFROM files\nLIMIT 10";

export class SQLSealFileView extends TextFileView {
private fileDb: MemoryDatabase | null = null;
private schema: TableInfo[] = [];
private editor: Editor | null = null;
private fileContent: string = "";

constructor(
leaf: WorkspaceLeaf,
private manager: DatabaseManager,
private viewPluginGenerator: ViewPluginGeneratorType,
private rendererRegistry: RendererRegistry,
private cellParser: ModernCellParser,
private settings: Settings,
private sync: Sync,
private vaultDb: Pick<SqlSealDatabase, 'select' | 'explain'>,
) {
super(leaf);
}

getViewType(): string {
return SQLSEAL_FILE_VIEW;
}

getDisplayText(): string {
return this.file?.basename || 'SQLSeal';
}

async onOpen() {
this.contentEl.addClass("sqlseal-file-view-container");
}

async setViewData(data: string, clear: boolean): Promise<void> {
this.fileContent = data;
await this.initializeView();
}

getViewData(): string {
if (this.editor) {
return this.editor.getCurrentQuery();
}
return this.fileContent;
}

clear(): void {
this.fileContent = "";
this.contentEl.empty();
}

private async initializeView() {
if (!this.file) return;

const fileExtension = this.file.extension.toLowerCase();

if (fileExtension === 'sqlite' || fileExtension === 'db') {
// Handle database files
await this.initializeDatabaseView();
} else if (fileExtension === 'sql' || fileExtension === 'sqlseal') {
// Handle SQL text files
await this.initializeSQLView();
}
}

private async initializeDatabaseView() {
if (!this.file) return;

try {
this.fileDb = await this.manager.getDatabaseConnection(this.file);
await this.fileDb.connect();
this.schema = this.fileDb.getSchema();
} catch (error) {
console.error("Failed to connect to database:", error);
return;
}

await this.render(DEFAULT_SQLITE_QUERY);
}

private async initializeSQLView() {
// For SQL files, use the vault database that was injected
// No need to connect as it's already available

// Use file content as initial query, or default if empty
const initialQuery = this.fileContent.trim() || DEFAULT_SQL_QUERY;
await this.render(initialQuery);
}

private async render(initialQuery: string) {
const codeblockProcessorGenerator = async (el: HTMLElement, source: string) => {
const ctx: MarkdownPostProcessorContext = {
docId: "",
sourcePath: this.file?.path || "",
frontmatter: {},
} as any;

// Create a database adapter to handle both MemoryDatabase and SqlSealDatabase
const dbAdapter = this.fileDb ? {
select: async (statement: string, frontmatter: Record<string, unknown>) => {
const result = this.fileDb!.select(statement);
return {
data: result.data,
columns: Array.isArray(result.columns) ? result.columns : Object.keys(result.columns)
};
},
explain: async () => ""
} : this.vaultDb;

const processor = new CodeblockProcessor(
el,
source,
ctx,
this.rendererRegistry,
dbAdapter,
this.cellParser,
this.settings,
this.app,
this.sync,
);
await processor.onload();

// Resizing and layout configuration for explorer
const renderer = processor.renderer;
if ('communicator' in renderer && 'gridApi' in (renderer as any)['communicator']) {
const api: GridApi = (renderer.communicator as any).gridApi;
api.setGridOption('paginationAutoPageSize', true);
api.setGridOption('domLayout', 'normal'); // Override autoHeight for proper pagination
}

await processor.render();
return processor;
};

this.editor = new Editor(
codeblockProcessorGenerator,
this.viewPluginGenerator,
this.app,
initialQuery,
this.fileDb // Pass the file database (only for sqlite files)
);

// Override the editor's play function to include save functionality
const originalPlay = this.editor.play.bind(this.editor);
this.editor.play = async () => {
// Save the file first if it's a SQL file
if (this.file && (this.file.extension === 'sql' || this.file.extension === 'sqlseal')) {
const currentContent = this.editor?.getCurrentQuery() || "";
if (currentContent !== this.fileContent) {
this.fileContent = currentContent;
await this.save();
}
}
// Then run the query
await originalPlay();
};

this.contentEl.empty();
this.editor.render(this.contentEl);
}

onPaneMenu(menu: Menu, source: "more-options" | "tab-header" | string): void {
if (this.file && (this.file.extension === 'sql' || this.file.extension === 'sqlseal')) {
menu.addItem(item => {
item.setTitle("Save and Run Query")
.setIcon("play")
.onClick(() => {
if (this.editor) {
this.editor.play();
}
});
});
}

menu.addItem(item => {
item.setTitle("Run Query")
.setIcon("play")
.onClick(() => {
if (this.editor) {
this.editor.play();
}
});
});

super.onPaneMenu(menu, source);
}

getIcon(): IconName {
if (!this.file) return 'database';

const ext = this.file.extension.toLowerCase();
if (ext === 'sql' || ext === 'sqlseal') {
return 'code';
}
return 'database';
}

async onClose() {
// MemoryDatabase doesn't need explicit disconnection
}
}
Loading