vitess.io/vitess@v0.16.2/go/flags/endtoend/mysqlctl.txt (about)

     1  Usage: mysqlctl [global-flags] <command> -- [command-flags]
     2  
     3  The commands are listed below. Use 'mysqlctl <command> -- {-h, --help}' for command help.
     4  
     5    init [--wait_time=5m] [--init_db_sql_file=]
     6    init_config
     7    reinit_config
     8    teardown [--wait_time=5m] [--force]
     9    start [--wait_time=5m]
    10    shutdown [--wait_time=5m]
    11    position <operation> <pos1> <pos2 | gtid>
    12  
    13  Global flags:
    14        --alsologtostderr                                 log to standard error as well as files
    15        --app_idle_timeout duration                       Idle timeout for app connections (default 1m0s)
    16        --app_pool_size int                               Size of the connection pool for app connections (default 40)
    17        --catch-sigpipe                                   catch and ignore SIGPIPE on stdout and stderr if specified
    18        --db-credentials-file string                      db credentials file; send SIGHUP to reload this file
    19        --db-credentials-server string                    db credentials server type ('file' - file implementation; 'vault' - HashiCorp Vault implementation) (default "file")
    20        --db-credentials-vault-addr string                URL to Vault server
    21        --db-credentials-vault-path string                Vault path to credentials JSON blob, e.g.: secret/data/prod/dbcreds
    22        --db-credentials-vault-role-mountpoint string     Vault AppRole mountpoint; can also be passed using VAULT_MOUNTPOINT environment variable (default "approle")
    23        --db-credentials-vault-role-secretidfile string   Path to file containing Vault AppRole secret_id; can also be passed using VAULT_SECRETID environment variable
    24        --db-credentials-vault-roleid string              Vault AppRole id; can also be passed using VAULT_ROLEID environment variable
    25        --db-credentials-vault-timeout duration           Timeout for vault API operations (default 10s)
    26        --db-credentials-vault-tls-ca string              Path to CA PEM for validating Vault server certificate
    27        --db-credentials-vault-tokenfile string           Path to file containing Vault auth token; token can also be passed using VAULT_TOKEN environment variable
    28        --db-credentials-vault-ttl duration               How long to cache DB credentials from the Vault server (default 30m0s)
    29        --db_charset string                               Character set used for this tablet. (default "utf8mb4")
    30        --db_conn_query_info                              enable parsing and processing of QUERY_OK info fields
    31        --db_connect_timeout_ms int                       connection timeout to mysqld in milliseconds (0 for no timeout)
    32        --db_dba_password string                          db dba password
    33        --db_dba_use_ssl                                  Set this flag to false to make the dba connection to not use ssl (default true)
    34        --db_dba_user string                              db dba user userKey (default "vt_dba")
    35        --db_flags uint                                   Flag values as defined by MySQL.
    36        --db_flavor string                                Flavor overrid. Valid value is FilePos.
    37        --db_host string                                  The host name for the tcp connection.
    38        --db_port int                                     tcp port
    39        --db_server_name string                           server name of the DB we are connecting to.
    40        --db_socket string                                The unix socket to connect on. If this is specified, host and port will not be used.
    41        --db_ssl_ca string                                connection ssl ca
    42        --db_ssl_ca_path string                           connection ssl ca path
    43        --db_ssl_cert string                              connection ssl certificate
    44        --db_ssl_key string                               connection ssl key
    45        --db_ssl_mode SslMode                             SSL mode to connect with. One of disabled, preferred, required, verify_ca & verify_identity.
    46        --db_tls_min_version string                       Configures the minimal TLS version negotiated when SSL is enabled. Defaults to TLSv1.2. Options: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3.
    47        --dba_idle_timeout duration                       Idle timeout for dba connections (default 1m0s)
    48        --dba_pool_size int                               Size of the connection pool for dba connections (default 20)
    49    -h, --help                                            display usage and exit
    50        --keep_logs duration                              keep logs for this long (using ctime) (zero to keep forever)
    51        --keep_logs_by_mtime duration                     keep logs for this long (using mtime) (zero to keep forever)
    52        --lameduck-period duration                        keep running at least this long after SIGTERM before stopping (default 50ms)
    53        --log_backtrace_at traceLocation                  when logging hits line file:N, emit a stack trace (default :0)
    54        --log_dir string                                  If non-empty, write log files in this directory
    55        --log_err_stacks                                  log stack traces for errors
    56        --log_rotate_max_size uint                        size in bytes at which logs are rotated (glog.MaxSize) (default 1887436800)
    57        --logtostderr                                     log to standard error instead of files
    58        --max-stack-size int                              configure the maximum stack size in bytes (default 67108864)
    59        --mysql_port int                                  MySQL port (default 3306)
    60        --mysql_server_version string                     MySQL server version to advertise. (default "8.0.30-Vitess")
    61        --mysql_socket string                             Path to the mysqld socket file
    62        --mysqlctl_client_protocol string                 the protocol to use to talk to the mysqlctl server (default "grpc")
    63        --mysqlctl_mycnf_template string                  template file to use for generating the my.cnf file during server init
    64        --mysqlctl_socket string                          socket file to use for remote mysqlctl actions (empty for local actions)
    65        --onclose_timeout duration                        wait no more than this for OnClose handlers before stopping (default 10s)
    66        --onterm_timeout duration                         wait no more than this for OnTermSync handlers before stopping (default 10s)
    67        --pid_file string                                 If set, the process will write its pid to the named file, and delete it on graceful shutdown.
    68        --pool_hostname_resolve_interval duration         if set force an update to all hostnames and reconnect if changed, defaults to 0 (disabled)
    69        --pprof strings                                   enable profiling
    70        --purge_logs_interval duration                    how often try to remove old logs (default 1h0m0s)
    71        --replication_connect_retry duration              how long to wait in between replica reconnect attempts. Only precise to the second. (default 10s)
    72        --security_policy string                          the name of a registered security policy to use for controlling access to URLs - empty means allow all for anyone (built-in policies: deny-all, read-only)
    73        --service_map strings                             comma separated list of services to enable (or disable if prefixed with '-') Example: grpc-queryservice
    74        --socket_file string                              Local unix socket file to listen on
    75        --stderrthreshold severity                        logs at or above this threshold go to stderr (default 1)
    76        --tablet_dir string                               The directory within the vtdataroot to store vttablet/mysql files. Defaults to being generated by the tablet uid.
    77        --tablet_uid uint                                 Tablet UID (default 41983)
    78        --v Level                                         log level for V logs
    79    -v, --version                                         print binary version
    80        --vmodule moduleSpec                              comma-separated list of pattern=N settings for file-filtered logging