Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

Task/support DIRECT_URL for Prisma CLI and seeding to support connection poolers (#6882)

Kenrick Tandrianbd2ca4aacdf7
diff --git a/.config/prisma.ts b/.config/prisma.ts
index a9e7bbf64d..4556ba3052 100644
--- a/.config/prisma.ts
+++ b/.config/prisma.ts
@@ -7,7 +7,7 @@ expand(config({ quiet: true }));
export default defineConfig({
datasource: {
- url: process.env.DATABASE_URL ?? ''
+ url: process.env.DIRECT_URL ?? process.env.DATABASE_URL
},
migrations: {
path: join(__dirname, '..', 'prisma', 'migrations'),
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d46d92da9b..1d696039ba 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## Unreleased
+### Added
+
+- Added support for the `DIRECT_URL` environment variable to enable direct database connections
+
### Changed
- Improved the pagination in the activities table of the holding detail dialog
diff --git a/README.md b/README.md
index 87710d610f..8557d4330d 100644
--- a/README.md
+++ b/README.md
@@ -85,26 +85,27 @@ We provide official container images hosted on [Docker Hub](https://hub.docker.c
### Supported Environment Variables
-| Name | Type | Default Value | Description |
-| --------------------------- | --------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
-| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
-| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
-| `DATABASE_URL` | `string` | | The database connection URL, e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}` |
-| `ENABLE_FEATURE_AUTH_TOKEN` | `boolean` (optional) | `true` | Enables authentication via security token |
-| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
-| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
-| `LOG_LEVELS` | `string[]` (optional) | | The logging levels for the Ghostfolio application, e.g. `["debug","error","log","warn"]` |
-| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
-| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
-| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
-| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
-| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
-| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
-| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
-| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
-| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
-| `ROOT_URL` | `string` (optional) | `http://0.0.0.0:3333` | The root URL of the Ghostfolio application, used for generating callback URLs and external links. |
+| Name | Type | Default Value | Description |
+| --------------------------- | --------------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `ACCESS_TOKEN_SALT` | `string` | | A random string used as salt for access tokens |
+| `API_KEY_COINGECKO_DEMO` | `string` (optional) |   | The _CoinGecko_ Demo API key |
+| `API_KEY_COINGECKO_PRO` | `string` (optional) | | The _CoinGecko_ Pro API key |
+| `DATABASE_URL` | `string` | | The database connection URL. If using a connection pooler, use the pooled connection URL here. e.g. `postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:5432/${POSTGRES_DB}` |
+| `DIRECT_URL` | `string` (optional) | | The direct database connection URL used by the _Prisma CLI_ (e.g. for schema migrations) and seeding, bypassing any connection poolers (falls back to `DATABASE_URL`) |
+| `ENABLE_FEATURE_AUTH_TOKEN` | `boolean` (optional) | `true` | Enables authentication via security token |
+| `HOST` | `string` (optional) | `0.0.0.0` | The host where the Ghostfolio application will run on |
+| `JWT_SECRET_KEY` | `string` | | A random string used for _JSON Web Tokens_ (JWT) |
+| `LOG_LEVELS` | `string[]` (optional) | | The logging levels for the Ghostfolio application, e.g. `["debug","error","log","warn"]` |
+| `PORT` | `number` (optional) | `3333` | The port where the Ghostfolio application will run on |
+| `POSTGRES_DB` | `string` | | The name of the _PostgreSQL_ database |
+| `POSTGRES_PASSWORD` | `string` | | The password of the _PostgreSQL_ database |
+| `POSTGRES_USER` | `string` | | The user of the _PostgreSQL_ database |
+| `REDIS_DB` | `number` (optional) | `0` | The database index of _Redis_ |
+| `REDIS_HOST` | `string` | | The host where _Redis_ is running |
+| `REDIS_PASSWORD` | `string` | | The password of _Redis_ |
+| `REDIS_PORT` | `number` | | The port where _Redis_ is running |
+| `REQUEST_TIMEOUT` | `number` (optional) | `2000` | The timeout of network requests to data providers in milliseconds |
+| `ROOT_URL` | `string` (optional) | `http://0.0.0.0:3333` | The root URL of the Ghostfolio application, used for generating callback URLs and external links. |
#### OpenID Connect OIDC (Experimental)
diff --git a/prisma/seed.mts b/prisma/seed.mts
index 4819e241e1..81f34d05a3 100644
--- a/prisma/seed.mts
+++ b/prisma/seed.mts
@@ -2,7 +2,7 @@ import { PrismaPg } from '@prisma/adapter-pg';
import { PrismaClient } from '@prisma/client';
const adapter = new PrismaPg({
- connectionString: process.env.DATABASE_URL
+ connectionString: process.env.DIRECT_URL ?? process.env.DATABASE_URL
});
const prisma = new PrismaClient({ adapter });