risingwave_meta/controller/
mod.rs

1// Copyright 2025 RisingWave Labs
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use std::collections::BTreeMap;
16use std::time::Duration;
17
18use anyhow::{Context, anyhow};
19use risingwave_common::bail;
20use risingwave_common::hash::VnodeCount;
21use risingwave_common::util::epoch::Epoch;
22use risingwave_meta_model::{
23    PrivateLinkService, connection, database, function, index, object, schema, secret, sink,
24    source, subscription, table, view,
25};
26use risingwave_meta_model_migration::{MigrationStatus, Migrator, MigratorTrait};
27use risingwave_pb::catalog::connection::PbInfo as PbConnectionInfo;
28use risingwave_pb::catalog::source::PbOptionalAssociatedTableId;
29use risingwave_pb::catalog::table::{
30    CdcTableType as PbCdcTableType, PbEngine, PbOptionalAssociatedSourceId, PbTableType,
31};
32use risingwave_pb::catalog::{
33    PbConnection, PbCreateType, PbDatabase, PbFunction, PbHandleConflictBehavior, PbIndex,
34    PbSchema, PbSecret, PbSink, PbSinkType, PbSource, PbStreamJobStatus, PbSubscription, PbTable,
35    PbView,
36};
37use sea_orm::{ConnectOptions, DatabaseConnection, DbBackend, ModelTrait};
38
39use crate::{MetaError, MetaResult, MetaStoreBackend};
40
41pub mod catalog;
42pub mod cluster;
43pub mod fragment;
44pub mod id;
45pub mod rename;
46pub mod scale;
47pub mod session_params;
48pub mod streaming_job;
49pub mod system_param;
50pub mod user;
51pub mod utils;
52
53// todo: refine the error transform.
54impl From<sea_orm::DbErr> for MetaError {
55    fn from(err: sea_orm::DbErr) -> Self {
56        if let Some(err) = err.sql_err() {
57            return anyhow!(err).into();
58        }
59        anyhow!(err).into()
60    }
61}
62
63#[derive(Clone)]
64pub struct SqlMetaStore {
65    pub conn: DatabaseConnection,
66    pub endpoint: String,
67}
68
69impl SqlMetaStore {
70    /// Connect to the SQL meta store based on the given configuration.
71    pub async fn connect(backend: MetaStoreBackend) -> MetaResult<Self> {
72        const MAX_DURATION: Duration = Duration::new(u64::MAX / 4, 0);
73
74        #[easy_ext::ext]
75        impl ConnectOptions {
76            /// Apply common settings for `SQLite` connections.
77            fn sqlite_common(&mut self) -> &mut Self {
78                self
79                    // Since Sqlite is prone to the error "(code: 5) database is locked" under concurrent access,
80                    // here we forcibly specify the number of connections as 1.
81                    .min_connections(1)
82                    .max_connections(1)
83                    // Workaround for https://github.com/risingwavelabs/risingwave/issues/18966.
84                    // Note: don't quite get the point but `acquire_timeout` and `connect_timeout` maps to the
85                    //       same underlying setting in `sqlx` under current implementation.
86                    .acquire_timeout(MAX_DURATION)
87                    .connect_timeout(MAX_DURATION)
88            }
89        }
90
91        Ok(match backend {
92            MetaStoreBackend::Mem => {
93                const IN_MEMORY_STORE: &str = "sqlite::memory:";
94
95                let mut options = ConnectOptions::new(IN_MEMORY_STORE);
96
97                options
98                    .sqlite_common()
99                    // Releasing the connection to in-memory SQLite database is unacceptable
100                    // because it will clear the database. Set a large enough timeout to prevent it.
101                    // `sqlx` actually supports disabling these timeouts by passing a `None`, but
102                    // `sea-orm` does not expose this option.
103                    .idle_timeout(MAX_DURATION)
104                    .max_lifetime(MAX_DURATION);
105
106                let conn = sea_orm::Database::connect(options).await?;
107                Self {
108                    conn,
109                    endpoint: IN_MEMORY_STORE.to_owned(),
110                }
111            }
112            MetaStoreBackend::Sql { endpoint, config } => {
113                let mut options = ConnectOptions::new(endpoint.clone());
114                options
115                    .max_connections(config.max_connections)
116                    .min_connections(config.min_connections)
117                    .connect_timeout(Duration::from_secs(config.connection_timeout_sec))
118                    .idle_timeout(Duration::from_secs(config.idle_timeout_sec))
119                    .acquire_timeout(Duration::from_secs(config.acquire_timeout_sec));
120
121                if DbBackend::Sqlite.is_prefix_of(&endpoint) {
122                    if endpoint.contains(":memory:") || endpoint.contains("mode=memory") {
123                        bail!(
124                            "use the `mem` backend instead of specifying a URL of in-memory SQLite"
125                        );
126                    }
127                    options.sqlite_common();
128                }
129
130                let conn = sea_orm::Database::connect(options).await?;
131                Self { conn, endpoint }
132            }
133        })
134    }
135
136    #[cfg(any(test, feature = "test"))]
137    pub async fn for_test() -> Self {
138        let this = Self::connect(MetaStoreBackend::Mem).await.unwrap();
139        Migrator::up(&this.conn, None).await.unwrap();
140        this
141    }
142
143    /// Check whether the cluster, which uses SQL as the backend, is a new cluster.
144    /// It determines this by inspecting the applied migrations. If the migration `m20230908_072257_init` has been applied,
145    /// then it is considered an old cluster.
146    ///
147    /// Note: this check should be performed before [`Self::up()`].
148    async fn is_first_launch(&self) -> MetaResult<bool> {
149        let migrations = Migrator::get_applied_migrations(&self.conn)
150            .await
151            .context("failed to get applied migrations")?;
152        for migration in migrations {
153            if migration.name() == "m20230908_072257_init"
154                && migration.status() == MigrationStatus::Applied
155            {
156                return Ok(false);
157            }
158        }
159        Ok(true)
160    }
161
162    /// Apply all the migrations to the meta store before starting the service.
163    ///
164    /// Returns whether the cluster is the first launch.
165    pub async fn up(&self) -> MetaResult<bool> {
166        let cluster_first_launch = self.is_first_launch().await?;
167        // Try to upgrade if any new model changes are added.
168        Migrator::up(&self.conn, None)
169            .await
170            .context("failed to upgrade models in meta store")?;
171
172        Ok(cluster_first_launch)
173    }
174}
175
176pub struct ObjectModel<M: ModelTrait>(M, object::Model);
177
178impl From<ObjectModel<database::Model>> for PbDatabase {
179    fn from(value: ObjectModel<database::Model>) -> Self {
180        Self {
181            id: value.0.database_id as _,
182            name: value.0.name,
183            owner: value.1.owner_id as _,
184            resource_group: value.0.resource_group.clone(),
185            barrier_interval_ms: value.0.barrier_interval_ms.map(|v| v as u32),
186            checkpoint_frequency: value.0.checkpoint_frequency.map(|v| v as u64),
187        }
188    }
189}
190
191impl From<ObjectModel<secret::Model>> for PbSecret {
192    fn from(value: ObjectModel<secret::Model>) -> Self {
193        Self {
194            id: value.0.secret_id as _,
195            name: value.0.name,
196            database_id: value.1.database_id.unwrap() as _,
197            value: value.0.value,
198            owner: value.1.owner_id as _,
199            schema_id: value.1.schema_id.unwrap() as _,
200        }
201    }
202}
203
204impl From<ObjectModel<schema::Model>> for PbSchema {
205    fn from(value: ObjectModel<schema::Model>) -> Self {
206        Self {
207            id: value.0.schema_id as _,
208            name: value.0.name,
209            database_id: value.1.database_id.unwrap() as _,
210            owner: value.1.owner_id as _,
211        }
212    }
213}
214
215impl From<ObjectModel<table::Model>> for PbTable {
216    fn from(value: ObjectModel<table::Model>) -> Self {
217        Self {
218            id: value.0.table_id as _,
219            schema_id: value.1.schema_id.unwrap() as _,
220            database_id: value.1.database_id.unwrap() as _,
221            name: value.0.name,
222            columns: value.0.columns.to_protobuf(),
223            pk: value.0.pk.to_protobuf(),
224            table_type: PbTableType::from(value.0.table_type) as _,
225            distribution_key: value.0.distribution_key.0,
226            stream_key: value.0.stream_key.0,
227            append_only: value.0.append_only,
228            owner: value.1.owner_id as _,
229            fragment_id: value.0.fragment_id.unwrap_or_default() as u32,
230            vnode_col_index: value.0.vnode_col_index.map(|index| index as _),
231            row_id_index: value.0.row_id_index.map(|index| index as _),
232            value_indices: value.0.value_indices.0,
233            definition: value.0.definition,
234            handle_pk_conflict_behavior: PbHandleConflictBehavior::from(
235                value.0.handle_pk_conflict_behavior,
236            ) as _,
237            version_column_indices: value
238                .0
239                .version_column_indices
240                .unwrap_or_default()
241                .0
242                .iter()
243                .map(|&idx| idx as u32)
244                .collect(),
245            read_prefix_len_hint: value.0.read_prefix_len_hint as _,
246            watermark_indices: value.0.watermark_indices.0,
247            dist_key_in_pk: value.0.dist_key_in_pk.0,
248            dml_fragment_id: value.0.dml_fragment_id.map(|id| id as u32),
249            cardinality: value
250                .0
251                .cardinality
252                .map(|cardinality| cardinality.to_protobuf()),
253            initialized_at_epoch: Some(
254                Epoch::from_unix_millis(value.1.initialized_at.and_utc().timestamp_millis() as _).0,
255            ),
256            created_at_epoch: Some(
257                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
258            ),
259            cleaned_by_watermark: value.0.cleaned_by_watermark,
260            stream_job_status: PbStreamJobStatus::Created as _,
261            create_type: PbCreateType::Foreground as _,
262            version: value.0.version.map(|v| v.to_protobuf()),
263            optional_associated_source_id: value
264                .0
265                .optional_associated_source_id
266                .map(|id| PbOptionalAssociatedSourceId::AssociatedSourceId(id as _)),
267            description: value.0.description,
268            #[expect(deprecated)]
269            incoming_sinks: vec![],
270            initialized_at_cluster_version: value.1.initialized_at_cluster_version,
271            created_at_cluster_version: value.1.created_at_cluster_version,
272            retention_seconds: value.0.retention_seconds.map(|id| id as u32),
273            cdc_table_id: value.0.cdc_table_id,
274            maybe_vnode_count: VnodeCount::set(value.0.vnode_count).to_protobuf(),
275            webhook_info: value.0.webhook_info.map(|info| info.to_protobuf()),
276            job_id: value.0.belongs_to_job_id.map(|id| id as _),
277            engine: value.0.engine.map(|engine| PbEngine::from(engine) as i32),
278            clean_watermark_index_in_pk: value.0.clean_watermark_index_in_pk,
279            refreshable: value.0.refreshable,
280            vector_index_info: value.0.vector_index_info.map(|index| index.to_protobuf()),
281            cdc_table_type: value
282                .0
283                .cdc_table_type
284                .map(|cdc_type| PbCdcTableType::from(cdc_type) as i32),
285        }
286    }
287}
288
289impl From<ObjectModel<source::Model>> for PbSource {
290    fn from(value: ObjectModel<source::Model>) -> Self {
291        let mut secret_ref_map = BTreeMap::new();
292        if let Some(secret_ref) = value.0.secret_ref {
293            secret_ref_map = secret_ref.to_protobuf();
294        }
295        Self {
296            id: value.0.source_id as _,
297            schema_id: value.1.schema_id.unwrap() as _,
298            database_id: value.1.database_id.unwrap() as _,
299            name: value.0.name,
300            row_id_index: value.0.row_id_index.map(|id| id as _),
301            columns: value.0.columns.to_protobuf(),
302            pk_column_ids: value.0.pk_column_ids.0,
303            with_properties: value.0.with_properties.0,
304            owner: value.1.owner_id as _,
305            info: value.0.source_info.map(|info| info.to_protobuf()),
306            watermark_descs: value.0.watermark_descs.to_protobuf(),
307            definition: value.0.definition,
308            connection_id: value.0.connection_id.map(|id| id as _),
309            // todo: using the timestamp from the database directly.
310            initialized_at_epoch: Some(
311                Epoch::from_unix_millis(value.1.initialized_at.and_utc().timestamp_millis() as _).0,
312            ),
313            created_at_epoch: Some(
314                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
315            ),
316            version: value.0.version as _,
317            optional_associated_table_id: value
318                .0
319                .optional_associated_table_id
320                .map(|id| PbOptionalAssociatedTableId::AssociatedTableId(id as _)),
321            initialized_at_cluster_version: value.1.initialized_at_cluster_version,
322            created_at_cluster_version: value.1.created_at_cluster_version,
323            secret_refs: secret_ref_map,
324            rate_limit: value.0.rate_limit.map(|v| v as _),
325        }
326    }
327}
328
329impl From<ObjectModel<sink::Model>> for PbSink {
330    fn from(value: ObjectModel<sink::Model>) -> Self {
331        let mut secret_ref_map = BTreeMap::new();
332        if let Some(secret_ref) = value.0.secret_ref {
333            secret_ref_map = secret_ref.to_protobuf();
334        }
335        Self {
336            id: value.0.sink_id as _,
337            schema_id: value.1.schema_id.unwrap() as _,
338            database_id: value.1.database_id.unwrap() as _,
339            name: value.0.name,
340            columns: value.0.columns.to_protobuf(),
341            plan_pk: value.0.plan_pk.to_protobuf(),
342            distribution_key: value.0.distribution_key.0,
343            downstream_pk: value.0.downstream_pk.0,
344            sink_type: PbSinkType::from(value.0.sink_type) as _,
345            owner: value.1.owner_id as _,
346            properties: value.0.properties.0,
347            definition: value.0.definition,
348            connection_id: value.0.connection_id.map(|id| id as _),
349            initialized_at_epoch: Some(
350                Epoch::from_unix_millis(value.1.initialized_at.and_utc().timestamp_millis() as _).0,
351            ),
352            created_at_epoch: Some(
353                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
354            ),
355            db_name: value.0.db_name,
356            sink_from_name: value.0.sink_from_name,
357            stream_job_status: PbStreamJobStatus::Created as _,
358            format_desc: value.0.sink_format_desc.map(|desc| desc.to_protobuf()),
359            target_table: value.0.target_table.map(|id| id as _),
360            initialized_at_cluster_version: value.1.initialized_at_cluster_version,
361            created_at_cluster_version: value.1.created_at_cluster_version,
362            create_type: PbCreateType::Foreground as _,
363            secret_refs: secret_ref_map,
364            original_target_columns: value
365                .0
366                .original_target_columns
367                .map(|cols| cols.to_protobuf())
368                .unwrap_or_default(),
369            auto_refresh_schema_from_table: value
370                .0
371                .auto_refresh_schema_from_table
372                .map(|id| id as _),
373        }
374    }
375}
376
377impl From<ObjectModel<subscription::Model>> for PbSubscription {
378    fn from(value: ObjectModel<subscription::Model>) -> Self {
379        Self {
380            id: value.0.subscription_id as _,
381            schema_id: value.1.schema_id.unwrap() as _,
382            database_id: value.1.database_id.unwrap() as _,
383            name: value.0.name,
384            owner: value.1.owner_id as _,
385            retention_seconds: value.0.retention_seconds as _,
386            definition: value.0.definition,
387            initialized_at_epoch: Some(
388                Epoch::from_unix_millis(value.1.initialized_at.and_utc().timestamp_millis() as _).0,
389            ),
390            created_at_epoch: Some(
391                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
392            ),
393            initialized_at_cluster_version: value.1.initialized_at_cluster_version,
394            created_at_cluster_version: value.1.created_at_cluster_version,
395            dependent_table_id: value.0.dependent_table_id as _,
396            subscription_state: value.0.subscription_state as _,
397        }
398    }
399}
400
401impl From<ObjectModel<index::Model>> for PbIndex {
402    fn from(value: ObjectModel<index::Model>) -> Self {
403        Self {
404            id: value.0.index_id as _,
405            schema_id: value.1.schema_id.unwrap() as _,
406            database_id: value.1.database_id.unwrap() as _,
407            name: value.0.name,
408            owner: value.1.owner_id as _,
409            index_table_id: value.0.index_table_id as _,
410            primary_table_id: value.0.primary_table_id as _,
411            index_item: value.0.index_items.to_protobuf(),
412            index_column_properties: value
413                .0
414                .index_column_properties
415                .map(|p| p.to_protobuf())
416                .unwrap_or_default(),
417            index_columns_len: value.0.index_columns_len as _,
418            initialized_at_epoch: Some(
419                Epoch::from_unix_millis(value.1.initialized_at.and_utc().timestamp_millis() as _).0,
420            ),
421            created_at_epoch: Some(
422                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
423            ),
424            stream_job_status: PbStreamJobStatus::Created as _,
425            initialized_at_cluster_version: value.1.initialized_at_cluster_version,
426            created_at_cluster_version: value.1.created_at_cluster_version,
427            create_type: risingwave_pb::catalog::CreateType::Foreground.into(), /* Default for existing indexes */
428        }
429    }
430}
431
432impl From<ObjectModel<view::Model>> for PbView {
433    fn from(value: ObjectModel<view::Model>) -> Self {
434        Self {
435            id: value.0.view_id as _,
436            schema_id: value.1.schema_id.unwrap() as _,
437            database_id: value.1.database_id.unwrap() as _,
438            name: value.0.name,
439            owner: value.1.owner_id as _,
440            properties: value.0.properties.0,
441            sql: value.0.definition,
442            columns: value.0.columns.to_protobuf(),
443        }
444    }
445}
446
447impl From<ObjectModel<connection::Model>> for PbConnection {
448    fn from(value: ObjectModel<connection::Model>) -> Self {
449        let info: PbConnectionInfo = if value.0.info == PrivateLinkService::default() {
450            PbConnectionInfo::ConnectionParams(value.0.params.to_protobuf())
451        } else {
452            PbConnectionInfo::PrivateLinkService(value.0.info.to_protobuf())
453        };
454        Self {
455            id: value.1.oid as _,
456            schema_id: value.1.schema_id.unwrap() as _,
457            database_id: value.1.database_id.unwrap() as _,
458            name: value.0.name,
459            owner: value.1.owner_id as _,
460            info: Some(info),
461        }
462    }
463}
464
465impl From<ObjectModel<function::Model>> for PbFunction {
466    fn from(value: ObjectModel<function::Model>) -> Self {
467        Self {
468            id: value.0.function_id as _,
469            schema_id: value.1.schema_id.unwrap() as _,
470            database_id: value.1.database_id.unwrap() as _,
471            name: value.0.name,
472            owner: value.1.owner_id as _,
473            arg_names: value.0.arg_names.split(',').map(|s| s.to_owned()).collect(),
474            arg_types: value.0.arg_types.to_protobuf(),
475            return_type: Some(value.0.return_type.to_protobuf()),
476            language: value.0.language,
477            runtime: value.0.runtime,
478            link: value.0.link,
479            name_in_runtime: value.0.name_in_runtime,
480            body: value.0.body,
481            compressed_binary: value.0.compressed_binary,
482            kind: Some(value.0.kind.into()),
483            always_retry_on_network_error: value.0.always_retry_on_network_error,
484            is_async: value
485                .0
486                .options
487                .as_ref()
488                .and_then(|o| o.0.get("async").map(|v| v == "true")),
489            is_batched: value
490                .0
491                .options
492                .as_ref()
493                .and_then(|o| o.0.get("batch").map(|v| v == "true")),
494            created_at_epoch: Some(
495                Epoch::from_unix_millis(value.1.created_at.and_utc().timestamp_millis() as _).0,
496            ),
497            created_at_cluster_version: value.1.created_at_cluster_version,
498        }
499    }
500}
risingwave_meta/controller/mod.rs

risingwave_meta/controller/
mod.rs
