Skip to content

Commit f44b841

Browse files
laodouyalaodouya
authored andcommitted
chore(publish): published 0.6.0 docs by [laodouya]
1 parent 2a822b4 commit f44b841

File tree

5 files changed

+15
-7
lines changed

5 files changed

+15
-7
lines changed

website/versioned_docs/version-0.6.0/cql_account.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ After get a wallet address, you may need to request PTC as above.
7171

7272
## Sub-command `generate` Complete Parameters
7373

74-
Also see [Common Parameters for Sub-commands](#common-parameters-for-sub-commands). We will not mention this again in the later sub-command introductions.
74+
Also see [Common Parameters for Sub-commands](cql_intro#common-parameters-for-sub-commands). We will not mention this again in the later sub-command introductions.
7575

7676
usage: cql generate [common params] [-source template_file] [-miner] [-private existing_private_key] [dest_path]
7777

website/versioned_docs/version-0.6.0/cql_db_access.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Output:
2020

2121
co:4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5=>
2222

23-
Or access as `account2` if it has been granted access permission successfully:
23+
Or access as `account2` (Should been granted access permission and transfered deposit token to the database successfully in last section):
2424

2525
```bash
2626
cql console -config "account2/config.yaml" 'covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e34a332626e7232ba5'
@@ -56,7 +56,7 @@ Here is an example of using the interactive console:
5656

5757
The sub-command `console` also supports running `adapter` or `explorer` servers in the background. Check [Local Servers](#local-servers) for details.
5858

59-
usage: cql console [common params] [-command sqlcommand] [-file filename] [-out outputfile] [-no-rc true/false] [-single-transaction] [-variable variables] [-explorer explorer_addr] [-adapter adapter_addr] [dsn]
59+
usage: cql console [common params] [Console params] dsn
6060

6161
Console runs an interactive SQL console for CovenantSQL.
6262
e.g.

website/versioned_docs/version-0.6.0/cql_db_manage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
145145
-to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 \
146146
-perm '
147147
{
148-
"patterns": nil,
148+
"patterns": null,
149149
"role": "Read,Write"
150150
}
151151
'
@@ -157,7 +157,7 @@ cql grant -to-dsn covenantsql://4bc27a06ae52a7b8b1747f3808dda786ddd188627bafe8e3
157157
-perm "Read,Write"
158158
```
159159

160-
Either setting the `pattern` field to `nil` or just resetting the user permission directly, will eliminate the white list and give back the access permission to the user.
160+
Either setting the `pattern` field to `null` or just resetting the user permission directly, will eliminate the white list and give back the access permission to the user.
161161

162162
## Sub-command `create` Complete Parameters
163163
usage: cql create [common params] [-wait-tx-confirm] [db_meta_params]

website/versioned_docs/version-0.6.0/cql_intro.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,18 @@ CovenantSQL provides a `cql` command line toolset for terminal users to access a
1111
The `cql` command needs to rely on a private key file `private.key` and a config file `config.yaml`:
1212

1313
- `private.key`:a private key file which is generated while creating an account, be sure to keep it safe
14-
- `config.yaml`:mainly used to config the CovenantSQL network for `cql` command to connect (e.g., the [TestNet](quickstart) or the [Docker Environment](deployment))
14+
- `config.yaml`:mainly used to config the CovenantSQL network for `cql` command to connect (e.g., the [TestNet](quickstart) or the [Private Deploy](advanced_deployment))
1515

1616
For security, the private key file is usually encrypted with a master key. A master key is individually chosen by the user while creating an account and is memorized or kept somewhere by the user -- note that the config file will not keep the master key. When the private key is required by the `cql` command, it will ask the user to input the master key to decrypt the private key file.
1717

18+
## Command Format
19+
20+
The `cql` command has more than a dozen subcommands, each one follows the same command format. e.g:
21+
22+
cql sub-command [common parameters] [subcommand parameters] arguments
23+
24+
The content of `arguments` may be empty, but it must be placed at the end of the command when it is not empty.
25+
1826
## Common Parameters for Sub-commands
1927

2028
The following parameters are commonly used by `cql` sub-commands:

website/versioned_docs/version-0.6.0/cql_wallet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Output:
5555

5656
## Transferring Tokens to Another Account
5757

58-
Once you get tokens from [TestNet](quickstart) or [Docker Environment](deployment), you can use the `transfer` sub-command to transfer tokens to another account. The command takes 3 main parameters, e.g.:
58+
Once you get tokens from [TestNet](quickstart) or [Private Deploy](advanced_deployment), you can use the `transfer` sub-command to transfer tokens to another account. The command takes 3 main parameters, e.g.:
5959

6060
```bash
6161
cql transfer -to-user 011f72fea9efa1a49a6663d66e514a34e45e426524c13335cf20bec1b47d10d6 -amount 1000000 -token Particle

0 commit comments

Comments
 (0)