OS Manuals

/usr/bin/mysqlrouter_mrs_client

The MySQL open source relational database

From mysql-9.5 9.5.2-r1 (enterprise-packages), captured 2026-11-08 by running mysqlrouter_mrs_client --help (exit 0). permalink

# Usage
/usr/bin/mysqlrouter_mrs_client [--help] --url=<meta_url> [--user|-u=<meta_user>] [--password|-p=<meta_password>] [--authentication|-a=<meta_auth>] [--accept=<meta_accept>] [--request-header-host=<host>] [--encoded-request-header-host=<host>] [--encoded-request-header-authorization=<authorization>] [--payload-file=<meta_payload>] [--payload=<meta_payload>] [--encoded-payload=<meta_payload>] [--write-format|-f=<write_format>] [--write-to-file|-w=<write_to_file>] [--wait-until-status=<meta_wait_status>] [--path=<meta_path>] [--session-type|-s=<meta_auth_session>] [--auth-app=<meta_auth_app>] [--json-pointer|-j=<meta_json_pointer>] [--exclude-json-pointer|-e=<meta_exclude_json_pointer>] [--expected-header=<meta_header>] [--expected-status=<meta_status>] [--display=<meta_display>] [--session-file=<meta_password>] [--request-type|-t=<type>] [--content-type=<ct>] [--response-type|-r=<type>] [--json-schema-file=<json_schema_file>] [--json-schema=<json_schema>]
                                [--encoded-json-schema=<json_schema>] [--encoded-expected-header=<meta_header>] [--protocol=<meta_protcol>] [--expected-fatal-error=<meta_fatal_error>] [--request-header-upgrade=<meta_header_upgrade>] [--request-header-http2-settings=<meta_header_upgrade>]

# Command line argument description
  --help
    Show help and exit.
  --url <meta_url>
    HTTP/HTTPS url pointing to remote resources.
  --user <meta_user>, -u <meta_user>
    User name, required for authentication.
  --password <meta_password>, -p <meta_password>
    Users password, required for authentication.
  --authentication <meta_auth>, -a <meta_auth>
    Execute authentication flow on given endpoint. Allowed values: NONE,BASIC,SCRAM_GET,OAUTH2_F
  --accept <meta_accept>
    Set the mime-type, that client can process.
  --request-header-host <host>
    Set the value in the 'Host' header of the request.
  --encoded-request-header-host <host>
    Set the value in the 'Host' header of the request. The value must be encoded using url-parameter encoding.
  --encoded-request-header-authorization <authorization>
    Set the value in the 'Authorization' header of the request. The value must be encoded using url-parameter encoding.
  --payload-file <meta_payload>
    Set the request body for POST, PUT requests.
  --payload <meta_payload>
    Set the request body for POST, PUT requests.
  --encoded-payload <meta_payload>
    Set the request body for POST, PUT requests (provided as an URL-encoded string).
  --write-format <write_format>, -f <write_format>
    Write format.
  --write-to-file <write_to_file>, -w <write_to_file>
    Write output to file.
  --wait-until-status <meta_wait_status>
    Wait until server returns status-code specified in `expected-status` parameter. The value specifies how long `mrs_client` should wait, for it.
  --path <meta_path>
    Overwrite the path specified in URL. Using this parameter, user may split the URL on host part specified in --url and path.
  --session-type <meta_auth_session>, -s <meta_auth_session>
    Define how the session should be identified by the client. Allowed values: COOKIE,JWT. Where default value is COOKIE.
  --auth-app <meta_auth_app>
    Define which authentication application should be used while authenticating.
  --json-pointer <meta_json_pointer>, -j <meta_json_pointer>
    Print only values selected by pointers (inclusive pointer). Multiple pointer should be separated by comma.
  --exclude-json-pointer <meta_exclude_json_pointer>, -e <meta_exclude_json_pointer>
    Print values that are not selected by the pointers(exclusive pointer). Multiple pointer should be separated by comma. Inclusive and exclusive pointers can't be used in the same execution.
  --expected-header <meta_header>
    Expect header/value in server's response message.
  --expected-status <meta_status>
    Specify allowed status code. Default is OK(200).
  --display <meta_display>
    What should be presented as output: VALUES=(none|all|VALUE[,VALUE[....]])where VALUE can be: REQUEST, TITLE, BODY, HEADER, STATUS, RESULT. By default its set to REQUEST,BODY,RESULT.
  --session-file <meta_password>
    File that contains session state, at start of the application
