Skip to content

feature/Add DATABASE_SCHEMA support for PostgreSQL #5368

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
azoz-w wants to merge 12 commits into
base: main
Choose a base branch
from
Open

feature/Add DATABASE_SCHEMA support for PostgreSQL #5368

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d2e0887
add schema selection on postgres config
Oct 24, 2025
eb9ee42
chore: remove logs and fix comments
Oct 24, 2025
43c142d
chore: remove logs and fix comments
Oct 24, 2025
7d09512
fix: md syntax error on CONTRIBUTING.md
Oct 24, 2025
b5f3e93
fix: linting error
Oct 25, 2025
4725d67
refactored the change and fixed minor issues
Oct 28, 2025
7c0116e
refactor for cleaner logic
Oct 29, 2025
2219277
fix UI issues for vector store setup
Oct 29, 2025
41faaff
Clean up: remove changes unrelated to PR scope
Oct 29, 2025
c560aec
Fix linting errors
Nov 2, 2025
7e9d3b1
Update .env.example
HenryHengZJ Nov 5, 2025
8076bd5
Update .env.example
HenryHengZJ Nov 5, 2025
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
1 change: 1 addition & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ Flowise support different environment variables to configure your instance. You
| DATABASE_USER | Database username (When DATABASE_TYPE is not sqlite) | String | |
| DATABASE_PASSWORD | Database password (When DATABASE_TYPE is not sqlite) | String | |
| DATABASE_NAME | Database name (When DATABASE_TYPE is not sqlite) | String | |
| DATABASE_SCHEMA | Database schema (When DATABASE_TYPE is postgres) | String | |
| DATABASE_SSL_KEY_BASE64 | Database SSL client cert in base64 (takes priority over DATABASE_SSL) | Boolean | false |
| DATABASE_SSL | Database connection overssl (When DATABASE_TYPE is postgre) | Boolean | false |
| SECRETKEY_PATH | Location where encryption key (used to encrypt/decrypt credentials) is saved | String | `your-path/Flowise/packages/server` |
Expand Down
1 change: 1 addition & 0 deletions docker/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ DATABASE_PATH=/root/.flowise
# DATABASE_PORT=5432
# DATABASE_HOST=""
# DATABASE_NAME=flowise
# DATABASE_SCHEMA: default,
# DATABASE_USER=root
# DATABASE_PASSWORD=mypassword
# DATABASE_SSL=true
Expand Down
2 changes: 2 additions & 0 deletions docker/docker-compose-queue-prebuilt.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ services:
- DATABASE_PORT=${DATABASE_PORT}
- DATABASE_HOST=${DATABASE_HOST}
- DATABASE_NAME=${DATABASE_NAME}
- DATABASE_SCHEMA=${DATABASE_SCHEMA}
- DATABASE_USER=${DATABASE_USER}
- DATABASE_PASSWORD=${DATABASE_PASSWORD}
- DATABASE_SSL=${DATABASE_SSL}
Expand Down Expand Up @@ -172,6 +173,7 @@ services:
- DATABASE_PORT=${DATABASE_PORT}
- DATABASE_HOST=${DATABASE_HOST}
- DATABASE_NAME=${DATABASE_NAME}
- DATABASE_SCHEMA=${DATABASE_SCHEMA}
- DATABASE_USER=${DATABASE_USER}
- DATABASE_PASSWORD=${DATABASE_PASSWORD}
- DATABASE_SSL=${DATABASE_SSL}
Expand Down
1 change: 1 addition & 0 deletions docker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ services:
- DATABASE_PORT=${DATABASE_PORT}
- DATABASE_HOST=${DATABASE_HOST}
- DATABASE_NAME=${DATABASE_NAME}
- DATABASE_SCHEMA=${DATABASE_SCHEMA}
- DATABASE_USER=${DATABASE_USER}
- DATABASE_PASSWORD=${DATABASE_PASSWORD}
- DATABASE_SSL=${DATABASE_SSL}
Expand Down
1 change: 1 addition & 0 deletions docker/worker/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ DATABASE_PATH=/root/.flowise
# DATABASE_PORT=5432
# DATABASE_HOST=""
# DATABASE_NAME=flowise
# # DATABASE_SCHEMA: default,
# DATABASE_USER=root
# DATABASE_PASSWORD=mypassword
# DATABASE_SSL=true
Expand Down
1 change: 1 addition & 0 deletions docker/worker/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ services:
- DATABASE_PORT=${DATABASE_PORT}
- DATABASE_HOST=${DATABASE_HOST}
- DATABASE_NAME=${DATABASE_NAME}
- DATABASE_SCHEMA=${DATABASE_SCHEMA}
- DATABASE_USER=${DATABASE_USER}
- DATABASE_PASSWORD=${DATABASE_PASSWORD}
- DATABASE_SSL=${DATABASE_SSL}
Expand Down
8 changes: 7 additions & 1 deletion packages/server/src/DataSource.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,20 +63,26 @@
})
break
case 'postgres':
const dbSchema = process.env.DATABASE_SCHEMA

