reifydb-catalog 0.4.13

// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2025 ReifyDB

use std::sync::Arc;

use reifydb_core::interface::VTable;

use super::VTable;

/// Factory for creating virtual table instances.
///
/// Implementations must be thread-safe and create fresh instances on each call.
/// The factory pattern allows virtual tables to be registered once and instantiated
/// on-demand for each query execution.
///
/// # Example
///
/// ```ignore
/// struct MyTableFactory {
///     definition: Arc<VTable>,
/// }
///
/// impl VirtualTableFactory for MyTableFactory {
///     fn create_boxed(&self) -> Box<dyn BaseVTable + Send + Sync> {
///         Box::new(MyVirtualTable::new(self.vtable.clone()))
///     }
///
///     fn definition(&self) -> Arc<VTable> {
///         self.vtable.clone()
///     }
/// }
/// ```
pub trait VirtualTableFactory: Send + Sync + 'static {
	/// Create a new virtual table instance.
	///
	/// Each call should return a fresh instance ready to process a new query.
	fn create_boxed(&self) -> Box<dyn BaseVTable + Send + Sync>;

	/// Get the table definition (shape).
	///
	/// Returns the metadata including column names, types, and constraints.
	fn definition(&self) -> Arc<VTable>;
}