SQLpipe Docs


The best way to get started with SQLpipe is with the official SQLpipe Docker image.

Quick and easy

SQLpipe has a number of command line flags available when starting a server, but the defaults are fine for experimentation, or even for use in a protected environment.
The following command is all you need to run a SQLpipe API server on port 9000:
docker run --name sqlpipe sqlpipe/sqlpipe:<image tag>
Note that SQLpipe requires you to enter an image tag. As of writing, the latest is 2.0.4.

More control

The following command will open a bash shell inside a running SQLpipe container:
docker run --name sqlpipe -it sqlpipe/sqlpipe bash
Then, you will have the ability to run the SQLpipe binary manually, which gives you access to command line flags. FYI, the SQLpipe binary is in the root of the Docker container's file system.
For example, if you want to generate an API key that must be provided by clients to make requests to the server, you could run:
./sqlpipe --secure
The next section will include more information about the available command line flags.

Adding ODBC drivers

SQLpipe's Docker image currently comes pre-installed with unixODBC and the following drivers:
  • SQL Server
  • Snowflake
  • PostgreSQL (also works for Redshift)
  • MySQL (also works for MariaDB)
Almost every modern data system has an ODBC driver available. If you'd like to add your own drivers to connect to additional sources, check out the Dockerfile that builds the image to see how that is done.

Next steps

Move on to the next page to learn how to interact with SQLpipe's CLI.