Skip to content

Commit 3fe169b

Browse files
oleg-jukovecDifferentialOrange
authored andcommitted
readme: focus on VShard instead of Cartridge
Part of #366
1 parent d18ad41 commit 3fe169b

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1515
You could to specify an environment variable `CARTIRDGE_VERSION` to install
1616
the `cartridge` and run tests cases with it.
1717
* Return explicit error for `*_many` call with no tuples/objects (#377).
18+
* Quickstart section in the README.md focuses on usage with `vshard` instead of
19+
`Cartridge` (#366).
1820

1921
### Fixed
2022
* `crud.readview` resource cleanup on garbage collect (#379).

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ project:
7171
```shell
7272
$ tt rocks install crud
7373
```
74-
75-
And add the [initialization code](#API) to storage and router instance files.
74+
* Add the [crud initialization code](#API) to router and storage instances
75+
initialization code for [VShard](https://github.com/tarantool/vshard).
7676
* Add crud into dependencies of a Cartridge application and add crud roles into
7777
dependencies of your roles (see [Cartridge roles](#cartridge-roles) section).
7878
* Add crud into dependencies of your application (rockspec, RPM spec -- depends
@@ -82,12 +82,19 @@ project:
8282
## API
8383

8484
The CRUD operations should be called from router.
85-
All storage replica sets should call `crud.init_storage()`
86-
(or enable the `crud-storage` role)
85+
86+
All VShard storages should call `crud.init_storage()` after
87+
`vshard.storage.cfg()` (or enable the `crud-storage` role for Cartridge)
8788
first to initialize storage-side functions that are used to manipulate data
8889
across the cluster.
89-
All routers should call `crud.init_router()` (or enable the `crud-router` role)
90-
to make `crud` functions callable via `net.box`.
90+
91+
All VShard routers should call `crud.init_router()` after `vshard.router.cfg()`
92+
(or enable the `crud-router` role for Cartridge) to make `crud` functions
93+
callable via `net.box`.
94+
95+
You can check out an example of the configuration for local development
96+
(a single instance that combines router and storage) in
97+
[playground.lua](./doc/playground.lua).
9198

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

0 commit comments

Comments
 (0)