Skip to content

Update README to reflect changes in properties format #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
KoishiMoe wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to reflect changes in properties format #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ database = "MYSQL"
url = ""
username = ""
password = ""
properties = []
properties = {}
maxPoolSize = 10
connectionTimeout = 60000
```
Expand All @@ -44,7 +44,7 @@ database = "MARIADB"
url = ""
username = ""
password = ""
properties = []
properties = {}
maxPoolSize = 10
connectionTimeout = 60000
```
Expand All @@ -59,7 +59,7 @@ database = "POSTGRESQL"
url = ""
username = ""
password = ""
properties = []
properties = {}
maxPoolSize = 10
connectionTimeout = 60000
```
Expand All @@ -73,8 +73,16 @@ database = "SQLITE"

## Connector properties

For some databases, such as MySQL, you can provide properties to the database connector. For each property, add a string entry to the `properties` array.
For some databases, such as MySQL, you can provide properties to the database connector. For each property, you can specify the key and value in the `properties` field. For example, to set the timezone shift and legacy datetime code properties for MySQL, you would add the following to your Ledger config file:

```toml
properties = ["useJDBCCompliantTimezoneShift=true", "useLegacyDatetimeCode=false", "serverTimezone=UTC"]
properties = {useJDBCCompliantTimezoneShift = "true", useLegacyDatetimeCode = "false", serverTimezone = "UTC"}
```

Or alternative table format:
```toml
[database_extensions.properties]
useJDBCCompliantTimezoneShift = "true"
useLegacyDatetimeCode = "false"
serverTimezone = "UTC"
```