feat(gb-8838): postgres extension

Author: pimeys

Cargo.lock

@@ -1,6 +1,6 @@
 [workspace]
 resolver = "2"
-members = ["extensions/*", "publish-extensions", "test-matrix"]
+members = ["crates/*", "extensions/*", "cli/*", "publish-extensions", "test-matrix"]
 
 [workspace.package]
 edition = "2024"
@@ -52,16 +52,24 @@ unused-self = "allow"
 wildcard-imports = "allow"
 
 [workspace.dependencies]
+Inflector = "0.11.4"
+anyhow = "1.0.98"
 async-nats = "0.40"
 base64 = "0.22.1"
 chrono = "0.4.40"
+clap = "4.5.36"
 duration-str = "0.16.1"
 futures = "0.3"
-grafbase-sdk = "0.12.0"
+grafbase-database-definition = { version = "0.1.0", path = "crates/database-definition" }
+grafbase-postgres-introspection = { version = "0.1.0", path = "crates/postgres-introspection" }
+grafbase-sdk = "0.14.0"
 http = "1.3"
+indexmap = "2.9.0"
 indoc = "2.0.6"
 insta = { version = "1.42.2", features = ["json"] }
+itertools = "0.14.0"
 jwt-compact = "0.8.0"
+names = "0.14.0"
 openidconnect = "4.0.0"
 ory-client = "=1.9.0"
 pem = "3.0.5"
@@ -72,6 +80,8 @@ serde = "1.0.219"
 serde_json = "1"
 serde_with = "3.12.0"
 sha2 = "0.10.8"
+sql-ast = { version = "0.1.0", path = "crates/sql-ast" }
+sqlx = { version = "0.8.4", default-features = false }
 strum = { version = "0.27.1", features = ["derive"] }
 tokio = { version = "1", features = ["rt-multi-thread", "macros", "test-util"] }
 toml = "0.8"

Cargo.toml

@@ -0,0 +1,33 @@
+[package]
+name = "postgres-cli"
+version = "0.1.0"
+edition = "2024"
+license = "Apache-2.0"
+
+[[bin]]
+name = "grafbase-postgres"
+path = "src/main.rs"
+
+[dependencies]
+Inflector.workspace = true
+chrono.workspace = true
+clap = { workspace = true, features = ["derive", "env"] }
+indexmap = { workspace = true, features = ["serde"] }
+itertools.workspace = true
+serde = { workspace = true, features = ["derive"] }
+serde_json.workspace = true
+anyhow.workspace = true
+indoc.workspace = true
+tokio = { workspace = true, features = ["rt", "macros"] }
+grafbase-database-definition.workspace = true
+grafbase-postgres-introspection.workspace = true
+sqlx = { workspace = true, features = [
+    "sqlx-postgres",
+    "json",
+    "runtime-tokio",
+    "tls-rustls-aws-lc-rs",
+    "tls-rustls-ring-native-roots",
+    "postgres",
+] }
+semver = { version = "1.0.26", features = ["serde"] }
+url = { version = "2.5.4", features = ["serde"] }

cli/postgres/Cargo.toml

@@ -0,0 +1,61 @@
+use std::path::PathBuf;
+
+use clap::{ArgGroup, Parser, Subcommand};
+use semver::Version;
+use url::Url;
+
+#[derive(Parser, Debug)]
+#[command(name = "grafbase-postgres")]
+#[command(about = "Grafbase Postgres Extension")]
+pub struct Args {
+    /// Connection string to the database
+    #[arg(short, long, env = "DATABASE_URL")]
+    pub database_url: String,
+
+    #[command(subcommand)]
+    pub command: Commands,
+}
+
+#[derive(Debug, Subcommand)]
+pub enum Commands {
+    /// Introspect a PostgreSQL database
+    #[command(name = "introspect")]
+    Introspect(IntrospectCommand),
+}
+
+#[derive(Parser, Debug)]
+#[command(group(
+    ArgGroup::new("extension_identifier")
+        .required(true)
+        .args(["extension_url", "extension_version"]),
+))]
+pub struct IntrospectCommand {
+    /// Output file path. If not provided, the SDL will be printed to stdout.
+    #[arg(short, long)]
+    pub output_file: Option<PathBuf>,
+    /// The name of the database to be used in the GraphQL SDL
+    #[arg(short, long, default_value = "default")]
+    pub database_name: String,
+    /// Default schema to be used in the GraphQL SDL (will be omitted from definitions)
+    #[arg(short = 's', long, default_value = "public")]
+    pub default_schema: String,
+    /// URL to the extension
+    #[arg(long, short = 'u')]
+    pub extension_url: Option<Url>,
+    /// Extension version following semver
+    #[arg(long, short = 'v')]
+    pub extension_version: Option<Version>,
+}
+
+impl IntrospectCommand {
+    pub fn extension_url(&self) -> String {
+        match self.extension_version.as_ref() {
+            Some(version) => format!("https://grafbase.com/extensions/postgres/{version}"),
+            None => self.extension_url.as_ref().unwrap().to_string(),
+        }
+    }
+}
+
+pub fn parse() -> Args {
+    Args::parse()
+}

