Skip to main content
VeloDB Cloud 26.x·Apache Doris 4.x (≤ 4.0 supported)·"Since X.Y" tags refer to Doris versionsversion mapping →

Connection

Open Connection from the Manage group in the left navigation.

Connection setup differs by warehouse type:

Warehouse typeNetwork access
SaaSChoose Public Link (internet, secured by IP allowlist) or PrivateLink (private backbone inside your VPC).
BYOCYour cloud network provides connectivity. Manage data-plane access via the Public Access Allowlist.

Connection Info

The Connection Info panel shows the details your applications need to connect to the warehouse.

FieldDescription
Warehouse IDUnique identifier for the warehouse.
Domain / IPHostname or IP address for MySQL and HTTP connections.
MySQL Protocol PortDefault: 9030.
HTTP Protocol PortDefault: 8080.
UsernameDatabase username. The default admin user is admin.
PasswordDatabase password. Click the edit icon to reset it.

SaaS warehouses only. Public Link exposes the warehouse over the public internet, secured by an IP allowlist.

On the Connection page, switch to the Public Link tab. The IP Allowlist section shows the current access policy. Click Edit IP Allowlist to add or remove source IPs and CIDR blocks.

public link

public link ip allowlist

Note The default entry is 0.0.0.0/0, which allows access from anywhere. Remove it and add your real source IPs as soon as possible to reduce exposure.

SaaS warehouses only. PrivateLink lets applications inside your own VPC access VeloDB Cloud across VPC boundaries over a private network, simplifying network architecture and avoiding the risks of public access.

A PrivateLink connection has two ends: an Endpoint Service (the publisher side) and an Endpoint (the consumer side). Depending on who is connecting to whom, the two ends are owned differently:

  • Access VeloDB from your VPC — VeloDB Cloud owns and manages the Endpoint Service; you create and manage the Endpoint in your own VPC.
  • VeloDB accesses your VPC — you own the Endpoint Service in your VPC; VeloDB Cloud creates and manages the Endpoint.

Note VeloDB Cloud does not charge extra for PrivateLink, but you pay the cloud provider for endpoint instances and traffic.

Access VeloDB from your VPC

Access VeloDB from Your VPC

Use this direction to let reporting tools, BI, log-analytics jobs, and other applications inside your VPC reach the VeloDB Cloud warehouse.

On AWS

  1. On the target warehouse, open Connection → Private Link, click Set up Connection under Connect Your VPC to VeloDB.

    private link ad

  2. Click Set up one or more endpoints to open AWS PrivateLink and create an endpoint.

    private link add endpoint

  3. In the AWS PrivateLink console, make sure the region matches the VeloDB warehouse's region (PrivateLink is region-scoped), then click Create endpoint.

    private link create endpoint on aws

    Note Sign in to AWS with a principal that has been allow-listed to access the VeloDB endpoint service, or service-name verification will fail.

  4. Fill in the endpoint form:

    private link create endpoint on aws01

    private link create endpoint on aws02

    ParameterDescription
    Name tagOptional. Tag with key Name and a value of your choice.
    Service categoryRequired. Pick Endpoint services that use NLBs and GWLBs.
    Service nameRequired. Copy the Service Name from the Endpoint Service information panel in VeloDB Cloud, paste it here, and click Verify service.
    VPCRequired. The VPC to create the endpoint in.
    SubnetsRequired. Same AZ as VeloDB's endpoint service (PrivateLink restriction). Pick a suitable subnet.
    Security groupsRequired. The rules must allow the protocol and port used by the warehouse and the source IP of your application.
    TagsOptional.
  5. When the endpoint status changes from Pending to Available, the private-link handshake is done.

    private link create endpoint on aws pending

  6. Refresh the VeloDB Cloud Connection page — the endpoint list shows the connection details.

    private link endpoint list table

    private link endpoint on aws details

    Note Click Find DNS Name to open the endpoint detail page in AWS, grab the DNS Name, and use it to access the warehouse.

  7. Applications connect to the warehouse via that DNS name using MySQL or HTTP. The Connection Examples popover on the Connection page shows ready-made snippets.

    private link connection example

    Note

    • VeloDB Cloud uses two independent account systems: Console accounts (sign in to the web console) and Database accounts (used to connect to the warehouse). This section is about database accounts.
    • For the first connection, use the admin user. You can initialize or reset its password from the Settings page.

