mohiit1502/Automata
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

⚡️ Revamp the docs

Browse Source 
Reflect support for MariaDB in docs
This commit is contained in:
Tanay Pant
2020-04-15 15:36:15 +02:00
parent 303062623b
commit 50bebe1b8a
18 changed files with 167 additions and 173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/database.md
View File

@@ -1,7 +1,7 @@
# Database
By default, n8n uses SQLite to save credentials, past executions, and workflows.
n8n however also supports MongoDB and PostgresDB.
By default, n8n uses SQLite to save credentials, past executions, and workflows. However,
n8n also supports MongoDB and PostgresDB.
## Shared Settings
@@ -13,12 +13,12 @@ The following environment variables get used by all databases:
## MongoDB
!> **WARNING**: Use Postgres if possible! Mongo has problems with saving large
amounts of data in a document and causes also other problems. So support will
!> **WARNING**: Use PostgresDB, if possible! MongoDB has problems saving large
amounts of data in a document, among other issues. So, support
may be dropped in the future.
To use MongoDB as database you can provide the following environment variables like
in the example bellow:
To use MongoDB as the database, you can provide the following environment variables like
in the example below:
- `DB_TYPE=mongodb`
- `DB_MONGODB_CONNECTION_URL=<CONNECTION_URL>`
@@ -38,7 +38,7 @@ n8n start
## PostgresDB
To use PostgresDB as database you can provide the following environment variables
To use PostgresDB as the database, you can provide the following environment variables
- `DB_TYPE=postgresdb`
- `DB_POSTGRESDB_DATABASE` (default: 'n8n')
- `DB_POSTGRESDB_HOST` (default: 'localhost')
@@ -62,7 +62,7 @@ n8n start
## MySQL / MariaDB
The compatibility with MySQL/MariaDB was tested, even so, it is advisable to observe the operation of the application with this DB, as it is a new option, recently added. If you spot any problems, feel free to submit a PR.
The compatibility with MySQL/MariaDB has been tested. Even then, it is advisable to observe the operation of the application with this database as this option has been recently added. If you spot any problems, feel free to submit a burg report or a pull request.
To use MySQL as database you can provide the following environment variables:
- `DB_TYPE=mysqldb` or `DB_TYPE=mariadb`
@@ -86,7 +86,7 @@ n8n start
## SQLite
The default database which gets used if no other one is defined.
This is the default database that gets used if nothing is defined.
The database file is located at:
`~/.n8n/database.sqlite`
@@ -94,17 +94,16 @@ The database file is located at:
## Other Databases
Currently, only the above databases are supported. n8n uses internally
[TypeORM](https://typeorm.io) so adding support for the following databases
Currently, only the databases mentioned above are supported. n8n internally uses
[TypeORM](https://typeorm.io), so adding support for the following databases
should not be too much work:
- CockroachDB
- MariaDB
- Microsoft SQL
- Oracle
If you can not use any of the currently supported databases for some reason and
you can program, you can simply add support by yourself. If not you can request
that support should be added here:
If you cannot use any of the currently supported databases for some reason and
you can code, we'd appreciate your support in the form of a pull request. If not, you can request
for support here:
[https://community.n8n.io/c/feature-requests/cli](https://community.n8n.io/c/feature-requests/cli)