Overview
Use the ToolJet-hosted database to build apps faster, and manage your data with ease. ToolJet database require no setup and gives you a powerful user interface for managing your data.
Enabling the ToolJet Database for your instance
Requires:
- PostgREST server
- Additional configuration for ToolJet server
PostgREST Server
PostgREST is a standalone web server that turns your PostgreSQL database directly into queryable RESTful APIs which is utilized for Tooljet Database. This server only communicates with the ToolJet server and therefore does not need to be publicly exposed.
If you have openssl installed, you can run the following command openssl rand -hex 32 to generate the value for PGRST_JWT_SECRET.
If this parameter is not specified, then PostgREST refuses authentication requests.
Variable | Description |
|---|---|
| PGRST_JWT_SECRET | JWT token client provided for authentication |
| PGRST_DB_URI | database connection string for tooljet database |
| PGRST_LOG_LEVEL | info |
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
Please make sure that DB_URI is given in the format postgres://[USERNAME]:[PASSWORD]@[HOST]:[PORT]/[DATABASE]
Additional ToolJet server configuration
Variable | Description |
|---|---|
| TOOLJET_DB | Default value is tooljet_db |
| TOOLJET_DB_HOST | database host |
| TOOLJET_DB_USER | database username |
| TOOLJET_DB_PASS | database password |
| TOOLJET_DB_PORT | database port |
| PGRST_JWT_SECRET | JWT token client provided for authentication |
| PGRST_HOST | postgrest database host |
| TOOLJET_DB_BULK_UPLOAD_MAX_ROWS | Maximum rows allowed to bulk upload. Default value is 1000 |
| TOOLJET_DB_BULK_UPLOAD_MAX_CSV_FILE_SIZE_MB | Maximum file size of CSV for bulk upload. Default value is 5 MB |
If you intend to make changes in the above configuration. Please refer PostgREST configuration docs.
When this feature is enabled, the database name provided for TOOLJET_DB will be utilized to create a new database during server boot process in all of our production deploy setups.
In case you want to trigger it manually, use the command npm run db:create on ToolJet server.
Features
ToolJet database allows you to:
- Maintain tables of data in a secure database that's only accessible within your ToolJet organization.
- Edit, search, filter, sort, and filter data using a spreadsheet-like interface.
- Use the SQL editor to write and execute complex SQL queries directly on your ToolJet database, providing more advanced data manipulation and retrieval capabilities.
- Quickly build applications and write queries to interact with the ToolJet Database, just like any other datasource but without any setup.
- Export schema from the ToolJet Database to a JSON file.
- Uniquely identify each record in a table using Primary Keys, ensuring data integrity and enabling efficient querying and indexing.
- Establish relationships between tables using Foreign Keys, allowing you to create associations based on the Primary Key of one table and maintain referential integrity.
Accessing ToolJet Database
Once you log-in to your ToolJet account, from the left sidebar of the dashboard you can navigate to ToolJet Database.
The ToolJet Database is available on: ToolJet Cloud, Self-Host, and Enterprise Edition. You can manage your database and its data using the Database editor UI.
