1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
#![warn(missing_docs)]
//! Catalog abstraction layer.
use std::error::Error;
use std::fmt;
use std::time::{Duration, Instant};
use chrono::{DateTime, Utc, MIN_DATETIME};
use dataflow_types::sources::SourceConnector;
use lazy_static::lazy_static;
use build_info::{BuildInfo, DUMMY_BUILD_INFO};
use expr::{DummyHumanizer, ExprHumanizer, GlobalId, MirScalarExpr};
use ore::now::{EpochMillis, NowFn, NOW_ZERO};
use repr::{RelationDesc, ScalarType};
use sql_parser::ast::{Expr, Raw};
use uuid::Uuid;
use crate::func::Func;
use crate::names::{FullName, PartialName, SchemaName};
use crate::plan::statement::StatementDesc;
/// A catalog keeps track of SQL objects and session state available to the
/// planner.
///
/// The `sql` crate is agnostic to any particular catalog implementation. This
/// trait describes the required interface.
///
/// The SQL standard mandates a catalog hierarchy of exactly three layers. A
/// catalog contains databases, databases contain schemas, and schemas contain
/// catalog items, like sources, sinks, view, and indexes.
///
/// There are two classes of operations provided by a catalog:
///
/// * Resolution operations, like [`resolve_item`]. These fill in missing name
/// components based upon connection defaults, e.g., resolving the partial
/// name `view42` to the fully-specified name `materialize.public.view42`.
///
/// * Lookup operations, like [`SessionCatalog::get_item_by_id`]. These retrieve
/// metadata about a catalog entity based on a fully-specified name that is
/// known to be valid (i.e., because the name was successfully resolved,
/// or was constructed based on the output of a prior lookup operation).
/// These functions panic if called with invalid input.
///
/// [`list_databases`]: Catalog::list_databases
/// [`get_item`]: Catalog::resolve_item
/// [`resolve_item`]: SessionCatalog::resolve_item
pub trait SessionCatalog: fmt::Debug + ExprHumanizer {
/// Returns the search path used by the catalog.
fn search_path(&self, include_system_schemas: bool) -> Vec<&str>;
/// Returns the name of the user who is issuing the query.
fn user(&self) -> &str;
/// Returns the descriptor of the named prepared statement on the session, or
/// None if the prepared statement does not exist.
fn get_prepared_statement_desc(&self, name: &str) -> Option<&StatementDesc>;
/// Returns the database to use if one is not explicitly specified.
fn default_database(&self) -> &str;
/// Resolves the named database.
///
/// If `database_name` exists in the catalog, it returns the ID of the
/// resolved database; otherwise it returns an error.
fn resolve_database(&self, database_name: &str) -> Result<&dyn CatalogDatabase, CatalogError>;
/// Resolves a partially-specified schema name.
///
/// If `database_name` is provided, it searches the named database for a
/// schema named `schema_name`. If `database_name` is not provided, it
/// searches the default database instead. It returns the ID of the schema
/// if found; otherwise it returns an error if the database does not exist,
/// or if the database exists but the schema does not.
fn resolve_schema(
&self,
database_name: Option<String>,
schema_name: &str,
) -> Result<&dyn CatalogSchema, CatalogError>;
/// Resolves the named role.
fn resolve_role(&self, role_name: &str) -> Result<&dyn CatalogRole, CatalogError>;
/// Resolves a partially-specified item name.
///
/// If the partial name has a database component, it searches only the
/// specified database; otherwise, it searches the default database. If the
/// partial name has a schema component, it searches only the specified
/// schema; otherwise, it searches a default set of schemas within the
/// selected database. It returns an error if none of the searched schemas
/// contain an item whose name matches the item component of the partial
/// name.
///
/// Note that it is not an error if the named item appears in more than one
/// of the search schemas. The catalog implementation must choose one.
fn resolve_item(&self, item_name: &PartialName) -> Result<&dyn CatalogItem, CatalogError>;
/// Performs the same operation as [`SessionCatalog::resolve_item`] but for
/// functions within the catalog.
fn resolve_function(&self, item_name: &PartialName) -> Result<&dyn CatalogItem, CatalogError>;
/// Gets an item by its ID.
fn try_get_item_by_id(&self, id: &GlobalId) -> Option<&dyn CatalogItem>;
/// Gets an item by its ID.
///
/// Panics if `id` does not specify a valid item.
fn get_item_by_id(&self, id: &GlobalId) -> &dyn CatalogItem;
/// Gets an item by its OID.
///
/// Panics if `oid` does not specify a valid item.
fn get_item_by_oid(&self, oid: &u32) -> &dyn CatalogItem;
/// Reports whether the specified type exists in the catalog.
fn item_exists(&self, name: &FullName) -> bool;
/// Returns a lossy `ScalarType` associated with `id` if one exists.
///
/// For example `pg_catalog.numeric` returns `ScalarType::Numeric { scale: None}`,
/// meaning that its precision and scale need to be associated with values
/// from elsewhere.
fn try_get_lossy_scalar_type_by_id(&self, id: &GlobalId) -> Option<ScalarType>;
/// Finds a name like `name` that is not already in use.
///
/// If `name` itself is available, it is returned unchanged.
fn find_available_name(&self, mut name: FullName) -> FullName {
let mut i = 0;
let orig_item_name = name.item.clone();
while self.item_exists(&name) {
i += 1;
name.item = format!("{}{}", orig_item_name, i);
}
name
}
/// Returns the configuration of the catalog.
fn config(&self) -> &CatalogConfig;
/// Returns the number of milliseconds since the system epoch. For normal use
/// this means the Unix epoch. This can safely be mocked in tests and start
/// at 0.
fn now(&self) -> EpochMillis;
}
/// Configuration associated with a catalog.
#[derive(Debug, Clone)]
pub struct CatalogConfig {
/// Returns the time at which the catalog booted.
pub start_time: DateTime<Utc>,
/// Returns the instant at which the catalog booted.
pub start_instant: Instant,
/// A random integer associated with this instance of the catalog.
///
/// NOTE(benesch): this is only necessary for producing unique Kafka sink
/// topics. Perhaps we can remove this when #2915 is complete.
pub nonce: u64,
/// A persistent UUID associated with the catalog.
pub cluster_id: Uuid,
/// A transient UUID associated with this process.
pub session_id: Uuid,
/// Whether the server is running in experimental mode.
pub experimental_mode: bool,
/// Whether the server is running in safe mode.
pub safe_mode: bool,
/// Information about this build of Materialize.
pub build_info: &'static BuildInfo,
/// An external ID to be supplied to all AWS AssumeRole operations.
pub aws_external_id: Option<String>,
/// Default timestamp frequency for CREATE SOURCE
pub timestamp_frequency: Duration,
/// Function that returns a wall clock now time; can safely be mocked to return
/// 0.
pub now: NowFn,
/// Whether to prevent user indexes from being considered for use.
pub disable_user_indexes: bool,
}
/// A database in a [`SessionCatalog`].
pub trait CatalogDatabase {
/// Returns a fully-specified name of the database.
fn name(&self) -> &str;
/// Returns a stable ID for the database.
fn id(&self) -> i64;
/// Returns whether the database contains schemas.
fn has_schemas(&self) -> bool;
}
/// A schema in a [`SessionCatalog`].
pub trait CatalogSchema {
/// Returns a fully-specified name of the schema.
fn name(&self) -> &SchemaName;
/// Returns a stable ID for the schema.
fn id(&self) -> i64;
/// Lists the `CatalogItem`s for the schema.
fn has_items(&self) -> bool;
}
/// A role in a [`SessionCatalog`].
pub trait CatalogRole {
/// Returns a fully-specified name of the role.
fn name(&self) -> &str;
/// Returns a stable ID for the role.
fn id(&self) -> i64;
}
/// An item in a [`SessionCatalog`].
///
/// Note that "item" has a very specific meaning in the context of a SQL
/// catalog, and refers to the various entities that belong to a schema.
pub trait CatalogItem {
/// Returns the fully-specified name of the catalog item.
fn name(&self) -> &FullName;
/// Returns a stable ID for the catalog item.
fn id(&self) -> GlobalId;
/// Returns the catalog item's OID.
fn oid(&self) -> u32;
/// Returns a description of the result set produced by the catalog item.
///
/// If the catalog item is not of a type that produces data (i.e., a sink or
/// an index), it returns an error.
fn desc(&self) -> Result<&RelationDesc, CatalogError>;
/// Returns the resolved function.
///
/// If the catalog item is not of a type that produces functions (i.e.,
/// anything other than a function), it returns an error.
fn func(&self) -> Result<&'static Func, CatalogError>;
/// Returns the resolved source connector.
///
/// If the catalog item is not of a type that contains a `SourceConnector`
/// (i.e., anything other than sources), it returns an error.
fn source_connector(&self) -> Result<&SourceConnector, CatalogError>;
/// Returns the type of the catalog item.
fn item_type(&self) -> CatalogItemType;
/// A normalized SQL statement that describes how to create the catalog
/// item.
fn create_sql(&self) -> &str;
/// Returns the IDs of the catalog items upon which this catalog item
/// depends.
fn uses(&self) -> &[GlobalId];
/// Returns the IDs of the catalog items that depend upon this catalog item.
fn used_by(&self) -> &[GlobalId];
/// Returns the index details associated with the catalog item, if the
/// catalog item is an index.
fn index_details(&self) -> Option<(&[MirScalarExpr], GlobalId)>;
/// Returns the column defaults associated with the catalog item, if the
/// catalog item is a table.
fn table_details(&self) -> Option<&[Expr<Raw>]>;
}
/// The type of a [`CatalogItem`].
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
pub enum CatalogItemType {
/// A table.
Table,
/// A source.
Source,
/// A sink.
Sink,
/// A view.
View,
/// An index.
Index,
/// A type.
Type,
/// A func.
Func,
}
impl fmt::Display for CatalogItemType {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
CatalogItemType::Table => f.write_str("table"),
CatalogItemType::Source => f.write_str("source"),
CatalogItemType::Sink => f.write_str("sink"),
CatalogItemType::View => f.write_str("view"),
CatalogItemType::Index => f.write_str("index"),
CatalogItemType::Type => f.write_str("type"),
CatalogItemType::Func => f.write_str("func"),
}
}
}
/// An error returned by the catalog.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum CatalogError {
/// Unknown database.
UnknownDatabase(String),
/// Unknown schema.
UnknownSchema(String),
/// Unknown role.
UnknownRole(String),
/// Unknown item.
UnknownItem(String),
/// Unknown function.
UnknownFunction(String),
/// Unknown source.
UnknownSource(String),
/// Invalid attempt to depend on a non-dependable item.
InvalidDependency {
/// The invalid item's name.
name: String,
/// The invalid item's type.
typ: CatalogItemType,
},
}
impl fmt::Display for CatalogError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match self {
Self::UnknownDatabase(name) => write!(f, "unknown database '{}'", name),
Self::UnknownFunction(name) => write!(f, "function \"{}\" does not exist", name),
Self::UnknownSource(name) => write!(f, "source \"{}\" does not exist", name),
Self::UnknownSchema(name) => write!(f, "unknown schema '{}'", name),
Self::UnknownRole(name) => write!(f, "unknown role '{}'", name),
Self::UnknownItem(name) => write!(f, "unknown catalog item '{}'", name),
Self::InvalidDependency { name, typ } => write!(
f,
"catalog item '{}' is {} {} and so cannot be depended upon",
name,
if matches!(typ, CatalogItemType::Index) {
"an"
} else {
"a"
},
typ,
),
}
}
}
impl Error for CatalogError {}
/// A dummy [`SessionCatalog`] implementation.
///
/// This implementation is suitable for use in tests that plan queries which are
/// not demanding of the catalog, as many methods are unimplemented.
#[derive(Debug)]
pub struct DummyCatalog;
lazy_static! {
static ref DUMMY_CONFIG: CatalogConfig = CatalogConfig {
start_time: MIN_DATETIME,
start_instant: Instant::now(),
nonce: 0,
cluster_id: Uuid::from_u128(0),
session_id: Uuid::from_u128(0),
experimental_mode: true,
safe_mode: false,
build_info: &DUMMY_BUILD_INFO,
aws_external_id: None,
timestamp_frequency: Duration::from_secs(1),
now: NOW_ZERO.clone(),
disable_user_indexes: false,
};
}
impl SessionCatalog for DummyCatalog {
fn search_path(&self, _: bool) -> Vec<&str> {
vec!["dummy"]
}
fn user(&self) -> &str {
"dummy"
}
fn get_prepared_statement_desc(&self, _: &str) -> Option<&StatementDesc> {
None
}
fn default_database(&self) -> &str {
"dummy"
}
fn resolve_database(&self, _: &str) -> Result<&dyn CatalogDatabase, CatalogError> {
unimplemented!();
}
fn resolve_schema(
&self,
_: Option<String>,
_: &str,
) -> Result<&dyn CatalogSchema, CatalogError> {
unimplemented!();
}
fn resolve_role(&self, _: &str) -> Result<&dyn CatalogRole, CatalogError> {
unimplemented!();
}
fn resolve_item(&self, _: &PartialName) -> Result<&dyn CatalogItem, CatalogError> {
unimplemented!();
}
fn resolve_function(&self, _: &PartialName) -> Result<&dyn CatalogItem, CatalogError> {
unimplemented!();
}
fn get_item_by_id(&self, _: &GlobalId) -> &dyn CatalogItem {
unimplemented!();
}
fn try_get_item_by_id(&self, _: &GlobalId) -> Option<&dyn CatalogItem> {
unimplemented!();
}
fn get_item_by_oid(&self, _: &u32) -> &dyn CatalogItem {
unimplemented!();
}
fn item_exists(&self, _: &FullName) -> bool {
false
}
fn try_get_lossy_scalar_type_by_id(&self, _: &GlobalId) -> Option<ScalarType> {
None
}
fn config(&self) -> &CatalogConfig {
&DUMMY_CONFIG
}
fn now(&self) -> EpochMillis {
(self.config().now)()
}
}
impl ExprHumanizer for DummyCatalog {
fn humanize_id(&self, id: GlobalId) -> Option<String> {
DummyHumanizer.humanize_id(id)
}
fn humanize_scalar_type(&self, ty: &ScalarType) -> String {
DummyHumanizer.humanize_scalar_type(ty)
}
}