Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
cp-20 committed Jan 26, 2025
1 parent 387e9f3 commit db439f1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
2. [Get your table schema](#getting-table-schemas)
3. [Generate cache plan](#generate-cache-plan)
4. [Generate the driver](#generate-the-driver)
5. [Switch the driver](#switch-the-driver)

### Extractor

Expand Down Expand Up @@ -86,6 +87,15 @@ go run cli/*.go generate --plan isuc.yaml --schema schema.sql <dist>
- Set to `schema.sql` by default
- `<dist>` represents the destination folder (must exist) that the generated driver will be stored into

### Switch the driver

Rewrite the section of connecting to a database.

```diff
- db, err := sql.Open("mysql", {dsn})
+ db, err := sql.Open("mysql+cache", {dsn})
```

## Appendix


Expand Down

0 comments on commit db439f1

Please sign in to comment.