🪝SQL Config File

Variable
Description
Type
Default

filePathOrConnectionURI

File Path Where You Want Your Database File (package.json is referenced) Or PostgreSQL Connection URI, For Example; postgresql://user:pass@localhost:5432/database

String

./database.sqlite

databaseType

Specify Database Type, Supported Database Types "postgre", "sqlite"

String

sqlite

databaseEngine

Database Engine Type, Currently Supported "InnoDB"

String

InnoDB

ssl

SSL Connection Status Setting

Boolean

false

pool

PostgreSQL Pool Structure Settings, You Can Access the Settings from the Row Below.

Object

default

connectionAlert

Notification in Console When Database is Ready

Boolean

true

backup

Backing Up the Database File

Boolean

false

backupPath

File Path to Save the Backup File (package.json is referenced)

String

./backup.sqlite

backupInterval

How Long Does It Take to Get a Backup (in Milliseconds)

Number

3600000

backupAlert

Notification on the Console When a Backup is Taken

Boolean

true

Pool Options ( For PostgreSQL )

Variable
Description
Type
Default

acquire

Pool Acquire Settings

Number

60000

idle

Pool Idle Settings

Number

10000

max

Pool Max Settings

Number

5

min

Pool Min Settings

Number

0

evict

Pool Evict Settings

Number

1000

{
  "filePathOrConnectionURI": "./database.sqlite",
  "databaseType": "sqlite",
  "databaseEngine": "InnoDB",
  "ssl": false,
  "pool": {
    "acquire": 60000,
    "idle": 10000,
    "max": 5,
    "min": 0,
    "evict": 1000
  },
  "connectionAlert": true,
  "backup": false,
  "backupPath": "./backup.sqlite",
  "backupInterval": 3600000,
  "backupAlert": false
}

Last updated