Skip to content

Commit

Permalink
Updating docs by deprecating environment variables.
Browse files Browse the repository at this point in the history
  • Loading branch information
andream16 committed Dec 5, 2024
1 parent 2050e86 commit ea5812b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,8 @@ You can customise a component using the following environment variables:
| Environment Variable | Type | Required | Default | Possible Values |
|-------------------------------------|--------|-----------|--------------------------|--------------------------|
| SMITHY\_COMPONENT\_NAME | string | yes | - | - |
| SMITHY\_BACKEND\_STORE\_TYPE | string | yes | - | local, test, \*remote |
| SSMITHY\_BACKEND\_STORE\_DSN | string | no | smithy.db | \* |
| SMITHY\_LOG\_LEVEL | string | false | info, debug, warn, error |

For `local` development, an `SQLite` Backend Store Type will be used.

`Runners` can be supplied with `RunnerConfigOption`s to customise how a component runs.
In the following example you can see how we change the component name:

Expand All @@ -42,6 +38,16 @@ component.RunTarget(
)
```

For local development, a default `SQLite` Backend Store Type will be used. This can be customised with:

```go
component.RunTarget(
ctx,
sampleTarget{},
component.RunnerWithStorer(//a storer),
)
```

### Components

#### Target
Expand Down

0 comments on commit ea5812b

Please sign in to comment.