Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase/dbdev
Database Package Registry for Postgres
https://github.com/supabase/dbdev
extensions postgres postgresql
Last synced: 2 days ago
JSON representation
Database Package Registry for Postgres
- Host: GitHub
- URL: https://github.com/supabase/dbdev
- Owner: supabase
- License: apache-2.0
- Created: 2022-01-17T21:35:49.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T04:51:43.000Z (4 months ago)
- Last Synced: 2024-10-29T14:38:38.186Z (3 months ago)
- Topics: extensions, postgres, postgresql
- Language: PLpgSQL
- Homepage: https://database.dev/
- Size: 4.28 MB
- Stars: 370
- Watchers: 25
- Forks: 20
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - supabase/dbdev - Database Package Registry for Postgres (PLpgSQL)
README
# dbdev
dbdev is a package manager for Postgres [trusted language extensions (TLE)](https://github.com/aws/pg_tle).
- Search for packages on [database.dev](https://database.dev).
- Documentation: [supabase.github.io/dbdev/](https://supabase.github.io/dbdev/)
- Publish your own Extension: [supabase.github.io/dbdev/publish-extension/](https://supabase.github.io/dbdev/publish-extension/)
- Read the dbdev [release blog post](https://supabase.com/blog/dbdev)
### Warning
Restoring a logical backup of a database with a TLE installed can fail. For this reason, dbdev should only be used with databases with physical backups enabled.
## Usage
Users primarily interact with the registry using the dbdev SQL client. Once present, packages can be installed as follows:
```sql
-- Load the package from the package index
select dbdev.install('olirice-index_advisor');
```
Where `olirice` is the handle of the publisher and `index_advisor` is the name of the package.
Once installed, packages are visible in PostgreSQL as extensions. At that point they can be enabled with standard Postgres commands i.e. the `create extension`
To improve reproducibility, we recommend __always__ specifying the package version in your `create extension` statements.
For example:
```sql
-- Enable the extension
create extension "olirice-index_advisor"
version '0.1.0';
```
Which creates all tables/indexes/functions/etc specified by the extension.
## Install the Client in Postgres
The in-database SQL client for the package registry is named `dbdev`. You can bootstrap the client with:
```sql
/*---------------------
---- install dbdev ----
----------------------
Requires:
- pg_tle: https://github.com/aws/pg_tle
- pgsql-http: https://github.com/pramsey/pgsql-http
*/
create extension if not exists http with schema extensions;
create extension if not exists pg_tle;
drop extension if exists "supabase-dbdev";
select pgtle.uninstall_extension_if_exists('supabase-dbdev');
select
pgtle.install_extension(
'supabase-dbdev',
resp.contents ->> 'version',
'PostgreSQL package manager',
resp.contents ->> 'sql'
)
from http(
(
'GET',
'https://api.database.dev/rest/v1/'
|| 'package_versions?select=sql,version'
|| '&package_name=eq.supabase-dbdev'
|| '&order=version.desc'
|| '&limit=1',
array[
('apiKey', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6InhtdXB0cHBsZnZpaWZyYndtbXR2Iiwicm9sZSI6ImFub24iLCJpYXQiOjE2ODAxMDczNzIsImV4cCI6MTk5NTY4MzM3Mn0.z2CN0mvO2No8wSi46Gw59DFGCTJrzM0AQKsu_5k134s')::http_header
],
null,
null
)
) x,
lateral (
select
((row_to_json(x) -> 'content') #>> '{}')::json -> 0
) resp(contents);
create extension "supabase-dbdev";
select dbdev.install('supabase-dbdev');
drop extension if exists "supabase-dbdev";
create extension "supabase-dbdev";
```
With the client ready, search for packages on [database.dev](database.dev) and install them
```sql
select dbdev.install('handle-package_name');
create extension "handle-package_name"
schema 'public'
version '1.2.3';
```
## Developers
The [`supabase/dbdev`](https://github.com/supabase/dbdev) repository hosts the source code for both the database.dev package registry and its accompanying website. It also hosts the work-in-progress CLI for authors manage their packages.
### Package Registry
The package registry `supabase/`, is a [Supabase](https://supabase.com) project where accounts, organizations, and packages are normalized into database tables. For more info of the registry, see the [architecture](#architecture) section
Requires:
- [Supabase CLI](https://github.com/supabase/cli)
- [docker](https://www.docker.com/)
```
supabase start
```
which returns a set of endpoints for each service
```text
supabase local development setup is running.
API URL: http://localhost:54321
GraphQL URL: http://localhost:54321/graphql/v1
DB URL: postgresql://postgres:postgres@localhost:54322/postgres
Studio URL: http://localhost:54323
Inbucket URL: http://localhost:54324
JWT secret: SECRET
anon key: KEY
service_role key: KEY
```
The *API URL* and *anon key* values will be used in the next section to setup environment variables.
### Website (database.dev)
The website/ directory contains a Next.js project, which serves as the visual interface for users to interact with the registry.
Requires:
- [node 14+](https://nodejs.org/en)
Copy `.env.example` file to `.env.local`:
```
cp .env.example .env.local
```
Edit the `.env.local` file with your favourite text editor to set the environment variables `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY`:
```
NEXT_PUBLIC_SUPABASE_URL=""
NEXT_PUBLIC_SUPABASE_ANON_KEY=""
```
Start the development environment:
```
cd website
npm install
npm run dev
```
Navigate to [http://localhost:3000](http://localhost:3000)
### CLI
Coming soon in the `cli/` directory
### Architecture
- The core tables are located in the `app` schema.
- The public API is located in the `public` schema.
