tschf / odb-task

A task runner for VSC based on atom-build-oracle implementation

Oracle Database Tasks for VSC

Overview

The goal of this extension is to simplify the ability to run scripts against your database connections. It works around the concept of having a config file in the root of your project with a list of all your connection details.

Install

Search the marketplace for odb-task and click the install button. Depends on having SQL*Plus or SQLcl available on your system (I recommend going to the effort of installing SQL*Plus).

Set up

1. Open your project
2. Create a file in your project root named .build-oracle.json
3. Update the contents per the below example
4. Reload Code just to make sure everything is detected

Key bindings

The best way to create a shortcut for build is to define it in keyboard shortcuts.

1. Ensure you have run a compile task - the command doesn't appear in the keyboard shortcuts settings until you have successfully run the task
2. Navigate to Keyboard Shortcuts: File -> Preferences -> Keyboard Shortcuts
3. Search odb-task and set your desired keyboard binding

Alternatively, you can just add to your keybindings.json file directly:

{
    "key": "ctrl+shift+b",
    "command": "odb-task.compileSqlPlus"
}

The command property can be either: odb-task.compileSqlPlus or odb-task.compileSqcl.

Example config

[
    {
        "targetName": "DEV",
        "connectionString": "user/password@XE"
    }
]

Usage

Open the command palette and type Compile with. You will see two entries:

1. Compile with SQL*Plus
2. Compile with SQLcl

note: This extension doesn't ship with these binaries, so it assumes if you are running one or the other, the command is available on your system.

Choose the interpreter you wish to compile with.

You will prompted for which connection to compile against. Choose the connection name.

Configuration

As mentioned, this extension depends on the binaries for SQL*Plus or SQLcl being available on your system. These default to sqlplus and sql respectively. If these are not within your Path, or have been renamed to something else, you can set an alternative path/name within settings.

Author

Trent Schafer

LICENSE

MIT

odb-task's Issues

Disable commands if there are no build targets available

Task running / Task finished indicator?

How do we know when a particular task is running and when it's finished?

Add support for key bindings

Compile script not included in package

compile.sql is located at src/lib/compile.sql. But src is not deployed in the vsix package. Need to store out side of src so it's deployed with the package

Ability to save the file when you compile it.

When you edit a package, you need to save before you recompile.
It would be nice if when you try to compile, it does a save and then compiles.

Allow to use with multiple projects opened at once

Now it fails when multiple projects are opened.
Works fine when only one project is opened.

Parse output to look for error codes to add to problems panel

Don't show quick pick list if there is only one target

Support alternate config file location

Use case:

• No version control
• Source code in a shared network folder
• Want to store connections locally

command 'odb-task.compileSqlPlus' not found

i have different Windows hosts all with Windows 10 Prof. Edition. My VSC Version is 1.33.1 and my Extension Version of odb-task is 0.0.2.

on two of three Windows hosts i get the following error:
command 'odb-task.compileSqlPlus' not found.

My settings in settings.json are:
.
My .build-oracle.json file is in one of the upper folders.

Do you know why i get the this kind of error:

Multi folder workspace only picks up build file in the first folder

If I have multiple project folders, currently it only observed the build file from the first folder.

Notes: On first activation, go over all workspace folders to set up build targets:

vcode.workspace.workspaceFolders

Then, when compiling a specific file, get the workspace of the active file to select a target from relevant workspace:

vscode.workspace.getWorkspaceFolder(uri)

See: https://code.visualstudio.com/docs/extensionAPI/vscode-api#_workspace

Subscribe to config file to prevent an edit reload

Does not work anymore in VSCode Version 1.25.0 (1.25.0)

Seems to compile about sqlplus although all setting are correct

SP2-0310: Unable to open file: "&1.sql"

Getting the following error when compiling package spec.

`Compiling script: &1

Error starting at line : 19 File @ /Users/vitoc/.vscode/extensions/tschf.odb-task-0.0.2/dist/compile.sql
In command -
@"&1"
Error report -
SP2-0310: Unable to open file: "&1.sql"
No errors.`

Add Colors to compile

See http://orasql.org/2013/05/22/sqlplus-tips-6-colorizing-output/

Example of how I used it:

set define off
--
<compile file>
--
set define on
@$SQL_FILE_COLOR
prompt &_C_RED
show errors
prompt &_C_RESET
exit;

Not sure if when running compile.sql you could reference colors.sql or if the path would come into play. Note colors.sql has some hidden characters so its important to include it as is (see blog post for file contents)