This article describes how to connect to PostgreSQL to create datasets.
Supports connecting to PostgreSQL databases to create datasets. Data connections support direct connection or offline extraction of PostgreSQL data sources.
warning
Direct connection requires product version V2.58.0 or later.
Before connecting to the data, contact the database administrator to collect the following information:
SaaS users must add to the allowlist in PostgreSQL by entering the "DataWind public IP address for access" in the allowlist settings area and granting this IP address permission to access the PostgreSQL service. The "DataWind public IP address for access" can be viewed Data Connections Overview.
warning
If SaaS users choose to connect using vpcMode, they must also add the IP address "100.64.0.0/10" to the allowlist configuration of the corresponding database (using MySQL as an example here), otherwise the connection will fail.
Go to BytePlus, click to enter a specific project, click Data Preparation, find Data Connection in the dropdown list, and click Data Connection.
Select PostgreSQL on the page.
The configuration instructions for connecting in the SaaS version are as follows:
Parameters | Configuration description |
|---|---|
Data connection name | Name for the new data connection, used to distinguish between different database connections in the system. For example, PostgreSQL_20250710163110. |
Server | The public network address of PostgreSQL. For details, refer to the official PostgreSQL documentation. |
Port | The instance port of PostgreSQL. For details, refer to the official PostgreSQL documentation. |
Username | The username created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel of the corresponding engine. |
Password | The password created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel of the corresponding engine. |
Database | The name of the database created in PostgreSQL. |
Driver | Generally defaults to org.postgresql.Driver. No modification is required. |
vpcMode | Select "Yes" to connect via the BytePlus intranet; select "No" for all other cases. |
VPC ID | This must be filled in when vpcMode is set to "Yes". For how to obtain it, refer to BytePlus intranet connection. warning To connect using vpcMode, add the IP address "100.64.0.0/10" to the allowlist configuration of the corresponding database; otherwise, the connection will fail. |
The configuration instructions for connecting in the self-hosted version are as follows:
Parameters | Configuration description |
|---|---|
Data connection name | Name for the new data connection, used to distinguish between different database connections in the system. For example, PostgreSQL_20250710163110. |
Server | The public network address of PostgreSQL. For details, refer to the official PostgreSQL documentation. |
Port | The instance port of PostgreSQL. For details, refer to the official PostgreSQL documentation. |
Username | The username created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel of the corresponding engine. |
Password | The password created in the database engine. If you do not know how to obtain it, it is recommended to contact the operations personnel of the corresponding engine. |
Database | The name of the database created in PostgreSQL. |
Driver | The default is usually org.postgresql.Driver and does not require modification. |
Go to BytePlus, click Data Preparation --> Dataset, select the "Create" button in the upper left corner to create a new dataset.
When selecting a data connection, click Create Configuration.
The subsequent steps are the same as steps 2 and 3 of Create from data connection above. After completing the configuration, you will remain in the pop-up window to select a data connection for the dataset, and you can proceed directly to the next step of dataset creation.
Use the previously created data connection to create a dataset: click Data Preparation --> Dataset, select the "Create" button in the upper left corner to create a new dataset.
Search for or select from the dropdown the previously created data connection.