-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reformat scopes command documentation
Reformat collections command documentation
- Loading branch information
Showing
3 changed files
with
138 additions
and
144 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
=== collections | ||
|
||
The `collections` commands are used to manage collections. | ||
|
||
==== `collections` | ||
|
||
Lists all of the collections in the active scope: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ travel-sample.inventory._default | ||
> collections | ||
โญโโโโฌโโโโโโโโโโโโโฌโโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ collection โ max_expiry โ cluster โ | ||
โโโโโผโโโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ landmark โ inherited โ local โ | ||
โ 1 โ hotel โ inherited โ local โ | ||
โ 2 โ airport โ inherited โ local โ | ||
โ 3 โ airline โ inherited โ local โ | ||
โ 4 โ route โ inherited โ local โ | ||
โฐโโโโดโโโโโโโโโโโโโดโโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
``` | ||
|
||
==== `collections create` | ||
|
||
Create a collection with the name supplied: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ my-bucket.my-scope._default | ||
> collections | ||
โญโโโโโโโโโโโโโฎ | ||
โ empty list โ | ||
โฐโโโโโโโโโโโโโฏ | ||
๐ค Charlie ๐ local in ๐ my-bucket.my-scope._default | ||
> collections create new-collection | ||
๐ค Charlie ๐ local in ๐ my-bucket.my-scope._default | ||
> collections | ||
โญโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ collection โ max_expiry โ cluster โ | ||
โโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ new-collection โ inherited โ local โ | ||
โฐโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
``` | ||
|
||
==== `collections drop` | ||
|
||
Drop the collection matching the name given: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ default.my-scope._default | ||
> collections | ||
โญโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ collection โ max_expiry โ cluster โ | ||
โโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ new-collection โ inherited โ local โ | ||
โฐโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
๐ค Charlie ๐ local in ๐ default.my-scope._default | ||
> collections drop new-collection | ||
๐ค Charlie ๐ local in ๐ default.my-scope._default | ||
> collections | ||
โญโโโโโโโโโโโโโฎ | ||
โ empty list โ | ||
โฐโโโโโโโโโโโโโฏ | ||
``` |
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,73 @@ | ||
=== scopes | ||
|
||
The `scopes` commands are used to manage scopes. | ||
|
||
==== `scopes` | ||
|
||
Lists all of the scopes in the active bucket: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ travel-sample._default._default | ||
> scopes | ||
โญโโโโฌโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ scope โ cluster โ | ||
โโโโโผโโโโโโโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ inventory โ local โ | ||
โ 1 โ tenant_agent_00 โ local โ | ||
โ 2 โ tenant_agent_01 โ local โ | ||
โ 3 โ tenant_agent_02 โ local โ | ||
โ 4 โ tenant_agent_03 โ local โ | ||
โ 5 โ tenant_agent_04 โ local โ | ||
โ 6 โ _default โ local โ | ||
โฐโโโโดโโโโโโโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
``` | ||
|
||
|
||
==== `scopes create` | ||
|
||
Creates a scope with the name supplied: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes | ||
โญโโโโฌโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ scope โ cluster โ | ||
โโโโโผโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ _default โ local โ | ||
โฐโโโโดโโโโโโโโโโโดโโโโโโโโโโฏ | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes create new-scope | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes | ||
โญโโโโฌโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ scope โ cluster โ | ||
โโโโโผโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ new-scope โ local โ | ||
โ 1 โ _default โ local โ | ||
โฐโโโโดโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
``` | ||
|
||
==== `scopes drop` | ||
|
||
|
||
Deletes the scope matching the given name: | ||
|
||
``` | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes | ||
โญโโโโฌโโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ scope โ cluster โ | ||
โโโโโผโโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ new-scope โ local โ | ||
โ 1 โ _default โ local โ | ||
โฐโโโโดโโโโโโโโโโโโดโโโโโโโโโโฏ | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes drop new-scope | ||
๐ค Charlie ๐ local in ๐ default._default._default | ||
> scopes | ||
โญโโโโฌโโโโโโโโโโโฌโโโโโโโโโโฎ | ||
โ # โ scope โ cluster โ | ||
โโโโโผโโโโโโโโโโโผโโโโโโโโโโค | ||
โ 0 โ _default โ local โ | ||
โฐโโโโดโโโโโโโโโโโดโโโโโโโโโโฏ | ||
``` |