Docs
Pricing
Blog
About
Sign In
Get Started
Docs
Pricing
Blog
About
Sign In
Get Started
Get started
What is Materialize?
Quickstart
Download and run Materialize Emulator
Install Self-Managed Materialize
Materialize console
Create new
SQL Shell
Database object explorer
Clusters
Integrations
Monitoring
Admin (Cloud-only)
Connect (Cloud-only)
User profile
Concepts
Clusters
Sources
Views
Indexes
Arrangements
Sinks
Snapshotting
Hydration
Reaction Time, Freshness, and Query Latency
Namespaces
Self-Managed Deployments
Installation
Install locally on kind
Install on AWS
Install on Azure
Install on GCP
Upgrading
Upgrade on kind
Upgrade on AWS
Upgrade on Azure
Upgrade on GCP
Upgrade notes
Adopting the v1 CRD
Deployment guidelines
AWS deployment guidelines
Azure deployment guidelines
GCP deployment guidelines
Resize node pools
GKE node pool upgrades
Materialize Operator Configuration
Materialize CRD Field Descriptions
v1
v1alpha1
Configuring System Parameters
Troubleshooting
FAQ
Self-managed release versions
Appendix
Prepare for swap and upgrade to v26.0
Cluster sizes
Architecture Patterns
Live Context Graph
Use an ontology table
Ingest data
MySQL
Amazon Aurora
Amazon RDS
Azure DB
Google Cloud SQL
Self-hosted
Snapshot parallelism
Troubleshooting
Received out of order GTIDs
Guide: Handle upstream schema changes with zero downtime
PostgreSQL
AlloyDB
Amazon Aurora
Amazon RDS
Azure DB
Google Cloud SQL
Neon
Self-hosted PostgreSQL
Ingest from a dedicated replica
Ingest from partitioned tables
Troubleshooting
Slot overcompacted
Replication slot is active
Connection closed
Guide: Handle upstream schema changes with zero downtime
FAQ: PostgreSQL sources
SQL Server
Azure SQL Database
Self-hosted SQL Server
Guide: Handle upstream schema changes with zero downtime
MongoDB
CockroachDB
Using Kafka and Changefeeds
Kafka
Amazon MSK
Confluent Cloud
Self-hosted Kafka
WarpStream
Guide: Handle upstream schema changes with zero downtime
Redpanda
Self-hosted Redpanda
Redpanda Cloud
Patterns
Absorbing upstream schema changes
Webhooks
Quickstart
Changing included headers
Amazon EventBridge
HubSpot
RudderStack
Segment
SnowcatCloud
Stripe
Network configuration
Static IP addresses (Cloud-only)
AWS PrivateLink connections (Cloud-only)
SSH tunnel connections
Monitoring data ingestion
Troubleshooting
Transform data
Overview
Idiomatic Materialize SQL
ANY()
equi-join condition
NOT IN
subquery
First value in group
Lag over
Last value in group
Lead over
mz_now() expressions
Top-K in group
Appendix
Idiomatic Materialize SQL chart
Window function to idiomatic Materialize
Example data: items and orders
Patterns
Durable subscriptions
Partitioning and filter pushdown
Percentile calculation
Rules execution engine
Temporal filters (time windows)
Query optimization
Dictionary compression
Updating materialized views
Replace Materialized Views
Monitor freshness
Freshness troubleshooting
Dataflow troubleshooting
Troubleshooting
FAQ: Indexes
Serve results
SELECT
and
SUBSCRIBE
Use BI/data collaboration tools
Deepnote
Hex
Metabase
Power BI
Tableau
Looker
Excel
Use foreign data wrapper (FDW)
Sink results
Amazon S3
S3 Compatible Object Storage
Apache Iceberg
AWS S3 Tables
GCP BigLake
Databricks on AWS
Census
Elasticsearch
Kafka and Redpanda
OpenSearch
turbopuffer
Snowflake
Troubleshooting sinks
Security
Cloud
User and service accounts
Invite users
Create service accounts
Configure single sign-on (SSO)
Sync identity provider groups to database roles
Access control (Role-based)
Manage database roles
Manage network policies
Self-managed
Authentication
Single sign-on (SSO)
Migrate to SSO
Access control
Manage database roles
Appendix
Appendix: Privileges
Appendix: Privileges by commands
Appendix: Built-in roles
AI & agents
Agent Skills
MCP Server for Agents
Available tools
Agent endpoint configuration
MCP Server for Developers
Available tools
Endpoint configuration
MCP Server Troubleshooting
Manage Materialize
Operational guidelines
Appendix: Alternative cluster architectures
Monitoring and alerting
Cloud
Datadog
Grafana
Alerting
Self-Managed
How logs and metrics are stored and delivered
Grafana
Datadog
Honeycomb
OpenTelemetry
Google Cloud Monitoring
Prometheus remote write
Alerting
Replica resource usage
Essential metrics
Appendix: Metrics
Manage with dbt
Get started
Development workflows
Blue-green deployment
Slim deployments
Manage with Terraform
Get started
Manage Materialize resources
Manage cloud resources
Manage privileges
Appendix: External secret stores
Manage with mz-deploy
Get started
Project structure
Infrastructure
Local development
Editor setup
AI agent setup
Deployments
Stable APIs
Profiles
Disaster recovery (Cloud)
Materialize Cloud DR characteristics
Usage & billing (Cloud)
Usage (Self-Managed)
Tools and integrations
SQL clients
Client libraries
Go
Java
Node.js
PHP
Python
Ruby
Rust
Connection Pooling
Foreign data wrapper (FDW)
ADBC (Arrow Database Connectivity)
HTTP API
WebSocket API
mz-debug
Debug tool
mz-debug self-managed
mz-debug emulator
mz
- Materialize CLI
Installation
Configuration
mz
Reference
mz app-password
mz config
mz profile
mz region
mz secret
mz sql
mz user
SQL Reference
SQL commands
ALTER CLUSTER
ALTER CLUSTER REPLICA
ALTER CONNECTION
ALTER DATABASE
ALTER DEFAULT PRIVILEGES
ALTER INDEX
ALTER MATERIALIZED VIEW
ALTER NETWORK POLICY (Cloud)
ALTER ROLE
ALTER SCHEMA
ALTER SECRET
ALTER SINK
ALTER SOURCE
ALTER SYSTEM RESET
ALTER SYSTEM SET
ALTER TABLE
ALTER TYPE
ALTER VIEW
BEGIN
CLOSE
COMMENT ON
COMMIT
COPY FROM
COPY TO
CREATE CLUSTER
CREATE CLUSTER REPLICA
CREATE CONNECTION
CREATE DATABASE
CREATE INDEX
CREATE MATERIALIZED VIEW
CREATE NETWORK POLICY (Cloud)
CREATE ROLE
CREATE SCHEMA
CREATE SECRET
CREATE SINK
Kafka/Redpanda
Iceberg
CREATE SOURCE
Kafka/Redpanda (New Syntax)
MySQL (New Syntax)
PostgreSQL (New Syntax)
SQL Server (New Syntax)
Webhook
Legacy Syntax
Kafka/Redpanda (Legacy Syntax)
MySQL (Legacy Syntax)
PostgreSQL (Legacy Syntax)
SQL Server (Legacy Syntax)
Load generator
CREATE TABLE
PostgreSQL source table
MySQL source table
SQL Server source table
Kafka source table
Read-write table
CREATE TYPE
CREATE VIEW
DEALLOCATE
DECLARE
DELETE
DISCARD
DROP CLUSTER
DROP CLUSTER REPLICA
DROP CONNECTION
DROP DATABASE
DROP INDEX
DROP MATERIALIZED VIEW
DROP NETWORK POLICY (Cloud)
DROP OWNED
DROP ROLE
DROP SCHEMA
DROP SECRET
DROP SINK
DROP SOURCE
DROP TABLE
DROP TYPE
DROP USER
DROP VIEW
EXECUTE
EXECUTE UNIT TEST
EXPLAIN ANALYZE
EXPLAIN FILTER PUSHDOWN
EXPLAIN PLAN
EXPLAIN SCHEMA
EXPLAIN TIMESTAMP
FETCH
GRANT PRIVILEGE
GRANT ROLE
INSERT
PREPARE
REASSIGN OWNED
RESET
REVOKE PRIVILEGE
REVOKE ROLE
ROLLBACK
SELECT
Joins
Recursive CTEs
SET
SHOW
SHOW CLUSTER REPLICAS
SHOW CLUSTERS
SHOW COLUMNS
SHOW CONNECTIONS
SHOW CREATE CLUSTER
SHOW CREATE CONNECTION
SHOW CREATE INDEX
SHOW CREATE MATERIALIZED VIEW
SHOW CREATE SINK
SHOW CREATE SOURCE
SHOW CREATE TABLE
SHOW CREATE TYPE
SHOW CREATE VIEW
SHOW DATABASES
SHOW DEFAULT PRIVILEGES
SHOW INDEXES
SHOW MATERIALIZED VIEWS
SHOW NETWORK POLICIES (Cloud)
SHOW OBJECTS
SHOW PRIVILEGES
SHOW ROLE MEMBERSHIP
SHOW ROLES
SHOW SCHEMAS
SHOW SECRETS
SHOW SINKS
SHOW SOURCES
SHOW SUBSOURCES
SHOW TABLES
SHOW TYPES
SHOW VIEWS
SUBSCRIBE
TABLE
UPDATE
VALIDATE CONNECTION
VALUES
SQL functions & operators
Aggregate function filters
array_agg function
CAST function and operator
COALESCE function
csv_extract function
date_bin function
date_part function
date_trunc function
datediff function
encode and decode functions
EXTRACT function
jsonb_agg function
jsonb_object_agg function
justify_days function
justify_hours function
justify_interval function
LENGTH function
list_agg function
map_agg function
normalize function
now and mz_now functions
Pushdown functions
string_agg function
SUBSTRING function
Table functions
TIMEZONE and AT TIME ZONE functions
to_char function
SQL data types
Array types
boolean type
bytea type
date type
Floating-point types
Integer types
interval type
jsonb type
List types
map type
mz_aclitem type
mz_timestamp type
numeric type
oid type
record type
text type
time type
Timestamp types
Unsigned Integer types
uuid type
SQL identifiers
SQL namespaces
Reference
M.1 to cc size mapping
Explain plan operators
Isolation levels
Ingestion performance
System catalog
mz_catalog
pg_catalog
information_schema
mz_internal
mz_introspection
System clusters
Releases
Release Schedule
About
Support
License
General FAQs
Customer responsibility model (Cloud)
Materialize Cloud Security and Compliance
Responsible disclosure policy
Close
Arrow Pointing to the left
All Topics
Home
/
Self-Managed Deployments
Appendix
View as Markdown
Table of contents
Appendix: Cluster sizes
Appendix: Prepare for swap and upgrade to v26.0
Back to top ↑