Skip to main content
The CHECK EXTERNAL CONNECTION tests the connection from each node in the cluster to an external cloud storage location. CHECK EXTERNAL CONNECTION will measure the time it takes each node to write a file, read it, and delete it from the specified storage location. You can adjust the number and concurrency of the test runs as well as the size of the file to write and read for each test.
You can use the CHECK EXTERNAL CONNECTION to test the connection to locations.

Synopsis

check_external_connection syntax diagram

Parameters

ParameterDescription
connection_uriThe URI to the external storage. Specify the (e.g., gs://bucket_name?AUTH...) or a user-defined (e.g., external://gcs).

Options

OptionValueDescription
concurrentlyINTRun multiple connection tests concurrently. If you also set the time option, it will run the specified number of concurrent tests until the time has elapsed. By default, only 1 connection test will run.
timeSTRINGRun the test repeatedly until the duration has elapsed.
transferSTRINGThe size of the file that is written and read during each iteration of the connection test. By default, this will transfer a 32MiB file.

Responses

FieldValueDescription
nodeINTThe node ID.
localitySTRINGThe of the node.
okBOOLWhether the test run succeeded.
errorSTRINGErrors encountered during the test run.
transferredSTRINGThe size of the file transferred during the test.
read_speedSTRINGThe speed at which the node read the test file.
write_speedSTRINGThe speed at which the node wrote the test file.
can_deleteBOOLWhether file deletion succeeded.

Test an external connection

Specify the connection URI to the , or a created :
To modify the testing parameters, use one or a combination of the options: concurrently, time, transfer. For details on each, refer to Options.

See also