Skip to content

Commit

Permalink
馃摑 add configuration section on readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Odonno committed Apr 24, 2023
1 parent 080c743 commit 0ce5a01
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,3 +104,23 @@ You can scaffold a project using any of these templates using the following comm
```
surrealdb-migrations scaffold <TEMPLATE>
```

### Configuration

You can create a `.surrealdb` configuration file at the root of your project. This way you won't have to set the same configuration values every time.

```toml
[core]
path = "./tests-files"

[db]
url = "localhost:8000"
username = "root"
password = "root"
ns = "test"
db = "test"
```

In the `core` section, you can define the path to your schema/migration files, if it is not the current folder.

In the `db` section, you can define the values used to access your SurrealDB database. It can be the `url`, `username`, `password`, the namespace `ns` or the name of the database `db`.

0 comments on commit 0ce5a01

Please sign in to comment.