Create a Neo4j data source

Permissions

Only custom global roles with the Create data source permission and the following system roles can create data sources: super administrator, data source administrator, plate architect, and project administrator.

Procedure

1. In the top navigation bar of the Dataphin homepage, click Management Center > Data Source Management.

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

3. On the Create Data Source page, select Neo4j from the semi-structured storage section.

   If you have used Neo4j recently, you can also select it from the Recently used section. You can also enter Neo4j in the search box to find it quickly.

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

   1. Configure basic information for the data source.

      Parameter	Description
      Data source name	The following naming rules apply: The name can contain only Chinese characters, uppercase and lowercase letters, digits, underscores (_), and hyphens (-). The name can be up to 64 characters long.
      Data source code	A unique identifier for the data source. After you configure the data source code, you can reference a physical table in a Flink SQL job using the data_source_code.table or data_source_code.schema.table format. To automatically access the data source corresponding to the current environment, use the ${data_source_code}.table or ${data_source_code}.schema.table format. 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. The description can be up to 128 characters long.
      Data source configuration	Select the type of data source to configure: If your business data is separated into production and development environments, select production and development data source. If your business data is not separated into production and development environments, select production data source.
      Tag	You can use tags to classify data sources. For more information about creating tags, see Manage data source tags.

   2. Configure the data source connection parameters.

      If you select production and development data source, you must configure the connection information for the production and development data source. If your data source is configured as a production data source, you only need to configure the connection information for the production data source.

      Note

      Typically, you configure the production and development data sources as separate instances to ensure environment isolation and reduce the impact of development activities on the production environment. However, Dataphin allows you to configure them as the same data source by using identical parameter values.

      Parameter	Description
      URL	The URL to access the Neo4j instance. For example, bolt://host:7687.
      Username, password	The username and password to access the Neo4j instance.
      Database (Optional)	Enter the database name. The default value is neo4j.

5. Select a default resource group. This resource group runs jobs related to the data source, including database SQL jobs, offline full-database migration, and data preview.

6. Click Test Connection, or click OK to save the Neo4j data source.

   Clicking Test Connection verifies that Dataphin can connect to the data source. If you click OK directly, the system automatically tests the connection for all selected clusters. The system creates the data source even if all connection tests fail.

   Test Connection tests the connection for the Default Cluster or Registered Scheduling Clusters that have been registered in Dataphin and are in normal use. The Default Cluster is selected by default and cannot be deselected. If there are no resource groups under a Registered Scheduling Cluster, connection testing is not supported. You need to create a resource group first before testing the connection.

   • The selected clusters are used only to test network connectivity and are not used for running tasks.

   • The test connection usually completes within 2 minutes. If it times out, click the icon to view the reason and retry.

   • Regardless of the test result (Connection Failed, Connection Successful, or Succeeded With Warning), the system records the timestamp of the final result.

     Note

     Only the test results for the Default Cluster include three connection statuses: Succeeded With Warning, Connection Successful, and Connection Failed. The test results for Registered Scheduling Clusters in Dataphin only include two connection statuses: Connection Successful and Connection Failed.

   • When the test result is Connection Failed, click the icon to view the failure reason.

   • When the test result is Succeeded With Warning, the application cluster connection succeeded but the scheduling cluster connection failed. The data source cannot be used for data development and integration. Click the icon to view the log information.