Open source, scale-to-zero, HTTP SQLite database built on top of Cloudflare Durable Objects.
- HTTPS Endpoints to query & interact with your database
- Web Socket Connections to query your database with low-latency web sockets
- Transactions Support for executing interdependent collections of queries
- REST API Support automatically included for interacting with your tables
- Database Interface included out of the box deployed with your Cloudflare Worker
- Export SQL Dump to extract your schema and data into a local `.sql` file
- Import SQL Dump to import your schema and data from a local `.sql` file
- Scale-to-zero Compute to reduce costs when your database is not in use
Throughout building this offering we are documenting as much of the journey as possible. Join us in our adventure and join the conversation on talking through our design decisions as we continue to move fast. Find more details on how we implement core features on our blog.
- Point in Time Rollbacks for rolling back your database to any minute in the past 30 days
- Data Replication to scale reads beyond the 1,000 RPS limitation
- Data Streaming for streaming responses back as rows are read
- Data Syncing between local source and your database
- Export Data as a CSV, JSON or SQLite file
- Import Data from a CSV, JSON or SQLite file
The above list is not an exhaustive list of features planned, but a glimpse at the direction we have in mind. We welcome any and all ideas from the community on what features or issues you would like to see be included as part of StarbaseDB. You can create new Bug Reports and Feature Requests and each will be reviewed.
Deploying a new SQLite database instance to a Cloudflare Durable Object can be done via a single command:
curl https://starbasedb.com/install.sh | bashThe above command will create two new resources in your Cloudflare account, a Worker and a Durable Object. Your Worker will be what clients make network requests to for fetching data from your database, and the Durable Object itself is the SQLite storage.
After your worker has been deployed, you'll receive a console message similar to the one below:
==========================================
Welcome to the StarbaseDB installation script!
This script will deploy a Cloudflare Worker and create an Outerbase Starlink session.
If you don't have a paid Cloudflare account, your deployment will fail.
IMPORTANT: You _MUST_ have a paid Cloudflare account to use SQLite in Durable Objects.
==========================================
Cloning the repository...
Please enter your Cloudflare account_id (from 'wrangler whoami' or the Cloudflare dashboard):
{{YOUR_ACCOUNT_ID}}
Deploying your worker...
Worker deployed successfully at https://starbasedb.{YOUR-IDENTIFIER}.workers.dev.
==========================================
Outerbase Studio user account created!
Use the following URL to view your database:
https://starbasedb.{YOUR-IDENTIFIER}.workers.dev/studio
Username: admin
Password: password
NOTE: You can change your Outerbase Studio password in the wrangler.toml file and redeploy.
==========================================
Start executing queries against your database with the following cURL commands:
curl --location --request POST 'https://starbasedb.YOUR-ID-HERE.workers.dev/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ABC123' \
--data-raw '{
"sql": "CREATE TABLE IF NOT EXISTS artist(artistid INTEGER PRIMARY KEY, artistname TEXT);"
}'
curl --location --request POST 'https://starbasedb.YOUR-ID-HERE.workers.dev/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ABC123' \
--data-raw '{
"sql": "INSERT INTO artist (artistid, artistname) VALUES (123, '\''Alice'\''), (456, '\''Bob'\''), (789, '\''Charlie'\'');"
}'
curl --location --request POST 'https://starbasedb.YOUR-ID-HERE.workers.dev/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ABC123' \
--data-raw '{
"sql": "SELECT * FROM artist WHERE artistid=$1;",
"params": [123]
}'
curl --location --request POST 'https://starbasedb.YOUR-ID-HERE.workers.dev/query' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ABC123' \
--data-raw '{
"transaction": [
{
"sql": "SELECT * FROM artist WHERE artistid=$1;",
"params": [123]
},
{
"sql": "SELECT * FROM artist;",
"params": []
}
]
}'
curl --location --request POST 'https://starbasedb.YOUR-ID-HERE.workers.dev/query/raw' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ABC123' \
--data-raw '{
"sql": "SELECT * FROM artist;",
"params": []
}'
let socket;
function connectWebSocket() {
logMessage("Connecting to WebSocket...");
socket = new WebSocket('wss://starbasedb.YOUR-ID-HERE.workers.dev/socket?token=ABC123');
socket.onopen = function() {
logMessage("WebSocket connection opened.");
};
socket.onmessage = function(event) {
logMessage("Received: " + event.data);
};
socket.onclose = function(event) {
logMessage(`WebSocket closed with code: ${event.code}, reason: ${event.reason}`);
};
socket.onerror = function(error) {
logMessage("WebSocket error: " + error.message);
};
}
function sendMessage() {
const message = document.getElementById('messageInput').value;
if (socket && socket.readyState === WebSocket.OPEN) {
logMessage("Sending: " + message);
socket.send(JSON.stringify({
sql: message,
params: [],
action: 'query'
}));
} else {
logMessage("WebSocket is not open.");
}
}
window.onload = connectWebSocket;
curl --location 'https://starbasedb.YOUR-ID-HERE.workers.dev/export/dump' \
--header 'Authorization: Bearer ABC123'
--output database_dump.sql
curl
--location 'https://starbasedb.YOUR-ID-HERE.workers.dev/export/json/users' \
--header 'Authorization: Bearer ABC123'
--output output.json
curl
--location 'https://starbasedb.YOUR-ID-HERE.workers.dev/export/csv/users' \
--header 'Authorization: Bearer ABC123'
--output output.csv
curl
--location 'https://starbasedb.YOUR-ID-HERE.workers.dev/import/dump' \
--header 'Authorization: Bearer ABC123' \
--form 'sqlFile=@"./Desktop/sqldump.sql"'
We welcome contributions! Please refer to our Contribution Guide for more details.
This project is licensed under the MIT license. See the LICENSE file for more info.
