Skip to content

Commit

Permalink
docs: About external database driver
Browse files Browse the repository at this point in the history
  • Loading branch information
k1LoW committed Feb 12, 2025
1 parent 84baa5f commit ce3878f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -652,6 +652,14 @@ dsn: github://k1LoW/tbls/sample/mysql/schema.json
docPath: doc/schema
```
### External database driver
tbls can integrate with external database drivers. If an executable with the pattern `tbls-driver-*` is on the PATH, tbls will recognize the corresponding scheme.

For example, if you have an executable named `tbls-driver-foodb`, tbls will recognize the `foodb://` scheme.

`tbls-driver-foodb` receives the DSN at runtime via the environment variable `TBLS_DSN`. By outputting [schema.json](spec/tbls.schema.json_schema.json) via STDOUT, tbls will work with it.

### Document format

`format:` is used to change the document format.
Expand Down

0 comments on commit ce3878f

Please sign in to comment.