All Products
Search

This Product

    Dataphin:Create a Vertica data source

    Document Center

    Dataphin:Create a Vertica data source

    Last Updated:Jun 23, 2026

    Create a Vertica data source to enable Dataphin to read business data from or write data to Vertica.

    Background information

    Vertica is a columnar storage database. Before connecting Vertica to Dataphin for data development, you must create a Vertica data source. For more information about Vertica, see Vertica official website.

    Permissions

    Only custom global roles with the Create Data Source permission and system roles such as super administrator, data source administrator, domain architect, and project administrator can create data sources.

    Procedure

    1. On the Dataphin homepage, click Management Center > Datasource Management in the top navigation bar.

    2. On the Datasource page, click +Create Data Source.

    3. On the Create Data Source page, select Vertica in the Relational Database section.

      Alternatively, select Vertica from the Recently Used section, or enter Vertica in the search box to find it quickly.

    4. On the Create Vertica Data Source page, configure the connection parameters.

      1. Configure the basic information of the data source.

        Parameter

        Description

        Datasource Name

        The name must meet the following requirements:

        • It can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-).

        • It cannot exceed 64 characters in length.

        Datasource Code

        After you configure the data source code, you can reference tables in the data source in Flink_SQL tasks by using the format data source code.table name or data source code.schema.table name. If you need to automatically access the data source in the corresponding environment based on the current environment, you can use the variable format ${data source code}.table or ${data source code}.schema.table. For more information, see Dataphin data source table development method.

        Important

        • The data source code cannot be modified after it is configured.

        • You can preview data on the object details page in the asset directory and asset checklist only after the data source code is configured.

        • In Flink SQL, only MySQL, Hologres, MaxCompute, Oracle, StarRocks, Hive, SelectDB, and GaussDB data warehouse service (DWS) data sources are currently supported.

        Data Source Description

        A brief description of the data source. It cannot exceed 128 characters.

        Data Source Configuration

        Select the data source to configure:

        • If the business data source distinguishes between production and development data sources, select Production + Development Data Source.

        • If the business data source does not distinguish between production and development data sources, select Production Data Source.

        Tag

        You can categorize and tag data sources using labels. For information about how to create tags, see Manage data source tags.

      2. Configure the connection parameters between the data source and Dataphin.

        If you selected Production + Development data source, configure connection information for both environments. If you selected Production data source, configure the connection information for the production environment only.

        Note

        We recommend configuring production and development as separate data sources for environment isolation. However, Dataphin also supports configuring them as the same data source with identical parameter values.

        Parameter

        Description

        JDBC URL

        The format of the connection URL is jdbc:vertica//host:port/dbname. For example, jdbc:vertica//192.168.*.1:5433/dataphin.

        Schema

        The schema of the Vertica database. If not specified, the default schema is public.

        Username, Password

        The username and password of the Vertica database.

      3. Configure advanced settings for the data source.

        Parameter

        Description

        loginTimeout

        The login timeout for database connections, in seconds. Default: 900 seconds (15 minutes).

        Note

        • If a loginTimeout value is specified in the JDBC URL, that value takes precedence.

        • For data sources created before Dataphin V3.11, the default loginTimeout is -1, which means no timeout limit.

        Connection Retries

        The number of automatic connection retries after a timeout. If the connection still fails after all retries, it is considered failed.

        Note

        • The default number of retries is 1. You can configure a value between 0 and 10.

        • The retry count applies by default to offline integration tasks and global quality (requires the asset quality module to be enabled). You can configure task-level retry counts separately in offline integration tasks.

    5. Select a Default Resource Group to run tasks related to this data source, such as database SQL, offline migration, and data preview.

    6. Click Test Connection or directly click OK to save and complete the creation of the Vertica data source.

      Clicking Test Connection verifies connectivity between the data source and Dataphin. If you click OK directly, the system automatically tests all selected clusters. The data source can still be created even if the connection test fails.