Skip to content

Commit

Permalink
PR(ACP-DOCS): Update Docs To Adjust For Identity
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzadlone committed Mar 5, 2024
1 parent 53db200 commit 7c8a5d7
Show file tree
Hide file tree
Showing 6 changed files with 50 additions and 29 deletions.
2 changes: 1 addition & 1 deletion docs/cli/defradb_client_acp_policy_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ defradb client acp policy add [-i --identity] [policy] [flags]
```
-f, --file string File to load a policy from
-h, --help help for add
-i, --identity string [Required] Signature identity of the creator
-i, --identity string [Required] Identity of the creator
```

### Options inherited from parent commands
Expand Down
18 changes: 11 additions & 7 deletions docs/cli/defradb_client_collection_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,32 @@ Create a new document.

Create a new document.

Example: create from string
Example: create from string:
defradb client collection create --name User '{ "name": "Bob" }'

Example: create multiple from string
Example: create from string, with identity:
defradb client collection create -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j --name User '{ "name": "Bob" }'

Example: create multiple from string:
defradb client collection create --name User '[{ "name": "Alice" }, { "name": "Bob" }]'

Example: create from file
Example: create from file:
defradb client collection create --name User -f document.json

Example: create from stdin
Example: create from stdin:
cat document.json | defradb client collection create --name User -


```
defradb client collection create <document> [flags]
defradb client collection create [-i --identity] <document> [flags]
```

### Options

```
-f, --file string File containing document(s)
-h, --help help for create
-f, --file string File containing document(s)
-h, --help help for create
-i, --identity string Identity of the actor
```

### Options inherited from parent commands
Expand Down
18 changes: 11 additions & 7 deletions docs/cli/defradb_client_collection_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,27 @@ Delete documents by docID or filter.

Delete documents by docID or filter and lists the number of documents deleted.

Example: delete by docID(s)
defradb client collection delete --name User --docID bae-123,bae-456
Example: delete by docID(s):
defradb client collection delete --name User --docID bae-123,bae-456

Example: delete by filter
Example: delete by docID(s) with identity:
defradb client collection delete -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j --name User --docID bae-123,bae-456

Example: delete by filter:
defradb client collection delete --name User --filter '{ "_gte": { "points": 100 } }'


```
defradb client collection delete [--filter <filter> --docID <docID>] [flags]
defradb client collection delete [-i --identity] [--filter <filter> --docID <docID>] [flags]
```

### Options

```
--docID strings Document ID
--filter string Document filter
-h, --help help for delete
--docID strings Document ID
--filter string Document filter
-h, --help help for delete
-i, --identity string Identity of the actor
```

### Options inherited from parent commands
Expand Down
10 changes: 7 additions & 3 deletions docs/cli/defradb_client_collection_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,21 @@ View document fields.

Example:
defradb client collection get --name User bae-123

Example to get a private document we must use an identity:
defradb client collection get -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j --name User bae-123


```
defradb client collection get <docID> [--show-deleted] [flags]
defradb client collection get [-i --identity] [--show-deleted] <docID> [flags]
```

### Options

```
-h, --help help for get
--show-deleted Show deleted documents
-h, --help help for get
-i, --identity string Identity of the actor
--show-deleted Show deleted documents
```

### Options inherited from parent commands
Expand Down
21 changes: 13 additions & 8 deletions docs/cli/defradb_client_collection_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,34 @@ Update documents by docID or filter.

Update documents by docID or filter.

Example: update from string
Example: update from string:
defradb client collection update --name User --docID bae-123 '{ "name": "Bob" }'

Example: update by filter
Example: update by filter:
defradb client collection update --name User \
--filter '{ "_gte": { "points": 100 } }' --updater '{ "verified": true }'

Example: update by docIDs
Example: update by docIDs:
defradb client collection update --name User \
--docID bae-123,bae-456 --updater '{ "verified": true }'

Example: update private docIDs, with identity:
defradb client collection update -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j --name User \
--docID bae-123,bae-456 --updater '{ "verified": true }'


```
defradb client collection update [--filter <filter> --docID <docID> --updater <updater>] <document> [flags]
defradb client collection update [-i --identity] [--filter <filter> --docID <docID> --updater <updater>] <document> [flags]
```

### Options

```
--docID strings Document ID
--filter string Document filter
-h, --help help for update
--updater string Document updater
--docID strings Document ID
--filter string Document filter
-h, --help help for update
-i, --identity string Identity of the actor
--updater string Document updater
```

### Options inherited from parent commands
Expand Down
10 changes: 7 additions & 3 deletions docs/cli/defradb_client_query.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ A query request can be sent as a single argument. Example command:
Do a query request from a file by using the '-f' flag. Example command:
defradb client query -f request.graphql

Do a query request from a file and with an identity. Example command:
defradb client query -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j -f request.graphql

Or it can be sent via stdin by using the '-' special syntax. Example command:
cat request.graphql | defradb client query -

Expand All @@ -21,14 +24,15 @@ with the database more conveniently.
To learn more about the DefraDB GraphQL Query Language, refer to https://docs.source.network.

```
defradb client query [query request] [flags]
defradb client query [-i --identity] [request] [flags]
```

### Options

```
-f, --file string File containing the query request
-h, --help help for query
-f, --file string File containing the query request
-h, --help help for query
-i, --identity string Identity of the actor
```

### Options inherited from parent commands
Expand Down

0 comments on commit 7c8a5d7

Please sign in to comment.