the state is restored. At end the application stores the state to it..
  --request-type <type>, -t <type>
    Define type of the request which should be send to the server.
By default its GET, where allowed values are: GET,POST,PUT,DELETE,OPTIONS.
  --content-type <ct>
    Expect the response to have this content type.

  --response-type <type>, -r <type>
    Define expected response type by the server.
By default its JSON, where allowed values are: JSON,RAW, BINARY(same as raw still shouldn't y).
  --json-schema-file <json_schema_file>
    Specify a file that contains JSON schema, which should be used for response validation.

  --json-schema <json_schema>
    Specify the JSON schema, which should be used for response validation.

  --encoded-json-schema <json_schema>
    Specify the JSON schema, which should be used for response validation.

  --encoded-expected-header <meta_header>
    Expect header/value in server's response message. The value must be encoded using url-parameter encoding.
  --protocol <meta_protcol>
    Force wire protocol. The value must be on of following values: HTTP1, HTTP2. Where the default is HTTP1.
  --expected-fatal-error <meta_fatal_error>
    Expect that HTTP client will return connection or protocol error. Match the error description with specified value.
  --request-header-upgrade <meta_header_upgrade>
    Specifies the value of the Upgrade header to be included in the HTTP/1.1 request, typically used to initiate protocol switching (e.g., to WebSocket).
  --request-header-http2-settings <meta_header_upgrade>
    Specifies the value of the HTTP2-Settings header to be included in the HTTP/1.1 request, used during HTTP/2 protocol upgrades to convey HTTP/2 settings in base64url-encoded format.
Options (25)
OptionDescriptionSource
--helpShow help and exit.help
--url meta_urlHTTP/HTTPS url pointing to remote resources.help
--accept meta_acceptSet the mime-type, that client can process.help
--request-header-host hostSet the value in the 'Host' header of the request.help
--encoded-request-header-host hostSet the value in the 'Host' header of the request.help
--encoded-request-header-authorization authorizationSet the value in the 'Authorization' header of the request.help
--payload-file meta_payloadSet the request body for POST, PUT requests.help
--payload meta_payloadSet the request body for POST, PUT requests.help
--encoded-payload meta_payloadSet the request body for POST, PUT requests (provided as an URL-encoded string).help
--wait-until-status meta_wait_statusWait until server returns status-code specified in `expected-status` parameter.help
--path meta_pathOverwrite the path specified in URL.help
--auth-app meta_auth_appDefine which authentication application should be used while authenticating.help
--expected-header meta_headerExpect header/value in server's response message.help
--expected-status meta_statusSpecify allowed status code.help
--display meta_displayWhat should be presented as output: VALUES=(none|all|VALUE[,VALUE[....]])where VALUE can be: REQUEST, TITLE, BODY, HEADER, STATUS, RESULT.help
--session-file meta_passwordFile that contains session state, at start of the applicationhelp
--content-type ctExpect the response to have this content type.help
--json-schema-file json_schema_fileSpecify a file that contains JSON schema, which should be used for response validation.help
--json-schema json_schemaSpecify the JSON schema, which should be used for response validation.help
--encoded-json-schema json_schemaSpecify the JSON schema, which should be used for response validation.help
--encoded-expected-header meta_headerExpect header/value in server's response message.help
--protocol meta_protcolForce wire protocol.help
--expected-fatal-error meta_fatal_errorExpect that HTTP client will return connection or protocol error.help
--request-header-upgrade meta_header_upgradeSpecifies the value of the Upgrade header to be included in the HTTP/1.1 request, typically used to initiate protocol switching (e.g., to WebSocket).help
--request-header-http2-settings meta_header_upgradeSpecifies the value of the HTTP2-Settings header to be included in the HTTP/1.1 request, used during HTTP/2 protocol upgrades to convey HTTP/2 settings in base64url-encoded format.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.