https://github.com/neurocode-io/d1-manager

https://github.com/neurocode-io/d1-manager

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/neurocode-io/d1-manager
• Owner: neurocode-io
• License: mit
• Created: 2023-12-22T18:38:06.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2023-12-22T19:47:50.000Z (11 months ago)
• Last Synced: 2023-12-22T20:55:20.752Z (11 months ago)
• Language: Svelte
• Size: 5.29 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# D1 Manager

D1 Manager is a web UI and API for Cloudflare D1, a serverless SQL database. It provides a user-friendly interface for managing databases, tables, and records, as well as an API for performing operations programmatically. D1 Manager simplifies database management, enabling users to focus on their data.

[![semantic-query-demo](./images/semantic-query-demo.gif)](https://storage.jacoblin.cool/semantic-query-demo.mp4)

## Features

-   [x] Multiple D1 Databases

-   [x] List all tables in a database

-   [x] Show table schema

-   [x] Run SQL queries

-   [x] Run Semantic Queries (with `OPENAI_API_KEY` env var set)

-   [x] Edit table data through UI

-   [x] I18n support (English, Chinese) [add more](./locales/)

-   [x] API support (see [routes/api](./src/routes/api/) for details)

## Setup

1. Fork this repo

2. Setup a **Cloudflare Pages** with the forked repo

3. Use **Cloudflare Access** to protect the your site

4. **Bind databases** to `DB_*` environment variables

![bind-d1](./images/bind-d1.png)

> Note: You can bind multiple databases to the manager. In theis example, `DB` will be `default` in the UI, and `DB_test` will be `test`.

### Environment Variables

Some plugins (e.g. Semantic Query) require additional environment variables to be set.

![set-env-var](./images/set-env-var.png)

Also, there are some configuration options that can be set through environment variables.

-   `SHOW_INTERNAL_TABLES`: Show internal tables (`splite_*` and `d1_*`) in the UI.

-   `OPENAI_API_KEY`: OpenAI API key for Semantic Query.

-   `OPENAI_API_URL`: You may use this with Cloudflare AI Gateway to proxy requests to OpenAI API.

## Screenshots

![tables](./images/tables.png)

![run-query](./images/run-query.png)

![table-browser](./images/table-browser.png)

![add-record](./images/add-record.png)

![semantic-query](./images/semantic-query.png)

> Semantic Query uses OpenAI GPT-3.5 Turbo to translate natural language queries into SQL.