Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme with new profile options
Browse files Browse the repository at this point in the history
kzajaczkowski committed Apr 25, 2024
1 parent 5261e70 commit bf9f2ae
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -86,17 +86,21 @@ your_profile_name:
username: your_mysql_username
password: your_mysql_password
ssl_disabled: True
charset: utf8mb4
collation: utf8mb4_0900_ai_ci
```

| Option | Description | Required? | Example |
| --------------- | ----------------------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------------------- |
| type | The specific adapter to use | Required | `mysql`, `mysql5` or `mariadb` |
| type | The specific adapter to use | Required | `mysql`, `mysql5` or `mariadb` |
| server | The server (hostname) to connect to | Required | `yourorg.mysqlhost.com` |
| port | The port to use | Optional | `3306` |
| schema | Specify the schema (database) to build models into | Required | `analytics` |
| username | The username to use to connect to the server | Required | `dbt_admin` |
| password | The password to use for authenticating to the server | Required | `correct-horse-battery-staple` |
| ssl_disabled | Set to enable or disable TLS connectivity to mysql5.x | Optional | `True` or `False` |
| charset | Specify charset to be used by a connection | Optional | `utf8mb4` |
| collation | Set to enable or disable TLS connectivity to mysql5.x | Optional | `utf8mb4_0900_ai_ci` |

### Notes

0 comments on commit bf9f2ae

Please sign in to comment.