Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for kubedb/cli@f9be578b #560

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/cli/kubectl-dba_data_drop.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ kubectl-dba data drop
* [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database
* [kubectl-dba data drop elasticsearch](/docs/reference/cli/kubectl-dba_data_drop_elasticsearch.md) - Delete data from elasticsearch database
* [kubectl-dba data drop mariadb](/docs/reference/cli/kubectl-dba_data_drop_mariadb.md) - Verify rows in a MariaDB database
* [kubectl-dba data drop mongodb](/docs/reference/cli/kubectl-dba_data_drop_mongodb.md) - Drop data from mongodb
* [kubectl-dba data drop mysql](/docs/reference/cli/kubectl-dba_data_drop_mysql.md) - Verify rows in a MySQL database
* [kubectl-dba data drop postgres](/docs/reference/cli/kubectl-dba_data_drop_postgres.md) - Delete data from postgres database
* [kubectl-dba data drop redis](/docs/reference/cli/kubectl-dba_data_drop_redis.md) - Delete data from redis database
Expand Down
63 changes: 63 additions & 0 deletions docs/reference/cli/kubectl-dba_data_drop_mongodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Kubectl-Dba Data Drop Mongodb
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-drop-mongodb
name: Kubectl-Dba Data Drop Mongodb
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data drop mongodb

Drop data from mongodb

### Synopsis

Use this cmd to drop data from a mongodb database.

```
kubectl-dba data drop mongodb [flags]
```

### Examples

```
kubectl dba data drop mg -n demo mg-rs
```

### Options

```
-h, --help help for mongodb
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "/home/runner/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
```

### SEE ALSO

* [kubectl-dba data drop](/docs/reference/cli/kubectl-dba_data_drop.md) - Drop data from a database

1 change: 1 addition & 0 deletions docs/reference/cli/kubectl-dba_data_insert.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ kubectl-dba data insert
* [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database
* [kubectl-dba data insert elasticsearch](/docs/reference/cli/kubectl-dba_data_insert_elasticsearch.md) - Insert data to a elasticsearch database
* [kubectl-dba data insert mariadb](/docs/reference/cli/kubectl-dba_data_insert_mariadb.md) - Connect to a mariadb object
* [kubectl-dba data insert mongodb](/docs/reference/cli/kubectl-dba_data_insert_mongodb.md) - Insert data to mongodb
* [kubectl-dba data insert mysql](/docs/reference/cli/kubectl-dba_data_insert_mysql.md) - Connect to a mysql object
* [kubectl-dba data insert postgres](/docs/reference/cli/kubectl-dba_data_insert_postgres.md) - Insert data to a postgres object's pod
* [kubectl-dba data insert redis](/docs/reference/cli/kubectl-dba_data_insert_redis.md) - Insert data to a redis database
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba insert -n demo es es-quickstart --rows 1000

```
-h, --help help for elasticsearch
-r, --rows int rows in (default 10)
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_insert_mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba insert mariadb -n demo sample-mariadb --rows 1000

```
-h, --help help for mariadb
-r, --rows int rows in (default 10)
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands
Expand Down
64 changes: 64 additions & 0 deletions docs/reference/cli/kubectl-dba_data_insert_mongodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Kubectl-Dba Data Insert Mongodb
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-insert-mongodb
name: Kubectl-Dba Data Insert Mongodb
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data insert mongodb

Insert data to mongodb

### Synopsis

Use this cmd to insert data into a mongodb database.

```
kubectl-dba data insert mongodb [flags]
```

### Examples

```
kubectl dba data insert mg -n demo mg-rs --rows 500
```

### Options

```
-h, --help help for mongodb
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "/home/runner/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
```

### SEE ALSO

* [kubectl-dba data insert](/docs/reference/cli/kubectl-dba_data_insert.md) - Insert random data in a database

2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_insert_mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba insert mysql -n demo sample-mysql --rows 1000

```
-h, --help help for mysql
-r, --rows int rows in (default 10)
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_insert_postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba insert postgres -n demo sample-postgres --rows 500

```
-h, --help help for postgres
-r, --rows int rows in (default 10)
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_insert_redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba data insert redis -n demo sample-redis --rows 500

```
-h, --help help for redis
-r, --rows int rows in (default 10)
-r, --rows int number of rows to insert (default 100)
```

### Options inherited from parent commands
Expand Down
1 change: 1 addition & 0 deletions docs/reference/cli/kubectl-dba_data_verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ kubectl-dba data verify
* [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database
* [kubectl-dba data verify elasticsearch](/docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md) - Verify rows in a elasticsearch database
* [kubectl-dba data verify mariadb](/docs/reference/cli/kubectl-dba_data_verify_mariadb.md) - Verify rows in a MariaDB database
* [kubectl-dba data verify mongodb](/docs/reference/cli/kubectl-dba_data_verify_mongodb.md) - Verify data to a mongodb resource
* [kubectl-dba data verify mysql](/docs/reference/cli/kubectl-dba_data_verify_mysql.md) - Verify rows in a MySQL database
* [kubectl-dba data verify postgres](/docs/reference/cli/kubectl-dba_data_verify_postgres.md) - Verify rows in a postgres database
* [kubectl-dba data verify redis](/docs/reference/cli/kubectl-dba_data_verify_redis.md) - Verify rows in a redis database
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/cli/kubectl-dba_data_verify_elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Verify rows in a elasticsearch database

### Synopsis

Use this cmd to verify data in a elasticsearc object
Use this cmd to verify data in a elasticsearch object

```
kubectl-dba data verify elasticsearch [flags]
Expand All @@ -30,7 +30,7 @@ kubectl dba verify -n demo es es-quickstart --rows 1000

```
-h, --help help for elasticsearch
-r, --rows int rows in (default 10)
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_verify_mariadb.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba verify mariadb -n demo sample-mariadb --rows 1000

```
-h, --help help for mariadb
-r, --rows int rows in (default 10)
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands
Expand Down
64 changes: 64 additions & 0 deletions docs/reference/cli/kubectl-dba_data_verify_mongodb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
title: Kubectl-Dba Data Verify Mongodb
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-verify-mongodb
name: Kubectl-Dba Data Verify Mongodb
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data verify mongodb

Verify data to a mongodb resource

### Synopsis

Use this cmd to verify data existence in a mongodb object

```
kubectl-dba data verify mongodb [flags]
```

### Examples

```
kubectl dba data verify mg -n demo mg-rs --rows 500
```

### Options

```
-h, --help help for mongodb
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands

```
--as string Username to impersonate for the operation. User could be a regular user or a service account in a namespace.
--as-group stringArray Group to impersonate for the operation, this flag can be repeated to specify multiple groups.
--as-uid string UID to impersonate for the operation.
--cache-dir string Default cache directory (default "/home/runner/.kube/cache")
--certificate-authority string Path to a cert file for the certificate authority
--client-certificate string Path to a client certificate file for TLS
--client-key string Path to a client key file for TLS
--cluster string The name of the kubeconfig cluster to use
--context string The name of the kubeconfig context to use
--insecure-skip-tls-verify If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure
--kubeconfig string Path to the kubeconfig file to use for CLI requests.
--match-server-version Require server version to match client version
-n, --namespace string If present, the namespace scope for this CLI request
--password string Password for basic authentication to the API server
--request-timeout string The length of time to wait before giving up on a single server request. Non-zero values should contain a corresponding time unit (e.g. 1s, 2m, 3h). A value of zero means don't timeout requests. (default "0")
-s, --server string The address and port of the Kubernetes API server
--tls-server-name string Server name to use for server certificate validation. If it is not provided, the hostname used to contact the server is used
--token string Bearer token for authentication to the API server
--user string The name of the kubeconfig user to use
--username string Username for basic authentication to the API server
```

### SEE ALSO

* [kubectl-dba data verify](/docs/reference/cli/kubectl-dba_data_verify.md) - Verify data in a database

2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_verify_mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba verify mysql -n demo sample-mysql --rows 1000

```
-h, --help help for mysql
-r, --rows int rows in (default 10)
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_verify_postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba verify pg -n demo sample-postgres --rows 500

```
-h, --help help for postgres
-r, --rows int rows in (default 10)
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/kubectl-dba_data_verify_redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ kubectl dba data verify redis -n demo sample-redis --rows 500

```
-h, --help help for redis
-r, --rows int rows in (default 10)
-r, --rows int number of rows to verify (default 100)
```

### Options inherited from parent commands
Expand Down
Loading