1515// specific language governing permissions and limitations
1616// under the License.
1717
18- use std:: path:: PathBuf ;
18+ use std:: path:: { Path , PathBuf } ;
1919use std:: sync:: Arc ;
2020
2121use super :: {
22- TPCH_QUERY_END_ID , TPCH_QUERY_START_ID , TPCH_TABLES , get_query_sql ,
22+ TPCH_QUERY_END_ID , TPCH_QUERY_START_ID , TPCH_TABLES , get_query_sql_for_scale_factor ,
2323 get_tbl_tpch_table_schema, get_tpch_table_schema,
2424} ;
2525use crate :: util:: { BenchmarkRun , CommonOpt , QueryResult , print_memory_stats} ;
2626
2727use arrow:: record_batch:: RecordBatch ;
2828use arrow:: util:: pretty:: { self , pretty_format_batches} ;
29+ use datafusion:: common:: exec_err;
2930use datafusion:: datasource:: file_format:: FileFormat ;
3031use datafusion:: datasource:: file_format:: csv:: CsvFormat ;
3132use datafusion:: datasource:: file_format:: parquet:: ParquetFormat ;
@@ -71,6 +72,11 @@ pub struct RunOpt {
7172 #[ arg( required = true , short = 'p' , long = "path" ) ]
7273 path : PathBuf ,
7374
75+ /// TPC-H scale factor used for query substitutions such as Q11 FRACTION.
76+ /// If omitted, the benchmark tries to infer it from paths like `.../tpch_sf10/...`.
77+ #[ arg( long) ]
78+ scale_factor : Option < f64 > ,
79+
7480 /// File format: `csv` or `parquet`
7581 #[ arg( short = 'f' , long = "format" , default_value = "csv" ) ]
7682 file_format : String ,
@@ -133,10 +139,11 @@ impl RunOpt {
133139 let ctx = SessionContext :: new_with_config_rt ( config, rt) ;
134140 // register tables
135141 self . register_tables ( & ctx) . await ?;
142+ let scale_factor = self . scale_factor ( ) ?;
136143
137144 for query_id in query_range {
138145 benchmark_run. start_new_case ( & format ! ( "Query {query_id}" ) ) ;
139- let query_run = self . benchmark_query ( query_id, & ctx) . await ;
146+ let query_run = self . benchmark_query ( query_id, scale_factor , & ctx) . await ;
140147 match query_run {
141148 Ok ( query_results) => {
142149 for iter in query_results {
@@ -157,13 +164,14 @@ impl RunOpt {
157164 async fn benchmark_query (
158165 & self ,
159166 query_id : usize ,
167+ scale_factor : f64 ,
160168 ctx : & SessionContext ,
161169 ) -> Result < Vec < QueryResult > > {
162170 let mut millis = vec ! [ ] ;
163171 // run benchmark
164172 let mut query_results = vec ! [ ] ;
165173
166- let sql = & get_query_sql ( query_id) ?;
174+ let sql = & get_query_sql_for_scale_factor ( query_id, scale_factor ) ?;
167175
168176 for i in 0 ..self . iterations ( ) {
169177 let start = Instant :: now ( ) ;
@@ -346,6 +354,82 @@ impl RunOpt {
346354 . partitions
347355 . unwrap_or_else ( get_available_parallelism)
348356 }
357+
358+ fn scale_factor ( & self ) -> Result < f64 > {
359+ resolve_scale_factor ( self . scale_factor , & self . path )
360+ }
361+ }
362+
363+ fn resolve_scale_factor ( scale_factor : Option < f64 > , path : & Path ) -> Result < f64 > {
364+ let scale_factor = scale_factor
365+ . or_else ( || infer_scale_factor_from_path ( path) )
366+ . unwrap_or ( 1.0 ) ;
367+
368+ if scale_factor. is_finite ( ) && scale_factor > 0.0 {
369+ Ok ( scale_factor)
370+ } else {
371+ exec_err ! (
372+ "Invalid TPC-H scale factor {scale_factor}. Expected a positive finite value"
373+ )
374+ }
375+ }
376+
377+ fn infer_scale_factor_from_path ( path : & Path ) -> Option < f64 > {
378+ path. iter ( ) . find_map ( |component| {
379+ component
380+ . to_str ( ) ?
381+ . strip_prefix ( "tpch_sf" ) ?
382+ . parse :: < f64 > ( )
383+ . ok ( )
384+ } )
385+ }
386+
387+ #[ cfg( test) ]
388+ mod scale_factor_tests {
389+ use std:: path:: Path ;
390+
391+ use super :: { infer_scale_factor_from_path, resolve_scale_factor} ;
392+ use datafusion:: error:: Result ;
393+
394+ #[ test]
395+ fn uses_explicit_scale_factor_when_provided ( ) -> Result < ( ) > {
396+ let scale_factor =
397+ resolve_scale_factor ( Some ( 30.0 ) , Path :: new ( "benchmarks/data/tpch_sf10" ) ) ?;
398+ assert_eq ! ( scale_factor, 30.0 ) ;
399+ Ok ( ( ) )
400+ }
401+
402+ #[ test]
403+ fn infers_scale_factor_from_standard_tpch_path ( ) -> Result < ( ) > {
404+ let scale_factor =
405+ resolve_scale_factor ( None , Path :: new ( "benchmarks/data/tpch_sf10" ) ) ?;
406+ assert_eq ! ( scale_factor, 10.0 ) ;
407+ assert_eq ! (
408+ infer_scale_factor_from_path( Path :: new( "benchmarks/data/tpch_sf0.1" ) ) ,
409+ Some ( 0.1 )
410+ ) ;
411+ Ok ( ( ) )
412+ }
413+
414+ #[ test]
415+ fn defaults_to_sf1_when_path_has_no_scale_factor ( ) -> Result < ( ) > {
416+ let scale_factor = resolve_scale_factor ( None , Path :: new ( "benchmarks/data" ) ) ?;
417+ assert_eq ! ( scale_factor, 1.0 ) ;
418+ Ok ( ( ) )
419+ }
420+
421+ #[ test]
422+ fn rejects_invalid_scale_factors ( ) {
423+ assert ! ( resolve_scale_factor( Some ( 0.0 ) , Path :: new( "benchmarks/data" ) ) . is_err( ) ) ;
424+ assert ! ( resolve_scale_factor( Some ( -1.0 ) , Path :: new( "benchmarks/data" ) ) . is_err( ) ) ;
425+ assert ! (
426+ resolve_scale_factor( Some ( f64 :: NAN ) , Path :: new( "benchmarks/data" ) ) . is_err( )
427+ ) ;
428+ assert ! (
429+ resolve_scale_factor( Some ( f64 :: INFINITY ) , Path :: new( "benchmarks/data" ) )
430+ . is_err( )
431+ ) ;
432+ }
349433}
350434
351435#[ cfg( test) ]
@@ -392,6 +476,7 @@ mod tests {
392476 query : Some ( query) ,
393477 common,
394478 path : PathBuf :: from ( path. to_string ( ) ) ,
479+ scale_factor : Some ( 1.0 ) ,
395480 file_format : "tbl" . to_string ( ) ,
396481 mem_table : false ,
397482 output_path : None ,
@@ -402,7 +487,7 @@ mod tests {
402487 hash_join_buffering_capacity : 0 ,
403488 } ;
404489 opt. register_tables ( & ctx) . await ?;
405- let queries = get_query_sql ( query) ?;
490+ let queries = crate :: tpch :: get_query_sql ( query) ?;
406491 for query in queries {
407492 let plan = ctx. sql ( & query) . await ?;
408493 let plan = plan. into_optimized_plan ( ) ?;
@@ -432,6 +517,7 @@ mod tests {
432517 query : Some ( query) ,
433518 common,
434519 path : PathBuf :: from ( path. to_string ( ) ) ,
520+ scale_factor : Some ( 1.0 ) ,
435521 file_format : "tbl" . to_string ( ) ,
436522 mem_table : false ,
437523 output_path : None ,
@@ -442,7 +528,7 @@ mod tests {
442528 hash_join_buffering_capacity : 0 ,
443529 } ;
444530 opt. register_tables ( & ctx) . await ?;
445- let queries = get_query_sql ( query) ?;
531+ let queries = crate :: tpch :: get_query_sql ( query) ?;
446532 for query in queries {
447533 let plan = ctx. sql ( & query) . await ?;
448534 let plan = plan. create_physical_plan ( ) . await ?;
0 commit comments