SingleStore driver for SQLTools

A Visual Studio Code extension which extends the SQTools extension to work with the SingleStore.

Features

• Connect to a SingleStoreDB instance
• Manage connections in SQLTools Database Explorer
• View tables, views, columns, functions, procedures
• Generate INSERT queries
• Autocomplete SQL keywords, table and view names, column names, SingleStore built-in

functions

• Run SQL queries
• Export SQL query results in CSV and JSON data formats

Instalation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install singlestore.sqltools-singlestore-driver

Alternatively, you can install this extension directly in VSCode IDE from Extensions tab (Ctrl+Shift+X) by searching for @tag:sqltools singlestore.

Usage

Here you can see several examples of driver usage. For more information on how to use SQLTools please refer to SQLTools documentation

Create a connection

untitled.mp4

Note: Show records default limit parameter defines the maximum number of rows that will be shown in the result.

View tables and views

untitled.mp4

Run SQL query

untitled.mp4

View and edit functions and procedures

untitled.mp4

Note: When creating a function or a procedure, you must change the delimiter to ensure that the function or procedure definition is correctly passed to the server as a single statement. The default delimiter is a semicolon (;). A problem arises when creating functions or procedures because they use semicolons as statement delimiters within the function body. Therefore, you must change the delimiter setting before creating your function or procedure, and then set it back to a semicolon after the alternate delimiter is no longer needed. The DELIMITER commands must be on independent lines.

Example:

DELIMITER //

CREATE OR REPLACE PROCEDURE courses_sp (course_code TEXT, section_number INT, number_students INT) AS
  DECLARE
    code TEXT = UCASE(course_code);
    num_students INT = number_students + 1;
  BEGIN
    INSERT INTO courses VALUES (code, section_number, num_students);
END //

DELIMITER ;

Raising issues

If you have any questions, find a bug, or have a feature request please open an issue.

Setup development environment

1. Clone this repository and open it in the VS Code.
2. Run npm install to install all dependencies.
3. Run npm run watch
4. Open extension.ts file and press F5. This opens a new VS Code window with a development version of the driver extension loaded.