Skip to content

🏗️ Building a Pipe

Pipes fetch and sync data from connectors. For this example, we will be using the connector plugin:noaa from the data plugin noaa. Type the commands below to bootstrap an example pipe.

See the bootstrapping reference page for further information.

  1. Launch the Meerschaum shell.

  2. Install the noaa plugin.

    install plugin noaa
  3. Bootstrap the pipe.

    bootstrap pipe
    1. Choose plugin:noaa for the connector, weather for the metric, and skip the location.

    2. The plugin will ask for weather stations. Enter KATL for Atlanta.

    3. We can keep the default target name plugin_noaa_weather. This will be our SQL table.

    4. Skip tags — those are useful for grouping together pipes.

    5. Answer n to skip editing the definition. Answering yes will open a YAML file of your pipe's parameters.

    6. Finally, answer y to sync the pipe.

Success! Now what?

Well done, you've built your first pipe! When you're ready to build your first project, head over the to compose projects guide.

For now, here are some useful commands to manage your pipe:

Command Description
show pipes Print the pipes on this instance.
show data Print a preview of the contents of your pipes.
sync pipes Sync new rows into your pipes.
sync pipes -m weather --loop -d Continuously (--loop) sync new rows into weather pipes (-m), and run in the background (-d).
show jobs Print the background jobs (created with -d).
stop jobs Stop the running background jobs.