1mod arrow_convert;
23pub(crate) mod cdc;
24mod from_parse;
25
26use std::collections::HashMap;
27use std::sync::Arc;
28
29use arrow::datatypes::{Schema, SchemaRef};
30use postgres::types::Type;
31use postgres::{Client, NoTls};
32
33use crate::config::{SourceType, TlsConfig};
34use crate::error::Result;
35use crate::source::batch_controller::AdaptiveBatchController;
36use crate::source::query::build_export_query;
37use crate::source::tls::build_native_tls;
38use crate::tuning::SourceTuning;
39use crate::types::{ColumnOverrides, SourceColumn, TypeMapping};
40
41use arrow_convert::{pg_columns_to_schema, rivet_type_for_pg_column, rows_to_record_batch_typed};
42use from_parse::try_parse_pg_simple_from_regclass_literal;
43
44pub struct PostgresSource {
45 client: Client,
46 transaction_pooler: bool,
49}
50
51fn detect_pg_transaction_pooler(client: &mut Client) -> bool {
59 let pid1: Option<i32> = client
60 .query_one("SELECT pg_backend_pid()", &[])
61 .ok()
62 .and_then(|r| r.try_get(0).ok());
63 let pid2: Option<i32> = client
64 .query_one("SELECT pg_backend_pid()", &[])
65 .ok()
66 .and_then(|r| r.try_get(0).ok());
67 matches!((pid1, pid2), (Some(a), Some(b)) if a != b)
68}
69
70impl PostgresSource {
71 pub fn connect(url: &str) -> Result<Self> {
74 let mut client = Client::connect(url, NoTls)?;
75 let transaction_pooler = detect_pg_transaction_pooler(&mut client);
76 if transaction_pooler {
77 log::warn!(
78 "transaction-mode connection pooler detected (pgBouncer/Odyssey) — \
79 SET LOCAL tuning is transaction-scoped; \
80 LISTEN/NOTIFY and advisory locks are unavailable"
81 );
82 }
83 Ok(Self {
84 client,
85 transaction_pooler,
86 })
87 }
88
89 pub fn connect_with_tls(url: &str, tls: Option<&TlsConfig>) -> Result<Self> {
92 crate::source::require_tls_or_loopback(url, tls)?;
94 match tls {
95 Some(cfg) if cfg.mode.is_enforced() => {
96 let connector = build_native_tls(cfg)?;
97 let make_tls = postgres_native_tls::MakeTlsConnector::new(connector);
98 let mut client = Client::connect(url, make_tls)?;
99 let transaction_pooler = detect_pg_transaction_pooler(&mut client);
100 if transaction_pooler {
101 log::warn!(
102 "transaction-mode connection pooler detected (pgBouncer/Odyssey) — \
103 SET LOCAL tuning is transaction-scoped; \
104 LISTEN/NOTIFY and advisory locks are unavailable"
105 );
106 }
107 Ok(Self {
108 client,
109 transaction_pooler,
110 })
111 }
112 _ => Self::connect(url),
113 }
114 }
115}
116
117struct PgTxnGuard<'a> {
125 client: &'a mut Client,
126 committed: bool,
127}
128
129impl<'a> PgTxnGuard<'a> {
130 fn begin(client: &'a mut Client) -> Result<Self> {
131 client.batch_execute("BEGIN")?;
132 Ok(Self {
133 client,
134 committed: false,
135 })
136 }
137
138 fn client_mut(&mut self) -> &mut Client {
139 self.client
140 }
141
142 fn commit(mut self) -> Result<()> {
143 self.client.batch_execute("COMMIT")?;
144 self.committed = true;
145 Ok(())
146 }
147}
148
149impl Drop for PgTxnGuard<'_> {
150 fn drop(&mut self) {
151 if !self.committed
152 && let Err(e) = self.client.batch_execute("ROLLBACK")
153 {
154 log::warn!("PgTxnGuard: ROLLBACK during drop failed: {e:#}");
157 }
158 }
159}
160
161pub(crate) fn sample_temp_bytes(url: &str, tls: Option<&TlsConfig>) -> Option<i64> {
173 let mut client = connect_client(url, tls).ok()?;
174 client
175 .query_one(
176 "SELECT temp_bytes::bigint FROM pg_stat_database WHERE datname = current_database()",
177 &[],
178 )
179 .ok()
180 .and_then(|r| r.try_get::<_, i64>(0).ok())
181}
182
183pub(crate) fn sample_harm_counters(
196 url: &str,
197 tls: Option<&TlsConfig>,
198) -> Option<Vec<(String, i64)>> {
199 let mut client = connect_client(url, tls).ok()?;
200 let row = client
205 .query_one(
206 "SELECT blks_read::bigint, blks_hit::bigint, tup_returned::bigint, \
207 tup_fetched::bigint, temp_files::bigint, deadlocks::bigint \
208 FROM pg_stat_database WHERE datname = current_database()",
209 &[],
210 )
211 .ok()?;
212 let names = [
213 "pg_blks_read",
214 "pg_blks_hit",
215 "pg_tup_returned",
216 "pg_tup_fetched",
217 "pg_temp_files",
218 "pg_deadlocks",
219 ];
220 let mut out = Vec::with_capacity(names.len());
221 for (i, name) in names.iter().enumerate() {
222 if let Ok(v) = row.try_get::<_, i64>(i) {
223 out.push(((*name).to_string(), v));
224 }
225 }
226 Some(out)
227}
228
229fn pg_fetch_work_mem_bytes(client: &mut Client) -> Option<i64> {
240 let raw: Option<String> = client
241 .query_one("SHOW work_mem", &[])
242 .ok()
243 .and_then(|r| r.try_get::<_, String>(0).ok());
244 raw.as_deref().and_then(parse_work_mem)
245}
246
247fn parse_work_mem(raw: &str) -> Option<i64> {
251 let s = raw.trim();
252 let mut split = 0;
254 for (i, ch) in s.char_indices() {
255 if !ch.is_ascii_digit() && ch != '.' && ch != '-' {
256 split = i;
257 break;
258 }
259 split = i + ch.len_utf8();
260 }
261 if split == 0 {
262 return None;
263 }
264 let (num_str, unit) = s.split_at(split);
265 let num: f64 = num_str.parse().ok()?;
266 let unit = unit.trim().to_ascii_lowercase();
267 let multiplier: f64 = match unit.as_str() {
268 "" | "kb" => 1024.0,
271 "mb" => 1024.0 * 1024.0,
272 "gb" => 1024.0 * 1024.0 * 1024.0,
273 "tb" => 1024.0 * 1024.0 * 1024.0 * 1024.0,
274 _ => return None,
275 };
276 let bytes = (num * multiplier) as i64;
277 (bytes > 0).then_some(bytes)
278}
279
280fn pg_sample_checkpoints_req(client: &mut Client) -> Option<i64> {
286 let _ = client.execute("SELECT pg_stat_clear_snapshot()", &[]);
287 client
288 .query_one("SELECT checkpoints_req FROM pg_stat_bgwriter", &[])
289 .ok()
290 .and_then(|r| r.try_get::<_, i64>(0).ok())
291}
292
293pub(crate) fn introspect_pg_table_for_chunking(
305 url: &str,
306 tls: Option<&TlsConfig>,
307 qualified_table: &str,
308) -> Result<crate::source::TableIntrospection> {
309 let (schema, table) = match qualified_table.split_once('.') {
310 Some((s, t)) => (s.to_string(), t.to_string()),
311 None => ("public".to_string(), qualified_table.to_string()),
312 };
313 let mut client = connect_client(url, tls)?;
314
315 let (row_estimate, rel_size_bytes) = match client.query_opt(
317 "SELECT c.reltuples::bigint, pg_relation_size(c.oid)::bigint \
318 FROM pg_class c JOIN pg_namespace n ON n.oid = c.relnamespace \
319 WHERE n.nspname = $1::text AND c.relname = $2::text",
320 &[&schema, &table],
321 )? {
322 Some(row) => {
323 let rt: i64 = row.try_get(0).unwrap_or(0);
324 let sz: i64 = row.try_get(1).unwrap_or(0);
325 (rt.max(0), sz.max(0))
326 }
327 None => (0, 0),
328 };
329 let avg_row_bytes = if row_estimate > 0 {
330 Some(rel_size_bytes / row_estimate)
331 } else {
332 None
333 };
334
335 let pk_rows = client.query(
337 "SELECT a.attname::text, t.typname::text \
338 FROM pg_index i \
339 JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = ANY(i.indkey) \
340 JOIN pg_type t ON t.oid = a.atttypid \
341 WHERE i.indrelid = (($1::text || '.' || $2::text)::regclass) \
342 AND i.indisprimary",
343 &[&schema, &table],
344 )?;
345 let single_int_pk = if pk_rows.len() == 1 {
346 let col: String = pk_rows[0].get(0);
347 let pg_type: String = pk_rows[0].get(1);
348 if matches!(pg_type.as_str(), "int2" | "int4" | "int8") {
352 Some(col)
353 } else {
354 log::debug!(
355 "introspect_pg_table: PK '{col}' on {schema}.{table} has non-int type '{pg_type}' — skipping auto-resolve"
356 );
357 None
358 }
359 } else {
360 None
361 };
362
363 let keyset_rows = client.query(
369 "SELECT a.attname::text, i.indisprimary \
370 FROM pg_index i \
371 JOIN pg_attribute a ON a.attrelid = i.indrelid AND a.attnum = i.indkey[0] \
372 WHERE i.indrelid = (($1::text || '.' || $2::text)::regclass) \
373 AND i.indisunique AND i.indnkeyatts = 1 AND a.attnotnull",
374 &[&schema, &table],
375 )?;
376 let mut keyset_keys: Vec<String> = Vec::new();
377 for primary in [true, false] {
378 for row in &keyset_rows {
379 let col: String = row.get(0);
380 let is_primary: bool = row.get(1);
381 if is_primary == primary && !keyset_keys.contains(&col) {
382 keyset_keys.push(col);
383 }
384 }
385 }
386
387 Ok(crate::source::TableIntrospection {
388 single_int_pk,
389 keyset_keys,
390 row_estimate,
391 avg_row_bytes,
392 })
393}
394
395pub(crate) fn connect_client(url: &str, tls: Option<&TlsConfig>) -> Result<Client> {
405 crate::source::require_tls_or_loopback(url, tls)?;
407 match tls {
408 Some(cfg) if cfg.mode.is_enforced() => {
409 let connector = build_native_tls(cfg)?;
410 let make_tls = postgres_native_tls::MakeTlsConnector::new(connector);
411 Ok(Client::connect(url, make_tls)?)
412 }
413 _ => Ok(Client::connect(url, NoTls)?),
414 }
415}
416
417fn pg_run_export(
426 client: &mut Client,
427 built_sql: &str,
428 tuning: &SourceTuning,
429 column_overrides: &ColumnOverrides,
430 sink: &mut dyn super::BatchSink,
431 numeric_hints: Option<&HashMap<String, (u8, i8)>>,
432) -> Result<(usize, bool)> {
433 let mut guard = PgTxnGuard::begin(client)?;
437 guard
449 .client_mut()
450 .batch_execute("SET LOCAL TimeZone = 'UTC'")?;
451 if tuning.statement_timeout_s > 0 {
452 guard.client_mut().batch_execute(&format!(
453 "SET LOCAL statement_timeout = '{}s'",
454 tuning.statement_timeout_s
455 ))?;
456 }
457 if tuning.lock_timeout_s > 0 {
458 guard.client_mut().batch_execute(&format!(
459 "SET LOCAL lock_timeout = '{}s'",
460 tuning.lock_timeout_s
461 ))?;
462 }
463 let work_mem_bytes = pg_fetch_work_mem_bytes(guard.client_mut());
470
471 guard
472 .client_mut()
473 .batch_execute(&format!("DECLARE _rivet NO SCROLL CURSOR FOR {built_sql}"))?;
474
475 let configured_batch_size = tuning.batch_size;
480 let mut ctl = AdaptiveBatchController::new(tuning, configured_batch_size);
483 ctl.seed_pressure(if tuning.adaptive {
484 pg_sample_checkpoints_req(guard.client_mut()).map(|v| v as u64)
485 } else {
486 None
487 });
488 let mut schema: Option<SchemaRef> = None;
489 let mut columns_cache: Option<Vec<(String, Type)>> = None;
490 let mut total_rows: usize = 0;
491 let mut cap_applied = false;
492 let max_value_bytes = tuning.max_value_bytes();
496
497 loop {
498 let requested = ctl.target();
499 let fetch_sql = format!("FETCH {} FROM _rivet", requested);
500 let rows = guard.client_mut().query(&fetch_sql, &[])?;
501 if rows.is_empty() {
502 break;
503 }
504
505 if schema.is_none() {
506 let stmt_cols: Vec<(String, Type)> = rows[0]
507 .columns()
508 .iter()
509 .map(|c| (c.name().to_string(), c.type_().clone()))
510 .collect();
511 let s = Arc::new(pg_columns_to_schema(
512 rows[0].columns(),
513 column_overrides,
514 numeric_hints,
515 )?);
516 sink.on_schema(s.clone())?;
517 if work_mem_bytes.is_none() {
520 let effective = tuning.effective_batch_size(Some(&s));
521 ctl.apply_memory_cap(effective.max(requested));
522 cap_applied = true;
523 }
524 schema = Some(s);
525 columns_cache = Some(stmt_cols);
526 }
527
528 let row_count = rows.len();
529 total_rows += row_count;
530
531 let s = schema.as_ref().expect("schema set on first iteration");
532 let cols = columns_cache
533 .as_ref()
534 .expect("columns set on first iteration");
535 let batch = rows_to_record_batch_typed(s, cols, &rows, max_value_bytes)?;
536 drop(rows);
537
538 if !cap_applied
543 && let Some(wm) = work_mem_bytes
544 && row_count > 0
545 {
546 let arrow_bytes = crate::tuning::SourceTuning::batch_memory_bytes(&batch);
547 let arrow_per_row = (arrow_bytes / row_count).max(1);
548 let pg_per_row = ((arrow_per_row * 12) / 10).max(64);
549 let safe = (((wm as f64) * 0.7) as usize / pg_per_row).max(100);
550 let mut target = safe;
551 if let Some(mem_mb) = tuning.batch_size_memory_mb {
552 let arrow_target = (mem_mb * 1024 * 1024) / arrow_per_row;
553 target = target.min(arrow_target.max(100));
554 }
555 if let Some(new) = ctl.apply_memory_cap(target) {
556 log::info!(
557 "PG work_mem={} B, observed row={} B (arrow), pg≈{} B → FETCH N → {} (configured={})",
558 wm,
559 arrow_per_row,
560 pg_per_row,
561 new,
562 configured_batch_size,
563 );
564 }
565 cap_applied = true;
566 }
567
568 sink.on_batch(&batch)?;
569
570 if let Some((new, under_pressure)) =
571 ctl.after_batch(|| pg_sample_checkpoints_req(guard.client_mut()).map(|v| v as u64))
572 {
573 log::info!(
574 "adaptive batch size → {} ({})",
575 new,
576 if under_pressure {
577 "pressure"
578 } else {
579 "recovery"
580 }
581 );
582 }
583
584 log::info!("fetched {} rows so far...", total_rows);
585
586 if row_count < requested {
587 break;
588 }
589 ctl.throttle(row_count);
590 }
591
592 guard.client_mut().batch_execute("CLOSE _rivet")?;
595 guard.commit()?;
596 Ok((total_rows, schema.is_some()))
597}
598
599impl super::Source for PostgresSource {
600 fn export(
601 &mut self,
602 request: &super::ExportRequest<'_>,
603 sink: &mut dyn super::BatchSink,
604 ) -> Result<()> {
605 let built = build_export_query(request, SourceType::Postgres);
606 debug_assert!(
607 built.cursor_param.is_none(),
608 "Postgres path inlines cursor values as E'…' literals — binding is unused"
609 );
610 log::debug!(
611 "executing query (connection={}): {}",
612 if self.transaction_pooler {
613 "transaction-pooler"
614 } else {
615 "direct"
616 },
617 built.sql
618 );
619
620 let hint_query = request.catalog_hint_query.unwrap_or(request.query);
624 let numeric_hints = pg_numeric_catalog_hints_opt(&mut self.client, hint_query);
625
626 let (total_rows, had_schema) = pg_run_export(
629 &mut self.client,
630 &built.sql,
631 request.tuning,
632 request.column_overrides,
633 sink,
634 numeric_hints.as_ref(),
635 )?;
636
637 if !had_schema {
638 sink.on_schema(Arc::new(Schema::empty()))?;
639 }
640
641 log::info!("total: {} rows", total_rows);
642 Ok(())
643 }
644
645 fn query_scalar(&mut self, sql: &str) -> Result<Option<String>> {
646 let rows = self.client.query(sql, &[])?;
647 if rows.is_empty() {
648 return Ok(None);
649 }
650 let row = &rows[0];
651 if let Ok(Some(v)) = row.try_get::<_, Option<i64>>(0) {
652 return Ok(Some(v.to_string()));
653 }
654 if let Ok(Some(v)) = row.try_get::<_, Option<i32>>(0) {
655 return Ok(Some(v.to_string()));
656 }
657 if let Ok(Some(v)) = row.try_get::<_, Option<f64>>(0) {
658 return Ok(Some(v.to_string()));
659 }
660 if let Ok(Some(v)) = row.try_get::<_, Option<chrono::NaiveDateTime>>(0) {
662 return Ok(Some(v.format("%Y-%m-%d %H:%M:%S").to_string()));
663 }
664 if let Ok(Some(v)) = row.try_get::<_, Option<chrono::NaiveDate>>(0) {
665 return Ok(Some(v.format("%Y-%m-%d").to_string()));
666 }
667 if let Ok(Some(v)) = row.try_get::<_, Option<chrono::DateTime<chrono::Utc>>>(0) {
668 return Ok(Some(v.format("%Y-%m-%d %H:%M:%S").to_string()));
669 }
670 if let Ok(Some(v)) = row.try_get::<_, Option<String>>(0) {
671 return Ok(Some(v));
672 }
673 Ok(None)
674 }
675
676 fn type_mappings(
677 &mut self,
678 query: &str,
679 column_overrides: &ColumnOverrides,
680 ) -> Result<Vec<TypeMapping>> {
681 let wrapped = format!("SELECT * FROM ({}) AS _rivet_type_probe LIMIT 0", query);
682 let stmt = self.client.prepare(&wrapped)?;
683 let hints = pg_numeric_catalog_hints_opt(&mut self.client, query);
684 let mappings = stmt
685 .columns()
686 .iter()
687 .map(|col| {
688 let rivet = rivet_type_for_pg_column(col, column_overrides, hints.as_ref());
689 let source = SourceColumn::simple(col.name(), col.type_().name(), true);
690 TypeMapping::from_source(&source, rivet)
691 })
692 .collect();
693 Ok(mappings)
694 }
695
696 fn sample_pressure(&mut self) -> Option<u64> {
700 pg_sample_checkpoints_req(&mut self.client).map(|v| v.max(0) as u64)
701 }
702}
703
704fn pg_numeric_catalog_hints_opt(
710 client: &mut Client,
711 query: &str,
712) -> Option<HashMap<String, (u8, i8)>> {
713 match pg_fetch_numeric_catalog_hints(client, query) {
714 Ok(m) => m,
715 Err(e) => {
716 log::warn!(
722 "PG numeric catalog lookup failed — NUMERIC columns will require explicit `columns:` overrides: {e}"
723 );
724 None
725 }
726 }
727}
728
729fn pg_fetch_numeric_catalog_hints(
730 client: &mut Client,
731 query: &str,
732) -> crate::error::Result<Option<HashMap<String, (u8, i8)>>> {
733 let Some(regclass_lit) = try_parse_pg_simple_from_regclass_literal(query) else {
734 return Ok(None);
735 };
736 let locate_sql = "SELECT n.nspname::text, c.relname::text \
737 FROM pg_catalog.pg_class c \
738 JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace \
739 WHERE c.oid = ($1::text)::regclass";
740 let row_opt = match client.query_opt(locate_sql, &[®class_lit]) {
741 Ok(r) => r,
742 Err(e) => {
743 log::warn!("PG numeric catalog: '{regclass_lit}' regclass lookup failed: {e}");
744 return Ok(None);
745 }
746 };
747 let Some(row) = row_opt else {
748 return Ok(None);
749 };
750 let schema: String = row.get(0);
751 let table: String = row.get(1);
752 let rows = client.query(
753 "SELECT column_name::text, data_type::text, numeric_precision, numeric_scale \
754 FROM information_schema.columns \
755 WHERE table_schema = $1 AND table_name = $2 \
756 ORDER BY ordinal_position",
757 &[&schema, &table],
758 )?;
759
760 let mut map = HashMap::new();
761 for row in rows {
762 let col: String = row.get(0);
763 let dt: String = row.get(1);
764 if !is_pg_numeric_information_type(&dt) {
765 continue;
766 }
767 let p: Option<i32> = row.get(2);
768 let s: Option<i32> = row.get(3);
769 if let (Some(p), Some(s)) = (p, s)
770 && let Some(pair) = catalog_numeric_to_decimal_params(p, s)
771 {
772 map.insert(col, pair);
773 }
774 }
775
776 if map.is_empty() {
777 Ok(None)
778 } else {
779 log::debug!(
780 "PG numeric catalog: resolved {} DECIMAL/NUMERIC column(s) for relation {regclass_lit}",
781 map.len(),
782 );
783 Ok(Some(map))
784 }
785}
786
787fn is_pg_numeric_information_type(dt: &str) -> bool {
788 let d = dt.trim().to_ascii_lowercase();
789 matches!(d.as_str(), "numeric" | "decimal")
790 || d.starts_with("numeric(")
791 || d.starts_with("decimal(")
792}
793
794fn catalog_numeric_to_decimal_params(precision: i32, scale: i32) -> Option<(u8, i8)> {
796 if precision <= 0 || precision > 76 {
797 return None;
798 }
799 let precision_u = precision as u8;
800 if scale < i32::from(i8::MIN) || scale > i32::from(i8::MAX) {
801 return None;
802 }
803 let scale_i = scale as i8;
804 if scale_i > precision as i8 {
805 return None;
806 }
807 Some((precision_u, scale_i))
808}
809
810#[cfg(test)]
811mod tests {
812 use super::catalog_numeric_to_decimal_params;
813
814 #[test]
817 fn catalog_decimal_bounds() {
818 assert_eq!(catalog_numeric_to_decimal_params(18, 2), Some((18, 2)));
819 assert!(catalog_numeric_to_decimal_params(0, 2).is_none());
820 assert!(catalog_numeric_to_decimal_params(77, 0).is_none());
821 assert!(catalog_numeric_to_decimal_params(18, 19).is_none());
822 assert_eq!(catalog_numeric_to_decimal_params(76, 0), Some((76, 0)));
825 assert_eq!(catalog_numeric_to_decimal_params(18, 18), Some((18, 18)));
827 assert_eq!(
829 catalog_numeric_to_decimal_params(10, -128),
830 Some((10, -128))
831 );
832 assert!(catalog_numeric_to_decimal_params(10, -129).is_none());
833 assert!(catalog_numeric_to_decimal_params(76, 200).is_none());
836 }
837
838 #[test]
839 fn parse_work_mem_handles_pg_units() {
840 use super::parse_work_mem;
841 assert_eq!(parse_work_mem("4MB"), Some(4 * 1024 * 1024));
844 assert_eq!(parse_work_mem("16384kB"), Some(16384 * 1024));
845 assert_eq!(parse_work_mem("1GB"), Some(1024 * 1024 * 1024));
846 assert_eq!(parse_work_mem(" 4MB "), Some(4 * 1024 * 1024));
847 assert_eq!(parse_work_mem("4mb"), Some(4 * 1024 * 1024));
848 assert_eq!(parse_work_mem("65536"), Some(65536 * 1024));
849 assert_eq!(parse_work_mem(""), None);
850 assert_eq!(parse_work_mem("garbage"), None);
851 assert_eq!(parse_work_mem("4s"), None);
853 assert_eq!(
856 parse_work_mem("2TB"),
857 Some(2 * 1024 * 1024 * 1024 * 1024),
858 "terabytes are 1024^4"
859 );
860 assert_eq!(parse_work_mem("0.5MB"), Some(512 * 1024));
862 assert_eq!(parse_work_mem("0"), None);
864 assert_eq!(parse_work_mem("0MB"), None);
865 }
866}