mz_sql/session/vars.rs
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 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405
// 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.
//! Run-time configuration parameters
//!
//! ## Overview
//! Materialize roughly follows the PostgreSQL configuration model, which works
//! as follows. There is a global set of named configuration parameters, like
//! `DateStyle` and `client_encoding`. These parameters can be set in several
//! places: in an on-disk configuration file (in Postgres, named
//! postgresql.conf), in command line arguments when the server is started, or
//! at runtime via the `ALTER SYSTEM` or `SET` statements. Parameters that are
//! set in a session take precedence over database defaults, which in turn take
//! precedence over command line arguments, which in turn take precedence over
//! settings in the on-disk configuration. Note that changing the value of
//! parameters obeys transaction semantics: if a transaction fails to commit,
//! any parameters that were changed in that transaction (i.e., via `SET`) will
//! be rolled back to their previous value.
//!
//! The Materialize configuration hierarchy at the moment is much simpler.
//! Global defaults are hardcoded into the binary, and a select few parameters
//! can be overridden per session. A select few parameters can be overridden on
//! disk.
//!
//! The set of variables that can be overridden per session and the set of
//! variables that can be overridden on disk are currently disjoint. The
//! infrastructure has been designed with an eye towards merging these two sets
//! and supporting additional layers to the hierarchy, however, should the need
//! arise.
//!
//! The configuration parameters that exist are driven by compatibility with
//! PostgreSQL drivers that expect them, not because they are particularly
//! important.
//!
//! ## Structure
//! Thw most meaningful exports from this module are:
//!
//! - [`SessionVars`] represent per-session parameters, which each user can
//! access independently of one another, and are accessed via `SET`.
//!
//! The fields of [`SessionVars`] are either;
//! - `SessionVar`, which is preferable and simply requires full support of
//! the `SessionVar` impl for its embedded value type.
//! - `ServerVar` for types that do not currently support everything
//! required by `SessionVar`, e.g. they are fixed-value parameters.
//!
//! In the fullness of time, all fields in [`SessionVars`] should be
//! `SessionVar`.
//!
//! - [`SystemVars`] represent system-wide configuration settings and are
//! accessed via `ALTER SYSTEM SET`.
//!
//! All elements of [`SystemVars`] are `SystemVar`.
//!
//! Some [`VarDefinition`] are also marked as a [`FeatureFlag`]; this is just a
//! wrapper to make working with a set of [`VarDefinition`] easier, primarily from
//! within SQL planning, where we might want to check if a feature is enabled
//! before planning it.
use std::borrow::Cow;
use std::clone::Clone;
use std::collections::BTreeMap;
use std::fmt::Debug;
use std::net::IpAddr;
use std::string::ToString;
use std::sync::{Arc, LazyLock};
use std::time::Duration;
use chrono::{DateTime, Utc};
use derivative::Derivative;
use im::OrdMap;
use mz_build_info::BuildInfo;
use mz_dyncfg::{ConfigSet, ConfigType, ConfigUpdates, ConfigVal};
use mz_persist_client::cfg::{CRDB_CONNECT_TIMEOUT, CRDB_TCP_USER_TIMEOUT};
use mz_repr::adt::numeric::Numeric;
use mz_repr::adt::timestamp::CheckedTimestamp;
use mz_repr::bytes::ByteSize;
use mz_repr::user::ExternalUserMetadata;
use mz_tracing::{CloneableEnvFilter, SerializableDirective};
use serde::Serialize;
use thiserror::Error;
use tracing::error;
use uncased::UncasedStr;
use crate::ast::Ident;
use crate::session::user::User;
pub(crate) mod constraints;
pub(crate) mod definitions;
pub(crate) mod errors;
pub(crate) mod polyfill;
pub(crate) mod value;
pub use definitions::*;
pub use errors::*;
pub use value::*;
/// The action to take during end_transaction.
///
/// This enum lives here because of convenience: it's more of an adapter
/// concept but [`SessionVars::end_transaction`] takes it.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EndTransactionAction {
/// Commit the transaction.
Commit,
/// Rollback the transaction.
Rollback,
}
/// Represents the input to a variable.
///
/// Each variable has different rules for how it handles each style of input.
/// This type allows us to defer interpretation of the input until the
/// variable-specific interpretation can be applied.
#[derive(Debug, Clone, Copy)]
pub enum VarInput<'a> {
/// The input has been flattened into a single string.
Flat(&'a str),
/// The input comes from a SQL `SET` statement and is jumbled across
/// multiple components.
SqlSet(&'a [String]),
}
impl<'a> VarInput<'a> {
/// Converts the variable input to an owned vector of strings.
pub fn to_vec(&self) -> Vec<String> {
match self {
VarInput::Flat(v) => vec![v.to_string()],
VarInput::SqlSet(values) => values.into_iter().map(|v| v.to_string()).collect(),
}
}
}
/// An owned version of [`VarInput`].
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Serialize)]
pub enum OwnedVarInput {
/// See [`VarInput::Flat`].
Flat(String),
/// See [`VarInput::SqlSet`].
SqlSet(Vec<String>),
}
impl OwnedVarInput {
/// Converts this owned variable input as a [`VarInput`].
pub fn borrow(&self) -> VarInput {
match self {
OwnedVarInput::Flat(v) => VarInput::Flat(v),
OwnedVarInput::SqlSet(v) => VarInput::SqlSet(v),
}
}
}
/// A `Var` represents a configuration parameter of an arbitrary type.
pub trait Var: Debug {
/// Returns the name of the configuration parameter.
fn name(&self) -> &'static str;
/// Constructs a flattened string representation of the current value of the
/// configuration parameter.
///
/// The resulting string is guaranteed to be parsable if provided to
/// `Value::parse` as a [`VarInput::Flat`].
fn value(&self) -> String;
/// Returns a short sentence describing the purpose of the configuration
/// parameter.
fn description(&self) -> &'static str;
/// Returns the name of the type of this variable.
fn type_name(&self) -> Cow<'static, str>;
/// Indicates wither the [`Var`] is visible as a function of the `user` and `system_vars`.
/// "Invisible" parameters return `VarErrors`.
///
/// Variables marked as `internal` are only visible for the system user.
fn visible(&self, user: &User, system_vars: &SystemVars) -> Result<(), VarError>;
/// Reports whether the variable is only visible in unsafe mode.
fn is_unsafe(&self) -> bool {
self.name().starts_with("unsafe_")
}
/// Upcast `self` to a `dyn Var`, useful when working with multiple different implementors of
/// [`Var`].
fn as_var(&self) -> &dyn Var
where
Self: Sized,
{
self
}
}
/// A `SessionVar` is the session value for a configuration parameter. If unset,
/// the server default is used instead.
///
/// Note: even though all of the different `*_value` fields are `Box<dyn Value>` they are enforced
/// to be the same type because we use the `definition`s `parse(...)` method. This is guaranteed to
/// return the same type as the compiled in default.
#[derive(Debug)]
pub struct SessionVar {
definition: VarDefinition,
/// System or Role default value.
default_value: Option<Box<dyn Value>>,
/// Value `LOCAL` to a transaction, will be unset at the completion of the transaction.
local_value: Option<Box<dyn Value>>,
/// Value set during a transaction, will be set if the transaction is committed.
staged_value: Option<Box<dyn Value>>,
/// Value that overrides the default.
session_value: Option<Box<dyn Value>>,
}
impl Clone for SessionVar {
fn clone(&self) -> Self {
SessionVar {
definition: self.definition.clone(),
default_value: self.default_value.as_ref().map(|v| v.box_clone()),
local_value: self.local_value.as_ref().map(|v| v.box_clone()),
staged_value: self.staged_value.as_ref().map(|v| v.box_clone()),
session_value: self.session_value.as_ref().map(|v| v.box_clone()),
}
}
}
impl SessionVar {
pub const fn new(var: VarDefinition) -> Self {
SessionVar {
definition: var,
default_value: None,
local_value: None,
staged_value: None,
session_value: None,
}
}
/// Checks if the provided [`VarInput`] is valid for the current session variable, returning
/// the formatted output if it's valid.
pub fn check(&self, input: VarInput) -> Result<String, VarError> {
let v = self.definition.parse(input)?;
self.validate_constraints(v.as_ref())?;
Ok(v.format())
}
/// Parse the input and update the stored value to match.
pub fn set(&mut self, input: VarInput, local: bool) -> Result<(), VarError> {
let v = self.definition.parse(input)?;
// Validate our parsed value.
self.validate_constraints(v.as_ref())?;
if local {
self.local_value = Some(v);
} else {
self.local_value = None;
self.staged_value = Some(v);
}
Ok(())
}
/// Sets the default value for the variable.
pub fn set_default(&mut self, input: VarInput) -> Result<(), VarError> {
let v = self.definition.parse(input)?;
self.validate_constraints(v.as_ref())?;
self.default_value = Some(v);
Ok(())
}
/// Reset the stored value to the default.
pub fn reset(&mut self, local: bool) {
let value = self
.default_value
.as_ref()
.map(|v| v.as_ref())
.unwrap_or(self.definition.value.value());
if local {
self.local_value = Some(value.box_clone());
} else {
self.local_value = None;
self.staged_value = Some(value.box_clone());
}
}
/// Returns a possibly new SessionVar if this needs to mutate at transaction end.
#[must_use]
pub fn end_transaction(&self, action: EndTransactionAction) -> Option<Self> {
if !self.is_mutating() {
return None;
}
let mut next: Self = self.clone();
next.local_value = None;
match action {
EndTransactionAction::Commit if next.staged_value.is_some() => {
next.session_value = next.staged_value.take()
}
_ => next.staged_value = None,
}
Some(next)
}
/// Whether this Var needs to mutate at the end of a transaction.
pub fn is_mutating(&self) -> bool {
self.local_value.is_some() || self.staged_value.is_some()
}
pub fn value_dyn(&self) -> &dyn Value {
self.local_value
.as_deref()
.or(self.staged_value.as_deref())
.or(self.session_value.as_deref())
.or(self.default_value.as_deref())
.unwrap_or(self.definition.value.value())
}
/// Returns the [`Value`] that is currently stored as the `session_value`.
///
/// Note: This should __only__ be used for inspection, if you want to determine the current
/// value of this [`SessionVar`] you should use [`SessionVar::value`].
pub fn inspect_session_value(&self) -> Option<&dyn Value> {
self.session_value.as_deref()
}
fn validate_constraints(&self, val: &dyn Value) -> Result<(), VarError> {
if let Some(constraint) = &self.definition.constraint {
constraint.check_constraint(self, self.value_dyn(), val)
} else {
Ok(())
}
}
}
impl Var for SessionVar {
fn name(&self) -> &'static str {
self.definition.name.as_str()
}
fn value(&self) -> String {
self.value_dyn().format()
}
fn description(&self) -> &'static str {
self.definition.description
}
fn type_name(&self) -> Cow<'static, str> {
self.definition.type_name()
}
fn visible(
&self,
user: &User,
system_vars: &super::vars::SystemVars,
) -> Result<(), super::vars::VarError> {
self.definition.visible(user, system_vars)
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct MzVersion {
/// Inputs to computed variables.
build_info: &'static BuildInfo,
/// Helm chart version
helm_chart_version: Option<String>,
}
impl MzVersion {
pub fn new(build_info: &'static BuildInfo, helm_chart_version: Option<String>) -> Self {
MzVersion {
build_info,
helm_chart_version,
}
}
}
/// Session variables.
///
/// See the [`crate::session::vars`] module documentation for more details on the
/// Materialize configuration model.
#[derive(Debug, Clone)]
pub struct SessionVars {
/// The set of all session variables.
vars: OrdMap<&'static UncasedStr, SessionVar>,
/// Inputs to computed variables.
mz_version: MzVersion,
/// Information about the user associated with this Session.
user: User,
}
impl SessionVars {
/// Creates a new [`SessionVars`] without considering the System or Role defaults.
pub fn new_unchecked(
build_info: &'static BuildInfo,
user: User,
helm_chart_version: Option<String>,
) -> SessionVars {
use definitions::*;
let vars = [
&FAILPOINTS,
&SERVER_VERSION,
&SERVER_VERSION_NUM,
&SQL_SAFE_UPDATES,
&REAL_TIME_RECENCY,
&EMIT_PLAN_INSIGHTS_NOTICE,
&EMIT_TIMESTAMP_NOTICE,
&EMIT_TRACE_ID_NOTICE,
&AUTO_ROUTE_CATALOG_QUERIES,
&ENABLE_SESSION_RBAC_CHECKS,
&ENABLE_SESSION_CARDINALITY_ESTIMATES,
&MAX_IDENTIFIER_LENGTH,
&STATEMENT_LOGGING_SAMPLE_RATE,
&EMIT_INTROSPECTION_QUERY_NOTICE,
&UNSAFE_NEW_TRANSACTION_WALL_TIME,
&WELCOME_MESSAGE,
]
.into_iter()
.chain(SESSION_SYSTEM_VARS.iter().map(|(_name, var)| *var))
.map(|var| (var.name, SessionVar::new(var.clone())))
.collect();
SessionVars {
vars,
mz_version: MzVersion::new(build_info, helm_chart_version),
user,
}
}
fn expect_value<V: Value>(&self, var: &VarDefinition) -> &V {
let var = self
.vars
.get(var.name)
.expect("provided var should be in state");
let val = var.value_dyn();
val.as_any().downcast_ref::<V>().expect("success")
}
/// Returns an iterator over the configuration parameters and their current
/// values for this session.
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
pub fn iter(&self) -> impl Iterator<Item = &dyn Var> {
#[allow(clippy::as_conversions)]
self.vars
.values()
.map(|v| v.as_var())
.chain([&self.mz_version as &dyn Var, &self.user])
}
/// Returns an iterator over configuration parameters (and their current
/// values for this session) that are expected to be sent to the client when
/// a new connection is established or when their value changes.
pub fn notify_set(&self) -> impl Iterator<Item = &dyn Var> {
// WARNING: variables in this set are not checked for visibility, and
// are assumed to be visible for all sessions.
//
// This is fixible with some elbow grease, but at the moment it seems
// unlikely that we'll have a variable in the notify set that shouldn't
// be visible to all sessions.
[
&APPLICATION_NAME,
&CLIENT_ENCODING,
&DATE_STYLE,
&INTEGER_DATETIMES,
&SERVER_VERSION,
&STANDARD_CONFORMING_STRINGS,
&TIMEZONE,
&INTERVAL_STYLE,
// Including `cluster`, `cluster_replica`, `database`, and `search_path` in the notify
// set is a Materialize extension. Doing so allows users to more easily identify where
// their queries will be executing, which is important to know when you consider the
// size of a cluster, what indexes are present, etc.
&CLUSTER,
&CLUSTER_REPLICA,
&DATABASE,
&SEARCH_PATH,
]
.into_iter()
.map(|v| self.vars[v.name].as_var())
// Including `mz_version` in the notify set is a Materialize
// extension. Doing so allows applications to detect whether they
// are talking to Materialize or PostgreSQL without an additional
// network roundtrip. This is known to be safe because CockroachDB
// has an analogous extension [0].
// [0]: https://github.com/cockroachdb/cockroach/blob/369c4057a/pkg/sql/pgwire/conn.go#L1840
.chain(std::iter::once(self.mz_version.as_var()))
}
/// Resets all variables to their default value.
pub fn reset_all(&mut self) {
let names: Vec<_> = self.vars.keys().copied().collect();
for name in names {
self.vars[name].reset(false);
}
}
/// Returns a [`Var`] representing the configuration parameter with the
/// specified name.
///
/// Configuration parameters are matched case insensitively. If no such
/// configuration parameter exists, `get` returns an error.
///
/// Note that if `name` is known at compile time, you should instead use the
/// named accessor to access the variable with its true Rust type. For
/// example, `self.get("sql_safe_updates").value()` returns the string
/// `"true"` or `"false"`, while `self.sql_safe_updates()` returns a bool.
pub fn get(&self, system_vars: &SystemVars, name: &str) -> Result<&dyn Var, VarError> {
let name = compat_translate_name(name);
let name = UncasedStr::new(name);
if name == MZ_VERSION_NAME {
Ok(&self.mz_version)
} else if name == IS_SUPERUSER_NAME {
Ok(&self.user)
} else {
self.vars
.get(name)
.map(|v| {
v.visible(&self.user, system_vars)?;
Ok(v.as_var())
})
.transpose()?
.ok_or_else(|| VarError::UnknownParameter(name.to_string()))
}
}
/// Returns a [`SessionVar`] for inspection.
///
/// Note: If you're trying to determine the value of the variable with `name` you should
/// instead use the named accessor, or [`SessionVars::get`].
pub fn inspect(&self, name: &str) -> Result<&SessionVar, VarError> {
let name = compat_translate_name(name);
self.vars
.get(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.to_string()))
}
/// Sets the configuration parameter named `name` to the value represented
/// by `value`.
///
/// The new value may be either committed or rolled back by the next call to
/// [`SessionVars::end_transaction`]. If `local` is true, the new value is always
/// discarded by the next call to [`SessionVars::end_transaction`], even if the
/// transaction is marked to commit.
///
/// Like with [`SessionVars::get`], configuration parameters are matched case
/// insensitively. If `value` is not valid, as determined by the underlying
/// configuration parameter, or if the named configuration parameter does
/// not exist, an error is returned.
pub fn set(
&mut self,
system_vars: &SystemVars,
name: &str,
input: VarInput,
local: bool,
) -> Result<(), VarError> {
let (name, input) = compat_translate(name, input);
let name = UncasedStr::new(name);
self.check_read_only(name)?;
self.vars
.get_mut(name)
.map(|v| {
v.visible(&self.user, system_vars)?;
v.set(input, local)
})
.transpose()?
.ok_or_else(|| VarError::UnknownParameter(name.to_string()))
}
/// Sets the default value for the parameter named `name` to the value
/// represented by `value`.
pub fn set_default(&mut self, name: &str, input: VarInput) -> Result<(), VarError> {
let (name, input) = compat_translate(name, input);
let name = UncasedStr::new(name);
self.check_read_only(name)?;
self.vars
.get_mut(name)
// Note: visibility is checked when persisting a role default.
.map(|v| v.set_default(input))
.transpose()?
.ok_or_else(|| VarError::UnknownParameter(name.to_string()))
}
/// Sets the configuration parameter named `name` to its default value.
///
/// The new value may be either committed or rolled back by the next call to
/// [`SessionVars::end_transaction`]. If `local` is true, the new value is
/// always discarded by the next call to [`SessionVars::end_transaction`],
/// even if the transaction is marked to commit.
///
/// Like with [`SessionVars::get`], configuration parameters are matched
/// case insensitively. If the named configuration parameter does not exist,
/// an error is returned.
///
/// If the variable does not exist or the user does not have the visibility
/// requires, this function returns an error.
pub fn reset(
&mut self,
system_vars: &SystemVars,
name: &str,
local: bool,
) -> Result<(), VarError> {
let name = compat_translate_name(name);
let name = UncasedStr::new(name);
self.check_read_only(name)?;
self.vars
.get_mut(name)
.map(|v| {
v.visible(&self.user, system_vars)?;
v.reset(local);
Ok(())
})
.transpose()?
.ok_or_else(|| VarError::UnknownParameter(name.to_string()))
}
/// Returns an error if the variable corresponding to `name` is read only.
fn check_read_only(&self, name: &UncasedStr) -> Result<(), VarError> {
if name == MZ_VERSION_NAME {
Err(VarError::ReadOnlyParameter(MZ_VERSION_NAME.as_str()))
} else if name == IS_SUPERUSER_NAME {
Err(VarError::ReadOnlyParameter(IS_SUPERUSER_NAME.as_str()))
} else if name == MAX_IDENTIFIER_LENGTH.name {
Err(VarError::ReadOnlyParameter(
MAX_IDENTIFIER_LENGTH.name.as_str(),
))
} else {
Ok(())
}
}
/// Commits or rolls back configuration parameter updates made via
/// [`SessionVars::set`] since the last call to `end_transaction`.
///
/// Returns any session parameters that changed because the transaction ended.
#[mz_ore::instrument(level = "debug")]
pub fn end_transaction(
&mut self,
action: EndTransactionAction,
) -> BTreeMap<&'static str, String> {
let mut changed = BTreeMap::new();
let mut updates = Vec::new();
for (name, var) in self.vars.iter() {
if !var.is_mutating() {
continue;
}
let before = var.value();
let next = var.end_transaction(action).expect("must mutate");
let after = next.value();
updates.push((*name, next));
// Report the new value of the parameter.
if before != after {
changed.insert(var.name(), after);
}
}
self.vars.extend(updates);
changed
}
/// Returns the value of the `application_name` configuration parameter.
pub fn application_name(&self) -> &str {
self.expect_value::<String>(&APPLICATION_NAME).as_str()
}
/// Returns the build info.
pub fn build_info(&self) -> &'static BuildInfo {
self.mz_version.build_info
}
/// Returns the value of the `client_encoding` configuration parameter.
pub fn client_encoding(&self) -> &ClientEncoding {
self.expect_value(&CLIENT_ENCODING)
}
/// Returns the value of the `client_min_messages` configuration parameter.
pub fn client_min_messages(&self) -> &ClientSeverity {
self.expect_value(&CLIENT_MIN_MESSAGES)
}
/// Returns the value of the `cluster` configuration parameter.
pub fn cluster(&self) -> &str {
self.expect_value::<String>(&CLUSTER).as_str()
}
/// Returns the value of the `cluster_replica` configuration parameter.
pub fn cluster_replica(&self) -> Option<&str> {
self.expect_value::<Option<String>>(&CLUSTER_REPLICA)
.as_deref()
}
/// Returns the value of the `current_object_missing_warnings` configuration
/// parameter.
pub fn current_object_missing_warnings(&self) -> bool {
*self.expect_value::<bool>(&CURRENT_OBJECT_MISSING_WARNINGS)
}
/// Returns the value of the `DateStyle` configuration parameter.
pub fn date_style(&self) -> &[&str] {
&self.expect_value::<DateStyle>(&DATE_STYLE).0
}
/// Returns the value of the `database` configuration parameter.
pub fn database(&self) -> &str {
self.expect_value::<String>(&DATABASE).as_str()
}
/// Returns the value of the `extra_float_digits` configuration parameter.
pub fn extra_float_digits(&self) -> i32 {
*self.expect_value(&EXTRA_FLOAT_DIGITS)
}
/// Returns the value of the `integer_datetimes` configuration parameter.
pub fn integer_datetimes(&self) -> bool {
*self.expect_value(&INTEGER_DATETIMES)
}
/// Returns the value of the `intervalstyle` configuration parameter.
pub fn intervalstyle(&self) -> &IntervalStyle {
self.expect_value(&INTERVAL_STYLE)
}
/// Returns the value of the `mz_version` configuration parameter.
pub fn mz_version(&self) -> String {
self.mz_version.value()
}
/// Returns the value of the `search_path` configuration parameter.
pub fn search_path(&self) -> &[Ident] {
self.expect_value::<Vec<Ident>>(&SEARCH_PATH).as_slice()
}
/// Returns the value of the `server_version` configuration parameter.
pub fn server_version(&self) -> &str {
self.expect_value::<String>(&SERVER_VERSION).as_str()
}
/// Returns the value of the `server_version_num` configuration parameter.
pub fn server_version_num(&self) -> i32 {
*self.expect_value(&SERVER_VERSION_NUM)
}
/// Returns the value of the `sql_safe_updates` configuration parameter.
pub fn sql_safe_updates(&self) -> bool {
*self.expect_value(&SQL_SAFE_UPDATES)
}
/// Returns the value of the `standard_conforming_strings` configuration
/// parameter.
pub fn standard_conforming_strings(&self) -> bool {
*self.expect_value(&STANDARD_CONFORMING_STRINGS)
}
/// Returns the value of the `statement_timeout` configuration parameter.
pub fn statement_timeout(&self) -> &Duration {
self.expect_value(&STATEMENT_TIMEOUT)
}
/// Returns the value of the `idle_in_transaction_session_timeout` configuration parameter.
pub fn idle_in_transaction_session_timeout(&self) -> &Duration {
self.expect_value(&IDLE_IN_TRANSACTION_SESSION_TIMEOUT)
}
/// Returns the value of the `timezone` configuration parameter.
pub fn timezone(&self) -> &TimeZone {
self.expect_value(&TIMEZONE)
}
/// Returns the value of the `transaction_isolation` configuration
/// parameter.
pub fn transaction_isolation(&self) -> &IsolationLevel {
self.expect_value(&TRANSACTION_ISOLATION)
}
/// Returns the value of `real_time_recency` configuration parameter.
pub fn real_time_recency(&self) -> bool {
*self.expect_value(&REAL_TIME_RECENCY)
}
/// Returns the value of the `real_time_recency_timeout` configuration parameter.
pub fn real_time_recency_timeout(&self) -> &Duration {
self.expect_value(&REAL_TIME_RECENCY_TIMEOUT)
}
/// Returns the value of `emit_plan_insights_notice` configuration parameter.
pub fn emit_plan_insights_notice(&self) -> bool {
*self.expect_value(&EMIT_PLAN_INSIGHTS_NOTICE)
}
/// Returns the value of `emit_timestamp_notice` configuration parameter.
pub fn emit_timestamp_notice(&self) -> bool {
*self.expect_value(&EMIT_TIMESTAMP_NOTICE)
}
/// Returns the value of `emit_trace_id_notice` configuration parameter.
pub fn emit_trace_id_notice(&self) -> bool {
*self.expect_value(&EMIT_TRACE_ID_NOTICE)
}
/// Returns the value of `auto_route_catalog_queries` configuration parameter.
pub fn auto_route_catalog_queries(&self) -> bool {
*self.expect_value(&AUTO_ROUTE_CATALOG_QUERIES)
}
/// Returns the value of `enable_session_rbac_checks` configuration parameter.
pub fn enable_session_rbac_checks(&self) -> bool {
*self.expect_value(&ENABLE_SESSION_RBAC_CHECKS)
}
/// Returns the value of `enable_session_cardinality_estimates` configuration parameter.
pub fn enable_session_cardinality_estimates(&self) -> bool {
*self.expect_value(&ENABLE_SESSION_CARDINALITY_ESTIMATES)
}
/// Returns the value of `is_superuser` configuration parameter.
pub fn is_superuser(&self) -> bool {
self.user.is_superuser()
}
/// Returns the user associated with this `SessionVars` instance.
pub fn user(&self) -> &User {
&self.user
}
/// Returns the value of the `max_query_result_size` configuration parameter.
pub fn max_query_result_size(&self) -> u64 {
self.expect_value::<ByteSize>(&MAX_QUERY_RESULT_SIZE)
.as_bytes()
}
/// Sets the external metadata associated with the user.
pub fn set_external_user_metadata(&mut self, metadata: ExternalUserMetadata) {
self.user.external_metadata = Some(metadata);
}
pub fn set_cluster(&mut self, cluster: String) {
let var = self
.vars
.get_mut(UncasedStr::new(CLUSTER.name()))
.expect("cluster variable must exist");
var.set(VarInput::Flat(&cluster), false)
.expect("setting cluster must succeed");
}
pub fn set_local_transaction_isolation(&mut self, transaction_isolation: IsolationLevel) {
let var = self
.vars
.get_mut(UncasedStr::new(TRANSACTION_ISOLATION.name()))
.expect("transaction_isolation variable must exist");
var.set(VarInput::Flat(transaction_isolation.as_str()), true)
.expect("setting transaction isolation must succeed");
}
pub fn get_statement_logging_sample_rate(&self) -> Numeric {
*self.expect_value(&STATEMENT_LOGGING_SAMPLE_RATE)
}
/// Returns the value of the `emit_introspection_query_notice` configuration parameter.
pub fn emit_introspection_query_notice(&self) -> bool {
*self.expect_value(&EMIT_INTROSPECTION_QUERY_NOTICE)
}
pub fn unsafe_new_transaction_wall_time(&self) -> Option<CheckedTimestamp<DateTime<Utc>>> {
*self.expect_value(&UNSAFE_NEW_TRANSACTION_WALL_TIME)
}
/// Returns the value of the `welcome_message` configuration parameter.
pub fn welcome_message(&self) -> bool {
*self.expect_value(&WELCOME_MESSAGE)
}
}
// TODO(database-issues#8069) remove together with `compat_translate`
pub const OLD_CATALOG_SERVER_CLUSTER: &str = "mz_introspection";
pub const OLD_AUTO_ROUTE_CATALOG_QUERIES: &str = "auto_route_introspection_queries";
/// If the given variable name and/or input is deprecated, return a corresponding updated value,
/// otherwise return the original.
///
/// This method was introduced to gracefully handle the rename of the `mz_introspection` cluster to
/// `mz_cluster_server`. The plan is to remove it once all users have migrated to the new name. The
/// debug logs will be helpful for checking this in production.
// TODO(database-issues#8069) remove this after sufficient time has passed
fn compat_translate<'a, 'b>(name: &'a str, input: VarInput<'b>) -> (&'a str, VarInput<'b>) {
if name == CLUSTER.name() {
if let Ok(value) = CLUSTER.parse(input) {
if value.format() == OLD_CATALOG_SERVER_CLUSTER {
tracing::debug!(
github_27285 = true,
"encountered deprecated `cluster` variable value: {}",
OLD_CATALOG_SERVER_CLUSTER,
);
return (name, VarInput::Flat("mz_catalog_server"));
}
}
}
if name == OLD_AUTO_ROUTE_CATALOG_QUERIES {
tracing::debug!(
github_27285 = true,
"encountered deprecated `{}` variable name",
OLD_AUTO_ROUTE_CATALOG_QUERIES,
);
return (AUTO_ROUTE_CATALOG_QUERIES.name(), input);
}
(name, input)
}
fn compat_translate_name(name: &str) -> &str {
let (name, _) = compat_translate(name, VarInput::Flat(""));
name
}
/// A `SystemVar` is persisted on disk value for a configuration parameter. If unset,
/// the server default is used instead.
#[derive(Debug)]
pub struct SystemVar {
definition: VarDefinition,
/// Value currently persisted to disk.
persisted_value: Option<Box<dyn Value>>,
/// Current default, not persisted to disk.
dynamic_default: Option<Box<dyn Value>>,
}
impl Clone for SystemVar {
fn clone(&self) -> Self {
SystemVar {
definition: self.definition.clone(),
persisted_value: self.persisted_value.as_ref().map(|v| v.box_clone()),
dynamic_default: self.dynamic_default.as_ref().map(|v| v.box_clone()),
}
}
}
impl SystemVar {
pub fn new(definition: VarDefinition) -> Self {
SystemVar {
definition,
persisted_value: None,
dynamic_default: None,
}
}
fn is_default(&self, input: VarInput) -> Result<bool, VarError> {
let v = self.definition.parse(input)?;
Ok(self.definition.default_value() == v.as_ref())
}
pub fn value_dyn(&self) -> &dyn Value {
self.persisted_value
.as_deref()
.or(self.dynamic_default.as_deref())
.unwrap_or(self.definition.default_value())
}
pub fn value<V: 'static>(&self) -> &V {
let val = self.value_dyn();
val.as_any().downcast_ref::<V>().expect("success")
}
fn parse(&self, input: VarInput) -> Result<Box<dyn Value>, VarError> {
let v = self.definition.parse(input)?;
// Validate our parsed value.
self.validate_constraints(v.as_ref())?;
Ok(v)
}
fn set(&mut self, input: VarInput) -> Result<bool, VarError> {
let v = self.parse(input)?;
if self.persisted_value.as_ref() != Some(&v) {
self.persisted_value = Some(v);
Ok(true)
} else {
Ok(false)
}
}
fn reset(&mut self) -> bool {
if self.persisted_value.is_some() {
self.persisted_value = None;
true
} else {
false
}
}
fn set_default(&mut self, input: VarInput) -> Result<(), VarError> {
let v = self.definition.parse(input)?;
self.dynamic_default = Some(v);
Ok(())
}
fn validate_constraints(&self, val: &dyn Value) -> Result<(), VarError> {
if let Some(constraint) = &self.definition.constraint {
constraint.check_constraint(self, self.value_dyn(), val)
} else {
Ok(())
}
}
}
impl Var for SystemVar {
fn name(&self) -> &'static str {
self.definition.name.as_str()
}
fn value(&self) -> String {
self.value_dyn().format()
}
fn description(&self) -> &'static str {
self.definition.description
}
fn type_name(&self) -> Cow<'static, str> {
self.definition.type_name()
}
fn visible(&self, user: &User, system_vars: &SystemVars) -> Result<(), VarError> {
self.definition.visible(user, system_vars)
}
}
#[derive(Debug, Error)]
pub enum NetworkPolicyError {
#[error("Access denied for address {0}")]
AddressDenied(IpAddr),
}
/// On disk variables.
///
/// See the [`crate::session::vars`] module documentation for more details on the
/// Materialize configuration model.
#[derive(Derivative, Clone)]
#[derivative(Debug)]
pub struct SystemVars {
/// Allows "unsafe" parameters to be set.
allow_unsafe: bool,
/// Set of all [`SystemVar`]s.
vars: BTreeMap<&'static UncasedStr, SystemVar>,
/// External components interested in when a [`SystemVar`] gets updated.
#[derivative(Debug = "ignore")]
callbacks: BTreeMap<String, Vec<Arc<dyn Fn(&SystemVars) + Send + Sync>>>,
/// NB: This is intentionally disconnected from the one that is plumbed around to persist and
/// the controllers. This is so we can explicitly control and reason about when changes to config
/// values are propagated to the rest of the system.
dyncfgs: ConfigSet,
}
impl Default for SystemVars {
fn default() -> Self {
Self::new()
}
}
impl SystemVars {
pub fn new() -> Self {
let system_vars = vec![
&MAX_KAFKA_CONNECTIONS,
&MAX_POSTGRES_CONNECTIONS,
&MAX_MYSQL_CONNECTIONS,
&MAX_AWS_PRIVATELINK_CONNECTIONS,
&MAX_TABLES,
&MAX_SOURCES,
&MAX_SINKS,
&MAX_MATERIALIZED_VIEWS,
&MAX_CLUSTERS,
&MAX_REPLICAS_PER_CLUSTER,
&MAX_CREDIT_CONSUMPTION_RATE,
&MAX_DATABASES,
&MAX_SCHEMAS_PER_DATABASE,
&MAX_OBJECTS_PER_SCHEMA,
&MAX_SECRETS,
&MAX_ROLES,
&MAX_CONTINUAL_TASKS,
&MAX_NETWORK_POLICIES,
&MAX_RULES_PER_NETWORK_POLICY,
&MAX_RESULT_SIZE,
&MAX_COPY_FROM_SIZE,
&ALLOWED_CLUSTER_REPLICA_SIZES,
&DISK_CLUSTER_REPLICAS_DEFAULT,
&upsert_rocksdb::UPSERT_ROCKSDB_AUTO_SPILL_TO_DISK,
&upsert_rocksdb::UPSERT_ROCKSDB_AUTO_SPILL_THRESHOLD_BYTES,
&upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE,
&upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET,
&upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES,
&upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO,
&upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM,
&upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE,
&upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE,
&upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE,
&upsert_rocksdb::UPSERT_ROCKSDB_RETRY_DURATION,
&upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS,
&upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS,
&upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB,
&upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO,
&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_CLUSTER_MEMORY_FRACTION,
&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_MEMORY_BYTES,
&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_ALLOW_STALL,
&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES,
&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION,
&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY,
&STORAGE_STATISTICS_INTERVAL,
&STORAGE_STATISTICS_COLLECTION_INTERVAL,
&STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO,
&STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS,
&PERSIST_FAST_PATH_LIMIT,
&METRICS_RETENTION,
&UNSAFE_MOCK_AUDIT_EVENT_TIMESTAMP,
&ENABLE_RBAC_CHECKS,
&PG_SOURCE_CONNECT_TIMEOUT,
&PG_SOURCE_TCP_KEEPALIVES_IDLE,
&PG_SOURCE_TCP_KEEPALIVES_INTERVAL,
&PG_SOURCE_TCP_KEEPALIVES_RETRIES,
&PG_SOURCE_TCP_USER_TIMEOUT,
&PG_SOURCE_TCP_CONFIGURE_SERVER,
&PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT,
&PG_SOURCE_WAL_SENDER_TIMEOUT,
&PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT,
&PG_SOURCE_SNAPSHOT_FALLBACK_TO_STRICT_COUNT,
&PG_SOURCE_SNAPSHOT_WAIT_FOR_COUNT,
&MYSQL_SOURCE_TCP_KEEPALIVE,
&MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME,
&MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT,
&MYSQL_SOURCE_CONNECT_TIMEOUT,
&SSH_CHECK_INTERVAL,
&SSH_CONNECT_TIMEOUT,
&SSH_KEEPALIVES_IDLE,
&KAFKA_SOCKET_KEEPALIVE,
&KAFKA_SOCKET_TIMEOUT,
&KAFKA_TRANSACTION_TIMEOUT,
&KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT,
&KAFKA_FETCH_METADATA_TIMEOUT,
&KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT,
&ENABLE_LAUNCHDARKLY,
&MAX_CONNECTIONS,
&NETWORK_POLICY,
&SUPERUSER_RESERVED_CONNECTIONS,
&KEEP_N_SOURCE_STATUS_HISTORY_ENTRIES,
&KEEP_N_SINK_STATUS_HISTORY_ENTRIES,
&KEEP_N_PRIVATELINK_STATUS_HISTORY_ENTRIES,
&REPLICA_STATUS_HISTORY_RETENTION_WINDOW,
&ARRANGEMENT_EXERT_PROPORTIONALITY,
&ENABLE_STORAGE_SHARD_FINALIZATION,
&ENABLE_CONSOLIDATE_AFTER_UNION_NEGATE,
&ENABLE_DEFAULT_CONNECTION_VALIDATION,
&ENABLE_REDUCE_REDUCTION,
&MIN_TIMESTAMP_INTERVAL,
&MAX_TIMESTAMP_INTERVAL,
&LOGGING_FILTER,
&OPENTELEMETRY_FILTER,
&LOGGING_FILTER_DEFAULTS,
&OPENTELEMETRY_FILTER_DEFAULTS,
&SENTRY_FILTERS,
&WEBHOOKS_SECRETS_CACHING_TTL_SECS,
&COORD_SLOW_MESSAGE_WARN_THRESHOLD,
&grpc_client::CONNECT_TIMEOUT,
&grpc_client::HTTP2_KEEP_ALIVE_INTERVAL,
&grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT,
&cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT,
&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY,
&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT,
&cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD,
&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE,
&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW,
&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT,
&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY,
&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT,
&cluster_scheduling::CLUSTER_ALWAYS_USE_DISK,
&cluster_scheduling::CLUSTER_ALTER_CHECK_READY_INTERVAL,
&cluster_scheduling::CLUSTER_CHECK_SCHEDULING_POLICIES_INTERVAL,
&cluster_scheduling::CLUSTER_SECURITY_CONTEXT_ENABLED,
&cluster_scheduling::CLUSTER_REFRESH_MV_COMPACTION_ESTIMATE,
&grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT,
&STATEMENT_LOGGING_MAX_SAMPLE_RATE,
&STATEMENT_LOGGING_DEFAULT_SAMPLE_RATE,
&STATEMENT_LOGGING_TARGET_DATA_RATE,
&STATEMENT_LOGGING_MAX_DATA_CREDIT,
&ENABLE_INTERNAL_STATEMENT_LOGGING,
&OPTIMIZER_STATS_TIMEOUT,
&OPTIMIZER_ONESHOT_STATS_TIMEOUT,
&PRIVATELINK_STATUS_UPDATE_QUOTA_PER_MINUTE,
&WEBHOOK_CONCURRENT_REQUEST_LIMIT,
&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE,
&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT,
&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL,
&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER,
&USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION,
&FORCE_SOURCE_TABLE_SYNTAX,
&OPTIMIZER_E2E_LATENCY_WARNING_THRESHOLD,
];
let dyncfgs = mz_dyncfgs::all_dyncfgs();
let dyncfg_vars: Vec<_> = dyncfgs
.entries()
.map(|cfg| match cfg.default() {
ConfigVal::Bool(default) => {
VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
}
ConfigVal::U32(default) => {
VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
}
ConfigVal::Usize(default) => {
VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
}
ConfigVal::OptUsize(default) => {
VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
}
ConfigVal::F64(default) => {
VarDefinition::new_runtime(cfg.name(), *default, cfg.desc(), false)
}
ConfigVal::String(default) => {
VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
}
ConfigVal::Duration(default) => {
VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
}
ConfigVal::Json(default) => {
VarDefinition::new_runtime(cfg.name(), default.clone(), cfg.desc(), false)
}
})
.collect();
let vars: BTreeMap<_, _> = system_vars
.into_iter()
// Include all of our feature flags.
.chain(definitions::FEATURE_FLAGS.iter().copied())
// Include the subset of Session variables we allow system defaults for.
.chain(SESSION_SYSTEM_VARS.values().copied())
.cloned()
// Include Persist configs.
.chain(dyncfg_vars)
.map(|var| (var.name, SystemVar::new(var)))
.collect();
let vars = SystemVars {
vars,
callbacks: BTreeMap::new(),
allow_unsafe: false,
dyncfgs,
};
vars
}
pub fn dyncfgs(&self) -> &ConfigSet {
&self.dyncfgs
}
pub fn set_unsafe(mut self, allow_unsafe: bool) -> Self {
self.allow_unsafe = allow_unsafe;
self
}
pub fn allow_unsafe(&self) -> bool {
self.allow_unsafe
}
fn expect_value<V: 'static>(&self, var: &VarDefinition) -> &V {
let val = self
.vars
.get(var.name)
.expect("provided var should be in state");
val.value_dyn()
.as_any()
.downcast_ref::<V>()
.expect("provided var type should matched stored var")
}
fn expect_config_value<V: ConfigType + 'static>(&self, name: &UncasedStr) -> &V {
let val = self
.vars
.get(name)
.unwrap_or_else(|| panic!("provided var {name} should be in state"));
val.value_dyn()
.as_any()
.downcast_ref()
.expect("provided var type should matched stored var")
}
/// Reset all the values to their defaults (preserving
/// defaults from `VarMut::set_default).
pub fn reset_all(&mut self) {
for (_, var) in &mut self.vars {
var.reset();
}
}
/// Returns an iterator over the configuration parameters and their current
/// values on disk.
pub fn iter(&self) -> impl Iterator<Item = &dyn Var> {
self.vars
.values()
.map(|v| v.as_var())
.filter(|v| !SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(v.name())))
}
/// Returns an iterator over the configuration parameters and their current
/// values on disk. Compared to [`SystemVars::iter`], this should omit vars
/// that shouldn't be synced by SystemParameterFrontend.
pub fn iter_synced(&self) -> impl Iterator<Item = &dyn Var> {
self.iter().filter(|v| v.name() != ENABLE_LAUNCHDARKLY.name)
}
/// Returns an iterator over the configuration parameters that can be overriden per-Session.
pub fn iter_session(&self) -> impl Iterator<Item = &dyn Var> {
self.vars
.values()
.map(|v| v.as_var())
.filter(|v| SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(v.name())))
}
/// Returns whether or not this parameter can be modified by a superuser.
pub fn user_modifiable(&self, name: &str) -> bool {
SESSION_SYSTEM_VARS.contains_key(UncasedStr::new(name))
|| name == ENABLE_RBAC_CHECKS.name()
|| name == NETWORK_POLICY.name()
}
/// Returns a [`Var`] representing the configuration parameter with the
/// specified name.
///
/// Configuration parameters are matched case insensitively. If no such
/// configuration parameter exists, `get` returns an error.
///
/// Note that:
/// - If `name` is known at compile time, you should instead use the named
/// accessor to access the variable with its true Rust type. For example,
/// `self.get("max_tables").value()` returns the string `"25"` or the
/// current value, while `self.max_tables()` returns an i32.
///
/// - This function does not check that the access variable should be
/// visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
///
/// # Errors
///
/// The call will return an error:
/// 1. If `name` does not refer to a valid [`SystemVars`] field.
pub fn get(&self, name: &str) -> Result<&dyn Var, VarError> {
self.vars
.get(UncasedStr::new(name))
.map(|v| v.as_var())
.ok_or_else(|| VarError::UnknownParameter(name.into()))
}
/// Check if the given `values` is the default value for the [`Var`]
/// identified by `name`.
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
///
/// # Errors
///
/// The call will return an error:
/// 1. If `name` does not refer to a valid [`SystemVars`] field.
/// 2. If `values` does not represent a valid [`SystemVars`] value for
/// `name`.
pub fn is_default(&self, name: &str, input: VarInput) -> Result<bool, VarError> {
self.vars
.get(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.into()))
.and_then(|v| v.is_default(input))
}
/// Sets the configuration parameter named `name` to the value represented
/// by `input`.
///
/// Like with [`SystemVars::get`], configuration parameters are matched case
/// insensitively. If `input` is not valid, as determined by the underlying
/// configuration parameter, or if the named configuration parameter does
/// not exist, an error is returned.
///
/// Return a `bool` value indicating whether the [`Var`] identified by
/// `name` was modified by this call (it won't be if it already had the
/// given `input`).
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
///
/// # Errors
///
/// The call will return an error:
/// 1. If `name` does not refer to a valid [`SystemVars`] field.
/// 2. If `input` does not represent a valid [`SystemVars`] value for
/// `name`.
pub fn set(&mut self, name: &str, input: VarInput) -> Result<bool, VarError> {
let result = self
.vars
.get_mut(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.into()))
.and_then(|v| v.set(input))?;
self.notify_callbacks(name);
Ok(result)
}
/// Parses the configuration parameter value represented by `input` named
/// `name`.
///
/// Like with [`SystemVars::get`], configuration parameters are matched case
/// insensitively. If `input` is not valid, as determined by the underlying
/// configuration parameter, or if the named configuration parameter does
/// not exist, an error is returned.
///
/// Return a `Box<dyn Value>` that is the result of parsing `input`.
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
///
/// # Errors
///
/// The call will return an error:
/// 1. If `name` does not refer to a valid [`SystemVars`] field.
/// 2. If `input` does not represent a valid [`SystemVars`] value for
/// `name`.
pub fn parse(&self, name: &str, input: VarInput) -> Result<Box<dyn Value>, VarError> {
self.vars
.get(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.into()))
.and_then(|v| v.parse(input))
}
/// Set the default for this variable. This is the value this
/// variable will be be `reset` to. If no default is set, the static default in the
/// variable definition is used instead.
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
pub fn set_default(&mut self, name: &str, input: VarInput) -> Result<(), VarError> {
let result = self
.vars
.get_mut(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.into()))
.and_then(|v| v.set_default(input))?;
self.notify_callbacks(name);
Ok(result)
}
/// Sets the configuration parameter named `name` to its default value.
///
/// Like with [`SystemVars::get`], configuration parameters are matched case
/// insensitively. If the named configuration parameter does not exist, an
/// error is returned.
///
/// Return a `bool` value indicating whether the [`Var`] identified by
/// `name` was modified by this call (it won't be if was already reset).
///
/// Note that this function does not check that the access variable should
/// be visible because of other settings or users. Before or after accessing
/// this method, you should call `Var::visible`.
///
/// # Errors
///
/// The call will return an error:
/// 1. If `name` does not refer to a valid [`SystemVars`] field.
pub fn reset(&mut self, name: &str) -> Result<bool, VarError> {
let result = self
.vars
.get_mut(UncasedStr::new(name))
.ok_or_else(|| VarError::UnknownParameter(name.into()))
.map(|v| v.reset())?;
self.notify_callbacks(name);
Ok(result)
}
/// Returns a map from each system parameter's name to its default value.
pub fn defaults(&self) -> BTreeMap<String, String> {
self.vars
.iter()
.map(|(name, var)| {
let default = var
.dynamic_default
.as_deref()
.unwrap_or(var.definition.default_value());
(name.as_str().to_owned(), default.format())
})
.collect()
}
/// Registers a closure that will get called when the value for the
/// specified [`VarDefinition`] changes.
///
/// The callback is guaranteed to be called at least once.
pub fn register_callback(
&mut self,
var: &VarDefinition,
callback: Arc<dyn Fn(&SystemVars) + Send + Sync>,
) {
self.callbacks
.entry(var.name().to_string())
.or_default()
.push(callback);
self.notify_callbacks(var.name());
}
/// Notify any external components interested in this variable.
fn notify_callbacks(&self, name: &str) {
// Get the callbacks interested in this variable.
if let Some(callbacks) = self.callbacks.get(name) {
for callback in callbacks {
(callback)(self);
}
}
}
/// Returns the system default for the [`CLUSTER`] session variable. To know the active cluster
/// for the current session, you must check the [`SessionVars`].
pub fn default_cluster(&self) -> String {
self.expect_value::<String>(&CLUSTER).to_owned()
}
/// Returns the value of the `max_kafka_connections` configuration parameter.
pub fn max_kafka_connections(&self) -> u32 {
*self.expect_value(&MAX_KAFKA_CONNECTIONS)
}
/// Returns the value of the `max_postgres_connections` configuration parameter.
pub fn max_postgres_connections(&self) -> u32 {
*self.expect_value(&MAX_POSTGRES_CONNECTIONS)
}
/// Returns the value of the `max_mysql_connections` configuration parameter.
pub fn max_mysql_connections(&self) -> u32 {
*self.expect_value(&MAX_MYSQL_CONNECTIONS)
}
/// Returns the value of the `max_aws_privatelink_connections` configuration parameter.
pub fn max_aws_privatelink_connections(&self) -> u32 {
*self.expect_value(&MAX_AWS_PRIVATELINK_CONNECTIONS)
}
/// Returns the value of the `max_tables` configuration parameter.
pub fn max_tables(&self) -> u32 {
*self.expect_value(&MAX_TABLES)
}
/// Returns the value of the `max_sources` configuration parameter.
pub fn max_sources(&self) -> u32 {
*self.expect_value(&MAX_SOURCES)
}
/// Returns the value of the `max_sinks` configuration parameter.
pub fn max_sinks(&self) -> u32 {
*self.expect_value(&MAX_SINKS)
}
/// Returns the value of the `max_materialized_views` configuration parameter.
pub fn max_materialized_views(&self) -> u32 {
*self.expect_value(&MAX_MATERIALIZED_VIEWS)
}
/// Returns the value of the `max_clusters` configuration parameter.
pub fn max_clusters(&self) -> u32 {
*self.expect_value(&MAX_CLUSTERS)
}
/// Returns the value of the `max_replicas_per_cluster` configuration parameter.
pub fn max_replicas_per_cluster(&self) -> u32 {
*self.expect_value(&MAX_REPLICAS_PER_CLUSTER)
}
/// Returns the value of the `max_credit_consumption_rate` configuration parameter.
pub fn max_credit_consumption_rate(&self) -> Numeric {
*self.expect_value(&MAX_CREDIT_CONSUMPTION_RATE)
}
/// Returns the value of the `max_databases` configuration parameter.
pub fn max_databases(&self) -> u32 {
*self.expect_value(&MAX_DATABASES)
}
/// Returns the value of the `max_schemas_per_database` configuration parameter.
pub fn max_schemas_per_database(&self) -> u32 {
*self.expect_value(&MAX_SCHEMAS_PER_DATABASE)
}
/// Returns the value of the `max_objects_per_schema` configuration parameter.
pub fn max_objects_per_schema(&self) -> u32 {
*self.expect_value(&MAX_OBJECTS_PER_SCHEMA)
}
/// Returns the value of the `max_secrets` configuration parameter.
pub fn max_secrets(&self) -> u32 {
*self.expect_value(&MAX_SECRETS)
}
/// Returns the value of the `max_roles` configuration parameter.
pub fn max_roles(&self) -> u32 {
*self.expect_value(&MAX_ROLES)
}
/// Returns the value of the `max_continual_tasks` configuration parameter.
pub fn max_continual_tasks(&self) -> u32 {
*self.expect_value(&MAX_CONTINUAL_TASKS)
}
/// Returns the value of the `max_network_policies` configuration parameter.
pub fn max_network_policies(&self) -> u32 {
*self.expect_value(&MAX_NETWORK_POLICIES)
}
/// Returns the value of the `max_network_policies` configuration parameter.
pub fn max_rules_per_network_policy(&self) -> u32 {
*self.expect_value(&MAX_RULES_PER_NETWORK_POLICY)
}
/// Returns the value of the `max_result_size` configuration parameter.
pub fn max_result_size(&self) -> u64 {
self.expect_value::<ByteSize>(&MAX_RESULT_SIZE).as_bytes()
}
/// Returns the value of the `max_copy_from_size` configuration parameter.
pub fn max_copy_from_size(&self) -> u32 {
*self.expect_value(&MAX_COPY_FROM_SIZE)
}
/// Returns the value of the `allowed_cluster_replica_sizes` configuration parameter.
pub fn allowed_cluster_replica_sizes(&self) -> Vec<String> {
self.expect_value::<Vec<Ident>>(&ALLOWED_CLUSTER_REPLICA_SIZES)
.into_iter()
.map(|s| s.as_str().into())
.collect()
}
/// Returns the `disk_cluster_replicas_default` configuration parameter.
pub fn disk_cluster_replicas_default(&self) -> bool {
*self.expect_value(&DISK_CLUSTER_REPLICAS_DEFAULT)
}
pub fn upsert_rocksdb_auto_spill_to_disk(&self) -> bool {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_AUTO_SPILL_TO_DISK)
}
pub fn upsert_rocksdb_auto_spill_threshold_bytes(&self) -> usize {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_AUTO_SPILL_THRESHOLD_BYTES)
}
pub fn upsert_rocksdb_compaction_style(&self) -> mz_rocksdb_types::config::CompactionStyle {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE)
}
pub fn upsert_rocksdb_optimize_compaction_memtable_budget(&self) -> usize {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET)
}
pub fn upsert_rocksdb_level_compaction_dynamic_level_bytes(&self) -> bool {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES)
}
pub fn upsert_rocksdb_universal_compaction_ratio(&self) -> i32 {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO)
}
pub fn upsert_rocksdb_parallelism(&self) -> Option<i32> {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM)
}
pub fn upsert_rocksdb_compression_type(&self) -> mz_rocksdb_types::config::CompressionType {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE)
}
pub fn upsert_rocksdb_bottommost_compression_type(
&self,
) -> mz_rocksdb_types::config::CompressionType {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE)
}
pub fn upsert_rocksdb_batch_size(&self) -> usize {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE)
}
pub fn upsert_rocksdb_retry_duration(&self) -> Duration {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_RETRY_DURATION)
}
pub fn upsert_rocksdb_stats_log_interval_seconds(&self) -> u32 {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS)
}
pub fn upsert_rocksdb_stats_persist_interval_seconds(&self) -> u32 {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS)
}
pub fn upsert_rocksdb_point_lookup_block_cache_size_mb(&self) -> Option<u32> {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB)
}
pub fn upsert_rocksdb_shrink_allocated_buffers_by_ratio(&self) -> usize {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO)
}
pub fn upsert_rocksdb_write_buffer_manager_cluster_memory_fraction(&self) -> Option<Numeric> {
*self.expect_value(
&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_CLUSTER_MEMORY_FRACTION,
)
}
pub fn upsert_rocksdb_write_buffer_manager_memory_bytes(&self) -> Option<usize> {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_MEMORY_BYTES)
}
pub fn upsert_rocksdb_write_buffer_manager_allow_stall(&self) -> bool {
*self.expect_value(&upsert_rocksdb::UPSERT_ROCKSDB_WRITE_BUFFER_MANAGER_ALLOW_STALL)
}
pub fn persist_fast_path_limit(&self) -> usize {
*self.expect_value(&PERSIST_FAST_PATH_LIMIT)
}
/// Returns the `pg_source_connect_timeout` configuration parameter.
pub fn pg_source_connect_timeout(&self) -> Duration {
*self.expect_value(&PG_SOURCE_CONNECT_TIMEOUT)
}
/// Returns the `pg_source_tcp_keepalives_retries` configuration parameter.
pub fn pg_source_tcp_keepalives_retries(&self) -> u32 {
*self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_RETRIES)
}
/// Returns the `pg_source_tcp_keepalives_idle` configuration parameter.
pub fn pg_source_tcp_keepalives_idle(&self) -> Duration {
*self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_IDLE)
}
/// Returns the `pg_source_tcp_keepalives_interval` configuration parameter.
pub fn pg_source_tcp_keepalives_interval(&self) -> Duration {
*self.expect_value(&PG_SOURCE_TCP_KEEPALIVES_INTERVAL)
}
/// Returns the `pg_source_tcp_user_timeout` configuration parameter.
pub fn pg_source_tcp_user_timeout(&self) -> Duration {
*self.expect_value(&PG_SOURCE_TCP_USER_TIMEOUT)
}
/// Returns the `pg_source_tcp_configure_server` configuration parameter.
pub fn pg_source_tcp_configure_server(&self) -> bool {
*self.expect_value(&PG_SOURCE_TCP_CONFIGURE_SERVER)
}
/// Returns the `pg_source_snapshot_statement_timeout` configuration parameter.
pub fn pg_source_snapshot_statement_timeout(&self) -> Duration {
*self.expect_value(&PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT)
}
/// Returns the `pg_source_wal_sender_timeout` configuration parameter.
pub fn pg_source_wal_sender_timeout(&self) -> Option<Duration> {
*self.expect_value(&PG_SOURCE_WAL_SENDER_TIMEOUT)
}
/// Returns the `pg_source_snapshot_collect_strict_count` configuration parameter.
pub fn pg_source_snapshot_collect_strict_count(&self) -> bool {
*self.expect_value(&PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT)
}
/// Returns the `pg_source_snapshot_fallback_to_strict_count` configuration parameter.
pub fn pg_source_snapshot_fallback_to_strict_count(&self) -> bool {
*self.expect_value(&PG_SOURCE_SNAPSHOT_FALLBACK_TO_STRICT_COUNT)
}
/// Returns the `pg_source_snapshot_collect_strict_count` configuration parameter.
pub fn pg_source_snapshot_wait_for_count(&self) -> bool {
*self.expect_value(&PG_SOURCE_SNAPSHOT_WAIT_FOR_COUNT)
}
/// Returns the `mysql_source_tcp_keepalive` configuration parameter.
pub fn mysql_source_tcp_keepalive(&self) -> Duration {
*self.expect_value(&MYSQL_SOURCE_TCP_KEEPALIVE)
}
/// Returns the `mysql_source_snapshot_max_execution_time` configuration parameter.
pub fn mysql_source_snapshot_max_execution_time(&self) -> Duration {
*self.expect_value(&MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME)
}
/// Returns the `mysql_source_snapshot_lock_wait_timeout` configuration parameter.
pub fn mysql_source_snapshot_lock_wait_timeout(&self) -> Duration {
*self.expect_value(&MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT)
}
/// Returns the `mysql_source_connect_timeout` configuration parameter.
pub fn mysql_source_connect_timeout(&self) -> Duration {
*self.expect_value(&MYSQL_SOURCE_CONNECT_TIMEOUT)
}
/// Returns the `ssh_check_interval` configuration parameter.
pub fn ssh_check_interval(&self) -> Duration {
*self.expect_value(&SSH_CHECK_INTERVAL)
}
/// Returns the `ssh_connect_timeout` configuration parameter.
pub fn ssh_connect_timeout(&self) -> Duration {
*self.expect_value(&SSH_CONNECT_TIMEOUT)
}
/// Returns the `ssh_keepalives_idle` configuration parameter.
pub fn ssh_keepalives_idle(&self) -> Duration {
*self.expect_value(&SSH_KEEPALIVES_IDLE)
}
/// Returns the `kafka_socket_keepalive` configuration parameter.
pub fn kafka_socket_keepalive(&self) -> bool {
*self.expect_value(&KAFKA_SOCKET_KEEPALIVE)
}
/// Returns the `kafka_socket_timeout` configuration parameter.
pub fn kafka_socket_timeout(&self) -> Option<Duration> {
*self.expect_value(&KAFKA_SOCKET_TIMEOUT)
}
/// Returns the `kafka_transaction_timeout` configuration parameter.
pub fn kafka_transaction_timeout(&self) -> Duration {
*self.expect_value(&KAFKA_TRANSACTION_TIMEOUT)
}
/// Returns the `kafka_socket_connection_setup_timeout` configuration parameter.
pub fn kafka_socket_connection_setup_timeout(&self) -> Duration {
*self.expect_value(&KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT)
}
/// Returns the `kafka_fetch_metadata_timeout` configuration parameter.
pub fn kafka_fetch_metadata_timeout(&self) -> Duration {
*self.expect_value(&KAFKA_FETCH_METADATA_TIMEOUT)
}
/// Returns the `kafka_progress_record_fetch_timeout` configuration parameter.
pub fn kafka_progress_record_fetch_timeout(&self) -> Option<Duration> {
*self.expect_value(&KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT)
}
/// Returns the `crdb_connect_timeout` configuration parameter.
pub fn crdb_connect_timeout(&self) -> Duration {
*self.expect_config_value(UncasedStr::new(
mz_persist_client::cfg::CRDB_CONNECT_TIMEOUT.name(),
))
}
/// Returns the `crdb_tcp_user_timeout` configuration parameter.
pub fn crdb_tcp_user_timeout(&self) -> Duration {
*self.expect_config_value(UncasedStr::new(
mz_persist_client::cfg::CRDB_TCP_USER_TIMEOUT.name(),
))
}
/// Returns the `storage_dataflow_max_inflight_bytes` configuration parameter.
pub fn storage_dataflow_max_inflight_bytes(&self) -> Option<usize> {
*self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES)
}
/// Returns the `storage_dataflow_max_inflight_bytes_to_cluster_size_fraction` configuration parameter.
pub fn storage_dataflow_max_inflight_bytes_to_cluster_size_fraction(&self) -> Option<Numeric> {
*self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION)
}
/// Returns the `storage_shrink_upsert_unused_buffers_by_ratio` configuration parameter.
pub fn storage_shrink_upsert_unused_buffers_by_ratio(&self) -> usize {
*self.expect_value(&STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO)
}
/// Returns the `storage_dataflow_max_inflight_bytes_disk_only` configuration parameter.
pub fn storage_dataflow_max_inflight_bytes_disk_only(&self) -> bool {
*self.expect_value(&STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY)
}
/// Returns the `storage_statistics_interval` configuration parameter.
pub fn storage_statistics_interval(&self) -> Duration {
*self.expect_value(&STORAGE_STATISTICS_INTERVAL)
}
/// Returns the `storage_statistics_collection_interval` configuration parameter.
pub fn storage_statistics_collection_interval(&self) -> Duration {
*self.expect_value(&STORAGE_STATISTICS_COLLECTION_INTERVAL)
}
/// Returns the `storage_record_source_sink_namespaced_errors` configuration parameter.
pub fn storage_record_source_sink_namespaced_errors(&self) -> bool {
*self.expect_value(&STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS)
}
/// Returns the `persist_stats_filter_enabled` configuration parameter.
pub fn persist_stats_filter_enabled(&self) -> bool {
*self.expect_config_value(UncasedStr::new(
mz_persist_client::stats::STATS_FILTER_ENABLED.name(),
))
}
pub fn dyncfg_updates(&self) -> ConfigUpdates {
let mut updates = ConfigUpdates::default();
for entry in self.dyncfgs.entries() {
let name = UncasedStr::new(entry.name());
let val = match entry.val() {
ConfigVal::Bool(_) => ConfigVal::from(*self.expect_config_value::<bool>(name)),
ConfigVal::U32(_) => ConfigVal::from(*self.expect_config_value::<u32>(name)),
ConfigVal::Usize(_) => ConfigVal::from(*self.expect_config_value::<usize>(name)),
ConfigVal::OptUsize(_) => {
ConfigVal::from(*self.expect_config_value::<Option<usize>>(name))
}
ConfigVal::F64(_) => ConfigVal::from(*self.expect_config_value::<f64>(name)),
ConfigVal::String(_) => {
ConfigVal::from(self.expect_config_value::<String>(name).clone())
}
ConfigVal::Duration(_) => {
ConfigVal::from(*self.expect_config_value::<Duration>(name))
}
ConfigVal::Json(_) => {
ConfigVal::from(self.expect_config_value::<serde_json::Value>(name).clone())
}
};
updates.add_dynamic(entry.name(), val);
}
updates.apply(&self.dyncfgs);
updates
}
/// Returns the `metrics_retention` configuration parameter.
pub fn metrics_retention(&self) -> Duration {
*self.expect_value(&METRICS_RETENTION)
}
/// Returns the `unsafe_mock_audit_event_timestamp` configuration parameter.
pub fn unsafe_mock_audit_event_timestamp(&self) -> Option<mz_repr::Timestamp> {
*self.expect_value(&UNSAFE_MOCK_AUDIT_EVENT_TIMESTAMP)
}
/// Returns the `enable_rbac_checks` configuration parameter.
pub fn enable_rbac_checks(&self) -> bool {
*self.expect_value(&ENABLE_RBAC_CHECKS)
}
/// Returns the `max_connections` configuration parameter.
pub fn max_connections(&self) -> u32 {
*self.expect_value(&MAX_CONNECTIONS)
}
pub fn default_network_policy_name(&self) -> String {
self.expect_value::<String>(&NETWORK_POLICY).clone()
}
/// Returns the `superuser_reserved_connections` configuration parameter.
pub fn superuser_reserved_connections(&self) -> u32 {
*self.expect_value(&SUPERUSER_RESERVED_CONNECTIONS)
}
pub fn keep_n_source_status_history_entries(&self) -> usize {
*self.expect_value(&KEEP_N_SOURCE_STATUS_HISTORY_ENTRIES)
}
pub fn keep_n_sink_status_history_entries(&self) -> usize {
*self.expect_value(&KEEP_N_SINK_STATUS_HISTORY_ENTRIES)
}
pub fn keep_n_privatelink_status_history_entries(&self) -> usize {
*self.expect_value(&KEEP_N_PRIVATELINK_STATUS_HISTORY_ENTRIES)
}
pub fn replica_status_history_retention_window(&self) -> Duration {
*self.expect_value(&REPLICA_STATUS_HISTORY_RETENTION_WINDOW)
}
/// Returns the `arrangement_exert_proportionality` configuration parameter.
pub fn arrangement_exert_proportionality(&self) -> u32 {
*self.expect_value(&ARRANGEMENT_EXERT_PROPORTIONALITY)
}
/// Returns the `enable_storage_shard_finalization` configuration parameter.
pub fn enable_storage_shard_finalization(&self) -> bool {
*self.expect_value(&ENABLE_STORAGE_SHARD_FINALIZATION)
}
pub fn enable_consolidate_after_union_negate(&self) -> bool {
*self.expect_value(&ENABLE_CONSOLIDATE_AFTER_UNION_NEGATE)
}
pub fn enable_reduce_reduction(&self) -> bool {
*self.expect_value(&ENABLE_REDUCE_REDUCTION)
}
/// Returns the `enable_default_connection_validation` configuration parameter.
pub fn enable_default_connection_validation(&self) -> bool {
*self.expect_value(&ENABLE_DEFAULT_CONNECTION_VALIDATION)
}
/// Returns the `min_timestamp_interval` configuration parameter.
pub fn min_timestamp_interval(&self) -> Duration {
*self.expect_value(&MIN_TIMESTAMP_INTERVAL)
}
/// Returns the `max_timestamp_interval` configuration parameter.
pub fn max_timestamp_interval(&self) -> Duration {
*self.expect_value(&MAX_TIMESTAMP_INTERVAL)
}
pub fn logging_filter(&self) -> CloneableEnvFilter {
self.expect_value::<CloneableEnvFilter>(&LOGGING_FILTER)
.clone()
}
pub fn opentelemetry_filter(&self) -> CloneableEnvFilter {
self.expect_value::<CloneableEnvFilter>(&OPENTELEMETRY_FILTER)
.clone()
}
pub fn logging_filter_defaults(&self) -> Vec<SerializableDirective> {
self.expect_value::<Vec<SerializableDirective>>(&LOGGING_FILTER_DEFAULTS)
.clone()
}
pub fn opentelemetry_filter_defaults(&self) -> Vec<SerializableDirective> {
self.expect_value::<Vec<SerializableDirective>>(&OPENTELEMETRY_FILTER_DEFAULTS)
.clone()
}
pub fn sentry_filters(&self) -> Vec<SerializableDirective> {
self.expect_value::<Vec<SerializableDirective>>(&SENTRY_FILTERS)
.clone()
}
pub fn webhooks_secrets_caching_ttl_secs(&self) -> usize {
*self.expect_value(&WEBHOOKS_SECRETS_CACHING_TTL_SECS)
}
pub fn coord_slow_message_warn_threshold(&self) -> Duration {
*self.expect_value(&COORD_SLOW_MESSAGE_WARN_THRESHOLD)
}
pub fn grpc_client_http2_keep_alive_interval(&self) -> Duration {
*self.expect_value(&grpc_client::HTTP2_KEEP_ALIVE_INTERVAL)
}
pub fn grpc_client_http2_keep_alive_timeout(&self) -> Duration {
*self.expect_value(&grpc_client::HTTP2_KEEP_ALIVE_TIMEOUT)
}
pub fn grpc_connect_timeout(&self) -> Duration {
*self.expect_value(&grpc_client::CONNECT_TIMEOUT)
}
pub fn cluster_multi_process_replica_az_affinity_weight(&self) -> Option<i32> {
*self.expect_value(&cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT)
}
pub fn cluster_soften_replication_anti_affinity(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY)
}
pub fn cluster_soften_replication_anti_affinity_weight(&self) -> i32 {
*self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT)
}
pub fn cluster_enable_topology_spread(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD)
}
pub fn cluster_topology_spread_ignore_non_singular_scale(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE)
}
pub fn cluster_topology_spread_max_skew(&self) -> i32 {
*self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW)
}
pub fn cluster_topology_spread_soft(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT)
}
pub fn cluster_soften_az_affinity(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY)
}
pub fn cluster_soften_az_affinity_weight(&self) -> i32 {
*self.expect_value(&cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT)
}
pub fn cluster_always_use_disk(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_ALWAYS_USE_DISK)
}
pub fn cluster_alter_check_ready_interval(&self) -> Duration {
*self.expect_value(&cluster_scheduling::CLUSTER_ALTER_CHECK_READY_INTERVAL)
}
pub fn cluster_check_scheduling_policies_interval(&self) -> Duration {
*self.expect_value(&cluster_scheduling::CLUSTER_CHECK_SCHEDULING_POLICIES_INTERVAL)
}
pub fn cluster_security_context_enabled(&self) -> bool {
*self.expect_value(&cluster_scheduling::CLUSTER_SECURITY_CONTEXT_ENABLED)
}
pub fn cluster_refresh_mv_compaction_estimate(&self) -> Duration {
*self.expect_value(&cluster_scheduling::CLUSTER_REFRESH_MV_COMPACTION_ESTIMATE)
}
/// Returns the `privatelink_status_update_quota_per_minute` configuration parameter.
pub fn privatelink_status_update_quota_per_minute(&self) -> u32 {
*self.expect_value(&PRIVATELINK_STATUS_UPDATE_QUOTA_PER_MINUTE)
}
pub fn statement_logging_target_data_rate(&self) -> Option<usize> {
*self.expect_value(&STATEMENT_LOGGING_TARGET_DATA_RATE)
}
pub fn statement_logging_max_data_credit(&self) -> Option<usize> {
*self.expect_value(&STATEMENT_LOGGING_MAX_DATA_CREDIT)
}
/// Returns the `statement_logging_max_sample_rate` configuration parameter.
pub fn statement_logging_max_sample_rate(&self) -> Numeric {
*self.expect_value(&STATEMENT_LOGGING_MAX_SAMPLE_RATE)
}
/// Returns the `statement_logging_default_sample_rate` configuration parameter.
pub fn statement_logging_default_sample_rate(&self) -> Numeric {
*self.expect_value(&STATEMENT_LOGGING_DEFAULT_SAMPLE_RATE)
}
/// Returns the `enable_internal_statement_logging` configuration parameter.
pub fn enable_internal_statement_logging(&self) -> bool {
*self.expect_value(&ENABLE_INTERNAL_STATEMENT_LOGGING)
}
/// Returns the `optimizer_stats_timeout` configuration parameter.
pub fn optimizer_stats_timeout(&self) -> Duration {
*self.expect_value(&OPTIMIZER_STATS_TIMEOUT)
}
/// Returns the `optimizer_oneshot_stats_timeout` configuration parameter.
pub fn optimizer_oneshot_stats_timeout(&self) -> Duration {
*self.expect_value(&OPTIMIZER_ONESHOT_STATS_TIMEOUT)
}
/// Returns the `webhook_concurrent_request_limit` configuration parameter.
pub fn webhook_concurrent_request_limit(&self) -> usize {
*self.expect_value(&WEBHOOK_CONCURRENT_REQUEST_LIMIT)
}
/// Returns the `pg_timestamp_oracle_connection_pool_max_size` configuration parameter.
pub fn pg_timestamp_oracle_connection_pool_max_size(&self) -> usize {
*self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE)
}
/// Returns the `pg_timestamp_oracle_connection_pool_max_wait` configuration parameter.
pub fn pg_timestamp_oracle_connection_pool_max_wait(&self) -> Option<Duration> {
*self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT)
}
/// Returns the `pg_timestamp_oracle_connection_pool_ttl` configuration parameter.
pub fn pg_timestamp_oracle_connection_pool_ttl(&self) -> Duration {
*self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL)
}
/// Returns the `pg_timestamp_oracle_connection_pool_ttl_stagger` configuration parameter.
pub fn pg_timestamp_oracle_connection_pool_ttl_stagger(&self) -> Duration {
*self.expect_value(&PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER)
}
/// Returns the `user_storage_managed_collections_batch_duration` configuration parameter.
pub fn user_storage_managed_collections_batch_duration(&self) -> Duration {
*self.expect_value(&USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION)
}
pub fn force_source_table_syntax(&self) -> bool {
*self.expect_value(&FORCE_SOURCE_TABLE_SYNTAX)
}
pub fn optimizer_e2e_latency_warning_threshold(&self) -> Duration {
*self.expect_value(&OPTIMIZER_E2E_LATENCY_WARNING_THRESHOLD)
}
/// Returns whether the named variable is a compute configuration parameter
/// (things that go in `ComputeParameters` and are sent to replicas via `UpdateConfiguration`
/// commands).
pub fn is_compute_config_var(&self, name: &str) -> bool {
name == MAX_RESULT_SIZE.name() || self.is_dyncfg_var(name) || is_tracing_var(name)
}
/// Returns whether the named variable is a metrics configuration parameter
pub fn is_metrics_config_var(&self, name: &str) -> bool {
self.is_dyncfg_var(name)
}
/// Returns whether the named variable is a storage configuration parameter.
pub fn is_storage_config_var(&self, name: &str) -> bool {
name == PG_SOURCE_CONNECT_TIMEOUT.name()
|| name == PG_SOURCE_TCP_KEEPALIVES_IDLE.name()
|| name == PG_SOURCE_TCP_KEEPALIVES_INTERVAL.name()
|| name == PG_SOURCE_TCP_KEEPALIVES_RETRIES.name()
|| name == PG_SOURCE_TCP_USER_TIMEOUT.name()
|| name == PG_SOURCE_TCP_CONFIGURE_SERVER.name()
|| name == PG_SOURCE_SNAPSHOT_STATEMENT_TIMEOUT.name()
|| name == PG_SOURCE_WAL_SENDER_TIMEOUT.name()
|| name == PG_SOURCE_SNAPSHOT_COLLECT_STRICT_COUNT.name()
|| name == PG_SOURCE_SNAPSHOT_FALLBACK_TO_STRICT_COUNT.name()
|| name == PG_SOURCE_SNAPSHOT_WAIT_FOR_COUNT.name()
|| name == MYSQL_SOURCE_TCP_KEEPALIVE.name()
|| name == MYSQL_SOURCE_SNAPSHOT_MAX_EXECUTION_TIME.name()
|| name == MYSQL_SOURCE_SNAPSHOT_LOCK_WAIT_TIMEOUT.name()
|| name == MYSQL_SOURCE_CONNECT_TIMEOUT.name()
|| name == ENABLE_STORAGE_SHARD_FINALIZATION.name()
|| name == SSH_CHECK_INTERVAL.name()
|| name == SSH_CONNECT_TIMEOUT.name()
|| name == SSH_KEEPALIVES_IDLE.name()
|| name == KAFKA_SOCKET_KEEPALIVE.name()
|| name == KAFKA_SOCKET_TIMEOUT.name()
|| name == KAFKA_TRANSACTION_TIMEOUT.name()
|| name == KAFKA_SOCKET_CONNECTION_SETUP_TIMEOUT.name()
|| name == KAFKA_FETCH_METADATA_TIMEOUT.name()
|| name == KAFKA_PROGRESS_RECORD_FETCH_TIMEOUT.name()
|| name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES.name()
|| name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_TO_CLUSTER_SIZE_FRACTION.name()
|| name == STORAGE_DATAFLOW_MAX_INFLIGHT_BYTES_DISK_ONLY.name()
|| name == STORAGE_SHRINK_UPSERT_UNUSED_BUFFERS_BY_RATIO.name()
|| name == STORAGE_RECORD_SOURCE_SINK_NAMESPACED_ERRORS.name()
|| name == STORAGE_STATISTICS_INTERVAL.name()
|| name == STORAGE_STATISTICS_COLLECTION_INTERVAL.name()
|| name == USER_STORAGE_MANAGED_COLLECTIONS_BATCH_DURATION.name()
|| is_upsert_rocksdb_config_var(name)
|| self.is_dyncfg_var(name)
|| is_tracing_var(name)
}
/// Returns whether the named variable is a dyncfg configuration parameter.
fn is_dyncfg_var(&self, name: &str) -> bool {
self.dyncfgs.entries().any(|e| name == e.name())
}
}
pub fn is_tracing_var(name: &str) -> bool {
name == LOGGING_FILTER.name()
|| name == LOGGING_FILTER_DEFAULTS.name()
|| name == OPENTELEMETRY_FILTER.name()
|| name == OPENTELEMETRY_FILTER_DEFAULTS.name()
|| name == SENTRY_FILTERS.name()
}
/// Returns whether the named variable is a caching configuration parameter.
pub fn is_secrets_caching_var(name: &str) -> bool {
name == WEBHOOKS_SECRETS_CACHING_TTL_SECS.name()
}
fn is_upsert_rocksdb_config_var(name: &str) -> bool {
name == upsert_rocksdb::UPSERT_ROCKSDB_COMPACTION_STYLE.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_OPTIMIZE_COMPACTION_MEMTABLE_BUDGET.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_LEVEL_COMPACTION_DYNAMIC_LEVEL_BYTES.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_UNIVERSAL_COMPACTION_RATIO.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_PARALLELISM.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_COMPRESSION_TYPE.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_BOTTOMMOST_COMPRESSION_TYPE.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_BATCH_SIZE.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_STATS_LOG_INTERVAL_SECONDS.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_STATS_PERSIST_INTERVAL_SECONDS.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_POINT_LOOKUP_BLOCK_CACHE_SIZE_MB.name()
|| name == upsert_rocksdb::UPSERT_ROCKSDB_SHRINK_ALLOCATED_BUFFERS_BY_RATIO.name()
}
/// Returns whether the named variable is a Postgres/CRDB timestamp oracle
/// configuration parameter.
pub fn is_pg_timestamp_oracle_config_var(name: &str) -> bool {
name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_SIZE.name()
|| name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_MAX_WAIT.name()
|| name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL.name()
|| name == PG_TIMESTAMP_ORACLE_CONNECTION_POOL_TTL_STAGGER.name()
|| name == CRDB_CONNECT_TIMEOUT.name()
|| name == CRDB_TCP_USER_TIMEOUT.name()
}
/// Returns whether the named variable is a cluster scheduling config
pub fn is_cluster_scheduling_var(name: &str) -> bool {
name == cluster_scheduling::CLUSTER_MULTI_PROCESS_REPLICA_AZ_AFFINITY_WEIGHT.name()
|| name == cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY.name()
|| name == cluster_scheduling::CLUSTER_SOFTEN_REPLICATION_ANTI_AFFINITY_WEIGHT.name()
|| name == cluster_scheduling::CLUSTER_ENABLE_TOPOLOGY_SPREAD.name()
|| name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_IGNORE_NON_SINGULAR_SCALE.name()
|| name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_MAX_SKEW.name()
|| name == cluster_scheduling::CLUSTER_TOPOLOGY_SPREAD_SOFT.name()
|| name == cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY.name()
|| name == cluster_scheduling::CLUSTER_SOFTEN_AZ_AFFINITY_WEIGHT.name()
|| name == cluster_scheduling::CLUSTER_ALWAYS_USE_DISK.name()
}
/// Returns whether the named variable is an HTTP server related config var.
pub fn is_http_config_var(name: &str) -> bool {
name == WEBHOOK_CONCURRENT_REQUEST_LIMIT.name()
}
/// Set of [`SystemVar`]s that can also get set at a per-Session level.
///
/// TODO(parkmycar): Instead of a separate list, make this a field on VarDefinition.
static SESSION_SYSTEM_VARS: LazyLock<BTreeMap<&'static UncasedStr, &'static VarDefinition>> =
LazyLock::new(|| {
[
&APPLICATION_NAME,
&CLIENT_ENCODING,
&CLIENT_MIN_MESSAGES,
&CLUSTER,
&CLUSTER_REPLICA,
&CURRENT_OBJECT_MISSING_WARNINGS,
&DATABASE,
&DATE_STYLE,
&EXTRA_FLOAT_DIGITS,
&INTEGER_DATETIMES,
&INTERVAL_STYLE,
&REAL_TIME_RECENCY_TIMEOUT,
&SEARCH_PATH,
&STANDARD_CONFORMING_STRINGS,
&STATEMENT_TIMEOUT,
&IDLE_IN_TRANSACTION_SESSION_TIMEOUT,
&TIMEZONE,
&TRANSACTION_ISOLATION,
&MAX_QUERY_RESULT_SIZE,
]
.into_iter()
.map(|var| (UncasedStr::new(var.name()), var))
.collect()
});
// Provides a wrapper to express that a particular `ServerVar` is meant to be used as a feature
/// flag.
#[derive(Debug)]
pub struct FeatureFlag {
pub flag: &'static VarDefinition,
pub feature_desc: &'static str,
}
impl FeatureFlag {
/// Returns an error unless the feature flag is enabled in the provided
/// `system_vars`.
pub fn require(&'static self, system_vars: &SystemVars) -> Result<(), VarError> {
match *system_vars.expect_value::<bool>(self.flag) {
true => Ok(()),
false => Err(VarError::RequiresFeatureFlag { feature_flag: self }),
}
}
}
impl PartialEq for FeatureFlag {
fn eq(&self, other: &FeatureFlag) -> bool {
self.flag.name() == other.flag.name()
}
}
impl Eq for FeatureFlag {}
impl Var for MzVersion {
fn name(&self) -> &'static str {
MZ_VERSION_NAME.as_str()
}
fn value(&self) -> String {
self.build_info
.human_version(self.helm_chart_version.clone())
}
fn description(&self) -> &'static str {
"Shows the Materialize server version (Materialize)."
}
fn type_name(&self) -> Cow<'static, str> {
String::type_name()
}
fn visible(&self, _: &User, _: &SystemVars) -> Result<(), VarError> {
Ok(())
}
}
impl Var for User {
fn name(&self) -> &'static str {
IS_SUPERUSER_NAME.as_str()
}
fn value(&self) -> String {
self.is_superuser().format()
}
fn description(&self) -> &'static str {
"Reports whether the current session is a superuser (PostgreSQL)."
}
fn type_name(&self) -> Cow<'static, str> {
bool::type_name()
}
fn visible(&self, _: &User, _: &SystemVars) -> Result<(), VarError> {
Ok(())
}
}