cli/postgres/src/args.rs

@@ -0,0 +1,37 @@
+use args::IntrospectCommand;
+use grafbase_postgres_introspection::IntrospectionOptions;
+use sqlx::{Connection, PgConnection};
+
+mod args;
+
+#[tokio::main(flavor = "current_thread")]
+async fn main() -> anyhow::Result<()> {
+    let args = args::parse();
+
+    let mut conn = PgConnection::connect(&args.database_url).await?;
+
+    match args.command {
+        args::Commands::Introspect(introspect_cmd) => {
+            introspect(&mut conn, introspect_cmd).await?;
+        }
+    }
+
+    Ok(())
+}
+
+async fn introspect(conn: &mut PgConnection, cmd: IntrospectCommand) -> anyhow::Result<()> {
+    let opts = IntrospectionOptions {
+        database_name: &cmd.database_name,
+        extension_url: &cmd.extension_url(),
+        default_schema: &cmd.default_schema,
+    };
+
+    let sdl = grafbase_postgres_introspection::introspect(conn, opts).await?;
+
+    match cmd.output_file {
+        Some(path) => std::fs::write(path, sdl)?,
+        None => println!("{sdl}"),
+    }
+
+    Ok(())
+}

cli/postgres/src/main.rs

@@ -7,15 +7,15 @@ services:
   hydra:
     image: oryd/hydra:v2.2.0
     ports:
-      - '4444:4444' # Public port
-      - '4445:4445' # Admin port
+      - "4444:4444" # Public port
+      - "4445:4445" # Admin port
     command: serve -c /etc/config/hydra/hydra.yml all --dev
     volumes:
       - hydra-sqlite:/var/lib/sqlite:Z
       - ./docker/hydra-config:/etc/config/hydra:Z
     environment:
-      DSN: 'sqlite:///var/lib/sqlite/db.sqlite?_fk=true'
-      URLS_SELF_ISSUER: 'http://127.0.0.1:4444'
+      DSN: "sqlite:///var/lib/sqlite/db.sqlite?_fk=true"
+      URLS_SELF_ISSUER: "http://127.0.0.1:4444"
     restart: unless-stopped
     depends_on:
       - hydra-migrate
@@ -25,7 +25,7 @@ services:
   hydra-migrate:
     image: oryd/hydra:v2.2.0
     environment:
-      DSN: 'sqlite:///var/lib/sqlite/db.sqlite?_fk=true'
+      DSN: "sqlite:///var/lib/sqlite/db.sqlite?_fk=true"
     command: migrate -c /etc/config/hydra/hydra.yml sql -e --yes
     volumes:
       - hydra-sqlite:/var/lib/sqlite:Z
@@ -38,17 +38,17 @@ services:
   hydra-2:
     image: oryd/hydra:v2.2.0
     ports:
-      - '4454:4454' # Public port
-      - '4455:4455' # Admin port
+      - "4454:4454" # Public port
+      - "4455:4455" # Admin port
     command: serve -c /etc/config/hydra/hydra.yml all --dev
     volumes:
       - hydra-2-sqlite:/var/lib/sqlite:Z
       - ./docker/hydra-config:/etc/config/hydra:Z
     environment:
-      DSN: 'sqlite:///var/lib/sqlite/db.sqlite?_fk=true'
-      URLS_SELF_ISSUER: 'http://127.0.0.1:4454'
-      SERVE_PUBLIC_PORT: '4454'
-      SERVE_ADMIN_PORT: '4455'
+      DSN: "sqlite:///var/lib/sqlite/db.sqlite?_fk=true"
+      URLS_SELF_ISSUER: "http://127.0.0.1:4454"
+      SERVE_PUBLIC_PORT: "4454"
+      SERVE_ADMIN_PORT: "4455"
     restart: unless-stopped
     depends_on:
       - hydra-migrate
