1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
// Copyright Materialize, Inc. and contributors. All rights reserved.
//
// Use of this software is governed by the Business Source License
// included in the LICENSE file.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0.
use tokio_postgres::types::Oid;
use tokio_postgres::Client;
use crate::desc::{PostgresColumnDesc, PostgresKeyDesc, PostgresSchemaDesc, PostgresTableDesc};
use crate::PostgresError;
pub async fn get_schemas(client: &Client) -> Result<Vec<PostgresSchemaDesc>, PostgresError> {
Ok(client
.query("SELECT oid, nspname, nspowner FROM pg_namespace", &[])
.await?
.into_iter()
.map(|row| {
let oid: Oid = row.get("oid");
let name: String = row.get("nspname");
let owner: Oid = row.get("nspowner");
PostgresSchemaDesc { oid, name, owner }
})
.collect::<Vec<_>>())
}
/// Fetches table schema information from an upstream Postgres source for tables
/// that are part of a publication, given a connection string and the
/// publication name.
///
/// # Errors
///
/// - Invalid connection string, user information, or user permissions.
/// - Upstream publication does not exist or contains invalid values.
pub async fn publication_info(
client: &Client,
publication: &str,
) -> Result<Vec<PostgresTableDesc>, PostgresError> {
client
.query(
"SELECT oid FROM pg_publication WHERE pubname = $1",
&[&publication],
)
.await
.map_err(PostgresError::from)?
.get(0)
.ok_or_else(|| PostgresError::PublicationMissing(publication.to_string()))?;
let tables = client
.query(
"SELECT
c.oid, p.schemaname, p.tablename
FROM
pg_catalog.pg_class AS c
JOIN pg_namespace AS n ON c.relnamespace = n.oid
JOIN pg_publication_tables AS p ON
c.relname = p.tablename AND n.nspname = p.schemaname
WHERE
p.pubname = $1",
&[&publication],
)
.await
.map_err(PostgresError::from)?;
let mut table_infos = vec![];
for row in tables {
let oid = row.get("oid");
// The Postgres replication protocol does not support GENERATED columns
// so we exclude them from this query. But not all Postgres-like
// databases have the `pg_attribute.attgenerated` column, so we maintain
// two different versions of the query.
let pg_columns_check_generated = "
SELECT
a.attname AS name,
a.atttypid AS typoid,
a.attnum AS colnum,
a.atttypmod AS typmod,
a.attnotnull AS not_null,
b.oid IS NOT NULL AS primary_key
FROM pg_catalog.pg_attribute a
LEFT JOIN pg_catalog.pg_constraint b
ON a.attrelid = b.conrelid
AND b.contype = 'p'
AND a.attnum = ANY (b.conkey)
WHERE a.attnum > 0::pg_catalog.int2
AND NOT a.attisdropped
AND a.attgenerated = ''
AND a.attrelid = $1
ORDER BY a.attnum";
let pg_columns_no_check_generated = "
SELECT
a.attname AS name,
a.atttypid AS typoid,
a.attnum AS colnum,
a.atttypmod AS typmod,
a.attnotnull AS not_null,
b.oid IS NOT NULL AS primary_key
FROM pg_catalog.pg_attribute a
LEFT JOIN pg_catalog.pg_constraint b
ON a.attrelid = b.conrelid
AND b.contype = 'p'
AND a.attnum = ANY (b.conkey)
WHERE a.attnum > 0::pg_catalog.int2
AND NOT a.attisdropped
AND a.attrelid = $1
ORDER BY a.attnum";
let columns_result = match client.query(pg_columns_check_generated, &[&oid]).await {
Ok(result) => Ok(result),
// Not all Postgres-like databases have the `attgenerated` column
// so issue a second query without the check if so.
Err(e)
if e.to_string()
.contains("column a.attgenerated does not exist") =>
{
client.query(pg_columns_no_check_generated, &[&oid]).await
}
other => other,
};
let columns = columns_result
.map_err(PostgresError::from)?
.into_iter()
.map(|row| {
let name: String = row.get("name");
let type_oid = row.get("typoid");
let col_num = row
.get::<_, i16>("colnum")
.try_into()
.expect("non-negative values");
let type_mod: i32 = row.get("typmod");
let not_null: bool = row.get("not_null");
Ok(PostgresColumnDesc {
name,
col_num,
type_oid,
type_mod,
nullable: !not_null,
})
})
.collect::<Result<Vec<_>, PostgresError>>()?;
// PG 15 adds UNIQUE NULLS NOT DISTINCT, which would let us use `UNIQUE` constraints over
// nullable columns as keys; i.e. aligns a PG index's NULL handling with an arrangement's
// keys. For more info, see https://www.postgresql.org/about/featurematrix/detail/392/
let pg_15_plus_keys = "
SELECT
pg_constraint.oid,
pg_constraint.conkey,
pg_constraint.conname,
pg_constraint.contype = 'p' AS is_primary,
pg_index.indnullsnotdistinct AS nulls_not_distinct
FROM
pg_constraint
JOIN
pg_index
ON pg_index.indexrelid = pg_constraint.conindid
WHERE
pg_constraint.conrelid = $1
AND
pg_constraint.contype =ANY (ARRAY['p', 'u']);";
// As above but for versions of PG without indnullsnotdistinct.
let pg_14_minus_keys = "
SELECT
pg_constraint.oid,
pg_constraint.conkey,
pg_constraint.conname,
pg_constraint.contype = 'p' AS is_primary,
false AS nulls_not_distinct
FROM pg_constraint
WHERE
pg_constraint.conrelid = $1
AND
pg_constraint.contype =ANY (ARRAY['p', 'u']);";
let keys = match client.query(pg_15_plus_keys, &[&oid]).await {
Ok(keys) => keys,
Err(e)
// PG versions prior to 15 do not contain this column.
if e.to_string()
== "db error: ERROR: column pg_index.indnullsnotdistinct does not exist" =>
{
client.query(pg_14_minus_keys, &[&oid]).await.map_err(PostgresError::from)?
}
e => e.map_err(PostgresError::from)?,
};
let keys = keys
.into_iter()
.map(|row| {
let oid: u32 = row.get("oid");
let cols: Vec<i16> = row.get("conkey");
let name: String = row.get("conname");
let is_primary: bool = row.get("is_primary");
let nulls_not_distinct: bool = row.get("nulls_not_distinct");
let cols = cols
.into_iter()
.map(|col| u16::try_from(col).expect("non-negative colnums"))
.collect();
PostgresKeyDesc {
oid,
name,
cols,
is_primary,
nulls_not_distinct,
}
})
.collect();
table_infos.push(PostgresTableDesc {
oid,
namespace: row.get("schemaname"),
name: row.get("tablename"),
columns,
keys,
});
}
Ok(table_infos)
}