1use std::collections::{BTreeMap, HashMap, HashSet};
16use std::rc::Rc;
17use std::sync::LazyLock;
18
19use anyhow::{Context, anyhow};
20use either::Either;
21use external_schema::debezium::extract_debezium_avro_table_pk_columns;
22use external_schema::nexmark::check_nexmark_schema;
23use itertools::Itertools;
24use maplit::{convert_args, hashmap, hashset};
25use pgwire::pg_response::{PgResponse, StatementType};
26use rand::Rng;
27use risingwave_common::array::arrow::{IcebergArrowConvert, arrow_schema_iceberg};
28use risingwave_common::bail_not_implemented;
29use risingwave_common::catalog::{
30 ColumnCatalog, ColumnDesc, ColumnId, INITIAL_SOURCE_VERSION_ID, KAFKA_TIMESTAMP_COLUMN_NAME,
31 ROW_ID_COLUMN_NAME, TableId, debug_assert_column_ids_distinct,
32};
33use risingwave_common::license::Feature;
34use risingwave_common::secret::LocalSecretManager;
35use risingwave_common::system_param::reader::SystemParamsRead;
36use risingwave_common::types::DataType;
37use risingwave_common::util::iter_util::ZipEqFast;
38use risingwave_connector::WithPropertiesExt;
39use risingwave_connector::parser::additional_columns::{
40 build_additional_column_desc, get_supported_additional_columns,
41 source_add_partition_offset_cols,
42};
43use risingwave_connector::parser::{
44 AvroParserConfig, DEBEZIUM_IGNORE_KEY, DebeziumAvroParserConfig, ProtobufParserConfig,
45 SchemaLocation, SpecificParserConfig, TimestamptzHandling,
46 fetch_json_schema_and_map_to_columns,
47};
48use risingwave_connector::schema::AWS_GLUE_SCHEMA_ARN_KEY;
49use risingwave_connector::schema::schema_registry::{
50 SCHEMA_REGISTRY_BACKOFF_DURATION_KEY, SCHEMA_REGISTRY_BACKOFF_FACTOR_KEY,
51 SCHEMA_REGISTRY_MAX_DELAY_KEY, SCHEMA_REGISTRY_PASSWORD, SCHEMA_REGISTRY_RETRIES_MAX_KEY,
52 SCHEMA_REGISTRY_USERNAME, SchemaRegistryConfig, name_strategy_from_str,
53};
54use risingwave_connector::source::cdc::{
55 CDC_AUTO_SCHEMA_CHANGE_KEY, CDC_MONGODB_STRONG_SCHEMA_KEY, CDC_SHARING_MODE_KEY,
56 CDC_SNAPSHOT_BACKFILL, CDC_SNAPSHOT_MODE_KEY, CDC_TRANSACTIONAL_KEY,
57 CDC_WAIT_FOR_STREAMING_START_TIMEOUT, CITUS_CDC_CONNECTOR, MONGODB_CDC_CONNECTOR,
58 MYSQL_CDC_CONNECTOR, POSTGRES_CDC_CONNECTOR, SQL_SERVER_CDC_CONNECTOR,
59};
60use risingwave_connector::source::datagen::DATAGEN_CONNECTOR;
61use risingwave_connector::source::iceberg::ICEBERG_CONNECTOR;
62use risingwave_connector::source::nexmark::source::{EventType, get_event_data_types_with_names};
63use risingwave_connector::source::test_source::TEST_CONNECTOR;
64use risingwave_connector::source::{
65 AZBLOB_CONNECTOR, ConnectorProperties, GCS_CONNECTOR, GOOGLE_PUBSUB_CONNECTOR, KAFKA_CONNECTOR,
66 KINESIS_CONNECTOR, LEGACY_S3_CONNECTOR, MQTT_CONNECTOR, NATS_CONNECTOR, NEXMARK_CONNECTOR,
67 OPENDAL_S3_CONNECTOR, POSIX_FS_CONNECTOR, PULSAR_CONNECTOR,
68};
69pub use risingwave_connector::source::{UPSTREAM_SOURCE_KEY, WEBHOOK_CONNECTOR};
70use risingwave_pb::catalog::connection_params::PbConnectionType;
71use risingwave_pb::catalog::{PbSchemaRegistryNameStrategy, StreamSourceInfo, WatermarkDesc};
72use risingwave_pb::plan_common::additional_column::ColumnType as AdditionalColumnType;
73use risingwave_pb::plan_common::{EncodeType, FormatType};
74use risingwave_pb::stream_plan::PbStreamFragmentGraph;
75use risingwave_pb::telemetry::TelemetryDatabaseObject;
76use risingwave_sqlparser::ast::{
77 AstString, ColumnDef, ColumnOption, CreateSourceStatement, Encode, Format, FormatEncodeOptions,
78 ObjectName, SourceWatermark, SqlOptionValue, TableConstraint, Value, get_delimiter,
79};
80use risingwave_sqlparser::parser::{IncludeOption, IncludeOptionItem};
81use thiserror_ext::AsReport;
82
83use super::RwPgResponse;
84use crate::binder::Binder;
85use crate::catalog::CatalogError;
86use crate::catalog::source_catalog::SourceCatalog;
87use crate::error::ErrorCode::{self, Deprecated, InvalidInputSyntax, NotSupported, ProtocolError};
88use crate::error::{Result, RwError};
89use crate::expr::Expr;
90use crate::handler::HandlerArgs;
91use crate::handler::create_table::{
92 ColumnIdGenerator, bind_pk_and_row_id_on_relation, bind_sql_column_constraints,
93 bind_sql_columns, bind_sql_pk_names, bind_table_constraints,
94};
95use crate::handler::util::{
96 SourceSchemaCompatExt, check_connector_match_connection_type, ensure_connection_type_allowed,
97};
98use crate::optimizer::plan_node::generic::SourceNodeKind;
99use crate::optimizer::plan_node::{LogicalSource, ToStream, ToStreamContext};
100use crate::session::SessionImpl;
101use crate::session::current::notice_to_user;
102use crate::utils::{
103 OverwriteOptions, resolve_connection_ref_and_secret_ref, resolve_privatelink_in_with_option,
104 resolve_secret_ref_in_with_options,
105};
106use crate::{OptimizerContext, WithOptions, WithOptionsSecResolved, bind_data_type, build_graph};
107
108mod external_schema;
109pub use external_schema::{
110 bind_columns_from_source, get_schema_location, schema_has_schema_registry,
111};
112mod validate;
113pub use validate::validate_compatibility;
114use validate::{SOURCE_ALLOWED_CONNECTION_CONNECTOR, SOURCE_ALLOWED_CONNECTION_SCHEMA_REGISTRY};
115mod additional_column;
116use additional_column::check_and_add_timestamp_column;
117pub use additional_column::handle_addition_columns;
118
119use crate::stream_fragmenter::GraphJobType;
120
121fn non_generated_sql_columns(columns: &[ColumnDef]) -> Vec<ColumnDef> {
122 columns
123 .iter()
124 .filter(|c| !c.is_generated())
125 .cloned()
126 .collect()
127}
128
129fn try_consume_string_from_options(
130 format_encode_options: &mut BTreeMap<String, String>,
131 key: &str,
132) -> Option<AstString> {
133 format_encode_options.remove(key).map(AstString)
134}
135
136fn try_consume_schema_registry_config_from_options(
137 format_encode_options: &mut BTreeMap<String, String>,
138) {
139 [
140 SCHEMA_REGISTRY_USERNAME,
141 SCHEMA_REGISTRY_PASSWORD,
142 SCHEMA_REGISTRY_MAX_DELAY_KEY,
143 SCHEMA_REGISTRY_BACKOFF_DURATION_KEY,
144 SCHEMA_REGISTRY_BACKOFF_FACTOR_KEY,
145 SCHEMA_REGISTRY_RETRIES_MAX_KEY,
146 ]
147 .iter()
148 .for_each(|key| {
149 try_consume_string_from_options(format_encode_options, key);
150 });
151}
152
153fn consume_string_from_options(
154 format_encode_options: &mut BTreeMap<String, String>,
155 key: &str,
156) -> Result<AstString> {
157 try_consume_string_from_options(format_encode_options, key).ok_or(RwError::from(ProtocolError(
158 format!("missing field {} in options", key),
159 )))
160}
161
162fn consume_aws_config_from_options(format_encode_options: &mut BTreeMap<String, String>) {
163 format_encode_options.retain(|key, _| !key.starts_with("aws."))
164}
165
166#[derive(Debug, Clone, Copy, PartialEq, Eq)]
167pub enum CreateSourceType {
168 SharedCdc,
169 SharedNonCdc,
171 NonShared,
172 Table,
174}
175
176impl CreateSourceType {
177 pub fn for_newly_created(
179 session: &SessionImpl,
180 with_properties: &impl WithPropertiesExt,
181 ) -> Self {
182 if with_properties.is_shareable_cdc_connector() {
183 CreateSourceType::SharedCdc
184 } else if with_properties.is_shareable_non_cdc_connector()
185 && session
186 .env()
187 .streaming_config()
188 .developer
189 .enable_shared_source
190 && session.config().streaming_use_shared_source()
191 {
192 CreateSourceType::SharedNonCdc
193 } else {
194 CreateSourceType::NonShared
195 }
196 }
197
198 pub fn for_replace(catalog: &SourceCatalog) -> Self {
199 if !catalog.info.is_shared() {
200 CreateSourceType::NonShared
201 } else if catalog.with_properties.is_shareable_cdc_connector() {
202 CreateSourceType::SharedCdc
203 } else {
204 CreateSourceType::SharedNonCdc
205 }
206 }
207
208 pub fn is_shared(&self) -> bool {
209 matches!(
210 self,
211 CreateSourceType::SharedCdc | CreateSourceType::SharedNonCdc
212 )
213 }
214}
215
216pub(crate) fn bind_all_columns(
218 format_encode: &FormatEncodeOptions,
219 cols_from_source: Option<Vec<ColumnCatalog>>,
220 cols_from_sql: Vec<ColumnCatalog>,
221 col_defs_from_sql: &[ColumnDef],
222 wildcard_idx: Option<usize>,
223 sql_column_strategy: SqlColumnStrategy,
224) -> Result<Vec<ColumnCatalog>> {
225 if let Some(cols_from_source) = cols_from_source {
226 let generated_cols_from_sql = cols_from_sql
229 .iter()
230 .filter(|c| {
231 col_defs_from_sql
232 .iter()
233 .find(|d| d.name.real_value() == c.name())
234 .unwrap()
235 .is_generated()
236 })
237 .cloned()
238 .collect_vec();
239
240 #[allow(clippy::collapsible_else_if)]
241 match sql_column_strategy {
242 SqlColumnStrategy::FollowUnchecked => {
244 assert!(
245 wildcard_idx.is_none(),
246 "wildcard still exists while strategy is Follows, not correctly purified?"
247 );
248 return Ok(cols_from_sql);
249 }
250
251 SqlColumnStrategy::Ignore => {}
253
254 SqlColumnStrategy::FollowChecked => {
255 let has_regular_cols_from_sql =
256 generated_cols_from_sql.len() != cols_from_sql.len();
257
258 if has_regular_cols_from_sql {
259 if wildcard_idx.is_some() {
260 return Err(RwError::from(NotSupported(
262 "When there's a wildcard (\"*\"), \
263 only generated columns are allowed in user-defined schema from SQL"
264 .to_owned(),
265 "Remove the non-generated columns".to_owned(),
266 )));
267 } else {
268 for col in &cols_from_sql {
271 if generated_cols_from_sql.contains(col) {
272 continue;
273 }
274 let Some(col_from_source) =
275 cols_from_source.iter().find(|c| c.name() == col.name())
276 else {
277 return Err(RwError::from(ProtocolError(format!(
278 "Column \"{}\" is defined in SQL but not found in the source",
279 col.name()
280 ))));
281 };
282
283 if col_from_source.data_type() != col.data_type() {
284 return Err(RwError::from(ProtocolError(format!(
285 "Data type mismatch for column \"{}\". \
286 Defined in SQL as \"{}\", but found in the source as \"{}\"",
287 col.name(),
288 col.data_type(),
289 col_from_source.data_type()
290 ))));
291 }
292 }
293 return Ok(cols_from_sql);
294 }
295 } else {
296 if wildcard_idx.is_some() {
297 } else {
301 notice_to_user("\
309 Neither wildcard (\"*\") nor regular (non-generated) columns appear in the user-defined schema from SQL. \
310 For backward compatibility, all columns from the source will be included at the beginning. \
311 For clarity, consider adding a wildcard (\"*\") to indicate where the columns from the source should be included, \
312 or specifying the columns you want to include from the source.
313 ");
314 }
315 }
316 }
317 }
318
319 let wildcard_idx = wildcard_idx.unwrap_or(0).min(generated_cols_from_sql.len());
324
325 let mut merged_cols = generated_cols_from_sql;
327 let merged_cols_r = merged_cols.split_off(wildcard_idx);
328 merged_cols.extend(cols_from_source);
329 merged_cols.extend(merged_cols_r);
330
331 Ok(merged_cols)
332 } else {
333 if wildcard_idx.is_some() {
334 return Err(RwError::from(NotSupported(
335 "Wildcard in user-defined schema is only allowed when there exists columns from external schema".to_owned(),
336 "Remove the wildcard or use a source with external schema".to_owned(),
337 )));
338 }
339 let non_generated_sql_defined_columns = non_generated_sql_columns(col_defs_from_sql);
340
341 match (&format_encode.format, &format_encode.row_encode) {
342 (Format::DebeziumMongo, Encode::Json) => {
343 let strong_schema = format_encode
344 .row_options
345 .iter()
346 .find(|k| k.name.real_value().to_lowercase() == CDC_MONGODB_STRONG_SCHEMA_KEY)
347 .map(|k| matches!(k.value, SqlOptionValue::Value(Value::Boolean(true))))
348 .unwrap_or(false);
349
350 if strong_schema {
352 let (_, id_column) = non_generated_sql_defined_columns
353 .iter()
354 .enumerate()
355 .find(|(idx, col)| *idx == 0 && col.name.real_value() == "_id")
356 .ok_or_else(|| {
357 RwError::from(ProtocolError(
358 "The `_id` column of the source with row format DebeziumMongoJson must be defined as the first column in SQL".to_owned(),
359 ))
360 })?;
361
362 let id_data_type = bind_data_type(id_column.data_type.as_ref().unwrap())?;
363 if !matches!(
364 id_data_type,
365 DataType::Varchar | DataType::Int32 | DataType::Int64 | DataType::Jsonb
366 ) {
367 return Err(RwError::from(ProtocolError(
368 "the `_id` column of the source with row format DebeziumMongoJson must be [Jsonb | Varchar | Int32 | Int64]".to_owned(),
369 )));
370 }
371
372 let mut columns = Vec::with_capacity(non_generated_sql_defined_columns.len());
373 columns.push(
374 ColumnCatalog {
376 column_desc: ColumnDesc::named("_id", 0.into(), id_data_type),
377 is_hidden: false,
378 },
379 );
380
381 for (idx, col) in non_generated_sql_defined_columns
383 .into_iter()
384 .skip(1)
386 .enumerate()
387 {
388 columns.push(ColumnCatalog {
389 column_desc: ColumnDesc::named(
390 col.name.real_value(),
391 (idx as i32).into(),
392 bind_data_type(col.data_type.as_ref().unwrap())?,
393 ),
394 is_hidden: false,
395 });
396 }
397
398 return Ok(columns);
399 }
400
401 let mut columns = vec![
402 ColumnCatalog {
403 column_desc: ColumnDesc::named("_id", 0.into(), DataType::Varchar),
404 is_hidden: false,
405 },
406 ColumnCatalog {
407 column_desc: ColumnDesc::named("payload", 0.into(), DataType::Jsonb),
408 is_hidden: false,
409 },
410 ];
411
412 if non_generated_sql_defined_columns.len() != 2
413 || non_generated_sql_defined_columns[0].name.real_value() != columns[0].name()
414 || non_generated_sql_defined_columns[1].name.real_value() != columns[1].name()
415 {
416 return Err(RwError::from(ProtocolError(
417 "the not generated columns of the source with row format DebeziumMongoJson
418 must be (_id [Jsonb | Varchar | Int32 | Int64], payload jsonb)."
419 .to_owned(),
420 )));
421 }
422 let key_data_type = bind_data_type(
424 non_generated_sql_defined_columns[0]
425 .data_type
426 .as_ref()
427 .unwrap(),
428 )?;
429 match key_data_type {
430 DataType::Jsonb | DataType::Varchar | DataType::Int32 | DataType::Int64 => {
431 columns[0].column_desc.data_type = key_data_type.clone();
432 }
433 _ => {
434 return Err(RwError::from(ProtocolError(
435 "the `_id` column of the source with row format DebeziumMongoJson
436 must be [Jsonb | Varchar | Int32 | Int64]"
437 .to_owned(),
438 )));
439 }
440 }
441
442 let value_data_type = bind_data_type(
444 non_generated_sql_defined_columns[1]
445 .data_type
446 .as_ref()
447 .unwrap(),
448 )?;
449 if !matches!(value_data_type, DataType::Jsonb) {
450 return Err(RwError::from(ProtocolError(
451 "the `payload` column of the source with row format DebeziumMongoJson
452 must be Jsonb datatype"
453 .to_owned(),
454 )));
455 }
456 Ok(columns)
457 }
458 (Format::Plain, Encode::Bytes) => {
459 let err = Err(RwError::from(ProtocolError(
460 "ENCODE BYTES only accepts one BYTEA type column".to_owned(),
461 )));
462 if non_generated_sql_defined_columns.len() == 1 {
463 let col_data_type = bind_data_type(
465 non_generated_sql_defined_columns[0]
466 .data_type
467 .as_ref()
468 .unwrap(),
469 )?;
470 if col_data_type == DataType::Bytea {
471 Ok(cols_from_sql)
472 } else {
473 err
474 }
475 } else {
476 err
477 }
478 }
479 (_, _) => Ok(cols_from_sql),
480 }
481 }
482}
483
484fn hint_format_encode(format_encode: &FormatEncodeOptions) -> String {
486 format!(
487 r#"Hint: For FORMAT {0} ENCODE {1}, INCLUDE KEY must be specified and the key column must be used as primary key.
488example:
489 CREATE TABLE <table_name> ( PRIMARY KEY ([rw_key | <key_name>]) )
490 INCLUDE KEY [AS <key_name>]
491 WITH (...)
492 FORMAT {0} ENCODE {1}{2}
493"#,
494 format_encode.format,
495 format_encode.row_encode,
496 if format_encode.row_encode == Encode::Json || format_encode.row_encode == Encode::Bytes {
497 "".to_owned()
498 } else {
499 " (...)".to_owned()
500 }
501 )
502}
503
504pub(crate) async fn bind_source_pk(
507 format_encode: &FormatEncodeOptions,
508 source_info: &StreamSourceInfo,
509 columns: &mut [ColumnCatalog],
510 sql_defined_pk_names: Vec<String>,
511 with_properties: &WithOptionsSecResolved,
512) -> Result<Vec<String>> {
513 let sql_defined_pk = !sql_defined_pk_names.is_empty();
514 let include_key_column_name: Option<String> = {
515 columns.iter().find_map(|catalog| {
518 if matches!(
519 catalog.column_desc.additional_column.column_type,
520 Some(AdditionalColumnType::Key(_))
521 ) {
522 Some(catalog.name().to_owned())
523 } else {
524 None
525 }
526 })
527 };
528 let additional_column_names = columns
529 .iter()
530 .filter_map(|col| {
531 if col.column_desc.additional_column.column_type.is_some() {
532 Some(col.name().to_owned())
533 } else {
534 None
535 }
536 })
537 .collect_vec();
538
539 let res = match (&format_encode.format, &format_encode.row_encode) {
540 (Format::Native, Encode::Native) | (Format::None, Encode::None) | (Format::Plain, _) => {
541 sql_defined_pk_names
542 }
543
544 (Format::Upsert, Encode::Json | Encode::Avro | Encode::Protobuf) => {
547 if let Some(ref key_column_name) = include_key_column_name
548 && sql_defined_pk
549 {
550 if sql_defined_pk_names.len() != 1
555 || !key_column_name.eq(sql_defined_pk_names[0].as_str())
556 {
557 return Err(RwError::from(ProtocolError(format!(
558 "Only \"{}\" can be used as primary key\n\n{}",
559 key_column_name,
560 hint_format_encode(format_encode)
561 ))));
562 }
563 sql_defined_pk_names
564 } else {
565 return if let Some(include_key_column_name) = include_key_column_name {
567 Err(RwError::from(ProtocolError(format!(
568 "Primary key must be specified to {}\n\n{}",
569 include_key_column_name,
570 hint_format_encode(format_encode)
571 ))))
572 } else {
573 Err(RwError::from(ProtocolError(format!(
574 "INCLUDE KEY clause not set\n\n{}",
575 hint_format_encode(format_encode)
576 ))))
577 };
578 }
579 }
580
581 (Format::Debezium, Encode::Json) => {
582 if !additional_column_names.is_empty() {
583 return Err(RwError::from(ProtocolError(format!(
584 "FORMAT DEBEZIUM forbids additional columns, but got {:?}",
585 additional_column_names
586 ))));
587 }
588 if !sql_defined_pk {
589 return Err(RwError::from(ProtocolError(
590 "Primary key must be specified when creating source with FORMAT DEBEZIUM."
591 .to_owned(),
592 )));
593 }
594 sql_defined_pk_names
595 }
596 (Format::Debezium, Encode::Avro) => {
597 if !additional_column_names.is_empty() {
598 return Err(RwError::from(ProtocolError(format!(
599 "FORMAT DEBEZIUM forbids additional columns, but got {:?}",
600 additional_column_names
601 ))));
602 }
603 if sql_defined_pk {
604 sql_defined_pk_names
605 } else {
606 let pk_names =
607 extract_debezium_avro_table_pk_columns(source_info, with_properties).await?;
608 for pk_name in &pk_names {
610 columns
611 .iter()
612 .find(|c: &&ColumnCatalog| c.name().eq(pk_name))
613 .ok_or_else(|| {
614 RwError::from(ProtocolError(format!(
615 "avro's key column {} not exists in avro's row schema",
616 pk_name
617 )))
618 })?;
619 }
620 pk_names
621 }
622 }
623 (Format::DebeziumMongo, Encode::Json) => {
624 if sql_defined_pk {
625 sql_defined_pk_names
626 } else {
627 vec!["_id".to_owned()]
628 }
629 }
630
631 (Format::Maxwell, Encode::Json) => {
632 if !additional_column_names.is_empty() {
633 return Err(RwError::from(ProtocolError(format!(
634 "FORMAT MAXWELL forbids additional columns, but got {:?}",
635 additional_column_names
636 ))));
637 }
638 if !sql_defined_pk {
639 return Err(RwError::from(ProtocolError(
640 "Primary key must be specified when creating source with FORMAT MAXWELL ENCODE JSON.".to_owned(),
641 )));
642 }
643 sql_defined_pk_names
644 }
645
646 (Format::Canal, Encode::Json) => {
647 if !additional_column_names.is_empty() {
648 return Err(RwError::from(ProtocolError(format!(
649 "FORMAT CANAL forbids additional columns, but got {:?}",
650 additional_column_names
651 ))));
652 }
653 if !sql_defined_pk {
654 return Err(RwError::from(ProtocolError(
655 "Primary key must be specified when creating source with FORMAT CANAL ENCODE JSON.".to_owned(),
656 )));
657 }
658 sql_defined_pk_names
659 }
660 (format, encoding) => {
661 return Err(RwError::from(ProtocolError(format!(
662 "Unknown combination {:?} {:?}",
663 format, encoding
664 ))));
665 }
666 };
667 Ok(res)
668}
669
670pub(super) fn bind_source_watermark(
671 session: &SessionImpl,
672 name: String,
673 source_watermarks: Vec<SourceWatermark>,
674 column_catalogs: &[ColumnCatalog],
675) -> Result<Vec<WatermarkDesc>> {
676 let mut binder = Binder::new_for_ddl(session);
677 binder.bind_columns_to_context(name.clone(), column_catalogs)?;
678
679 let watermark_descs = source_watermarks
680 .into_iter()
681 .map(|source_watermark| {
682 let col_name = source_watermark.column.real_value();
683 let watermark_idx = binder.get_column_binding_index(name.clone(), &col_name)?;
684
685 let expr = binder.bind_expr(source_watermark.expr)?;
686 let watermark_col_type = column_catalogs[watermark_idx].data_type();
687 let watermark_expr_type = &expr.return_type();
688 if watermark_col_type != watermark_expr_type {
689 Err(RwError::from(ErrorCode::BindError(
690 format!("The return value type of the watermark expression must be identical to the watermark column data type. Current data type of watermark return value: `{}`, column `{}`",watermark_expr_type, watermark_col_type),
691 )))
692 } else {
693 let expr_proto = expr.to_expr_proto();
694 Ok::<_, RwError>(WatermarkDesc {
695 watermark_idx: watermark_idx as u32,
696 expr: Some(expr_proto),
697 })
698 }
699 })
700 .try_collect()?;
701 Ok(watermark_descs)
702}
703
704pub(super) fn check_format_encode(
710 props: &WithOptionsSecResolved,
711 row_id_index: Option<usize>,
712 columns: &[ColumnCatalog],
713) -> Result<()> {
714 let Some(connector) = props.get_connector() else {
715 return Ok(());
716 };
717
718 if connector == NEXMARK_CONNECTOR {
719 check_nexmark_schema(props, row_id_index, columns)
720 } else {
721 Ok(())
722 }
723}
724
725pub fn bind_connector_props(
726 handler_args: &HandlerArgs,
727 format_encode: &FormatEncodeOptions,
728 is_create_source: bool,
729) -> Result<WithOptions> {
730 let mut with_properties = handler_args.with_options.clone().into_connector_props();
731 validate_compatibility(format_encode, &mut with_properties)?;
732 let create_cdc_source_job = with_properties.is_shareable_cdc_connector();
733
734 if !is_create_source && with_properties.is_shareable_only_cdc_connector() {
735 return Err(RwError::from(ProtocolError(format!(
736 "connector {} does not support `CREATE TABLE`, please use `CREATE SOURCE` instead",
737 with_properties.get_connector().unwrap(),
738 ))));
739 }
740 if is_create_source && create_cdc_source_job {
741 if let Some(value) = with_properties.get(CDC_AUTO_SCHEMA_CHANGE_KEY)
742 && value
743 .parse::<bool>()
744 .map_err(|_| anyhow!("invalid value of '{}' option", CDC_AUTO_SCHEMA_CHANGE_KEY))?
745 {
746 Feature::CdcAutoSchemaChange
747 .check_available()
748 .map_err(|e| anyhow::anyhow!(e))?;
749 }
750
751 with_properties.insert(CDC_SNAPSHOT_MODE_KEY.into(), CDC_SNAPSHOT_BACKFILL.into());
753 with_properties.insert(CDC_SHARING_MODE_KEY.into(), "true".into());
755 if with_properties.enable_transaction_metadata() {
757 with_properties.insert(CDC_TRANSACTIONAL_KEY.into(), "true".into());
758 }
759 with_properties.insert(
760 CDC_WAIT_FOR_STREAMING_START_TIMEOUT.into(),
761 handler_args
762 .session
763 .config()
764 .cdc_source_wait_streaming_start_timeout()
765 .to_string(),
766 );
767 }
768 if with_properties.is_mysql_cdc_connector() {
769 with_properties
773 .entry("server.id".to_owned())
774 .or_insert(rand::rng().random_range(1..u32::MAX).to_string());
775 }
776 Ok(with_properties)
777}
778
779pub enum SqlColumnStrategy {
782 FollowUnchecked,
787
788 FollowChecked,
795
796 Ignore,
801}
802
803#[allow(clippy::too_many_arguments)]
806pub async fn bind_create_source_or_table_with_connector(
807 handler_args: HandlerArgs,
808 full_name: ObjectName,
809 format_encode: FormatEncodeOptions,
810 with_properties: WithOptions,
811 sql_columns_defs: &[ColumnDef],
812 constraints: Vec<TableConstraint>,
813 wildcard_idx: Option<usize>,
814 source_watermarks: Vec<SourceWatermark>,
815 columns_from_resolve_source: Option<Vec<ColumnCatalog>>,
816 source_info: StreamSourceInfo,
817 include_column_options: IncludeOption,
818 col_id_gen: &mut ColumnIdGenerator,
819 create_source_type: CreateSourceType,
820 source_rate_limit: Option<u32>,
821 sql_column_strategy: SqlColumnStrategy,
822) -> Result<SourceCatalog> {
823 let session = &handler_args.session;
824 let db_name: &str = &session.database();
825 let (schema_name, source_name) = Binder::resolve_schema_qualified_name(db_name, full_name)?;
826 let (database_id, schema_id) =
827 session.get_database_and_schema_id_for_create(schema_name.clone())?;
828
829 let is_create_source = create_source_type != CreateSourceType::Table;
830 if !is_create_source && with_properties.is_iceberg_connector() {
831 return Err(ErrorCode::BindError(
832 "can't CREATE TABLE with iceberg connector\n\nHint: use CREATE SOURCE instead"
833 .to_owned(),
834 )
835 .into());
836 }
837
838 if is_create_source {
839 match format_encode.format {
840 Format::Upsert
841 | Format::Debezium
842 | Format::DebeziumMongo
843 | Format::Maxwell
844 | Format::Canal => {
845 return Err(ErrorCode::BindError(format!(
846 "can't CREATE SOURCE with FORMAT {}.\n\nHint: use CREATE TABLE instead\n\n{}",
847 format_encode.format,
848 hint_format_encode(&format_encode)
849 ))
850 .into());
851 }
852 _ => {
853 }
855 }
856 }
857
858 let sql_pk_names = bind_sql_pk_names(sql_columns_defs, bind_table_constraints(&constraints)?)?;
859
860 if with_properties.is_iceberg_connector() && !sql_columns_defs.is_empty() {
864 return Err(RwError::from(InvalidInputSyntax(
865 r#"Schema is automatically inferred for iceberg source and should not be specified
866
867HINT: use `CREATE SOURCE <name> WITH (...)` instead of `CREATE SOURCE <name> (<columns>) WITH (...)`."#.to_owned(),
868 )));
869 }
870 let columns_from_sql = bind_sql_columns(sql_columns_defs, false)?;
871
872 let mut columns = bind_all_columns(
873 &format_encode,
874 columns_from_resolve_source,
875 columns_from_sql,
876 sql_columns_defs,
877 wildcard_idx,
878 sql_column_strategy,
879 )?;
880
881 handle_addition_columns(
883 Some(&format_encode),
884 &with_properties,
885 include_column_options,
886 &mut columns,
887 false,
888 )?;
889
890 if columns.is_empty() {
891 return Err(RwError::from(ProtocolError(
892 "Schema definition is required, either from SQL or schema registry.".to_owned(),
893 )));
894 }
895
896 if is_create_source {
898 check_and_add_timestamp_column(&with_properties, &mut columns);
900
901 if create_source_type == CreateSourceType::SharedNonCdc {
904 let (columns_exist, additional_columns) = source_add_partition_offset_cols(
905 &columns,
906 &with_properties.get_connector().unwrap(),
907 true, );
909 for (existed, c) in columns_exist.into_iter().zip_eq_fast(additional_columns) {
910 if !existed {
911 columns.push(ColumnCatalog::hidden(c));
912 }
913 }
914 }
915 }
916
917 let mut with_properties = with_properties;
919 resolve_privatelink_in_with_option(&mut with_properties)?;
920
921 if session
923 .env()
924 .system_params_manager()
925 .get_params()
926 .load()
927 .enforce_secret()
928 && Feature::SecretManagement.check_available().is_ok()
929 {
930 ConnectorProperties::enforce_secret_source(&with_properties)?;
932 }
933
934 let (with_properties, connection_type, connector_conn_ref) =
935 resolve_connection_ref_and_secret_ref(
936 with_properties,
937 session,
938 Some(TelemetryDatabaseObject::Source),
939 )?;
940 ensure_connection_type_allowed(connection_type, &SOURCE_ALLOWED_CONNECTION_CONNECTOR)?;
941
942 if !matches!(connection_type, PbConnectionType::Unspecified) {
944 let Some(connector) = with_properties.get_connector() else {
945 return Err(RwError::from(ProtocolError(format!(
946 "missing field '{}' in WITH clause",
947 UPSTREAM_SOURCE_KEY
948 ))));
949 };
950 check_connector_match_connection_type(connector.as_str(), &connection_type)?;
951 }
952
953 let pk_names = bind_source_pk(
954 &format_encode,
955 &source_info,
956 &mut columns,
957 sql_pk_names,
958 &with_properties,
959 )
960 .await?;
961
962 if is_create_source && !pk_names.is_empty() {
963 return Err(ErrorCode::InvalidInputSyntax(
964 "Source does not support PRIMARY KEY constraint, please use \"CREATE TABLE\" instead"
965 .to_owned(),
966 )
967 .into());
968 }
969
970 if let Some(duplicated_name) = columns.iter().map(|c| c.name()).duplicates().next() {
973 return Err(ErrorCode::InvalidInputSyntax(format!(
974 "column \"{}\" specified more than once",
975 duplicated_name
976 ))
977 .into());
978 }
979
980 for c in &mut columns {
982 let original_data_type = c.data_type().clone();
983 col_id_gen.generate(c)?;
984 if is_create_source {
988 c.column_desc.data_type = original_data_type;
989 }
990 }
991 debug_assert_column_ids_distinct(&columns);
992
993 let (mut columns, pk_col_ids, row_id_index) =
994 bind_pk_and_row_id_on_relation(columns, pk_names, true)?;
995
996 let watermark_descs =
997 bind_source_watermark(session, source_name.clone(), source_watermarks, &columns)?;
998 assert!(watermark_descs.len() <= 1);
1000
1001 bind_sql_column_constraints(
1002 session,
1003 source_name.clone(),
1004 &mut columns,
1005 sql_columns_defs.to_vec(),
1007 &pk_col_ids,
1008 )?;
1009 check_format_encode(&with_properties, row_id_index, &columns)?;
1010
1011 let definition = handler_args.normalized_sql.clone();
1012
1013 let associated_table_id = if is_create_source {
1014 None
1015 } else {
1016 Some(TableId::placeholder())
1017 };
1018 let source = SourceCatalog {
1019 id: TableId::placeholder().table_id,
1020 name: source_name,
1021 schema_id,
1022 database_id,
1023 columns,
1024 pk_col_ids,
1025 append_only: row_id_index.is_some(),
1026 owner: session.user_id(),
1027 info: source_info,
1028 row_id_index,
1029 with_properties,
1030 watermark_descs,
1031 associated_table_id,
1032 definition,
1033 connection_id: connector_conn_ref,
1034 created_at_epoch: None,
1035 initialized_at_epoch: None,
1036 version: INITIAL_SOURCE_VERSION_ID,
1037 created_at_cluster_version: None,
1038 initialized_at_cluster_version: None,
1039 rate_limit: source_rate_limit,
1040 };
1041 Ok(source)
1042}
1043
1044pub async fn handle_create_source(
1045 mut handler_args: HandlerArgs,
1046 stmt: CreateSourceStatement,
1047) -> Result<RwPgResponse> {
1048 let session = handler_args.session.clone();
1049 let overwrite_options = OverwriteOptions::new(&mut handler_args);
1050
1051 if let Either::Right(resp) = session.check_relation_name_duplicated(
1052 stmt.source_name.clone(),
1053 StatementType::CREATE_SOURCE,
1054 stmt.if_not_exists,
1055 )? {
1056 return Ok(resp);
1057 }
1058
1059 if handler_args.with_options.is_empty() {
1060 return Err(RwError::from(InvalidInputSyntax(
1061 "missing WITH clause".to_owned(),
1062 )));
1063 }
1064
1065 let format_encode = stmt.format_encode.into_v2_with_warning();
1066 let with_properties = bind_connector_props(&handler_args, &format_encode, true)?;
1067
1068 let create_source_type = CreateSourceType::for_newly_created(&session, &*with_properties);
1069 let (columns_from_resolve_source, source_info) = bind_columns_from_source(
1070 &session,
1071 &format_encode,
1072 Either::Left(&with_properties),
1073 create_source_type,
1074 )
1075 .await?;
1076 let mut col_id_gen = ColumnIdGenerator::new_initial();
1077
1078 if stmt.columns.iter().any(|col| {
1079 col.options
1080 .iter()
1081 .any(|def| matches!(def.option, ColumnOption::NotNull))
1082 }) {
1083 return Err(RwError::from(InvalidInputSyntax(
1084 "NOT NULL constraint is not supported in source schema".to_owned(),
1085 )));
1086 }
1087
1088 let source_catalog = bind_create_source_or_table_with_connector(
1089 handler_args.clone(),
1090 stmt.source_name,
1091 format_encode,
1092 with_properties,
1093 &stmt.columns,
1094 stmt.constraints,
1095 stmt.wildcard_idx,
1096 stmt.source_watermarks,
1097 columns_from_resolve_source,
1098 source_info,
1099 stmt.include_column_options,
1100 &mut col_id_gen,
1101 create_source_type,
1102 overwrite_options.source_rate_limit,
1103 SqlColumnStrategy::FollowChecked,
1104 )
1105 .await?;
1106
1107 if stmt.temporary {
1109 if session.get_temporary_source(&source_catalog.name).is_some() {
1110 return Err(CatalogError::duplicated("source", source_catalog.name.clone()).into());
1111 }
1112 session.create_temporary_source(source_catalog);
1113 return Ok(PgResponse::empty_result(StatementType::CREATE_SOURCE));
1114 }
1115
1116 let source = source_catalog.to_prost();
1117
1118 let catalog_writer = session.catalog_writer()?;
1119
1120 if create_source_type.is_shared() {
1121 let graph = generate_stream_graph_for_source(handler_args, source_catalog)?;
1122 catalog_writer.create_source(source, Some(graph)).await?;
1123 } else {
1124 catalog_writer.create_source(source, None).await?;
1126 }
1127
1128 Ok(PgResponse::empty_result(StatementType::CREATE_SOURCE))
1129}
1130
1131pub(super) fn generate_stream_graph_for_source(
1132 handler_args: HandlerArgs,
1133 source_catalog: SourceCatalog,
1134) -> Result<PbStreamFragmentGraph> {
1135 let context = OptimizerContext::from_handler_args(handler_args);
1136 let source_node = LogicalSource::with_catalog(
1137 Rc::new(source_catalog),
1138 SourceNodeKind::CreateSharedSource,
1139 context.into(),
1140 None,
1141 )?;
1142
1143 let stream_plan = source_node.to_stream(&mut ToStreamContext::new(false))?;
1144 let graph = build_graph(stream_plan, Some(GraphJobType::Source))?;
1145 Ok(graph)
1146}
1147
1148#[cfg(test)]
1149pub mod tests {
1150 use std::collections::HashMap;
1151 use std::sync::Arc;
1152
1153 use risingwave_common::catalog::{
1154 DEFAULT_DATABASE_NAME, DEFAULT_SCHEMA_NAME, ROW_ID_COLUMN_NAME,
1155 };
1156 use risingwave_common::types::{DataType, StructType};
1157
1158 use crate::catalog::root_catalog::SchemaPath;
1159 use crate::catalog::source_catalog::SourceCatalog;
1160 use crate::test_utils::{LocalFrontend, PROTO_FILE_DATA, create_proto_file};
1161
1162 const GET_COLUMN_FROM_CATALOG: fn(&Arc<SourceCatalog>) -> HashMap<&str, DataType> =
1163 |catalog: &Arc<SourceCatalog>| -> HashMap<&str, DataType> {
1164 catalog
1165 .columns
1166 .iter()
1167 .map(|col| (col.name(), col.data_type().clone()))
1168 .collect::<HashMap<&str, DataType>>()
1169 };
1170
1171 #[tokio::test]
1172 async fn test_create_source_handler() {
1173 let proto_file = create_proto_file(PROTO_FILE_DATA);
1174 let sql = format!(
1175 r#"CREATE SOURCE t
1176 WITH (connector = 'kinesis')
1177 FORMAT PLAIN ENCODE PROTOBUF (message = '.test.TestRecord', schema.location = 'file://{}')"#,
1178 proto_file.path().to_str().unwrap()
1179 );
1180 let frontend = LocalFrontend::new(Default::default()).await;
1181 frontend.run_sql(sql).await.unwrap();
1182
1183 let session = frontend.session_ref();
1184 let catalog_reader = session.env().catalog_reader().read_guard();
1185 let schema_path = SchemaPath::Name(DEFAULT_SCHEMA_NAME);
1186
1187 let (source, _) = catalog_reader
1189 .get_source_by_name(DEFAULT_DATABASE_NAME, schema_path, "t")
1190 .unwrap();
1191 assert_eq!(source.name, "t");
1192
1193 let columns = GET_COLUMN_FROM_CATALOG(source);
1194
1195 let city_type = StructType::new(vec![
1196 ("address", DataType::Varchar),
1197 ("zipcode", DataType::Varchar),
1198 ])
1199 .into();
1201 let expected_columns = maplit::hashmap! {
1202 ROW_ID_COLUMN_NAME => DataType::Serial,
1203 "id" => DataType::Int32,
1204 "zipcode" => DataType::Int64,
1205 "rate" => DataType::Float32,
1206 "country" => StructType::new(
1207 vec![("address", DataType::Varchar),("city", city_type),("zipcode", DataType::Varchar)],
1208 )
1209 .into(),
1211 };
1212 assert_eq!(columns, expected_columns, "{columns:#?}");
1213 }
1214
1215 #[tokio::test]
1216 async fn test_duplicate_props_options() {
1217 let proto_file = create_proto_file(PROTO_FILE_DATA);
1218 let sql = format!(
1219 r#"CREATE SOURCE t
1220 WITH (
1221 connector = 'kinesis',
1222 aws.region='user_test_topic',
1223 endpoint='172.10.1.1:9090,172.10.1.2:9090',
1224 aws.credentials.access_key_id = 'your_access_key_1',
1225 aws.credentials.secret_access_key = 'your_secret_key_1'
1226 )
1227 FORMAT PLAIN ENCODE PROTOBUF (
1228 message = '.test.TestRecord',
1229 aws.credentials.access_key_id = 'your_access_key_2',
1230 aws.credentials.secret_access_key = 'your_secret_key_2',
1231 schema.location = 'file://{}',
1232 )"#,
1233 proto_file.path().to_str().unwrap()
1234 );
1235 let frontend = LocalFrontend::new(Default::default()).await;
1236 frontend.run_sql(sql).await.unwrap();
1237
1238 let session = frontend.session_ref();
1239 let catalog_reader = session.env().catalog_reader().read_guard();
1240 let schema_path = SchemaPath::Name(DEFAULT_SCHEMA_NAME);
1241
1242 let (source, _) = catalog_reader
1244 .get_source_by_name(DEFAULT_DATABASE_NAME, schema_path, "t")
1245 .unwrap();
1246 assert_eq!(source.name, "t");
1247
1248 assert_eq!(
1250 source
1251 .info
1252 .format_encode_options
1253 .get("aws.credentials.access_key_id")
1254 .unwrap(),
1255 "your_access_key_2"
1256 );
1257 assert_eq!(
1258 source
1259 .info
1260 .format_encode_options
1261 .get("aws.credentials.secret_access_key")
1262 .unwrap(),
1263 "your_secret_key_2"
1264 );
1265
1266 assert_eq!(
1268 source
1269 .with_properties
1270 .get("aws.credentials.access_key_id")
1271 .unwrap(),
1272 "your_access_key_1"
1273 );
1274 assert_eq!(
1275 source
1276 .with_properties
1277 .get("aws.credentials.secret_access_key")
1278 .unwrap(),
1279 "your_secret_key_1"
1280 );
1281
1282 assert!(!source.with_properties.contains_key("schema.location"));
1284 }
1285
1286 #[tokio::test]
1287 async fn test_multi_table_cdc_create_source_handler() {
1288 let sql =
1289 "CREATE SOURCE t2 WITH (connector = 'mysql-cdc') FORMAT PLAIN ENCODE JSON".to_owned();
1290 let frontend = LocalFrontend::new(Default::default()).await;
1291 let session = frontend.session_ref();
1292
1293 frontend
1294 .run_sql_with_session(session.clone(), sql)
1295 .await
1296 .unwrap();
1297 let catalog_reader = session.env().catalog_reader().read_guard();
1298 let schema_path = SchemaPath::Name(DEFAULT_SCHEMA_NAME);
1299
1300 let (source, _) = catalog_reader
1302 .get_source_by_name(DEFAULT_DATABASE_NAME, schema_path, "t2")
1303 .unwrap();
1304 assert_eq!(source.name, "t2");
1305
1306 let columns = source
1307 .columns
1308 .iter()
1309 .map(|col| (col.name(), col.data_type().clone()))
1310 .collect::<Vec<(&str, DataType)>>();
1311
1312 expect_test::expect![[r#"
1313 [
1314 (
1315 "payload",
1316 Jsonb,
1317 ),
1318 (
1319 "_rw_offset",
1320 Varchar,
1321 ),
1322 (
1323 "_rw_table_name",
1324 Varchar,
1325 ),
1326 (
1327 "_row_id",
1328 Serial,
1329 ),
1330 ]
1331 "#]]
1332 .assert_debug_eq(&columns);
1333 }
1334
1335 #[tokio::test]
1336 async fn test_source_addition_columns() {
1337 let sql =
1339 "CREATE SOURCE s (v1 int) include key as _rw_kafka_key with (connector = 'kafka') format plain encode json".to_owned();
1340 let frontend = LocalFrontend::new(Default::default()).await;
1341 frontend.run_sql(sql).await.unwrap();
1342 let session = frontend.session_ref();
1343 let catalog_reader = session.env().catalog_reader().read_guard();
1344 let (source, _) = catalog_reader
1345 .get_source_by_name(
1346 DEFAULT_DATABASE_NAME,
1347 SchemaPath::Name(DEFAULT_SCHEMA_NAME),
1348 "s",
1349 )
1350 .unwrap();
1351 assert_eq!(source.name, "s");
1352
1353 let columns = source
1354 .columns
1355 .iter()
1356 .map(|col| (col.name(), col.data_type().clone()))
1357 .collect::<Vec<(&str, DataType)>>();
1358
1359 expect_test::expect![[r#"
1360 [
1361 (
1362 "v1",
1363 Int32,
1364 ),
1365 (
1366 "_rw_kafka_key",
1367 Bytea,
1368 ),
1369 (
1370 "_rw_kafka_timestamp",
1371 Timestamptz,
1372 ),
1373 (
1374 "_rw_kafka_partition",
1375 Varchar,
1376 ),
1377 (
1378 "_rw_kafka_offset",
1379 Varchar,
1380 ),
1381 (
1382 "_row_id",
1383 Serial,
1384 ),
1385 ]
1386 "#]]
1387 .assert_debug_eq(&columns);
1388
1389 let sql =
1390 "CREATE SOURCE s3 (v1 int) include timestamp 'header1' as header_col with (connector = 'kafka') format plain encode json".to_owned();
1391 match frontend.run_sql(sql).await {
1392 Err(e) => {
1393 assert_eq!(
1394 e.to_string(),
1395 "Protocol error: Only header column can have inner field, but got \"timestamp\""
1396 )
1397 }
1398 _ => unreachable!(),
1399 }
1400 }
1401}