@@ -58,7 +58,7 @@ services:
   hydra-2-migrate:
     image: oryd/hydra:v2.2.0
     environment:
-      DSN: 'sqlite:///var/lib/sqlite/db.sqlite?_fk=true'
+      DSN: "sqlite:///var/lib/sqlite/db.sqlite?_fk=true"
     command: migrate -c /etc/config/hydra/hydra.yml sql -e --yes
     volumes:
       - hydra-2-sqlite:/var/lib/sqlite:Z
@@ -70,20 +70,32 @@ services:
   nats:
     image: nats
     ports:
-      - '4222:4222'
-      - '8222:8222'
+      - "4222:4222"
+      - "8222:8222"
     command: >
       --jetstream
       --http_port=8222
       --user=grafbase
       --pass=grafbase
-    networks: ['nats']
+    networks: ["nats"]
+
+  postgres:
+    image: postgres:17
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: grafbase
+    ports:
+      - "5432:5432"
+    networks: ["postgres"]
+    restart: unless-stopped
 
 networks:
   hydra:
   hydra-2:
   nats:
+  postgres:
 
 volumes:
   hydra-sqlite:
   hydra-2-sqlite:
+  postgres-data:

compose.yaml

@@ -0,0 +1,12 @@
+[package]
+name = "grafbase-database-definition"
+version = "0.1.0"
+edition = "2024"
+license = "Apache-2.0"
+
+[dependencies]
+Inflector.workspace = true
+grafbase-sdk.workspace = true
+serde.workspace = true
+itertools.workspace = true
+indexmap.workspace = true

crates/database-definition/Cargo.toml

@@ -0,0 +1,50 @@
+use inflector::Inflector;
+
+use super::{SchemaId, names::StringId};
+
+#[derive(Debug, Clone)]
+pub struct Enum<T> {
+    pub(super) schema_id: SchemaId,
+    pub(super) database_name: T,
+    pub(super) client_name: T,
+}
+
+impl<T> Enum<T> {
+    pub(crate) fn schema_id(&self) -> SchemaId {
+        self.schema_id
+    }
+
+    pub(crate) fn set_client_name(&mut self, client_name: T) {
+        self.client_name = client_name;
+    }
+}
+
+impl Enum<String> {
+    pub fn new(schema_id: SchemaId, database_name: String, client_name: Option<String>) -> Self {
+        let client_name = client_name.unwrap_or_else(|| database_name.to_pascal_case());
+
+        Self {
+            schema_id,
+            database_name,
+            client_name,
+        }
+    }
+
+    pub fn database_name(&self) -> &str {
+        &self.database_name
+    }
+
+    pub fn client_name(&self) -> &str {
+        &self.client_name
+    }
+}
+
+impl Enum<StringId> {
+    pub fn database_name(&self) -> StringId {
+        self.database_name
+    }
+
+    pub fn client_name(&self) -> StringId {
+        self.client_name
+    }
+}

crates/database-definition/src/enum.rs

@@ -0,0 +1,46 @@
+use inflector::Inflector;
+
+use super::{EnumId, names::StringId};
+
+#[derive(Debug, Clone)]
+pub struct EnumVariant<T> {
+    pub(super) enum_id: EnumId,
+    pub(super) database_name: T,
+    pub(super) client_name: T,
+}
+
+impl<T> EnumVariant<T> {
+    pub(crate) fn enum_id(&self) -> EnumId {
+        self.enum_id
+    }
+}
+
+impl EnumVariant<String> {
+    pub fn new(enum_id: EnumId, database_name: String, client_name: Option<String>) -> Self {
+        let client_name = client_name.unwrap_or_else(|| database_name.to_screaming_snake_case());
+
+        Self {
+            enum_id,
+            database_name,
+            client_name,
+        }
+    }
+
+    pub(crate) fn database_name(&self) -> &str {
+        &self.database_name
+    }
+
+    pub(crate) fn client_name(&self) -> &str {
+        &self.client_name
+    }
+}
+
+impl EnumVariant<StringId> {
+    pub(crate) fn database_name(&self) -> StringId {
+        self.database_name
+    }
+
+    pub(crate) fn client_name(&self) -> StringId {
+        self.client_name
+    }
+}