-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #165 from dojoengine/edits
components to models
- Loading branch information
Showing
4 changed files
with
73 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
# models | ||
|
||
## sozo model | ||
|
||
`model` is used to interact with a World's models. It is useful for querying about a model's information, or a model value of an entity. | ||
|
||
### USAGE | ||
|
||
```sh | ||
sozo model <COMMAND> | ||
|
||
Commands: | ||
get Get the class hash of a model | ||
schema Retrieve the schema for a model | ||
entity Get the model value for an entity | ||
``` | ||
|
||
### SUBCOMMANDS | ||
|
||
#### `get` | ||
|
||
Get the class hash of a model | ||
|
||
```sh | ||
sozo model get <NAME> | ||
``` | ||
|
||
##### Arguments | ||
|
||
_`NAME`_ | ||
The name of the model | ||
|
||
#### `schema` | ||
|
||
Retrieve the schema for a model | ||
|
||
```sh | ||
sozo model schema <NAME> | ||
``` | ||
|
||
##### Arguments | ||
|
||
_`NAME`_ | ||
The name of the model | ||
|
||
#### `entity` | ||
|
||
Get the model value for an entity | ||
|
||
```sh | ||
sozo model entity <NAME> [KEYS]... | ||
``` | ||
|
||
##### Arguments | ||
|
||
_`NAME`_ | ||
The name of the model | ||
|
||
_`KEYS`_ | ||
The keys of the entity that you want to query. | ||
Comma separated values e.g., 0x12345,0x69420,... | ||
|
||
### OPTIONS | ||
|
||
#### World Options | ||
|
||
{{#include ../common/world-options.md}} | ||
|
||
#### Starknet Options | ||
|
||
{{#include ../common/starknet-options.md}} |