chore: add readme examples and tests for reading single event types

Snapstromegon · Snapstromegon · commit 1560df9fcf9d · 2025-08-03T20:17:59.000+02:00
Signed-off-by: Raphael Höser &lt;raphael@hoeser.info&gt;
diff --git a/README.md b/README.md
@@ -412,6 +412,20 @@ match result {
   Err(err) => // ...
 }
 ```
+
+### Listing a Specific Event Types
+
+To list a specific event type, call the `read_event_type` function. The function returns the detailed event type, which includes the schema:
+
+```rust
+let event_type_name = "io.eventsourcingdb.library.book-acquired";
+let result := client.read_event_type(event_type_name).await;
+match result {
+  Ok(event_type) => // ...
+  Err(err) => // ...
+}
+```
+
 ### Using Testcontainers
 
 Call the `Container::start_default()` function, get a client, and run your test code:
diff --git a/examples/event_types.rs b/examples/event_types.rs
@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut event_types) => {
             while let Some(Ok(event_type)) = event_types.next().await {
-                println!("{:?}", event_type)
+                println!("{event_type:?}")
             }
         }
     }
diff --git a/examples/listing_subjects.rs b/examples/listing_subjects.rs
@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -14,7 +14,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut subjects) => {
             while let Some(Ok(subject)) = subjects.next().await {
-                println!("{:?}", subject)
+                println!("{subject:?}")
             }
         }
     }
diff --git a/examples/observing_events.rs b/examples/observing_events.rs
@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -26,7 +26,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }
diff --git a/examples/ping.rs b/examples/ping.rs
@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
diff --git a/examples/reading_events.rs b/examples/reading_events.rs
@@ -6,7 +6,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -28,7 +28,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(event)) = stream.next().await {
-                println!("{:?}", event)
+                println!("{event:?}")
             }
         }
     }
diff --git a/examples/registering_event_schema.rs b/examples/registering_event_schema.rs
@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
diff --git a/examples/running_eventql.rs b/examples/running_eventql.rs
@@ -3,7 +3,7 @@ use futures::StreamExt;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -16,7 +16,7 @@ async fn main() {
         Err(err) => panic!("{}", err),
         Ok(mut stream) => {
             while let Some(Ok(row)) = stream.next().await {
-                println!("{:?}", row)
+                println!("{row:?}")
             }
         }
     }
diff --git a/examples/verify_api_token.rs b/examples/verify_api_token.rs
@@ -2,7 +2,7 @@ use eventsourcingdb::{client::Client, container::Container};
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
diff --git a/examples/write_events.rs b/examples/write_events.rs
@@ -3,7 +3,7 @@ use serde_json::json;
 
 #[tokio::main]
 async fn main() {
-    let db = Container::start_default().await.unwrap();
+    let db = Container::start_preview().await.unwrap();
     let base_url = db.get_base_url().await.unwrap();
     let api_token = db.get_api_token();
     let client = Client::new(base_url, api_token);
@@ -21,7 +21,7 @@ async fn main() {
 
     let result = client.write_events(vec![event.clone()], vec![]).await;
     match result {
-        Ok(written_events) => println!("{:?}", written_events),
+        Ok(written_events) => println!("{written_events:?}"),
         Err(err) => panic!("{}", err),
     }
 }
diff --git a/src/client.rs b/src/client.rs
@@ -3,7 +3,7 @@
 //! To use the client, create it with the base URL and API token of your [EventsourcingDB](https://www.eventsourcingdb.io/) instance.
 //! ```
 //! # tokio_test::block_on(async {
-//! # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+//! # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
 //! let db_url = "http://localhost:3000/";
 //! let api_token = "secrettoken";
 //! # let db_url = container.get_base_url().await.unwrap();