On Azure

  1. On the target warehouse, open Connection → Private Link, click New Connection under Access VeloDB from Your VPC.

  2. Click Set up one or more endpoints to open Azure PrivateLink.

    azure private link access velodb 2

  3. In the Basics tab, make sure the region matches the VeloDB warehouse and fill in the form, then click Next: Resource.

    azure private link access velodb 3

    ParameterCategoryDescription
    SubscriptionProject detailsSubscription to use for access.
    Resource groupProject detailsResource group for the private endpoint. Create one if none is suitable.
    NameInstance detailsPrivate endpoint instance name.
    Network Interface NameInstance detailsAuto-generated from the instance name; editable.
    RegionInstance detailsMust match the warehouse region.
  4. In the Resource tab, choose Connect to an Azure resource by resource ID or alias, paste the Service Alias from the VeloDB endpoint service information panel, and click Next: Virtual Network.

    azure private link access velodb 4

  5. In the Virtual Network tab, pick the VNet and subnet for the endpoint and click Next: DNS.

    azure private link access velodb 5

  6. On the DNS and Tags tabs, keep the defaults (you need a DNS record to connect privately — see Azure's Private DNS guidance). Review and click Create.

    azure private link access velodb 6

    azure private link access velodb 7

    azure private link access velodb 8

  7. When the endpoint status changes from Created to OK, the handshake is done.

    azure private link access velodb 9 1

    azure private link access velodb 9 2

  8. Refresh the VeloDB Cloud Connection page — the endpoint list shows the connection details.

    azure private link access velodb 10

  9. Click Find DNS Name in the endpoint list to get the IP or DNS name of the endpoint.

    azure private link access velodb 11

  10. Use the Connection Examples popover on the Connection page for snippets covering MySQL and HTTP.

    azure private link access velodb 12

VeloDB accesses your VPC

VeloDB Accesses Your VPC

Use this direction when VeloDB needs to read from resources inside your VPC — for example, a data source for import.

Note Endpoint instance and traffic fees generated by VeloDB's access to the private network are currently not charged to users.

On AWS

  1. On the target warehouse, open Connection → Private Link, click New Connection under Grant VeloDB Access to Your VPC.

  2. The page displays the Current Region of the warehouse and the ARN of VeloDB. Click Set up endpoint services to open the AWS PrivateLink console.

    private link create connection choose endpoint service register

  3. In the AWS console, open VPC → Endpoint services, switch to the same region as the warehouse, and click Create endpoint service.

    private link create endpoint service on aws

  4. Configure the endpoint service and click Create.

    private link create connection choose endpoint service create

    private link create connection choose endpoint service create 1

    If there is no suitable network load balancer, click Create Network Load Balancer first, then filter and select it.

    private link create connection create nlb 0

    private link create connection create nlb 1

    private link create connection create nlb 2

    private link create connection create nlb 3

    If there is no suitable target group, click Create Target Group first, then refresh and select it.

    private link create connection create tg 0

    private link create connection create tg 1

  5. In the endpoint service's Allow principals tab, add ARN of VeloDB.

    private link create connection choose endpoint service details

    private link create connection choose endpoint service allow principals

  6. Copy the Service ID and Service Name from the endpoint service details page and paste them into the VeloDB Cloud Endpoint Service registration page.

    private link create connection choose endpoint service details02

  7. After registration, give the endpoint a name and click Create Now.

    private link create connection choose endpoint service chosen

  8. In the endpoint service's Endpoint connections tab, accept the endpoint connection request.

    private link velodb acdess user vpc endpoint accept

    private link velodb acdess user vpc endpoint accept ok

  9. Refresh and wait for the endpoint status to change from pendingAcceptance to available.

    private link velodb acdess user vpc endpoint pendingacceptance

On Azure

  1. On the target warehouse, open Connection → Private Link, click Set up Connection under Grant VeloDB Access to Your VPC.

  2. The page shows the Current Region and the Subscription ID of VeloDB. Click Set up endpoint services to open the Azure Private Link Service console.

    azure velodb access vpc 2

  3. In the Basics tab, make sure the region matches the warehouse and fill in the form, then click Next: Outbound settings.

    azure velodb access vpc 3

    ParameterCategoryDescription
    SubscriptionProject detailsSubscription for the Private Link Service.
    Resource groupProject detailsResource group to put the Private Link Service in.
    NameInstance detailsPrivate Link Service instance name.
    RegionInstance detailsMust match the warehouse region.
  4. On Outbound settings, select the load balancer, front-end IP, and source NAT network / subnet, then click Next: Access Security.

    azure velodb access vpc 4

  5. On Access Security, set Restricted by subscription, add the Subscription ID of VeloDB to the allowlist, set auto-approve to Yes, then click Next: Tags.

    azure velodb access vpc 5

  6. On Tags, keep defaults. Review and click Create.

    azure velodb access vpc 6

    azure velodb access vpc 7

  7. When the status changes from Created to OK, the service is ready.

    azure velodb access vpc 8

    azure velodb access vpc 8 2

  8. Copy the Resource ID and Alias from the Private Link Service details page and paste them into VeloDB Cloud's Endpoint Service registration page.

    azure velodb access vpc 9 1

    azure velodb access vpc 9 2

  9. After registration, give the endpoint a name and click Create Now.

    azure velodb access vpc 10 2

  10. Refresh and wait for the endpoint status to change from pendingAcceptance to Approve.

    azure velodb access vpc 11 1

    azure velodb access vpc 11 2

Public Access Allowlist

BYOC warehouses only. Controls which sources can perform data plane operations (query, upsert, fetch) via the console. Control plane operations (create, delete, scale, etc.) are not affected and remain fully accessible regardless of this setting.

byoc public access allowlist

Click Edit IP Allowlist to open the settings and choose one of three options:

byoc public access allowlist modal

OptionBehavior
AnywhereAll sources can reach the warehouse.
NowhereNo data plane access via the console.
Specific LocationsRestrict to listed IP addresses or CIDR blocks.

Connection strings

VeloDB Cloud uses the MySQL network connection protocol and is compatible with MySQL command line tools, JDBC/ODBC drivers, and visualization tools.

MySQL client:

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

JDBC:

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

If the warehouse has multiple clusters, route to a specific cluster by appending @<cluster_name> to the database name:

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

HTTP (Stream Load):

curl --location-trusted -u <username>:<password> \
-H "label:<load-label>" \
-H "column_separator:," \
-T data.csv \
http://<host>:<port>/api/<database>/<table>/_stream_load

To target a specific cluster, add the cloud_cluster header:

-H "cloud_cluster:<cluster>"

For the exact host and port, use the Connection Examples popover on the Connection page.