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@196a75ca #549

Closed
wants to merge 1 commit 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.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ kubectl-dba [flags]

* [kubectl-dba completion](/docs/reference/cli/kubectl-dba_completion.md) - Generate completion script
* [kubectl-dba connect](/docs/reference/cli/kubectl-dba_connect.md) - Connect to a database.
* [kubectl-dba data](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a database
* [kubectl-dba describe](/docs/reference/cli/kubectl-dba_describe.md) - Show details of a specific resource or group of resources
* [kubectl-dba exec](/docs/reference/cli/kubectl-dba_exec.md) - Execute script or command to a database.
* [kubectl-dba options](/docs/reference/cli/kubectl-dba_options.md) - Print the list of flags inherited by all commands
Expand Down
82 changes: 82 additions & 0 deletions docs/reference/cli/kubectl-dba_data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: Kubectl-Dba Data
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data
name: Kubectl-Dba Data
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data

Insert, Drop or Verify data in a database

### Synopsis

Insert random data or verify data in a database.

```
kubectl-dba data
```

### Examples

```
# Insert 100 rows in mysql table
kubectl dba data insert mysql mysql-demo -n demo --rows=100

# Verify that postgres has at least 100 rows data
kubectl dba data verify postgres sample-postgres -n demo --rows=100

# Drop all the CLI inserted data from mongodb
kubectl dba data drop mg -n demo sample-mg


Valid resource types include:
* elasticsearch
* mongodb
* mariadb
* mysql
* postgres
* redis
```

### Options

```
-h, --help help for data
```

### 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](/docs/reference/cli/kubectl-dba.md) - kubectl plugin for KubeDB
* [kubectl-dba data drop](/docs/reference/cli/kubectl-dba_data_drop.md) - Drop data from a database
* [kubectl-dba data insert](/docs/reference/cli/kubectl-dba_data_insert.md) - Insert random data in a database
* [kubectl-dba data verify](/docs/reference/cli/kubectl-dba_data_verify.md) - Verify data in a database

79 changes: 79 additions & 0 deletions docs/reference/cli/kubectl-dba_data_drop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Kubectl-Dba Data Drop
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-drop
name: Kubectl-Dba Data Drop
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data drop

Drop data from a database

### Synopsis

Drop data in a database.

```
kubectl-dba data drop
```

### Examples

```
# Drop all the cli inserted data from mariadb
kubectl dba data drop mariadb -n demo sample-maria

# Drop all the cli inserted data from elasticsearch
kubectl dba data drop es -n demo

Valid resource types include:
* elasticsearch
* mongodb
* mariadb
* mysql
* postgres
* redis
```

### Options

```
-h, --help help for drop
```

### 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](/docs/reference/cli/kubectl-dba_data.md) - Insert, Drop or Verify data in a 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 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

63 changes: 63 additions & 0 deletions docs/reference/cli/kubectl-dba_data_drop_mariadb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Kubectl-Dba Data Drop Mariadb
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-drop-mariadb
name: Kubectl-Dba Data Drop Mariadb
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data drop mariadb

Verify rows in a MariaDB database

### Synopsis

Use this cmd to verify data in a mariadb object

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

### Examples

```
kubectl dba drop mariadb -n demo sample-mariadb
```

### Options

```
-h, --help help for mariadb
```

### 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

63 changes: 63 additions & 0 deletions docs/reference/cli/kubectl-dba_data_drop_mysql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Kubectl-Dba Data Drop Mysql
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-drop-mysql
name: Kubectl-Dba Data Drop Mysql
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data drop mysql

Verify rows in a MySQL database

### Synopsis

Use this cmd to verify data in a mysql object

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

### Examples

```
kubectl dba drop mysql -n demo sample-mysql
```

### Options

```
-h, --help help for mysql
```

### 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

63 changes: 63 additions & 0 deletions docs/reference/cli/kubectl-dba_data_drop_postgres.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Kubectl-Dba Data Drop Postgres
menu:
docs_{{ .version }}:
identifier: kubectl-dba-data-drop-postgres
name: Kubectl-Dba Data Drop Postgres
parent: reference-cli
menu_name: docs_{{ .version }}
section_menu_id: reference
---
## kubectl-dba data drop postgres

Delete data from postgres database

### Synopsis

Use this cmd to delete inserted data in a postgres object

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

### Examples

```
kubectl dba drop pg -n demo sample-postgres
```

### Options

```
-h, --help help for postgres
```

### 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

Loading
Loading