Skip to main content

Connection Methods

The Connection page generates the endpoint, credentials, commands, and URL templates that clients need to connect to a selected warehouse. Use this page after choosing the warehouse deployment type and network path.

The available methods depend on the network path:

Network pathHow to choose a method
SaaS Public EndpointMySQL, JDBC, Stream Load and MCP
SaaS Private EndpointEndpoints or endpoint services
BYOC Connect to your warehouseMySQL, JDBC, Stream Load, MCP, and Arrow Flight SQL

Before you begin​

  • Make sure the warehouse is running.
  • For a SaaS private connection, create the endpoint and wait until its status is ready. See Access VeloDB from Your VPC.
  • Make sure the client can reach the host, endpoint, and ports shown for the selected method.
  • Have a warehouse SQL username and password ready. The console shows the password only when the warehouse is created.

Choose a connection method​

  1. Log in to the VeloDB Cloud console.
  2. In the upper-left corner, select the warehouse that you want to use.
  3. In the left navigation pane, click Connection.
  4. Open the network path:
    • For a SaaS public connection, select Public Endpoint.
    • For a SaaS private connection, select Private Endpoint.
    • For a BYOC warehouse, use the Connect to your warehouse page that opens by default.
  5. Choose a connection method.

If Frontend Group appears, select a group from Select a frontend group before copying the connection details. The selected group determines the Host and Port shown for MySQL CLI and JDBC. Default Frontend Group is selected by default.

Note:

  • Frontend Groups is currently in Private Preview. To enable FE group expansion for a warehouse, contact VeloDB Cloud Support. When enabled, Frontend Groups appears under Compute in the VeloDB Cloud console.

For Open Database Connectivity (ODBC) drivers and MySQL-compatible visualization tools, use the Host, Port, Username, and Password shown for MySQL CLI.

Note:

The Password value is shown only when the warehouse is created. If you no longer have it, click Reset password, or open Warehouse Settings > Security and click Change Password. After changing the password, update every client that uses the old value.

MySQL CLI​

Select MySQL CLI, and then copy the generated Command. It follows this format:

mysql -h <host> -P <port> -u <username> -p

Run the command and enter the warehouse password when prompted.

If TLS is Required, the generated command includes --ssl-mode=REQUIRED. Keep this option when you configure the client. If you use a SaaS private endpoint, configure private DNS so the VeloDB Cloud hostname matches the server certificate.

JDBC​

Select JDBC, and then copy the JDBC URL template:

jdbc:mysql://<host>:<port>/<database>?user=<username>&password=<password>

Replace <database> and <password> before using the URL. If the warehouse has multiple clusters, route the connection to a cluster by appending @<cluster_name> to the database name:

jdbc:mysql://<host>:<port>/<database>@<cluster_name>?user=<username>&password=<password>

If TLS is Required, the generated template includes &sslMode=REQUIRED. Keep this parameter in the JDBC URL. If you use a SaaS private endpoint, configure private DNS before connecting.

Stream Load​

Select Stream Load, and then copy the Request URL template. The page also lists the HTTP protocol port and the cluster-specific ports that must be reachable when they are available.

If TLS is Required, the Endpoint and Request URL template use HTTPS. Keep the generated https:// URL when you configure the client.

The following example prompts for the warehouse password instead of storing it in the URL or shell history:

curl --location-trusted -u "<username>" \
  -H "label:<load_label>" \
  -H "column_separator:," \
  -T data.csv \
  "<endpoint>/api/<database>/<table>/_stream_load"

To target a specific cluster, add the cloud_cluster header:

-H "cloud_cluster:<cluster_name>"

MCP​

Select MCP, copy the MCP Server URL, and add it to a supported AI client or agent.

For client configuration and authentication requirements, see Get Started with the VeloDB Cloud MCP Server.

Arrow Flight SQL​

Arrow Flight SQL is a columnar data transfer protocol for SQL clients. It is available for BYOC warehouses when enabled. In the Connection page, choose Arrow Flight SQL and copy the connection details shown for the warehouse.

For client libraries, connection examples, and protocol background, see Connecting by Arrow Flight SQL Protocol. That page includes self-managed Apache Doris configuration steps; do not apply host-level configuration changes such as editing fe.conf or be.conf to a VeloDB Cloud warehouse.

Troubleshooting​

If a client cannot connect, verify the following:

  • The warehouse is running and the selected network path is ready.
  • The client uses the current host, port, username, and password.
  • Security groups, firewalls, routes, and network ACLs allow the required traffic.
  • The client uses the generated TLS option or HTTPS URL when TLS is Required.
  • Private DNS maps the VeloDB Cloud hostname to the private endpoint when you use an encrypted SaaS private connection.

See also​