Skip to content

Commit

Permalink
readme: focus on VShard instead of Cartridge
Browse files Browse the repository at this point in the history
Part of #366
  • Loading branch information
oleg-jukovec committed Oct 12, 2023
1 parent bbe1bd5 commit 05cf67a
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
You could to specify an environment variable `CARTIRDGE_VERSION` to install
the `cartridge` and run tests cases with it.
* Return explicit error for `*_many` call with no tuples/objects (#377).
* Quickstart section in the README.md focuses on usage with `vshard` instead of
`Cartridge` (#366).

### Fixed
* `crud.readview` resource cleanup on garbage collect (#379).
Expand Down
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ project:
```shell
$ tt rocks install crud
```

And add the [initialization code](#API) to storage and router instance files.
* Add the [crud initialization code](#API) to router and storage instances
initialization code for [VShard](https://github.com/tarantool/vshard).
* Add crud into dependencies of a Cartridge application and add crud roles into
dependencies of your roles (see [Cartridge roles](#cartridge-roles) section).
* Add crud into dependencies of your application (rockspec, RPM spec -- depends
Expand All @@ -82,12 +82,19 @@ project:
## API

The CRUD operations should be called from router.
All storage replica sets should call `crud.init_storage()`
(or enable the `crud-storage` role)

All VShard storages should call `crud.init_storage()` after
`vshard.storage.cfg()` (or enable the `crud-storage` role for Cartridge)
first to initialize storage-side functions that are used to manipulate data
across the cluster.
All routers should call `crud.init_router()` (or enable the `crud-router` role)
to make `crud` functions callable via `net.box`.

All VShard routers should call `crud.init_router()` after `vshard.router.cfg()`
(or enable the `crud-router` role for Cartridge) to make `crud` functions
callable via `net.box`.

You can check out an example of the configuration for local development
(a single instance that combines router and storage) in
[playground.lua](./doc/playground.lua).

All operations return a table that contains rows (tuples) and metadata
(space format).
Expand Down

0 comments on commit 05cf67a

Please sign in to comment.