Skip to content

Create a Storage Plugin

Paul Rogers edited this page Nov 14, 2019 · 22 revisions

Create the Project

Choose a name for your project. Let's call ours "example". Storage plugins typically go in the contrib module, in a subdirectory named storage-example.

To create the project in Eclipse:

  • Select the drill-contrib-parent node in the Eclipse Package Explorer.
  • Choose Maven → New Maven Module Project from the context menu.
  • Give your project the storage-example name.
  • Accept the other defaults and create the project.
  • Edit the resulting pom.xml file to add your needed dependencies. Use other storage plugins as a "cheat sheet" to see what is needed.
  • Edit drill-contrib-parent/pom.xml to verify your module appears in the module list. Add it if missing:
  <modules>
    ...
    <module>storage-example</module>
    <module>data</module>
    ...
  </modules>
  • (Review this part.) Get Eclipse to know about your project. Use File → Import → Existing Maven Projects. Select the Drill root. Your project should now appear in the Package Explorer as storage-example. (If this does not work, try selecting drill and Maven → Update Project.
  • Eclipse named your new package org.storage.example. Rename this package to org.apache.drill.exec.store.example.
  • Do the same for the test package.
  • Run the Maven-provided 'App' class to ensure everything works. Select the class name, then Debug as → Java Application from the context menu.
  • Delete the example App and AppTest classes.

Storage Plugin Class

The storage plugin class is Drill's main entry point to your plugin.

Clone this wiki locally