v1.1
- Overview
- Quick Start
- Install PTK
- Usage
- Configuration
- Config Samples
- Commands
- ptk
- ptk completion
- ptk register
- ptk init-cluster
- ptk collect
- ptk rec-guc
- ptk cache
- ptk gen-ptkc
- ptk manage
- ptk demo
- ptk meta
- ptk version
- ptk self
- ptk gen-om-xml
- ptk env
- ptk gen-static-config
- ptk cluster
- ptk cluster rename
- ptk cluster throwout
- ptk cluster takeover
- ptk cluster uninstall-cm
- ptk cluster install-cm
- ptk cluster gen-cert-files
- ptk cluster load-cm-vip
- ptk cluster del-kerberos-auth
- ptk cluster add-kerberos-auth
- ptk cluster uninstall-kerberos-server
- ptk cluster install-kerberos-server
- ptk cluster is-in-upgrade
- ptk cluster upgrade-rollback
- ptk cluster upgrade-commit
- ptk cluster upgrade
- ptk cluster demote
- ptk cluster promote
- ptk cluster refresh
- ptk cluster shell
- ptk cluster modify-comment
- ptk cluster show-config
- ptk cluster set-guc
- ptk cluster show-guc
- ptk cluster set-hba
- ptk cluster show-hba
- ptk cluster scale-out
- ptk cluster scale-in
- ptk cluster uninstall-mogha
- ptk cluster install-mogha
- ptk cluster list-plugins
- ptk cluster install-plugin
- ptk cluster inspect
- ptk cluster failover
- ptk cluster switchover
- ptk cluster build
- ptk cluster status
- ptk cluster restart
- ptk cluster stop
- ptk cluster start
- ptk uninstall
- ptk ls
- ptk install
- ptk exec
- ptk template
- ptk encrypt
- ptk checkos
- ptk download
- ptk candidate
- Troubleshooting
- FAQ
- Release Note
- GPTK - Graphical Deployment Tool
- Community
- Appendix: YAML Syntax
Viewing Help Information
After PTK is successfully installed, you can run ptk -h
to view the help information. For details about command parameters, see PTK Command Reference.
PTK is a command line tool for deploying and managing the MogDB database cluster.
Usage:
ptk [flags] <command> [args...]
ptk [command]
Available Commands:
env Prints PTK-loaded environment variable values.
gen-om-xml Generates the gs_om XML configuration file.
self Operates with the PTK self installation package.
version Prints the PTK version.
help Prints the PTK help information.
completion Generate the autocompletion script for the specified shell
Pre Install Commands:
candidate Prints the PTK-supported software version list.
download Downloads the MogDB installation package online.
checkos Checks whether the cluster server system meets database installation requirements.
encrypt Provides a convenient method of encrypting your text or password.
template Prints the configuration template.
Install Commands:
install Configures and deploys the MogDB database cluster based on the given topology.
uninstall Uninstalls the MogDB database cluster.
Post Install Commands:
ls Lists all MogDB clusters.
cluster Manages the database cluster.
Experimental Commands:
register Register PTK internal types for specific needs.
Flags:
-h, --help Prints the PTK help information.
--log-file string Specifies a path of the run log file
--log-format string Specifies the output format of the run log. The value can be text or json. The default value is text.
--log-level string Specifies the run log level. The value can be debug, info, warning, error, and panic. The default value is info.
-v, --version Prints the PTK version.
Use "ptk [command] --help" for more information about a command.
Viewing Version
You can run ptk -v
to view PTK version.
$ ptk -v
PTK Version: v0.8.0 release
Go Version: go1.19.4
Build Date: 2023-05-26T18:07:20
Git Hash: c87adff
OS/Arch: linux/amd64
The output includes the PTK version, Golang version in compilation, build time, and git hash value.