diff --git a/sqllogictest/src/parser.rs b/sqllogictest/src/parser.rs index 39d79b1..0e59ddd 100644 --- a/sqllogictest/src/parser.rs +++ b/sqllogictest/src/parser.rs @@ -294,6 +294,7 @@ impl std::fmt::Display for Record { } } +/// Whether to enable or disable a feature. Used in `control` statements. #[derive(Debug, PartialEq, Eq, Clone)] pub enum OnOff { On, diff --git a/sqllogictest/src/runner.rs b/sqllogictest/src/runner.rs index f6d5abe..2799151 100644 --- a/sqllogictest/src/runner.rs +++ b/sqllogictest/src/runner.rs @@ -21,6 +21,7 @@ use crate::parser::*; use crate::substitution::Substitution; use crate::{ColumnType, Connections, MakeConnection}; +/// Type-erased error type. type AnyError = Arc; #[derive(Debug, Clone)] @@ -1067,8 +1068,8 @@ impl> Runner { block_on(self.run_parallel_async(glob, hosts, conn_builder, jobs)) } - /// Substitute the input SQL or command with environment variables and `__TEST_DIR__`, if - /// enabled with `control`. + /// Substitute the input SQL or command with [`Substitution`], if enabled by `control + /// substitution`. fn may_substitute(&self, input: String) -> Result { if let Some(substitution) = &self.substitution { subst::substitute(&input, substitution).map_err(|e| Arc::new(e) as AnyError) diff --git a/sqllogictest/src/substitution.rs b/sqllogictest/src/substitution.rs index f376c0c..7ca27da 100644 --- a/sqllogictest/src/substitution.rs +++ b/sqllogictest/src/substitution.rs @@ -3,8 +3,11 @@ use std::sync::OnceLock; use subst::Env; use tempfile::{tempdir, TempDir}; +/// Substitute environment variables and special variables like `__TEST_DIR__` in SQL. #[derive(Default)] pub(crate) struct Substitution { + /// The temporary directory for `__TEST_DIR__`. + /// Lazily initialized and cleaned up when dropped. test_dir: OnceLock, }