Skip to main content
Get StartedConsole GuideWork With DataRelease NotesReference
Resources

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. Arrow Flight SQL is available on request.
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.

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.

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>

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.

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​

Warning:

The Arrow Flight SQL high-speed data transmission capability described in this document is currently an experimental feature. It is not recommended for production use.

Arrow Flight SQL transfers query results in the Apache Arrow columnar format. Use it when your client can consume columnar results, such as a Python ADBC application. It is available for BYOC warehouses when enabled. To request Arrow Flight SQL for a SaaS warehouse, contact VeloDB Cloud Support.

In the Connection page, choose Arrow Flight SQL and copy the connection details. Use the generated URI settings exactly as shown. Your client must be able to reach every host and port included in the connection details.

Python ADBC​

Install the Apache Arrow Database Connectivity (ADBC) Flight SQL driver:

pip install adbc_driver_manager adbc_driver_flightsql

Use the URI, username, and password from the Connection page. Do not place the password in the URI or source code.

import adbc_driver_manager
import adbc_driver_flightsql.dbapi as flight_sql

conn = flight_sql.connect(
    uri="<arrow-flight-sql-uri>",
    db_kwargs={
        adbc_driver_manager.DatabaseOptions.USERNAME.value: "<username>",
        adbc_driver_manager.DatabaseOptions.PASSWORD.value: "<password>",
    },
)
cursor = conn.cursor()

try:
    cursor.execute("SELECT * FROM <database>.<table> LIMIT 10")
    dataframe = cursor.fetchallarrow().to_pandas()
finally:
    cursor.close()
    conn.close()

Use cursor.fetchallarrow() to keep results in Arrow format, or cursor.fetch_df() to return a pandas DataFrame. Avoid cursor.fetchall() when your application needs columnar results because it converts the results to rows.

Java clients​

Arrow Flight SQL provides a JDBC driver for applications that use the standard JDBC API. For applications that process Arrow data directly, use an ADBC Flight SQL driver instead. See the Apache Arrow Flight SQL documentation for client libraries and dependencies.

When using Arrow libraries with Java 9 or later, add the following JVM option if the client reports that java.nio is not open:

--add-opens=java.base/java.nio=ALL-UNNAMED

Troubleshooting Arrow Flight SQL​

  • Confirm that the warehouse is running.
  • Copy the current URI, and credentials from the Connection page. Update the client after resetting the warehouse password.
  • Confirm that VPC routes, security groups, firewalls, and network ACLs allow traffic to every host and port in the generated connection details.
  • Contact VeloDB Cloud Support for endpoint or connectivity issues. Do not modify fe.conf, be.conf, service logs, reverse proxies, or connection-limit settings in a VeloDB Cloud environment.

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.
  • Private DNS maps the VeloDB Cloud hostname to the private endpoint when you use an encrypted SaaS private connection.

See also​