Skip to main content
Brightstack gives you a fast, easy to use, fully-capable data warehouse in 5 minutes. Let’s set it up! First, download and install the CLI:

Setup

Next, sign up or log in:
NOTE: this authentication key is valid for one week, so you may need to authenticate again in the future.

Engines

Engines provide the compute resources necessary to access and work with your data. So let’s create one!
After creation, you’ll need to start your engine manually using:
This might take up to a minute. Available engine types are sandbox, boost, xsmall, small, medium, and large. You can check the status of your engines using:
You can use engines in running state right away. Here is an example:
NOTE: our data engine is powered by the amazing DuckDB. You can use their awesome documentation as a reference for supported commands and syntax. They have a Postgres-style SQL syntax with additional goodies on top. Remember to stop your engines when you’re done to avoid unnecessary charges:
We’re working on automatic idle detection and stopping to make this easier. To start them back up in the future:
Finally, you want to create an API Key in order to use your data engine inside an application.
IMPORTANT: the default database is memory-backed. All data in it is lost between restarts. Please create a database and use in order to persist data! Please see the next section for info on how to do this. From this point forward on you can use bright help for a complete command reference. For detailed information about engine tiers, compute units, and storage options, see our Engines documentation.

Usage

Using the CLI is great for maintenance, quick tests, and one-off tasks, but brightstack really shines when you integrate it with your applications using our API or one of our libraries. Below is an example of integration using our JS client library, @brightstack/client. More clients coming soon!

Installation

Setup Client

Instantiate your dw (data warehouse) client:

Create a Database

The default database is memory-backed. All data is lost between engine restarts. In order to persist data you must create and use a database.

Making SQL Queries

Our Data Engine is powered by a DuckDB core, so most of DuckDB’s SQL dialect will work out of the box.
Here is a reference of the data types we support. For advanced usage including raw API calls, sessions, and more detailed examples, see our Advanced documentation.