Skip to content

Commit

Permalink
update welcome words (#215)
Browse files Browse the repository at this point in the history
  • Loading branch information
jievince authored Apr 10, 2023
1 parent 0dd79e2 commit 4aeebbd
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ This repository contains the NebulaGraph Console for NebulaGraph 3.x. NebulaGrap

### From Source Code

1. Build Nebula Graph Console
1. Build NebulaGraph Console

To build Nebula Graph Console, make sure that you have installed [Go](https://golang.org/doc/install).
To build NebulaGraph Console, make sure that you have installed [Go](https://golang.org/doc/install).

> NOTE: Go version provided with apt on ubuntu is usually "outdated".
Expand All @@ -42,21 +42,21 @@ This repository contains the NebulaGraph Console for NebulaGraph 3.x. NebulaGrap

The version should be newer than 1.13.

Use Git to clone the source code of Nebula Graph Console to your host.
Use Git to clone the source code of NebulaGraph Console to your host.

```bash
$ git clone https://github.com/vesoft-inc/nebula-console
```

Run the following command to build Nebula Graph Console.
Run the following command to build NebulaGraph Console.

```bash
$ cd nebula-console
$ make
```
You can find a binary named `nebula-console`.

2. Connect to Nebula Graph
2. Connect to NebulaGraph

To connect to your Nebula Graph services, use the following command.

Expand All @@ -70,12 +70,12 @@ This repository contains the NebulaGraph Console for NebulaGraph 3.x. NebulaGrap
| `-h` | Shows the help menu. |
| `-addr/-address`| Sets the IP/HOST address of the graphd service. |
| `-P/-port` | Sets the port number of the graphd service. |
| `-u/-user` | Sets the username of your Nebula Graph account. See [authentication](https://docs.nebula-graph.io/2.0/7.data-security/1.authentication/1.authentication/). |
| `-p/-password` | Sets the password of your Nebula Graph account. |
| `-u/-user` | Sets the username of your NebulaGraph account. See [authentication](https://docs.nebula-graph.io/2.0/7.data-security/1.authentication/1.authentication/). |
| `-p/-password` | Sets the password of your NebulaGraph account. |
| `-t/-timeout` | Sets an integer-type timeout threshold for the connection. The unit is millisecond. The default value is 120. |
| `-e/-eval` | Sets a string-type nGQL statement. The nGQL statement is executed once the connection succeeds. The connection stops after the result is returned. |
| `-f/-file` | Sets the path of an nGQL file. The nGQL statements in the file are executed once the connection succeeds. You'll get the return messages and the connection stops then. |
| `-enable_ssl` | Enable SSL when connecting to Nebula Graph |
| `-enable_ssl` | Enable SSL when connecting to NebulaGraph |
| `-ssl_root_ca_path` | Sets the path of the certification authority file |
| `-ssl_cert_path` | Sets the path of the certificate file |
| `-ssl_private_key_path` | Sets the path of the private key file |
Expand All @@ -86,7 +86,7 @@ This repository contains the NebulaGraph Console for NebulaGraph 3.x. NebulaGrap
```bash
$./nebula-console -addr=192.168.10.111 -port 9669 -u root -p nebula
2021/03/15 15:21:43 [INFO] connection pool is initialized successfully
Welcome to Nebula Graph!
Welcome to NebulaGraph!
```

Check options for `./nebula-console -h`:
Expand All @@ -103,7 +103,7 @@ This repository contains the NebulaGraph Console for NebulaGraph 3.x. NebulaGrap

- Add execute permissions to the binary file of NebulaGraph

- Connect to your Nebula Graph services:
- Connect to your NebulaGraph services:

```bash
$ ./<$YOUR_BINARY> -addr <ip> -port <port> -u <username> -p <password>
Expand Down Expand Up @@ -184,7 +184,7 @@ nebula> :sleep 3
* Exit the console
You can use `:EXIT` or `:QUIT` to disconnect from Nebula Graph. For convenience, nebula-console supports using these commands in lower case without the colon (":"), such as `quit`.
You can use `:EXIT` or `:QUIT` to disconnect from NebulaGraph. For convenience, nebula-console supports using these commands in lower case without the colon (":"), such as `quit`.
```nGQL
nebula> :QUIT
Expand Down
26 changes: 13 additions & 13 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func welcome(interactive bool) {
return
}
fmt.Println()
fmt.Printf("Welcome to Nebula Graph!\n")
fmt.Printf("Welcome!\n")
fmt.Println()
}

Expand Down Expand Up @@ -436,15 +436,15 @@ var (
)

var (
address *string = flag.String("addr", "127.0.0.1", "The Nebula Graph IP/HOST address")
port *int = flag.Int("P", -1, "The Nebula Graph Port")
username *string = flag.String("u", "", "The Nebula Graph login user name")
password *string = flag.String("p", "", "The Nebula Graph login password")
timeout *int = flag.Int("t", 0, "The Nebula Graph client connection timeout in millisecond, 0 means never timeout")
address *string = flag.String("addr", "127.0.0.1", "The Graph IP/HOST address")
port *int = flag.Int("P", -1, "The Graph Port")
username *string = flag.String("u", "", "The Graph login user name")
password *string = flag.String("p", "", "The Graph login password")
timeout *int = flag.Int("t", 0, "The Graph client connection timeout in millisecond, 0 means never timeout")
script *string = flag.String("e", "", "The nGQL directly")
file *string = flag.String("f", "", "The nGQL script file name")
version *bool = flag.Bool("v", false, "The Nebula Console version")
enableSsl *bool = flag.Bool("enable_ssl", false, "Enable SSL when connecting to Nebula Graph")
version *bool = flag.Bool("v", false, "The NebulaConsole version")
enableSsl *bool = flag.Bool("enable_ssl", false, "Enable SSL when connecting to Graph")
sslRootCAPath *string = flag.String("ssl_root_ca_path", "", "SSL root certification authority's file path")
sslCertPath *string = flag.String("ssl_cert_path", "", "SSL certificate's file path")
sslPrivateKeyPath *string = flag.String("ssl_private_key_path", "", "SSL private key's file path")
Expand All @@ -453,11 +453,11 @@ var (
)

func init() {
flag.StringVar(address, "address", "127.0.0.1", "The Nebula Graph IP/HOST address")
flag.IntVar(port, "port", -1, "The Nebula Graph Port")
flag.StringVar(username, "user", "", "The Nebula Graph login user name")
flag.StringVar(password, "password", "", "The Nebula Graph login password")
flag.IntVar(timeout, "timeout", 0, "The Nebula Graph client connection timeout in millisecond, 0 means never timeout")
flag.StringVar(address, "address", "127.0.0.1", "The Graph IP/HOST address")
flag.IntVar(port, "port", -1, "The Graph Port")
flag.StringVar(username, "user", "", "The Graph login user name")
flag.StringVar(password, "password", "", "The Graph login password")
flag.IntVar(timeout, "timeout", 0, "The Graph client connection timeout in millisecond, 0 means never timeout")
flag.StringVar(script, "eval", "", "The nGQL directly")
flag.StringVar(file, "file", "", "The nGQL script file name")
}
Expand Down

0 comments on commit 4aeebbd

Please sign in to comment.