# SQL Config File

| Variable                                                | Description                                                                                                                                                               | Type                                         | Default                                                          |
| ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | ---------------------------------------------------------------- |
| <mark style="color:red;">filePathOrConnectionURI</mark> | File Path Where You Want Your Database File (package.json is referenced) Or PostgreSQL Connection URI, For Example; ***postgresql://user:pass\@localhost:5432/database*** | <mark style="color:blue;">**String**</mark>  | <mark style="background-color:red;">**./database.sqlite**</mark> |
| <mark style="color:red;">databaseType</mark>            | Specify Database Type, Supported Database Types "**postgre**", "**sqlite**"                                                                                               | <mark style="color:blue;">**String**</mark>  | <mark style="background-color:red;">**sqlite**</mark>            |
| <mark style="color:red;">databaseEngine</mark>          | Database Engine Type, Currently Supported "**InnoDB**"                                                                                                                    | <mark style="color:blue;">**String**</mark>  | <mark style="background-color:red;">**InnoDB**</mark>            |
| <mark style="color:red;">ssl</mark>                     | SSL Connection Status Setting                                                                                                                                             | <mark style="color:blue;">**Boolean**</mark> | <mark style="background-color:red;">**false**</mark>             |
| <mark style="color:red;">pool</mark>                    | PostgreSQL Pool Structure Settings, You Can Access the Settings from the Row Below.                                                                                       | <mark style="color:blue;">**Object**</mark>  | <mark style="background-color:red;">**default**</mark>           |
| <mark style="color:red;">connectionAlert</mark>         | Notification in Console When Database is Ready                                                                                                                            | <mark style="color:blue;">**Boolean**</mark> | <mark style="background-color:red;">**true**</mark>              |
| <mark style="color:red;">backup</mark>                  | Backing Up the Database File                                                                                                                                              | <mark style="color:blue;">**Boolean**</mark> | <mark style="background-color:red;">**false**</mark>             |
| <mark style="color:red;">backupPath</mark>              | File Path to Save the Backup File (package.json is referenced)                                                                                                            | <mark style="color:blue;">**String**</mark>  | <mark style="background-color:red;">**./backup.sqlite**</mark>   |
| <mark style="color:red;">backupInterval</mark>          | How Long Does It Take to Get a Backup (in Milliseconds)                                                                                                                   | <mark style="color:blue;">**Number**</mark>  | <mark style="background-color:red;">**3600000**</mark>           |
| <mark style="color:red;">backupAlert</mark>             | Notification on the Console When a Backup is Taken                                                                                                                        | <mark style="color:blue;">**Boolean**</mark> | <mark style="background-color:red;">**true**</mark>              |

## Pool Options ( For PostgreSQL )

| Variable                                | Description           | Type                                        | Default                                              |
| --------------------------------------- | --------------------- | ------------------------------------------- | ---------------------------------------------------- |
| <mark style="color:red;">acquire</mark> | Pool Acquire Settings | <mark style="color:blue;">**Number**</mark> | <mark style="background-color:red;">**60000**</mark> |
| <mark style="color:red;">idle</mark>    | Pool Idle Settings    | <mark style="color:blue;">**Number**</mark> | <mark style="background-color:red;">**10000**</mark> |
| <mark style="color:red;">max</mark>     | Pool Max Settings     | <mark style="color:blue;">**Number**</mark> | <mark style="background-color:red;">**5**</mark>     |
| <mark style="color:red;">min</mark>     | Pool Min Settings     | <mark style="color:blue;">**Number**</mark> | <mark style="background-color:red;">**0**</mark>     |
| <mark style="color:red;">evict</mark>   | Pool Evict Settings   | <mark style="color:blue;">**Number**</mark> | <mark style="background-color:red;">**1000**</mark>  |

```json
{
  "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
}
```