docs: add basic docs for KeyValueRepository #1654
Conversation
docs/site/Repositories.md
Outdated
| ### Define a KeyValue Datasource | ||
|
|
||
| We first need to define a datasource to configure the key-value store. For | ||
| better flexibility, we spilt the datasource definition into two files. |
There was a problem hiding this comment.
As a reader I'm left wondering where is the flexibility? Is this covered in this doc somewhere before this point? If not we may want to mention that the flexibility comes from being able to inject the config into the DataSource class.
There was a problem hiding this comment.
typo: spilt change to split or splited ?
There was a problem hiding this comment.
Good catch. Will fix.
docs/site/Repositories.md
Outdated
| ### Define a KeyValueRepository | ||
|
|
||
| The KeyValueRepository binds a model such as `ShoppingCart` to the | ||
| `RedisDataSource`. The base `DefaultKeyValueRepository` provides an |
docs/site/Repositories.md
Outdated
| testKV(); | ||
| ``` | ||
|
|
||
| [keyvaluerepository]: |
There was a problem hiding this comment.
Oh, this would explain the broken links above, this should be KeyValueRepository.
There was a problem hiding this comment.
Argh, prettier converts it to be lower case :-(.
docs/site/Repositories.md
Outdated
| ## Persisting Data without Juggler [Using MySQL database] | ||
| ## Access KeyValue Stores | ||
|
|
||
| We can now access key-value stores such as [redis](Redis) using the |
docs/site/Repositories.md
Outdated
| ### Perform Key Value Operations | ||
|
|
||
| The KeyValueRepository provides a set of key based operations, such as `set`, | ||
| `get`, `delete`, `expire`, `ttl`, and `keys`. See [KeyValueRepository] for a |
There was a problem hiding this comment.
See [KeyValueRepository] for a
Missing link?
There was a problem hiding this comment.
Fix this before landing this PR.
raymondfeng
force-pushed
the
add-kv-docs
branch
from
9c14ab4 to
fe4eca9
Compare
|
Comments addressed. PTAL. |
raymondfeng
force-pushed
the
add-kv-docs
branch
from
fe4eca9 to
7059eee
Compare
| better flexibility, we spilt the datasource definition into two files. The json | ||
| file captures the configuration properties and it can be possibly overridden by | ||
| dependency injection. | ||
|
|
There was a problem hiding this comment.
sorry to chime in, but wouldn't be good to add the following NOTE?. Especially for new LB4 adopters?
NOTE:
The prefix redis is related to the name of the data source, so you can use any name you want here. Usually you use lb4 datasource name to generate it, where name is the prefix mentioned above.
There was a problem hiding this comment.
The effective name is from https://github.com/strongloop/loopback4-example-shopping/blob/master/src/datasources/redis.datasource.json#L2 and the file name should not matter.
There was a problem hiding this comment.
👍 I didn't notice the context of the example-shopping.
Add basic docs for
KeyValueRepository]using loopbackio/loopback4-example-shopping#4 as an example.Checklist
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated