Skip to content

Javascript, SQL creation and execution, Markdown, etc. can be centrally managed in a file format called a notebook.

License

Notifications You must be signed in to change notification settings

damoscodehub/db-notebook

 
 

Repository files navigation

Database Notebook

Database Notebook is a Visual Studio Code extension that allows access to various databases through the VSCODE Notebook interface.

It also provides a CSV and Har file preview feature.

logo

Features

  • Various databases accesss in Notebooks, Sidebars and panels UI
    • MySQL, PostgreSQL, SQL Server, SQLite, Redis, AWS, Keycloak, Auth0
  • Execute & stop SQL, JavaScript code in node.js
  • Execute SQL mode
    • Execute query (Default)
    • Execute explain plan (Devises a query plan)
    • Execute explain analyze (Displays actual execution time and statistics)
  • SQL history management
  • Variable sharing between notebook cells
  • ER diagram creation in mermaid format
  • Count the number of all tables belonging to the schema
  • Provide IntelliSense using DB resource names and comments
  • Convenient visualization of result sets
    • Difference display using comparison key (Primary or Unique key)
    • Label display using code label resolver
    • Verify result sets comply with a rule.
    • Output in Excel file format
    • Generate descriptive statistics
    • Support graphs
  • Create and execute "Undo changes sql statements"
  • Output notebook in HTML file format
  • File preview
    • CSV file preview
    • Har file preview

Screenshots

  • Setup connection settings, access to Mysql through the Side-panel

  • Access to Mysql through the Notebook ( Create a new blank Database Notebook )

  • Execute SQL mode

    • Execute query (Default)
    • Execute explain plan (Devises a query plan)
    • Execute explain analyze (Displays actual
  • Variable sharing between notebook cells

  • ER diagram creation in mermaid format

  • Format SQL statement

  • Count the number of all tables belonging to the schema

  • Output notebook in HTML file format

  • Create DB Notebook from a sql file

  • Access to Aws( DynamoDB ) through the Notebook

    • On the DB Notebook, specify the number of counts in the LIMIT clause
Screenshots ( Convenient visualization of result sets )

Difference display using comparison key (Primary or Unique key)

  • Create and execute "Undo changes sql statements"

Label display using code label resolver ( Create a new blank Code label resolver )

Verify records comply with a rule ( Create a new blank DB record rule )

Generate descriptive statistics

Screenshots ( Access to the Keycloak from the side panel )

Access to the Keycloak from the side panel to display changes in user information.

Expand and display JSON items in columns.

Screenshots ( File viewer )

Csv file viewer

  • After previewing the CSV file, descriptive statistics were displayed according to its content.

Har file viewer

Tips

  1. You can specify a default connection definition each time you add a new SQL cell to the notebook

Examples

Keyboard shortcuts

You can open this editor by going to the menu under Code > Settings > Keyboard Shortcuts or by using the Preferences: Open Keyboard Shortcuts command (⌘K ⌘S).

Command Keybindings When Source
Mark cell as skip or not ctrl+alt+s notebookType == 'database-notebook-type' && notebookCellListFocused && notebookCellType == 'code' Database notebook
Specify connection to use ctrl+alt+c notebookType == 'database-notebook-type' && notebookCellListFocused && cellLangId == 'sql' Database notebook
Notebook: cell execution ctrl+enter - System (default)

Requirements

  • node.js >= 18

Recommended Extensions

The ER diagram is output in mermaid format. It is recommended to use the "Markdown Preview Mermaid Support" extension together to visualize it.

🎁 Donate

Buy Me A Coffee

About

Javascript, SQL creation and execution, Markdown, etc. can be centrally managed in a file format called a notebook.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 51.0%
  • Vue 28.8%
  • HTML 17.3%
  • CSS 2.6%
  • Other 0.3%