Getting Started with Zeppelin

This topic helps you to get started with using Zeppelin with your Splice Machine database service, in the following sections:

The Zeppelin Dashboard

When you click the Notebook button in your Cluster Management dashboard, you land on the Zeppelin welcome page. To start using Zeppelin with your database service, you need to log in to your database by clicking the Login button.

Use the same user ID and password to log into Zeppelin as you use to log into your database.

When you log into Zeppelin for your database, you’ll land on the Zeppelin dashboard, which displays the list of available notebooks. As you can see, notebooks can be organized in folders.

Splice Machine has already created a number of useful notebooks; we suggest that you try running some of them to get a feel for what Zeppelin can do: click a notebook name, and you’ll land on the notebook page in Zeppelin. From there, you can run all or portions of the notebook, modify its content, and create new notebooks. Our next topic, A Simple Tutorial, uses the our Simple Example tutorial.

Adding Your Credentials

You use the Splice Machine interpreter (%splicemachine) in Zeppelin notebooks to interact with your Splice Machine database; this interpreter uses a JDBC connection to the database, and making that connection requires you to supply user credentials. Here’s how you can create the credentials to use with the Splice Machine interpreter in your Zeppelin notebooks:

  1. Log in to Zeppelin, using the Notebook button, as described above.

  2. Click the Zeppelin dropdrop in the upper right corner of the window, and select Credential:

    image of the Zeppelin drop-down

    The Zeppelin Credentials Management page displays:

    image of the Zeppelin credentials management page

  3. Click the Add button to add your credentials:

    image of the Zeppelin add credentials page

    • Enter jdbc.splicemachine as the Entity.
    • Use the same Username and password that you use to log into your database.
  4. Click the Save button to add your credentials.

Now, when you specify the %splicemachine interpreter for a Zeppelin paragraph, your credentials will be used to connect to your Splice Machine database.

Remember to explicitly specify the %splicemachine interpreter in paragraphs, even if %splicemachine is the default interpreter for the notebook you’re working on.

First Notebook Run: Save Interpreter Bindings

The first time that you run any Zeppelin notebook, you need to bind any interpreters needed by the notebook. For our tutorials, these are preconfigured for you; all you need to do is click the Save button:

If you neglect to save its bindings, the notebook will not run. And again: you only need to do this one time for each notebook that you run.

The Zeppelin Note Toolbar

Zeppelin displays a toolbar at the top of each note that provides convenient access to a number of options:

The following table describes the toolbar buttons:

Executes all of the paragraphs in the note, in display-order sequence.
Shows or hides the code sections of the paragraphs in the note.
Shows or hides the result sections of the paragraphs in the note.
Clears the result sections of the paragraphs in the note.
Clones the current note.
Exports the current note in JSON format.

The code and result sections of all paragraphs are exported; you might want to clear your results before exporting a note.

Switches between personal and collaboration modes.
Commits changes that you've made to the content of the current note (and allows you to add a commit note).
Displays the revision you're currently viewing, and lets you select from available revisions.
Deletes the note.
Schedules execution of the note, using CRON syntax.

When you’re working in Zeppelin, you can quickly jump to another notebook or create a new note by clicking the Zeppelin drop-down menu:

Monitoring Job Status

You can monitor the status of any Zeppelin notebook job(s) running in your cluster by clicking the Job button at the top of the Zeppelin screen. This displays a list of the notebook jobs that are running and have run on your cluster.

From the Job screen, you can:

  • Monitor all jobs associated with your account.
  • Filter which jobs are displayed.
  • Search for notebooks.
  • Start, Pause, or Terminate a running job.
  • Click a notebook job name to navigate to that notebook.

Creating Notebooks

Be sure to view our Usage Notes page for important information about creating Zeppelin notebooks to use with Splice Machine.

We strongly encourage you to visit the Zeppelin documentation site to learn about creating, modifying, and running your own Zeppelin notebooks.