Skip to main content

risingwave_connector/sink/
postgres.rs

1// Copyright 2024 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, HashSet};
16use std::sync::Arc;
17
18use anyhow::{Context, anyhow};
19use async_trait::async_trait;
20use futures::StreamExt;
21use futures::stream::FuturesUnordered;
22use itertools::Itertools;
23use phf::phf_set;
24use risingwave_common::array::{Op, StreamChunk};
25use risingwave_common::catalog::Schema;
26use risingwave_common::row::{Row, RowExt};
27use serde::Deserialize;
28use serde_with::{DisplayFromStr, serde_as};
29use simd_json::prelude::ArrayTrait;
30use thiserror_ext::AsReport;
31use tokio_postgres::types::Type as PgType;
32
33use super::{
34    LogSinker, SINK_TYPE_APPEND_ONLY, SINK_TYPE_OPTION, SINK_TYPE_UPSERT, SinkError, SinkLogReader,
35};
36use crate::connector_common::{
37    PgConnectionConfig, PostgresExternalTable, SslMode, TcpKeepaliveConfig, create_pg_client,
38};
39use crate::enforce_secret::EnforceSecret;
40use crate::parser::scalar_adapter::{ScalarAdapter, validate_pg_type_to_rw_type};
41use crate::sink::log_store::{LogStoreReadItem, TruncateOffset};
42use crate::sink::{Result, Sink, SinkParam, SinkWriterParam};
43
44pub const POSTGRES_SINK: &str = "postgres";
45
46const CHECK_FOREIGN_KEY_SQL: &str = r#"
47    SELECT EXISTS (
48        SELECT 1
49        FROM pg_constraint c
50        JOIN pg_class t ON t.oid = c.conrelid
51        JOIN pg_namespace n ON n.oid = t.relnamespace
52        WHERE n.nspname = $1
53          AND t.relname = $2
54          AND c.contype = 'f'
55    )
56"#;
57
58#[serde_as]
59#[derive(Clone, Debug, Deserialize)]
60pub struct PostgresConfig {
61    pub host: String,
62    #[serde_as(as = "DisplayFromStr")]
63    pub port: u16,
64    pub user: String,
65    pub password: String,
66    pub database: String,
67    pub table: String,
68    #[serde(default = "default_schema")]
69    pub schema: String,
70    #[serde(default = "Default::default")]
71    pub ssl_mode: SslMode,
72    #[serde(rename = "ssl.root.cert")]
73    pub ssl_root_cert: Option<String>,
74    #[serde(default = "default_max_batch_rows")]
75    #[serde_as(as = "DisplayFromStr")]
76    pub max_batch_rows: usize,
77    pub r#type: String, // accept "append-only" or "upsert"
78    #[serde(default, rename = "tcp.keepalive.enable")]
79    #[serde_as(as = "DisplayFromStr")]
80    pub tcp_keepalive_enable: bool,
81
82    #[serde(flatten)]
83    pub tcp_keepalive: Option<TcpKeepaliveConfig>,
84
85    #[serde(flatten)]
86    pub unknown_fields: std::collections::HashMap<String, String>,
87}
88
89crate::impl_sink_unknown_fields!(PostgresConfig);
90
91impl EnforceSecret for PostgresConfig {
92    const ENFORCE_SECRET_PROPERTIES: phf::Set<&'static str> = phf_set! {
93        "password", "ssl.root.cert"
94    };
95}
96
97fn default_max_batch_rows() -> usize {
98    1024
99}
100
101fn default_schema() -> String {
102    "public".to_owned()
103}
104
105fn tcp_keepalive_from_config(config: &PostgresConfig) -> Option<TcpKeepaliveConfig> {
106    if config.tcp_keepalive_enable {
107        config
108            .tcp_keepalive
109            .clone()
110            .or_else(|| Some(TcpKeepaliveConfig::default()))
111    } else {
112        None
113    }
114}
115
116async fn ensure_no_foreign_key(config: &PostgresConfig) -> Result<()> {
117    let pg_conn = config.pg_connection_config();
118    let client = create_pg_client(&pg_conn, tcp_keepalive_from_config(config)).await?;
119
120    ensure_no_foreign_key_with_client(&client, &config.schema, &config.table).await
121}
122
123async fn ensure_no_foreign_key_with_client(
124    client: &tokio_postgres::Client,
125    schema: &str,
126    table: &str,
127) -> Result<()> {
128    let has_foreign_key = client
129        .query_one(CHECK_FOREIGN_KEY_SQL, &[&schema, &table])
130        .await
131        .context("failed to check foreign key constraints")?
132        .get::<_, bool>(0);
133
134    if has_foreign_key {
135        return Err(SinkError::Config(anyhow!(
136            "Postgres sink does not support target table \"{}\".\"{}\" with foreign key constraints. Please remove foreign key constraints from the target table or choose a different sink table.",
137            schema,
138            table,
139        )));
140    }
141
142    Ok(())
143}
144
145impl PostgresConfig {
146    pub fn from_btreemap(properties: BTreeMap<String, String>) -> Result<Self> {
147        let config =
148            serde_json::from_value::<PostgresConfig>(serde_json::to_value(properties).unwrap())
149                .map_err(|e| SinkError::Config(anyhow!(e)))?;
150        if config.r#type != SINK_TYPE_APPEND_ONLY && config.r#type != SINK_TYPE_UPSERT {
151            return Err(SinkError::Config(anyhow!(
152                "`{}` must be {}, or {}",
153                SINK_TYPE_OPTION,
154                SINK_TYPE_APPEND_ONLY,
155                SINK_TYPE_UPSERT
156            )));
157        }
158        Ok(config)
159    }
160
161    pub fn pg_connection_config(&self) -> PgConnectionConfig {
162        PgConnectionConfig {
163            host: self.host.clone(),
164            port: self.port,
165            user: self.user.clone(),
166            password: self.password.clone(),
167            database: self.database.clone(),
168            ssl_mode: self.ssl_mode.clone(),
169            ssl_root_cert: self.ssl_root_cert.clone(),
170        }
171    }
172}
173
174#[derive(Debug)]
175pub struct PostgresSink {
176    pub config: PostgresConfig,
177    schema: Schema,
178    pk_indices: Vec<usize>,
179    is_append_only: bool,
180}
181
182impl PostgresSink {
183    pub fn new(
184        config: PostgresConfig,
185        schema: Schema,
186        pk_indices: Vec<usize>,
187        is_append_only: bool,
188    ) -> Result<Self> {
189        Ok(Self {
190            config,
191            schema,
192            pk_indices,
193            is_append_only,
194        })
195    }
196}
197
198impl EnforceSecret for PostgresSink {
199    fn enforce_secret<'a>(
200        prop_iter: impl Iterator<Item = &'a str>,
201    ) -> crate::error::ConnectorResult<()> {
202        for prop in prop_iter {
203            PostgresConfig::enforce_one(prop)?;
204        }
205        Ok(())
206    }
207}
208
209impl TryFrom<SinkParam> for PostgresSink {
210    type Error = SinkError;
211
212    fn try_from(param: SinkParam) -> std::result::Result<Self, Self::Error> {
213        let schema = param.schema();
214        let pk_indices = param.downstream_pk_or_empty();
215        let config = PostgresConfig::from_btreemap(param.properties)?;
216        PostgresSink::new(config, schema, pk_indices, param.sink_type.is_append_only())
217    }
218}
219
220impl Sink for PostgresSink {
221    type LogSinker = PostgresSinkWriter;
222
223    const SINK_NAME: &'static str = POSTGRES_SINK;
224
225    crate::impl_validate_sink_unknown_fields!();
226
227    async fn validate(&self) -> Result<()> {
228        if !self.is_append_only && self.pk_indices.is_empty() {
229            return Err(SinkError::Config(anyhow!(
230                "Primary key not defined for upsert Postgres sink (please define in `primary_key` field)"
231            )));
232        }
233
234        ensure_no_foreign_key(&self.config).await?;
235
236        // Verify our sink schema is compatible with Postgres
237        {
238            let pg_conn = self.config.pg_connection_config();
239            let pg_table = PostgresExternalTable::connect(
240                &pg_conn,
241                &self.config.schema,
242                &self.config.table,
243                self.is_append_only,
244            )
245            .await
246            .context(format!(
247                "failed to connect to database: {}, schema: {}, table: {}",
248                self.config.database, self.config.schema, self.config.table
249            ))?;
250
251            // Check that names and types match, order of columns doesn't matter.
252            {
253                let pg_columns = pg_table.column_descs();
254                let sink_columns = self.schema.fields();
255                if pg_columns.len() < sink_columns.len() {
256                    return Err(SinkError::Config(anyhow!(
257                        "Column count mismatch: Postgres table has {} columns, but sink schema has {} columns, sink should have less or equal columns to the Postgres table",
258                        pg_columns.len(),
259                        sink_columns.len()
260                    )));
261                }
262
263                let pg_columns_lookup = pg_columns
264                    .iter()
265                    .map(|c| (c.name.clone(), c.data_type.clone()))
266                    .collect::<BTreeMap<_, _>>();
267                for sink_column in sink_columns {
268                    let pg_column = pg_columns_lookup.get(&sink_column.name);
269                    match pg_column {
270                        None => {
271                            return Err(SinkError::Config(anyhow!(
272                                "Column `{}` not found in Postgres table `{}`",
273                                sink_column.name,
274                                self.config.table
275                            )));
276                        }
277                        Some(pg_column) => {
278                            if !validate_pg_type_to_rw_type(pg_column, &sink_column.data_type()) {
279                                return Err(SinkError::Config(anyhow!(
280                                    "Column `{}` in Postgres table `{}` has type `{}`, but sink schema defines it as type `{}`",
281                                    sink_column.name,
282                                    self.config.table,
283                                    pg_column,
284                                    sink_column.data_type()
285                                )));
286                            }
287                        }
288                    }
289                }
290            }
291
292            // check that pk matches
293            {
294                let pg_pk_names = pg_table.pk_names();
295                let sink_pk_names = self
296                    .pk_indices
297                    .iter()
298                    .map(|i| &self.schema.fields()[*i].name)
299                    .collect::<HashSet<_>>();
300                if pg_pk_names.len() != sink_pk_names.len() {
301                    return Err(SinkError::Config(anyhow!(
302                        "Primary key mismatch: Postgres table has primary key on columns {:?}, but sink schema defines primary key on columns {:?}",
303                        pg_pk_names,
304                        sink_pk_names
305                    )));
306                }
307                for name in pg_pk_names {
308                    if !sink_pk_names.contains(name) {
309                        return Err(SinkError::Config(anyhow!(
310                            "Primary key mismatch: Postgres table has primary key on column `{}`, but sink schema does not define it as a primary key",
311                            name
312                        )));
313                    }
314                }
315            }
316        }
317
318        Ok(())
319    }
320
321    async fn new_log_sinker(&self, _writer_param: SinkWriterParam) -> Result<Self::LogSinker> {
322        PostgresSinkWriter::new(
323            self.config.clone(),
324            self.schema.clone(),
325            self.pk_indices.clone(),
326            self.is_append_only,
327        )
328        .await
329    }
330}
331
332pub struct PostgresSinkWriter {
333    is_append_only: bool,
334    client: tokio_postgres::Client,
335    pk_indices: Vec<usize>,
336    pk_types: Vec<PgType>,
337    schema_types: Vec<PgType>,
338    raw_insert_sql: Arc<String>,
339    raw_upsert_sql: Arc<String>,
340    raw_delete_sql: Arc<String>,
341    insert_sql: Arc<tokio_postgres::Statement>,
342    delete_sql: Arc<tokio_postgres::Statement>,
343    upsert_sql: Arc<tokio_postgres::Statement>,
344}
345
346impl PostgresSinkWriter {
347    async fn new(
348        config: PostgresConfig,
349        schema: Schema,
350        pk_indices: Vec<usize>,
351        is_append_only: bool,
352    ) -> Result<Self> {
353        let tcp_keepalive = tcp_keepalive_from_config(&config);
354
355        let pg_conn = config.pg_connection_config();
356        let client = create_pg_client(&pg_conn, tcp_keepalive).await?;
357
358        ensure_no_foreign_key_with_client(&client, &config.schema, &config.table).await?;
359
360        let pk_indices_lookup = pk_indices.iter().copied().collect::<HashSet<_>>();
361
362        // Rewrite schema types for serialization
363        let (pk_types, schema_types) = {
364            let name_to_type = PostgresExternalTable::type_mapping(
365                &pg_conn,
366                &config.schema,
367                &config.table,
368                is_append_only,
369            )
370            .await?;
371            let mut schema_types = Vec::with_capacity(schema.fields.len());
372            let mut pk_types = Vec::with_capacity(pk_indices.len());
373            for (i, field) in schema.fields.iter().enumerate() {
374                let field_name = &field.name;
375                let actual_data_type = name_to_type.get(field_name).map(|t| (*t).clone());
376                let actual_data_type = actual_data_type
377                    .ok_or_else(|| {
378                        SinkError::Config(anyhow!(
379                            "Column `{}` not found in sink schema",
380                            field_name
381                        ))
382                    })?
383                    .clone();
384                if pk_indices_lookup.contains(&i) {
385                    pk_types.push(actual_data_type.clone())
386                }
387                schema_types.push(actual_data_type);
388            }
389            (pk_types, schema_types)
390        };
391
392        let raw_insert_sql = create_insert_sql(&schema, &config.schema, &config.table);
393        let raw_upsert_sql = create_upsert_sql(
394            &schema,
395            &config.schema,
396            &config.table,
397            &pk_indices,
398            &pk_indices_lookup,
399        );
400        let raw_delete_sql = create_delete_sql(&schema, &config.schema, &config.table, &pk_indices);
401
402        let insert_sql = client
403            .prepare(&raw_insert_sql)
404            .await
405            .with_context(|| format!("failed to prepare insert statement: {}", raw_insert_sql))?;
406        let upsert_sql = client
407            .prepare(&raw_upsert_sql)
408            .await
409            .with_context(|| format!("failed to prepare upsert statement: {}", raw_upsert_sql))?;
410        let delete_sql = client
411            .prepare(&raw_delete_sql)
412            .await
413            .with_context(|| format!("failed to prepare delete statement: {}", raw_delete_sql))?;
414
415        let writer = Self {
416            is_append_only,
417            client,
418            pk_indices,
419            pk_types,
420            schema_types,
421            raw_insert_sql: Arc::new(raw_insert_sql),
422            raw_upsert_sql: Arc::new(raw_upsert_sql),
423            raw_delete_sql: Arc::new(raw_delete_sql),
424            insert_sql: Arc::new(insert_sql),
425            delete_sql: Arc::new(delete_sql),
426            upsert_sql: Arc::new(upsert_sql),
427        };
428        Ok(writer)
429    }
430
431    async fn write_batch(&mut self, chunk: StreamChunk) -> Result<()> {
432        // https://www.postgresql.org/docs/current/limits.html
433        // We have a limit of 65,535 parameters in a single query, as restricted by the PostgreSQL protocol.
434        if self.is_append_only {
435            self.write_batch_append_only(chunk).await
436        } else {
437            self.write_batch_non_append_only(chunk).await
438        }
439    }
440
441    async fn write_batch_append_only(&mut self, chunk: StreamChunk) -> Result<()> {
442        let transaction = Arc::new(self.client.transaction().await?);
443        let mut insert_futures = FuturesUnordered::new();
444        for (op, row) in chunk.rows() {
445            match op {
446                Op::Insert => {
447                    let pg_row = convert_row_to_pg_row(row, &self.schema_types);
448                    let insert_sql = self.insert_sql.clone();
449                    let raw_insert_sql = self.raw_insert_sql.clone();
450                    let transaction = transaction.clone();
451                    let future = async move {
452                        transaction
453                            .execute_raw(insert_sql.as_ref(), &pg_row)
454                            .await
455                            .with_context(|| {
456                                format!(
457                                    "failed to execute insert statement: {}, parameters: {:?}",
458                                    raw_insert_sql, pg_row
459                                )
460                            })
461                    };
462                    insert_futures.push(future);
463                }
464                _ => {
465                    tracing::error!(
466                        "row ignored, append-only sink should not receive update insert, update delete and delete operations"
467                    );
468                }
469            }
470        }
471
472        while let Some(result) = insert_futures.next().await {
473            result?;
474        }
475        if let Some(transaction) = Arc::into_inner(transaction) {
476            transaction.commit().await?;
477        } else {
478            tracing::error!("transaction lost!");
479        }
480
481        Ok(())
482    }
483
484    async fn write_batch_non_append_only(&mut self, chunk: StreamChunk) -> Result<()> {
485        let transaction = Arc::new(self.client.transaction().await?);
486        let mut delete_futures = FuturesUnordered::new();
487        let mut upsert_futures = FuturesUnordered::new();
488        for (op, row) in chunk.rows() {
489            match op {
490                Op::Delete | Op::UpdateDelete => {
491                    let pg_row =
492                        convert_row_to_pg_row(row.project(&self.pk_indices), &self.pk_types);
493                    let delete_sql = self.delete_sql.clone();
494                    let raw_delete_sql = self.raw_delete_sql.clone();
495                    let transaction = transaction.clone();
496                    let future = async move {
497                        transaction
498                            .execute_raw(delete_sql.as_ref(), &pg_row)
499                            .await
500                            .with_context(|| {
501                                format!(
502                                    "failed to execute delete statement: {}, parameters: {:?}",
503                                    raw_delete_sql, pg_row
504                                )
505                            })
506                    };
507                    delete_futures.push(future);
508                }
509                Op::Insert | Op::UpdateInsert => {
510                    let pg_row = convert_row_to_pg_row(row, &self.schema_types);
511                    let upsert_sql = self.upsert_sql.clone();
512                    let raw_upsert_sql = self.raw_upsert_sql.clone();
513                    let transaction = transaction.clone();
514                    let future = async move {
515                        transaction
516                            .execute_raw(upsert_sql.as_ref(), &pg_row)
517                            .await
518                            .with_context(|| {
519                                format!(
520                                    "failed to execute upsert statement: {}, parameters: {:?}",
521                                    raw_upsert_sql, pg_row
522                                )
523                            })
524                    };
525                    upsert_futures.push(future);
526                }
527            }
528        }
529        while let Some(result) = delete_futures.next().await {
530            result?;
531        }
532        while let Some(result) = upsert_futures.next().await {
533            result?;
534        }
535        if let Some(transaction) = Arc::into_inner(transaction) {
536            transaction.commit().await?;
537        } else {
538            tracing::error!("transaction lost!");
539        }
540        Ok(())
541    }
542}
543
544#[async_trait]
545impl LogSinker for PostgresSinkWriter {
546    async fn consume_log_and_sink(mut self, mut log_reader: impl SinkLogReader) -> Result<!> {
547        log_reader.start_from(None).await?;
548        loop {
549            let (epoch, item) = log_reader.next_item().await?;
550            match item {
551                LogStoreReadItem::StreamChunk { chunk, chunk_id } => {
552                    self.write_batch(chunk).await?;
553                    log_reader.truncate(TruncateOffset::Chunk { epoch, chunk_id })?;
554                }
555                LogStoreReadItem::Barrier { .. } => {
556                    log_reader.truncate(TruncateOffset::Barrier { epoch })?;
557                }
558            }
559        }
560    }
561}
562
563fn create_insert_sql(schema: &Schema, schema_name: &str, table_name: &str) -> String {
564    let normalized_table_name = format!(
565        "{}.{}",
566        quote_identifier(schema_name),
567        quote_identifier(table_name)
568    );
569    let number_of_columns = schema.len();
570    let columns: String = schema
571        .fields()
572        .iter()
573        .map(|field| quote_identifier(&field.name))
574        .join(", ");
575    let column_parameters: String = (0..number_of_columns)
576        .map(|i| format!("${}", i + 1))
577        .join(", ");
578    format!("INSERT INTO {normalized_table_name} ({columns}) VALUES ({column_parameters})")
579}
580
581fn create_delete_sql(
582    schema: &Schema,
583    schema_name: &str,
584    table_name: &str,
585    pk_indices: &[usize],
586) -> String {
587    let normalized_table_name = format!(
588        "{}.{}",
589        quote_identifier(schema_name),
590        quote_identifier(table_name)
591    );
592    let pk_indices = if pk_indices.is_empty() {
593        (0..schema.len()).collect_vec()
594    } else {
595        pk_indices.to_vec()
596    };
597    let pk = {
598        let pk_symbols = pk_indices
599            .iter()
600            .map(|pk_index| quote_identifier(&schema.fields()[*pk_index].name))
601            .join(", ");
602        format!("({})", pk_symbols)
603    };
604    let parameters: String = (0..pk_indices.len())
605        .map(|i| format!("${}", i + 1))
606        .join(", ");
607    format!("DELETE FROM {normalized_table_name} WHERE {pk} in (({parameters}))")
608}
609
610fn create_upsert_sql(
611    schema: &Schema,
612    schema_name: &str,
613    table_name: &str,
614    pk_indices: &[usize],
615    pk_indices_lookup: &HashSet<usize>,
616) -> String {
617    let insert_sql = create_insert_sql(schema, schema_name, table_name);
618    if pk_indices.is_empty() {
619        return insert_sql;
620    }
621    let pk_columns = pk_indices
622        .iter()
623        .map(|pk_index| quote_identifier(&schema.fields()[*pk_index].name))
624        .collect_vec()
625        .join(", ");
626    let update_parameters: String = (0..schema.len())
627        .filter(|i| !pk_indices_lookup.contains(i))
628        .map(|i| {
629            let column = quote_identifier(&schema.fields()[i].name);
630            format!("{column} = EXCLUDED.{column}")
631        })
632        .collect_vec()
633        .join(", ");
634    if update_parameters.is_empty() {
635        format!("{insert_sql} on conflict ({pk_columns}) do nothing")
636    } else {
637        format!("{insert_sql} on conflict ({pk_columns}) do update set {update_parameters}")
638    }
639}
640
641/// Quote an identifier for PostgreSQL.
642fn quote_identifier(identifier: &str) -> String {
643    format!("\"{}\"", identifier.replace("\"", "\"\""))
644}
645
646type PgDatum = Option<ScalarAdapter>;
647type PgRow = Vec<PgDatum>;
648
649fn convert_row_to_pg_row(row: impl Row, schema_types: &[PgType]) -> PgRow {
650    let mut buffer = Vec::with_capacity(row.len());
651    for (i, datum_ref) in row.iter().enumerate() {
652        let pg_datum = datum_ref.map(|s| {
653            match ScalarAdapter::from_scalar(s, &schema_types[i]) {
654                Ok(scalar) => Some(scalar),
655                Err(e) => {
656                    tracing::error!(error=%e.as_report(), scalar=?s, "Failed to convert scalar to pg value");
657                    None
658                }
659            }
660        });
661        buffer.push(pg_datum.flatten());
662    }
663    buffer
664}
665
666#[cfg(test)]
667mod tests {
668    use std::fmt::Display;
669
670    use expect_test::{Expect, expect};
671    use risingwave_common::catalog::Field;
672    use risingwave_common::types::DataType;
673
674    use super::*;
675
676    fn check(actual: impl Display, expect: Expect) {
677        let actual = actual.to_string();
678        expect.assert_eq(&actual);
679    }
680
681    #[test]
682    fn test_create_insert_sql() {
683        let schema = Schema::new(vec![
684            Field {
685                data_type: DataType::Int32,
686                name: "a".to_owned(),
687            },
688            Field {
689                data_type: DataType::Int32,
690                name: "b".to_owned(),
691            },
692        ]);
693        let schema_name = "test_schema";
694        let table_name = "test_table";
695        let sql = create_insert_sql(&schema, schema_name, table_name);
696        check(
697            sql,
698            expect![[r#"INSERT INTO "test_schema"."test_table" ("a", "b") VALUES ($1, $2)"#]],
699        );
700    }
701
702    #[test]
703    fn test_create_delete_sql() {
704        let schema = Schema::new(vec![
705            Field {
706                data_type: DataType::Int32,
707                name: "a".to_owned(),
708            },
709            Field {
710                data_type: DataType::Int32,
711                name: "b".to_owned(),
712            },
713        ]);
714        let schema_name = "test_schema";
715        let table_name = "test_table";
716        let sql = create_delete_sql(&schema, schema_name, table_name, &[1]);
717        check(
718            sql,
719            expect![[r#"DELETE FROM "test_schema"."test_table" WHERE ("b") in (($1))"#]],
720        );
721        let table_name = "test_table";
722        let sql = create_delete_sql(&schema, schema_name, table_name, &[0, 1]);
723        check(
724            sql,
725            expect![[r#"DELETE FROM "test_schema"."test_table" WHERE ("a", "b") in (($1, $2))"#]],
726        );
727    }
728
729    #[test]
730    fn test_create_upsert_sql() {
731        let schema = Schema::new(vec![
732            Field {
733                data_type: DataType::Int32,
734                name: "a".to_owned(),
735            },
736            Field {
737                data_type: DataType::Int32,
738                name: "b".to_owned(),
739            },
740        ]);
741        let schema_name = "test_schema";
742        let table_name = "test_table";
743        let pk_indices_lookup = HashSet::from_iter([1]);
744        let sql = create_upsert_sql(&schema, schema_name, table_name, &[1], &pk_indices_lookup);
745        check(
746            sql,
747            expect![[
748                r#"INSERT INTO "test_schema"."test_table" ("a", "b") VALUES ($1, $2) on conflict ("b") do update set "a" = EXCLUDED."a""#
749            ]],
750        );
751    }
752
753    #[test]
754    fn test_create_upsert_sql_all_columns_are_primary_keys() {
755        let schema = Schema::new(vec![
756            Field {
757                data_type: DataType::Int32,
758                name: "user_id".to_owned(),
759            },
760            Field {
761                data_type: DataType::Int32,
762                name: "client_id".to_owned(),
763            },
764        ]);
765        let schema_name = "test_schema";
766        let table_name = "test_table";
767        let pk_indices_lookup = HashSet::from_iter([0, 1]);
768        let sql = create_upsert_sql(
769            &schema,
770            schema_name,
771            table_name,
772            &[0, 1],
773            &pk_indices_lookup,
774        );
775        check(
776            sql,
777            expect![[
778                r#"INSERT INTO "test_schema"."test_table" ("user_id", "client_id") VALUES ($1, $2) on conflict ("user_id", "client_id") do nothing"#
779            ]],
780        );
781    }
782}