Add PartiqlSharedCatalog for Send+Sync catalog usage. (#583)

Author: jpschorr

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Changed
 - Changed many internal `HashMap`s to use `rustc-hash`'s `FxHash`
+- *BREAKING* Refactors `Catalog` to allow `Send`+`Sync` for re-use.
 
 ### Added
 

extension/partiql-extension-csv/tests/scan.rs

@@ -1,4 +1,4 @@
-use partiql_catalog::catalog::{Catalog, PartiqlCatalog};
+use partiql_catalog::catalog::{PartiqlCatalog, SharedCatalog};
 use partiql_catalog::context::SystemContext;
 use partiql_catalog::extension::Extension;
 use partiql_eval::env::basic::MapBindings;
@@ -19,7 +19,7 @@ pub(crate) fn parse(statement: &str) -> ParserResult<'_> {
 #[track_caller]
 #[inline]
 pub(crate) fn lower(
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     parsed: &Parsed<'_>,
 ) -> partiql_logical::LogicalPlan<partiql_logical::BindingsOp> {
     let planner = partiql_logical_planner::LogicalPlanner::new(catalog);
@@ -29,7 +29,7 @@ pub(crate) fn lower(
 #[track_caller]
 #[inline]
 pub(crate) fn evaluate(
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     logical: partiql_logical::LogicalPlan<partiql_logical::BindingsOp>,
     bindings: MapBindings<Value>,
 ) -> (Value, Vec<EvaluationError>) {
@@ -61,6 +61,7 @@ pub(crate) fn evaluate_with_csv_scan(
     let ext = CsvExtension {};
     ext.load(&mut catalog)
         .expect("ion extension load to succeed");
+    let catalog = catalog.to_shared_catalog();
 
     let parsed = parse(statement);
     let lowered = lower(&catalog, &parsed.expect("parse"));

extension/partiql-extension-ion-functions/tests/scan.rs

@@ -1,4 +1,4 @@
-use partiql_catalog::catalog::{Catalog, PartiqlCatalog};
+use partiql_catalog::catalog::{PartiqlCatalog, SharedCatalog};
 use partiql_catalog::context::SystemContext;
 use partiql_catalog::extension::Extension;
 use partiql_eval::env::basic::MapBindings;
@@ -19,7 +19,7 @@ pub(crate) fn parse(statement: &str) -> ParserResult<'_> {
 #[track_caller]
 #[inline]
 pub(crate) fn lower(
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     parsed: &Parsed<'_>,
 ) -> partiql_logical::LogicalPlan<partiql_logical::BindingsOp> {
     let planner = partiql_logical_planner::LogicalPlanner::new(catalog);
@@ -29,7 +29,7 @@ pub(crate) fn lower(
 #[track_caller]
 #[inline]
 pub(crate) fn evaluate(
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     logical: partiql_logical::LogicalPlan<partiql_logical::BindingsOp>,
     bindings: MapBindings<Value>,
 ) -> (Value, Vec<EvaluationError>) {
@@ -61,6 +61,7 @@ pub(crate) fn evaluate_with_ion_scan(
     let ext = IonExtension {};
     ext.load(&mut catalog)
         .expect("ion extension load to succeed");
+    let catalog = catalog.to_shared_catalog();
 
     let parsed = parse(statement);
     let lowered = lower(&catalog, &parsed.expect("parse"));

partiql-ast-passes/src/name_resolver.rs

@@ -4,7 +4,7 @@ use indexmap::{IndexMap, IndexSet};
 use partiql_ast::ast;
 use partiql_ast::ast::{GraphPattern, GroupByExpr, GroupKey};
 use partiql_ast::visit::{Traverse, Visit, Visitor};
-use partiql_catalog::catalog::Catalog;
+use partiql_catalog::catalog::SharedCatalog;
 use partiql_common::node::NodeId;
 use std::sync::atomic::{AtomicU32, Ordering};
 
@@ -102,11 +102,11 @@ pub struct NameResolver<'c> {
 
     // errors that occur during name resolution
     errors: Vec<AstTransformError>,
-    catalog: &'c dyn Catalog,
+    catalog: &'c dyn SharedCatalog,
 }
 
 impl<'c> NameResolver<'c> {
-    pub fn new(catalog: &'c dyn Catalog) -> Self {
+    pub fn new(catalog: &'c dyn SharedCatalog) -> Self {
         NameResolver {
             // environment stack tracking
             id_path_to_root: Default::default(),

partiql-catalog/Cargo.toml

@@ -31,5 +31,5 @@ ordered-float = "5"
 itertools = "0.14"
 unicase = "2.7"
 rustc-hash = "2"
-
+delegate = "0.13"
 dyn-clone = "1"

partiql-catalog/src/catalog.rs

@@ -1,6 +1,7 @@
 use crate::call_defs::ScalarFnCallSpecs;
 use crate::scalar_fn::ScalarFunction;
 use crate::table_fn::TableFunction;
+use delegate::delegate;
 use partiql_common::catalog::{CatalogId, EntryId, ObjectId};
 use partiql_types::PartiqlShape;
 use rustc_hash::FxHashMap;
@@ -42,19 +43,22 @@ pub enum CatalogErrorKind {
     Unknown,
 }
 
-pub trait Catalog: Debug {
+pub trait MutableCatalog: Debug {
     fn add_table_function(&mut self, info: TableFunction) -> Result<ObjectId, CatalogError>;
     fn add_scalar_function(&mut self, info: ScalarFunction) -> Result<ObjectId, CatalogError>;
-
     fn add_type_entry(&mut self, entry: TypeEnvEntry<'_>) -> Result<ObjectId, CatalogError>;
+}
 
+pub trait ReadOnlyCatalog: Debug {
     fn get_function(&self, name: &str) -> Option<FunctionEntry<'_>>;
-
     fn get_function_by_id(&self, id: ObjectId) -> Option<FunctionEntry<'_>>;
-
     fn resolve_type(&self, name: &str) -> Option<TypeEntry>;
 }
 
+pub trait SharedCatalog: ReadOnlyCatalog + Send + Sync {}
+
+pub trait Catalog: MutableCatalog + ReadOnlyCatalog {}
+
 #[derive(Debug)]
 pub struct TypeEnvEntry<'a> {
     name: UniCase<String>,
@@ -123,6 +127,9 @@ pub struct PartiqlCatalog {
     id: CatalogId,
 }
 
+#[derive(Debug)]
+pub struct PartiqlSharedCatalog(PartiqlCatalog);
+
 impl Default for PartiqlCatalog {
     fn default() -> Self {
         PartiqlCatalog {
@@ -133,9 +140,15 @@ impl Default for PartiqlCatalog {
     }
 }
 
-impl PartiqlCatalog {}
+impl PartiqlCatalog {
+    pub fn to_shared_catalog(self) -> PartiqlSharedCatalog {
+        PartiqlSharedCatalog(self)
+    }
+}
+
+impl Catalog for PartiqlCatalog {}
 
-impl Catalog for PartiqlCatalog {
+impl MutableCatalog for PartiqlCatalog {
     fn add_table_function(&mut self, info: TableFunction) -> Result<ObjectId, CatalogError> {
         let call_def = info.call_def();
         let names = call_def.names.clone();
@@ -180,7 +193,9 @@ impl Catalog for PartiqlCatalog {
             Err(e) => Err(e),
         }
     }
+}
 
+impl ReadOnlyCatalog for PartiqlCatalog {
     fn get_function(&self, name: &str) -> Option<FunctionEntry<'_>> {
         self.functions
             .find_by_name(name)
@@ -202,6 +217,18 @@ impl Catalog for PartiqlCatalog {
     }
 }
 
+impl ReadOnlyCatalog for PartiqlSharedCatalog {
+    delegate! {
+        to self.0 {
+            fn get_function(&self, name: &str) -> Option<FunctionEntry<'_>>;
+            fn get_function_by_id(&self, id: ObjectId) -> Option<FunctionEntry<'_>>;
+            fn resolve_type(&self, name: &str) -> Option<TypeEntry>;
+        }
+    }
+}
+
+impl SharedCatalog for PartiqlSharedCatalog {}
+
 impl PartiqlCatalog {
     fn to_function_entry<'a>(
         &'a self,

partiql-catalog/src/scalar_fn.rs

@@ -11,7 +11,7 @@ use std::fmt::{Debug, Formatter};
 pub type ScalarFnExprResultValue<'a> = Cow<'a, Value>;
 pub type ScalarFnExprResult<'a> = Result<ScalarFnExprResultValue<'a>, ExtensionResultError>;
 
-pub trait ScalarFnExpr: DynClone + Debug {
+pub trait ScalarFnExpr: DynClone + Debug + Send + Sync {
     fn evaluate<'c>(
         &self,
         args: &[Cow<'_, Value>],

partiql-catalog/src/table_fn.rs

@@ -17,7 +17,7 @@ pub trait BaseTableExpr: Debug {
     ) -> BaseTableExprResult<'c>;
 }
 
-pub trait BaseTableFunctionInfo: Debug {
+pub trait BaseTableFunctionInfo: Debug + Send + Sync {
     fn call_def(&self) -> &CallDef;
     fn plan_eval(&self) -> Box<dyn BaseTableExpr>;
 }

partiql-conformance-tests/tests/mod.rs

@@ -1,19 +1,27 @@
 use partiql_ast_passes::error::AstTransformationError;
 use partiql_eval as eval;
+use std::ops::Deref;
 
 use partiql_eval::error::{EvalErr, PlanErr};
 use partiql_eval::eval::{BasicContext, EvalContext, EvalPlan, EvalResult, Evaluated};
 use partiql_logical as logical;
 use partiql_parser::{Parsed, ParserError, ParserResult};
 use partiql_value::DateTime;
 
-use partiql_catalog::catalog::{Catalog, PartiqlCatalog};
+use partiql_catalog::catalog::{PartiqlCatalog, PartiqlSharedCatalog, SharedCatalog};
 use partiql_catalog::context::SystemContext;
 use thiserror::Error;
 
 mod test_value;
 pub(crate) use test_value::TestValue;
 
+use once_cell::sync::Lazy;
+pub(crate) static SHARED_CATALOG: Lazy<PartiqlSharedCatalog> = Lazy::new(init_shared_catalog);
+
+fn init_shared_catalog() -> PartiqlSharedCatalog {
+    PartiqlCatalog::default().to_shared_catalog()
+}
+
 #[derive(Debug, Copy, Clone)]
 #[allow(dead_code)]
 pub(crate) enum EvaluationMode {
@@ -52,7 +60,7 @@ pub(crate) fn parse(statement: &str) -> ParserResult {
 #[track_caller]
 #[inline]
 pub(crate) fn lower(
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     parsed: &Parsed<'_>,
 ) -> Result<logical::LogicalPlan<logical::BindingsOp>, AstTransformationError> {
     let planner = partiql_logical_planner::LogicalPlanner::new(catalog);
@@ -63,7 +71,7 @@ pub(crate) fn lower(
 #[inline]
 pub(crate) fn compile(
     mode: EvaluationMode,
-    catalog: &dyn Catalog,
+    catalog: &dyn SharedCatalog,
     logical: logical::LogicalPlan<logical::BindingsOp>,
 ) -> Result<EvalPlan, PlanErr> {
     let mut planner = eval::plan::EvaluatorPlanner::new(mode.into(), catalog);
@@ -103,9 +111,9 @@ pub(crate) fn pass_syntax(statement: &str) -> Parsed {
 #[inline]
 #[allow(dead_code)]
 pub(crate) fn fail_semantics(statement: &str) {
-    let catalog = PartiqlCatalog::default();
+    let catalog: &PartiqlSharedCatalog = SHARED_CATALOG.deref();
     if let Ok(parsed) = parse(statement) {
-        let lowered = lower(&catalog, &parsed);
+        let lowered = lower(catalog, &parsed);
 
         assert!(
             lowered.is_err(),
@@ -118,9 +126,9 @@ pub(crate) fn fail_semantics(statement: &str) {
 #[inline]
 #[allow(dead_code)]
 pub(crate) fn pass_semantics(statement: &str) {
-    let catalog = PartiqlCatalog::default();
+    let catalog: &PartiqlSharedCatalog = SHARED_CATALOG.deref();
     let parsed = pass_syntax(statement);
-    let lowered = lower(&catalog, &parsed);
+    let lowered = lower(catalog, &parsed);
     assert!(
         lowered.is_ok(),
         "When semantically verifying `{statement}`, expected `Ok(_)`, but was `{lowered:#?}`"
@@ -171,17 +179,17 @@ pub(crate) fn eval<'a>(
     mode: EvaluationMode,
     env: &Option<TestValue>,
 ) -> Result<Evaluated, TestError<'a>> {
-    let catalog = PartiqlCatalog::default();
+    let catalog: &PartiqlSharedCatalog = SHARED_CATALOG.deref();
 
     let parsed = parse(statement)?;
-    let lowered = lower(&catalog, &parsed)?;
+    let lowered = lower(catalog, &parsed)?;
 
     let bindings = env.as_ref().map(|e| (&e.value).into()).unwrap_or_default();
     let sys = SystemContext {
         now: DateTime::from_system_now_utc(),
     };
     let ctx = BasicContext::new(bindings, sys);
-    let plan = compile(mode, &catalog, lowered)?;
+    let plan = compile(mode, catalog, lowered)?;
 
     Ok(evaluate(plan, &ctx)?)
 }

partiql-eval/Cargo.toml

@@ -44,6 +44,7 @@ rustc-hash = "2"
 delegate = "0.13"
 
 serde = { version = "1", features = ["derive"], optional = true }
+once_cell = "1"
 
 [dev-dependencies]
 criterion = "0.5"