Starbasedb
HTTP SQLite scale-to-zero database on the edge built on Cloudflare Durable Objects.
Install / Use
/learn @outerbase/StarbasedbREADME
<br /> <p align="center"> <a href="https://starbasedb.com"> <img alt="StarbaseDB – Scale-to-zero HTTP SQLite database" src="https://github.com/Brayden/starbasedb/blob/main/banner.png?raw=true" width="1280"> </a> </p> <h1 align="center">StarbaseDB</h1> <p align="center"> <i>Open source, scale-to-zero, HTTP SQLite database built on top of <a href="https://developers.cloudflare.com/durable-objects/" target="_blank">Cloudflare Durable Objects</a>.</i> </p> <div align="center"> <a href="https://github.com/Brayden/starbasedb/releases"><img src="https://img.shields.io/github/v/release/Brayden/starbasedb?display_name=tag&style=flat"></img></a> <a href="https://starbasedb.hashnode.space/default-guide/introduction/quick-start"><img src="https://img.shields.io/static/v1?label=Read&message=Documentation&color=purple&style=flat"></img></a> <a href="https://starbasedb.com"><img src="https://img.shields.io/static/v1?label=Website&message=StarbaseDB&color=%23be185d&style=flat"></img></a> <a href="https://twitter.com/BraydenWilmoth"><img src="https://img.shields.io/static/v1?label=Follow&message=@BraydenWilmoth&color=black&style=flat"></img></a> <a href="https://discord.gg/k2J7jcJCvd"><img src="https://img.shields.io/static/v1?label=Join us on&message=Discord&color=%237289da&style=flat"></img></a> <a href="https://outerbase.com"><img src="https://img.shields.io/static/v1?label=Check out&message=Outerbase&color=gray&style=flat"></img></a> </div> <br /> <h2>Features</h2> <ul> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/http-endpoints/query">HTTPS Endpoints</a></strong> to query & interact with your database</li> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/web-sockets/introduction">Web Socket Connections</a></strong> to query your database with low-latency web sockets</li> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/http-endpoints/transactions">Transactions Support</a></strong> for executing interdependent collections of queries</li> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/rest-api/introduction">REST API Support</a></strong> automatically included for interacting with your tables</li> <li><strong><a href="https://github.com/Brayden/starbasedb/edit/main/README.md#deploy-a-starbasedb">Database Interface</a></strong> included out of the box deployed with your Cloudflare Worker</li> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/import-export/sql-dump">Import & Export Data</a></strong> to import & extract your schema and data into a local `.sql`, `.json` or `.csv` file</li> <li><strong><a href="https://github.com/Brayden/starbasedb/pull/26">Bindable Microservices</a></strong> via templates to kickstart development and own the logic (e.g. user authentication)</li> <li><strong><a href="https://starbasedb.hashnode.space/default-guide/introduction/connect-external-database">Connect to External Databases</a></strong> such as Postgres and MySQL and access it with the methods above</li> <li><strong>Scale-to-zero Compute</strong> to reduce costs when your database is not in use</li> </ul> <br /> <p>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 <a href="https://starbasedb.com/blog/">on our blog</a>.</p> <br /> <h2>Roadmap</h2> <ul> <li><strong>Migrations</strong> for applying schema updates in safe sequential order</li> <li><strong>JWT Authentication</strong> template for quickly allowing user auth flows</li> <li><strong>Row Level Security (RLS)</strong> template for preventing data access on unauthorized rows</li> <li><strong>Point in Time Rollbacks</strong> for rolling back your database to any minute in the past 30 days</li> <li><strong>Data Replication</strong> to scale reads beyond the 1,000 RPS limitation</li> <li><strong>Data Syncing</strong> between local source and your database</li> <li><strong>Scheduled CRON Tasks</strong> to execute code at desired intervals</li> </ul> <br /> <p>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 <a href="https://github.com/Brayden/starbasedb/issues/new?assignees=&labels=&projects=&template=bug_report.md&title=">Bug Reports</a> and <a href="https://github.com/Brayden/starbasedb/issues/new?assignees=&labels=&projects=&template=feature_request.md&title=">Feature Requests</a> and each will be reviewed.</p> <br /> <h2>Deploy a StarbaseDB</h2> <p>Deploying a new SQLite database instance to a Cloudflare Durable Object can be done via a single command:</p>[!CAUTION] Outerbase has been acquired by Cloudflare. This repository will not be receiving any additional changes.
curl https://starbasedb.com/install.sh | bash
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
