How to Install Splice Machine for Zeppelin

This topic describes how to install the Splice Machine interpreter for Apache Zeppelin.

If you’ve not yet installed Zeppelin, please follow the official Apache instructions for the latest version. At the time of this writing, the latest version is 0.8.0, and the installation instructions are here:

    http://zeppelin.apache.org/docs/0.8.0/usage/interpreter/installation.html

Add the Splice Machine Zeppelin Interpreter

To add the Splice Machine Zeppelin interpreter to the set of interpreters available in your Zeppelin environment, follow these steps:

  1. Download the splicemachine-zeppelin-0.8.0.jar file. We recommend saving the download in the /tmp directory, though you can use another directory if you add it to the Zeppelin path.

  2. Navigate to your zeppelin home directory.

  3. Use the following command to install the Splice Machine interpreter for Zeppelin:
    .bin//install-interpreter.sh --name splicemachine --artifact /tmp/splicemachine-zeppelin-0.8.0.jar
    

    If you saved the jar file to a directory other than /tmp, remember to change its location in the install command.

  4. Restart the Zeppelin server

  5. Navigate to the Interpreter page in Zeppelin, which is accessible from drop-down menu in the upper-right corner of the Zeppelin window.

  6. Click the Create button in the Interpreter window. This opens a form; enter the following into the form fields:

    Field Value to Enter
    Name splicemachine
    Interpreter Group Select splicemachine from the drop-down menu.
    default.user Set this value to your default user name; this value is initially set to splice.
    default.password Set this value to your default password.
    default.url Set this value to match your server's configuration; this value is initially set to jdbc:splice://localhost:1527/splicedb.
    default.splitQueries true
  7. Save your changes.

Restart Zeppelin

After installing the Splice Machine interpreter, you need to restart Zeppelin again:

  1. Stop Zeppelin:
    ./bin/zeppelin-daemon.sh stop
    
  2. Start Zeppelin:
    ./bin/zeppelin-daemon.sh start
    

Start Using Splice Machine in Your Zeppelin Notebooks

To use the new interpreter in a notebook, you must bind it into the notebook, following these steps:

  1. Open or create a notebook in Zeppelin.

  2. Click the gear icon in the upper right corner of the Zeppelin window to display the list of interpreters that are currently bound to this notebook:

  3. Scroll down through the list of interpreters, and click the splicemachine button: 

  4. Click the Save button to bind the interpreter to this notebook.

If you’re able to connect to a Splice Machine instance, you can create paragraphs in your Zeppelin notebooks that work with your database, assuming: specify the %splicemachine interpreter at the top of the paragraph, and issue commands just as you would with the splice command line interpreter. For example:

%splicemachine
drop table myTable;
create table myTable ( id int, name varchar(64) );
insert into myTable value (1, 'John Doe'), (2, 'Jane Doe');
select * from myTable where id > 10;