diff --git a/docs/website/references/cli/defradb_client_collection_create.md b/docs/website/references/cli/defradb_client_collection_create.md index 5425e3f860..862d30cf2e 100644 --- a/docs/website/references/cli/defradb_client_collection_create.md +++ b/docs/website/references/cli/defradb_client_collection_create.md @@ -7,13 +7,19 @@ Create a new document. Create a new document. Options: - -i, --identity - Marks the document as private and set the identity as the owner. The access to the document + -i, --identity + Marks the document as private and set the identity as the owner. The access to the document and permissions are controlled by ACP (Access Control Policy). -e, --encrypt Encrypt flag specified if the document needs to be encrypted. If set, DefraDB will generate a symmetric key for encryption using AES-GCM. + + --encrypt-fields + Comma-separated list of fields to encrypt. If set, DefraDB will encrypt only the specified fields + and for every field in the list it will generate a symmetric key for encryption using AES-GCM. + If combined with '--encrypt' flag, all the fields in the document not listed in '--encrypt-fields' + will be encrypted with the same key. Example: create from string: defradb client collection create --name User '{ "name": "Bob" }' @@ -33,15 +39,16 @@ Example: create from stdin: ``` -defradb client collection create [-i --identity] [-e --encrypt] [flags] +defradb client collection create [-i --identity] [-e --encrypt] [--encrypt-fields] [flags] ``` ### Options ``` - -e, --encrypt Flag to enable encryption of the document - -f, --file string File containing document(s) - -h, --help help for create + -e, --encrypt Flag to enable encryption of the document + --encrypt-fields strings Comma-separated list of fields to encrypt + -f, --file string File containing document(s) + -h, --help help for create ``` ### Options inherited from parent commands