mlxprs

A MarkLogic Visual Studio Code extension

This extension allows you to run XQuery and JavaScript Queries against a MarkLogic database. It also adds syntax highlighting for the MarkLogic XQuery (version "1.0-ml") dialect.

What it does

The extension adds two commands to the VS Code command palette:

Eval XQuery
Eval JavaScript

This will take the contents of the current active editor window and run it against a configured MarkLogic database instance. The results of the query will be shown in the next tab over.

Features

It's asynchronous: long-running queries won't freeze the editor
Changes to the config file take immediate effect, switch databases and credentials on-the-fly
Readability—pretty-formatting of query results based on their contents
XQuery and SJS code completion with functions from the MarkLogic API

Coming soon (hopefully)

Code completion with user-defined functions (locally or in the configured modules database)
Edit MarkLogic XML and JSON documents in the text editor, save them back to the database
Interactive selection of configuration options

Getting started

Use the Visual Studio Code extension manager to install the extension from the VS Code Marketplace. Search for "mlxprs".

Manual installation

After cloning the project, the following steps should enable the extension.

Copy or symlink the root of this project (the mlxprs folder) into your VSCode extensions folder:
- at $HOME/.vscode/extensions/ for *nix,
- or %USERPROFILE%\.vscode\extensions for Windows.
In the root of this project run: npm install
Then run node ./node_modules/vscode/bin/compile
Restart VSCode if it was running

Connect and query

If you're running MarkLogic on localhost:8000 admin/admin, and want to query the "Documents" database, simply:

type some valid XQuery in the editor,
open the command palette ([Shift]+[Cmd]+[P]),
type "MarkLogic: Eval XQuery", or better yet, let the command palette autocomplete it.

If your query can be completed, it will open a new tab and output the results there. If not, the error message will be shown.

Configuration

If you're prudently running with less trivial connection credentials, simply define the variables in your settings.json file ([Cmd]-[,]), for example:

{
    "marklogic.host": "marklogic-instance.geocities.com",
    "marklogic.port": 8040,
    "marklogic.username": "admin-username",
    "marklogic.password": "4DM|Ñ-πå55'.'.'0®∂",
    "marklogic.documentsDb": "myproject-content",
    "marklogic.modulesDb": "myproject-modules"
}

You can also set marklogic.authType to DIGEST or BASIC. DIGEST is default, and appears to work even if the server is running BASIC authentication.

SSL Configuration

You can turn on SSL with the marklogic.ssl configuration property. If the CA is not in your chain of trust (e.g. if the certificate is self-signed), you need to point to it in your configuration as well, using marklogic.pathToCa. It will look something like this:

{
    "marklogic.ssl": true,
    "marklogic.pathToCa": "/Users/myself/certs/my.own.ca.crt"
}

You can acquire the CA file from MarkLogic's admin panel (usually port 8001), by going to 'Security' -> 'Certificate Templates' -> (cert host name), and then selecting the "Status" tab. There is an "download" button in the "certificate template status" section. Click that button to download a copy of your root CA.

Requirements

I've been building and testing with the following ingredients:

MarkLogic 9, with admin access
Visual Studio Code, version 1.33.0
npm version 6.9.0
node.js v11.13.0

Credit

Aside from excellent development and extension support from Visual Studio Code,

Portions of Josh Johnson's vscode-xml project are re-used for XML formatting. The MIT license and source code are kept in the src/xmlFormatting folder of this project.
Christy Haragan's marklogic-node-typescript-definitions made this project possible.
Paxton Hare's marklogic-sublime xquery-ml.tmLanguage code is used for XQuery-ML syntax and snippets, and the MarkLogic Sublime project inspired this one.

jmakeig / mlxprs