SQLpipe does not have any "sub commands" - if you run SQLpipe's binary, it starts the server. However, there are a few command line flags available:
-portSpecifies what port SQLpipe will listen on. Default 9000.
-secureIf true, will require clients to provide an API token. Default false.
-tokenSets the API token. Must be 32 characters.
-tokenis provided without
-secure, SQLpipe automatically sets
-secureis provided without
-token, SQLpipe will automatically generate a 32 character API token.
-limiter-enabledEnables the rate limiter, which limits the amount of requests that a given client (IP address) can send. Default false.
-limiter-rpsLimits the average amount of requests per second from client. Default 10.
-limiter-burstAllows a temporary burst of requests, per the token bucket rate limiting algorithm.
-versionPrints the current version (in git hash) of SQLpipe and exits.
If you start SQLpipe's container as specified under the "more control" heading of the installation page, running the following command in the root of the container's file system will spin up something that will work fine in a production environment:
That's it! Let's move on to the good stuff - the API.