@@ -162,7 +162,7 @@ impl Client {
     ///
     /// ```
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -186,7 +186,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -262,7 +262,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -305,7 +305,7 @@ impl Client {
     ///
     /// ```
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -329,7 +329,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -371,7 +371,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -390,7 +390,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -424,7 +424,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -452,7 +452,7 @@ impl Client {
     /// use eventsourcingdb::event::EventCandidate;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
@@ -491,7 +491,7 @@ impl Client {
     /// use futures::StreamExt;
     /// # use serde_json::json;
     /// # tokio_test::block_on(async {
-    /// # let container = eventsourcingdb::container::Container::start_default().await.unwrap();
+    /// # let container = eventsourcingdb::container::Container::start_preview().await.unwrap();
     /// let db_url = "http://localhost:3000/";
     /// let api_token = "secrettoken";
     /// # let db_url = container.get_base_url().await.unwrap();
diff --git a/src/container.rs b/src/container.rs
@@ -12,6 +12,7 @@
 //! # use eventsourcingdb::container::Container;
 //! # tokio_test::block_on(async {
 //! let container = Container::start_default().await;
+//! # let container = Container::start_preview().await;
 //! // let client = container.get_client().await;
 //! # });
 //! ```
@@ -147,6 +148,7 @@ impl ContainerBuilder {
 /// # use eventsourcingdb::container::Container;
 /// # tokio_test::block_on(async {
 /// let container = Container::start_default().await;
+/// # let container = Container::start_preview().await;
 /// // let client = container.get_client().await;
 /// # });
 /// ```
diff --git a/tests/metadata_and_discovery.rs b/tests/metadata_and_discovery.rs
@@ -116,4 +116,50 @@ async fn list_all_event_types() {
     }
 }
 
+#[tokio::test]
+async fn read_single_event_type() {
+    let container = create_test_container().await;
+    let client = container.get_client().await.unwrap();
+    let test_event_type = "io.eventsourcingdb.test";
+    let schema = json!({
+        "type": "object",
+        "properties": {
+            "id": {
+                "type": "string"
+            },
+            "name": {
+                "type": "string"
+            }
+        },
+        "required": ["id", "name"]
+    });
+    client
+        .register_event_schema(test_event_type, &schema)
+        .await
+        .expect("Failed to register event schema");
+    let res = client.read_event_type(test_event_type).await;
+    match res {
+        Ok(event_type) => {
+            assert_eq!(
+                event_type.name, test_event_type,
+                "Expected event type to be 'io.eventsourcingdb.test', but got: {:?}",
+                event_type.name
+            );
+            assert_eq!(
+                event_type.schema.as_ref(),
+                Some(&schema),
+                "Expected event type schema to be {:?}, but got: {:?}",
+                schema,
+                event_type.schema
+            );
+            assert!(
+                event_type.is_phantom,
+                "Expected event type is_phantom to be true, but got: {:?}",
+                event_type.is_phantom
+            );
+        }
+        Err(err) => panic!("Failed to read event type: {err:?}"),
+    }
+}
+
 // TODO!: add list event types test after writing to db
diff --git a/tests/testcontainer.rs b/tests/testcontainer.rs
@@ -2,13 +2,13 @@ use eventsourcingdb::container::Container;
 
 #[tokio::test]
 async fn start_stop_testcontainer() {
-    let c = Container::start_default().await.unwrap();
+    let c = Container::start_preview().await.unwrap();
     c.stop().await.unwrap();
 }
 
 #[tokio::test]
 async fn get_base_url() {
-    let c = Container::start_default().await.unwrap();
+    let c = Container::start_preview().await.unwrap();
     let base_url = c.get_base_url().await.unwrap();
     let host = c.get_host().await.unwrap();
     let port = c.get_mapped_port().await.unwrap();
@@ -17,7 +17,7 @@ async fn get_base_url() {
 
 #[tokio::test]
 async fn db_is_reachable() {
-    let c = Container::start_default().await.unwrap();
+    let c = Container::start_preview().await.unwrap();
     let base_url = c.get_base_url().await.unwrap();
     let ping_url = base_url
         .join("/api/v1/ping")
@@ -27,7 +27,7 @@ async fn db_is_reachable() {
 
 #[tokio::test]
 async fn generate_client() {
-    let c = Container::start_default().await.unwrap();
+    let c = Container::start_preview().await.unwrap();
     let generated_client = c.get_client().await.unwrap();
     let base_url = c.get_base_url().await.unwrap();
     let api_token = c.get_api_token();

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ use futures::StreamExt;`
`3`	`3`
`4`	`4`	`#[tokio::main]`
`5`	`5`	`async fn main() {`
`6`		`- let db = Container::start_default().await.unwrap();`
	`6`	`+ let db = Container::start_preview().await.unwrap();`
`7`	`7`	`let base_url = db.get_base_url().await.unwrap();`
`8`	`8`	`let api_token = db.get_api_token();`
`9`	`9`	`let client = Client::new(base_url, api_token);`
`@@ -14,7 +14,7 @@ async fn main() {`
`14`	`14`	`Err(err) => panic!("{}", err),`
`15`	`15`	`Ok(mut event_types) => {`
`16`	`16`	`while let Some(Ok(event_type)) = event_types.next().await {`
`17`		`- println!("{:?}", event_type)`
	`17`	`+ println!("{event_type:?}")`
`18`	`18`	`}`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ use futures::StreamExt;`
`6`	`6`
`7`	`7`	`#[tokio::main]`
`8`	`8`	`async fn main() {`
`9`		`- let db = Container::start_default().await.unwrap();`
	`9`	`+ let db = Container::start_preview().await.unwrap();`
`10`	`10`	`let base_url = db.get_base_url().await.unwrap();`
`11`	`11`	`let api_token = db.get_api_token();`
`12`	`12`	`let client = Client::new(base_url, api_token);`
`@@ -26,7 +26,7 @@ async fn main() {`
`26`	`26`	`Err(err) => panic!("{}", err),`
`27`	`27`	`Ok(mut stream) => {`
`28`	`28`	`while let Some(Ok(event)) = stream.next().await {`
`29`		`- println!("{:?}", event)`
	`29`	`+ println!("{event:?}")`
`30`	`30`	`}`
`31`	`31`	`}`
`32`	`32`	`}`