Enum sc_client_db::DatabaseSource

pub enum DatabaseSource {
    Auto {
        paritydb_path: PathBuf,
        rocksdb_path: PathBuf,
        cache_size: usize,
    },
    ParityDb {
        path: PathBuf,
    },
    Custom {
        db: Arc<dyn Database<DbHash>>,
        require_create_flag: bool,
    },
}

Where to find the database..

Variants

Auto

Fields

paritydb_path: PathBuf

Path to the paritydb database.

rocksdb_path: PathBuf

Path to the rocksdb database.

cache_size: usize

Cache size in MiB. Used only by RocksDb variant of DatabaseSource.

Check given path, and see if there is an existing database there. If it’s either RocksDb or ParityDb, use it. If there is none, create a new instance of ParityDb.

ParityDb

Fields

path: PathBuf

Path to the database.

Load a ParityDb database from a given path.

Custom

Fields

db: Arc<dyn Database<DbHash>>

the handle to the custom storage

require_create_flag: bool

if set, the create flag will be required to open such datasource

Use a custom already-open database.

Implementations

impl DatabaseSource

pub fn path(&self) -> Option<&Path>

Return path for databases that are stored on disk.

Examples found in repository

src/utils.rs (line 383)

fn maybe_migrate_to_type_subdir<Block: BlockT>(
	source: &DatabaseSource,
	db_type: DatabaseType,
) -> Result<(), OpenDbError> {
	if let Some(p) = source.path() {
		let mut basedir = p.to_path_buf();
		basedir.pop();

		// Do we have to migrate to a database-type-based subdirectory layout:
		// See if there's a file identifying a rocksdb or paritydb folder in the parent dir and
		// the target path ends in a role specific directory
		if (basedir.join("db_version").exists() || basedir.join("metadata").exists()) &&
			(p.ends_with(DatabaseType::Full.as_str()))
		{
			// Try to open the database to check if the current `DatabaseType` matches the type of
			// database stored in the target directory and close the database on success.
			let mut old_source = source.clone();
			old_source.set_path(&basedir);
			open_database_at::<Block>(&old_source, db_type, false)?;

			info!(
				"Migrating database to a database-type-based subdirectory: '{:?}' -> '{:?}'",
				basedir,
				basedir.join(db_type.as_str())
			);

			let mut tmp_dir = basedir.clone();
			tmp_dir.pop();
			tmp_dir.push("tmp");

			fs::rename(&basedir, &tmp_dir)?;
			fs::create_dir_all(&p)?;
			fs::rename(tmp_dir, &p)?;
		}
	}

	Ok(())
}

pub fn set_path(&mut self, p: &Path) -> bool

Set path for databases that are stored on disk.

Examples found in repository

src/utils.rs (line 396)

fn maybe_migrate_to_type_subdir<Block: BlockT>(
	source: &DatabaseSource,
	db_type: DatabaseType,
) -> Result<(), OpenDbError> {
	if let Some(p) = source.path() {
		let mut basedir = p.to_path_buf();
		basedir.pop();

		// Do we have to migrate to a database-type-based subdirectory layout:
		// See if there's a file identifying a rocksdb or paritydb folder in the parent dir and
		// the target path ends in a role specific directory
		if (basedir.join("db_version").exists() || basedir.join("metadata").exists()) &&
			(p.ends_with(DatabaseType::Full.as_str()))
		{
			// Try to open the database to check if the current `DatabaseType` matches the type of
			// database stored in the target directory and close the database on success.
			let mut old_source = source.clone();
			old_source.set_path(&basedir);
			open_database_at::<Block>(&old_source, db_type, false)?;

			info!(
				"Migrating database to a database-type-based subdirectory: '{:?}' -> '{:?}'",
				basedir,
				basedir.join(db_type.as_str())
			);

			let mut tmp_dir = basedir.clone();
			tmp_dir.pop();
			tmp_dir.push("tmp");

			fs::rename(&basedir, &tmp_dir)?;
			fs::create_dir_all(&p)?;
			fs::rename(tmp_dir, &p)?;
		}
	}

	Ok(())
}

Trait Implementations

impl Clone for DatabaseSource

fn clone(&self) -> DatabaseSource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DatabaseSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for DatabaseSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.