Check failure on line 66 in packages/server/src/DataSource.ts

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest, 18.15.0) 

Unexpected lexical declaration in case block
Copy link
Contributor

@HenryHengZJ HenryHengZJ Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need to wrap these in curly brackets if using const

const isCustomSchema = dbSchema && dbSchema !== 'public'

Check failure on line 67 in packages/server/src/DataSource.ts

View workflow job for this annotation

GitHub Actions / build (ubuntu-latest, 18.15.0) 

Unexpected lexical declaration in case block
appDataSource = new DataSource({
type: 'postgres',
host: process.env.DATABASE_HOST,
port: parseInt(process.env.DATABASE_PORT || '5432'),
username: process.env.DATABASE_USER,
password: process.env.DATABASE_PASSWORD,
database: process.env.DATABASE_NAME,
...(isCustomSchema && { schema: dbSchema }), // set custom schema if provided
ssl: getDatabaseSSLFromEnv(),
synchronize: false,
migrationsRun: false,
entities: Object.values(entities),
migrations: postgresMigrations,
migrationsTableName: 'migrations',
Copy link
Contributor

@HenryHengZJ HenryHengZJ Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this necessary? can we use the default table name instead of hardcoding migrations as the table name

Copy link
Author

@azoz-w azoz-w Oct 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, im just completing the change as it seems a bit more larger. And ill refactor it better.

Thanks for the comment

extra: {
idleTimeoutMillis: 120000
idleTimeoutMillis: 120000,
// set the search_path for the migrations and queries to the desired schema
...(isCustomSchema && { options: `-c search_path=${dbSchema},public` })
},
logging: ['error', 'warn', 'info', 'log'],
logger: 'advanced-console',
Expand Down
2 changes: 2 additions & 0 deletions packages/server/src/commands/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ export abstract class BaseCommand extends Command {
DATABASE_PORT: Flags.string(),
DATABASE_HOST: Flags.string(),
DATABASE_NAME: Flags.string(),
DATABASE_SCHEMA: Flags.string(),
DATABASE_USER: Flags.string(),
DATABASE_PASSWORD: Flags.string(),
DATABASE_SSL: Flags.string(),
Expand Down Expand Up @@ -159,6 +160,7 @@ export abstract class BaseCommand extends Command {
if (flags.DATABASE_PORT) process.env.DATABASE_PORT = flags.DATABASE_PORT
if (flags.DATABASE_HOST) process.env.DATABASE_HOST = flags.DATABASE_HOST
if (flags.DATABASE_NAME) process.env.DATABASE_NAME = flags.DATABASE_NAME
if (flags.DATABASE_SCHEMA) process.env.DATABASE_SCHEMA = flags.DATABASE_SCHEMA
if (flags.DATABASE_USER) process.env.DATABASE_USER = flags.DATABASE_USER
if (flags.DATABASE_PASSWORD) process.env.DATABASE_PASSWORD = flags.DATABASE_PASSWORD
if (flags.DATABASE_SSL) process.env.DATABASE_SSL = flags.DATABASE_SSL
Expand Down
1 change: 1 addition & 0 deletions packages/server/src/enterprise/middleware/passport/SessionPersistance.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ export const initializeDBClientAndStore: any = () => {
user: process.env.DATABASE_USER,
password: process.env.DATABASE_PASSWORD,
database: process.env.DATABASE_NAME,
schema: process.env.DATABASE_SCHEMA,
ssl: getDatabaseSSLFromEnv()
})
return new pgSession({
Expand Down
Loading