Skip to content

feat(export): stream database dumps with bounded pagination and optional R2 offload (#59) #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Yuvi1192p wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(export): stream database dumps with bounded pagination and optional R2 offload (#59) #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ window.onload = connectWebSocket
```

<h3>SQL Dump</h3>
You can request a `database_dump.sql` file that exports your database schema and data into a single file.
You can request a `database_dump.sql` file that exports your database schema and data into a single file. Dumps are streamed incrementally in bounded memory pages:

<pre>
<code>
Expand All @@ -243,6 +243,15 @@ curl --location 'https://starbasedb.YOUR-ID-HERE.workers.dev/export/dump' \
</code>
</pre>

For large databases, offload the dump directly to Cloudflare R2 storage without hitting worker execution time limits:

<pre>
<code>
curl --location 'https://starbasedb.YOUR-ID-HERE.workers.dev/export/dump?location=r2&callback=https://example.com/webhook' \
--header 'Authorization: Bearer ABC123'
</code>
</pre>

<h3>JSON Data Export</h3>
<pre>
<code>
Expand Down
Loading