Database queries with Diesel

diesel.toml

@@ -0,0 +1,5 @@
+# For documentation on how to configure this file,
+# see diesel.rs/guides/configuring-diesel-cli
+
+[print_schema]
+file = "omicron-nexus/src/db/diesel_schema.rs"

migrations/00000000000000_diesel_initial_setup/down.sql

@@ -0,0 +1,5 @@
+-- This file was automatically created by Diesel to setup helper functions
+-- and other internal bookkeeping. This file is safe to edit, any future
+-- changes will be added to existing projects as new migrations.
+
+SELECT 1;

migrations/00000000000000_diesel_initial_setup/up.sql

@@ -0,0 +1,21 @@
+-- This file was automatically created by Diesel to setup helper functions
+-- and other internal bookkeeping. This file is safe to edit, any future
+-- changes will be added to existing projects as new migrations.
+
+
+
+
+-- Sets up a trigger for the given table to automatically set a column called
+-- `updated_at` whenever the row is modified (unless `updated_at` was included
+-- in the modified columns)
+--
+-- # Example
+--
+-- ```sql
+-- CREATE TABLE users (id SERIAL PRIMARY KEY, updated_at TIMESTAMP NOT NULL DEFAULT NOW());
+--
+-- SELECT diesel_manage_updated_at('users');
+-- ```
+
+-- had to replace generated contents with this because it contained syntax CRDB didn't like
+SELECT 1;

notes.txt

@@ -0,0 +1,31 @@
+there are still issues with CRDB compatibility:
+https://github.com/cockroachdb/cockroach/issues/13787#issuecomment-748301955
+
+first install postgres first to fix -lpq linker error:
+
+  brew install postgresql
+  cargo install diesel_cli --no-default-features --features postgres
+
+add diesel to deps
+
+  diesel = { version = "1.4.4", features = ["postgres"] }
+
+run DB (imitate console API start script). in two separate terminals:
+
+  cargo run --bin=omicron-dev -- db-run --no-populate
+  cargo run --bin=omicron-dev -- db-populate --database-url postgresql://[email protected]:32221
+
+then run setup
+
+  export DATABASE_URL=postgresql://root@localhost:32221/omicron?sslmode=disable
+  diesel setup
+
+SQL changes for compatibility reasons:
+- replace contents of generated up.sql and down.sql with SELECT 1;
+- comment out DbMetadata table in dbinit.sql bc it has no primary key
+
+Then run:
+
+  diesel migration run
+
+This successfully generates src/schema.rs

omicron-common/Cargo.toml

@@ -6,6 +6,7 @@ edition = "2018"
 [dependencies]
 anyhow = "1.0"
 async-trait = "0.1.51"
+diesel = { version = "1.4.4", features = ["postgres", "r2d2", "chrono", "uuidv07"] }
 futures = "0.3.15"
 http = "0.2.0"
 hyper = "0.14"

omicron-common/src/api/external/error.rs

@@ -6,6 +6,7 @@
 
 use crate::api::external::Name;
 use crate::api::external::ResourceType;
+use diesel::result::Error as DieselError;
 use dropshot::HttpError;
 use dropshot::HttpErrorResponseBody;
 use serde::Deserialize;
@@ -163,6 +164,19 @@ impl Error {
     }
 }
 
+impl From<DieselError> for Error {
+    fn from(error: DieselError) -> Self {
+        match error {
+            // our not found wants by_id or by_name, which this error doesn't have
+            // DieselError::NotFound => Error::not_found_other(...),
+            DieselError::DatabaseError(kind, _info) => {
+                Error::unavail(format!("Database error: {:?}", kind).as_str())
+            }
+            _ => Error::internal_error("Unknown diesel error"),
+        }
+    }
+}
+
 impl From<Error> for HttpError {
     /**
      * Converts an `Error` error into an `HttpError`.  This defines how

omicron-common/src/config.rs

@@ -30,6 +30,12 @@ pub struct PostgresConfigWithUrl {
     config: tokio_postgres::config::Config,
 }
 
+impl PostgresConfigWithUrl {
+    pub fn url(&self) -> String {
+        self.url_raw.clone()
+    }
+}
+
 impl FromStr for PostgresConfigWithUrl {
     type Err = tokio_postgres::Error;
 

omicron-common/src/sql/dbinit.sql

@@ -417,15 +417,15 @@ CREATE TABLE omicron.public.SagaNodeEvent (
  * nothing to ensure it gets bumped when it should be, but it's a start.
  */
 
-CREATE TABLE omicron.public.DbMetadata (
-    name  STRING(63) NOT NULL,
-    value STRING(1023) NOT NULL
-);
+-- CREATE TABLE omicron.public.DbMetadata (
+--     name  STRING(63) NOT NULL,
+--     value STRING(1023) NOT NULL
+-- );
 
-INSERT INTO omicron.public.DbMetadata (
-    name,
-    value
-) VALUES (
-    'schema_version',
-    '1.0.0'
-);
+-- INSERT INTO omicron.public.DbMetadata (
+--     name,
+--     value
+-- ) VALUES (
+--     'schema_version',
+--     '1.0.0'
+-- );

omicron-nexus/Cargo.toml

@@ -7,6 +7,7 @@ edition = "2018"
 anyhow = "1.0"
 async-trait = "0.1.51"
 bb8 = "0.7.0"
+diesel = { version = "1.4.4", features = ["postgres", "r2d2", "chrono", "uuidv07"] }
 bb8-postgres = "0.7.0"
 futures = "0.3.15"
 http = "0.2.0"

omicron-nexus/src/context.rs

@@ -8,6 +8,8 @@ use slog::Logger;
 use std::sync::Arc;
 use uuid::Uuid;
 
+use diesel::{r2d2, PgConnection};
+
 /**
  * Shared state available to all API request handlers
  */
@@ -27,13 +29,15 @@ impl ServerContext {
         rack_id: &Uuid,
         log: Logger,
         pool: db::Pool,
+        dpool: r2d2::Pool<r2d2::ConnectionManager<PgConnection>>,
         nexus_id: &Uuid,
     ) -> Arc<ServerContext> {
         Arc::new(ServerContext {
             nexus: Nexus::new_with_id(
                 rack_id,
                 log.new(o!("component" => "nexus")),
                 pool,
+                dpool,
                 nexus_id,
             ),
             log,

omicron-nexus/src/db/datastore.rs

@@ -84,20 +84,6 @@ impl DataStore {
             .await
     }
 
-    /// Fetch metadata for a project
-    pub async fn project_fetch(
-        &self,
-        project_name: &Name,
-    ) -> LookupResult<db::model::Project> {
-        let client = self.pool.acquire().await?;
-        sql_fetch_row_by::<LookupByUniqueName, Project>(
-            &client,
-            (),
-            project_name,
-        )
-        .await
-    }
-
     /// Delete a project
     /*
      * TODO-correctness This needs to check whether there are any resources that