Implementation:Apache Shardingsphere DataSourceUnitPersistService Persist

Knowledge Sources	Apache_Shardingsphere
Domains	Persistence, Data_Source
Last Updated	2026-02-10 00:00 GMT

Overview

Persistence service for loading and storing data source pool configurations with version management.

Description

DataSourceUnitPersistService handles the serialization and deserialization of DataSourcePoolProperties to and from the registry center. It uses VersionPersistService for versioned persistence and YamlDataSourceConfigurationSwapper for YAML conversion. Supports loading individual or all data source configurations for a database.

Usage

Used internally by the metadata persistence layer to load data source configurations during initialization and to persist changes when storage units are registered or altered.

Code Reference

Source Location

• Repository: Apache_Shardingsphere
• File: DataSourceUnitPersistService.java
• Lines: 1-101

Signature

@RequiredArgsConstructor
public final class DataSourceUnitPersistService {

    private final PersistRepository repository;

    public Map<String, DataSourcePoolProperties> load(String databaseName);
    public DataSourcePoolProperties load(String databaseName, String dataSourceName);
    public Collection<MetaDataVersion> persist(String databaseName, Map<String, DataSourcePoolProperties> dataSourcePoolPropsMap);
    public void delete(String databaseName, String dataSourceName);
}

Import

import org.apache.shardingsphere.mode.metadata.persist.config.database.DataSourceUnitPersistService;

I/O Contract

Inputs

Name	Type	Required	Description
databaseName	String	Yes	Target database name
dataSourcePoolPropsMap	Map<String, DataSourcePoolProperties>	Varies	Data source properties to persist

Outputs

Name	Type	Description
load() returns	Map<String, DataSourcePoolProperties>	All data source pool properties for a database
persist() returns	Collection<MetaDataVersion>	Version records created for persisted configs

Usage Examples

DataSourceUnitPersistService service = metaDataPersistFacade.getDataSourceUnitService();

// Load all data source configs for a database
Map<String, DataSourcePoolProperties> props = service.load("my_database");

// Persist new data source configurations
Collection<MetaDataVersion> versions = service.persist("my_database", newPropsMap);

Related Pages

• Principle:Apache_Shardingsphere_Versioned_Change_Persistence