docs: document 28 of the existing rust community modules (#142)

CommanderStorm · DDtKey · mdelapenya · web-flow · commit ef842a8ffb10 · 2025-09-18T18:39:41.000+02:00
* document 28 of the existing rust community modules

* fix having surrealdb twice

* test if a different linting thing works

* remove unnessesarily specific examples

* fix typo

Co-authored-by: Artem Medvedev &lt;i@ddtkey.com&gt;

* fix typo

Co-authored-by: Artem Medvedev &lt;i@ddtkey.com&gt;

---------

Co-authored-by: Artem Medvedev &lt;i@ddtkey.com&gt;
Co-authored-by: Manuel de la Peña &lt;social.mdelapenya@gmail.com&gt;
diff --git a/modules/azurite/index.md b/modules/azurite/index.md
@@ -72,6 +72,17 @@ docs:
       ```bash
       npm install @testcontainers/azurite --save-dev
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/index.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::azurite::Azurite::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F azurite --dev testcontainers-modules
+      ```
 description: |
   A lightweight server clone of Azure Storage.
 ---
diff --git a/modules/clickhouse/index.md b/modules/clickhouse/index.md
@@ -58,6 +58,16 @@ docs:
       ```bash
       pip install testcontainers[clickhouse]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/clickhouse/struct.ClickHouse.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::clickhouse::ClickHouse::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F clickhouse --dev testcontainers-modules
   - id: nodejs
     url: https://node.testcontainers.org/modules/clickhouse/
     maintainer: core
diff --git a/modules/cockroachdb/index.md b/modules/cockroachdb/index.md
@@ -74,6 +74,17 @@ docs:
       ```bash
       pip install testcontainers[cockroachdb]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/cockroach_db/struct.CockroachDb.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::cockroach_db::CockroachDb::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F clicockroach_db --dev testcontainers-modules
+      ```
 description: |
   CockroachDB is an open-source, cloud-native, resilient, distributed SQL database.
 ---
diff --git a/modules/consul/index.md b/modules/consul/index.md
@@ -45,6 +45,17 @@ docs:
       ```bash
       dotnet add package Testcontainers.Consul
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/consul/struct.Consul.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::consul::Consul::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F consul --dev testcontainers-modules
+      ```
 description: |
   Consul is a service mesh and distributed key-value store.
 
diff --git a/modules/databend/index.md b/modules/databend/index.md
@@ -32,15 +32,15 @@ docs:
       go get github.com/testcontainers/testcontainers-go/modules/databend
       ```
   - id: rust
-    url: https://github.com/testcontainers/testcontainers-rs-modules-community
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/databend/struct.Databend.html
     maintainer: community
     example: |
       ```rust
-      let databend = DatabendImage::default().start().await.unwrap();
+      testcontainers_modules::databend::Databend::default().start()
       ```
     installation: |
       ```bash
-      cargo add -F surrealdb --dev testcontainers-modules
+      cargo add -F databend --dev testcontainers-modules
       ```
 description: |
     Databend, built in Rust, is an open-source cloud data warehouse.
diff --git a/modules/dynamodb/index.md b/modules/dynamodb/index.md
@@ -28,6 +28,17 @@ docs:
       ```bash
       dotnet add package Testcontainers.DynamoDb
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/dynamodb_local/struct.DynamoDb.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::dynamodb_local::DynamoDb::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F dynamodb --dev testcontainers-modules
+      ```
 description: |
   Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability.
 
diff --git a/modules/elasticsearch/index.md b/modules/elasticsearch/index.md
@@ -69,6 +69,17 @@ docs:
       ```bash
       pip install testcontainers[elasticsearch]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/elastic_search/struct.ElasticSearch.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::elastic_search::ElasticSearch::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F elastic_search --dev testcontainers-modules
+      ```
 description: |
   Elasticsearch is a search and analytics engine based on Apache Lucene. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.
 ---
diff --git a/modules/k3s/index.md b/modules/k3s/index.md
@@ -67,6 +67,17 @@ docs:
       ```bash
       npm install @testcontainers/k3s --save-dev
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/k3s/struct.K3s.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::k3s::K3s::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F k3s --dev testcontainers-modules
+      ```
 description: |
   K3s is a highly available, certified Kubernetes distribution designed for production workloads in unattended, resource-constrained, remote locations or inside IoT appliances.
 ---
diff --git a/modules/kafka/index.md b/modules/kafka/index.md
@@ -68,6 +68,18 @@ docs:
       ```bash
       pip install testcontainers[kafka]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/kafka/index.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::kafka::confluent::Kafka::default().start()
+      // or also: testcontainers_modules::kafka::apache::Kafka::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F kafka --dev testcontainers-modules
+      ```
 description: |
   Kafka is an open-source distributed event streaming platform for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications.
 ---
diff --git a/modules/mariadb/index.md b/modules/mariadb/index.md
@@ -56,6 +56,17 @@ docs:
       ```bash
       npm install @testcontainers/mariadb --save-dev
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/mariadb/struct.Mariadb.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::mariadb::Mariadb::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F mariadb --dev testcontainers-modules
+      ```
 description: |
   MariaDB is a community-developed, commercially supported fork of the MySQL relational database management system.
 ---
diff --git a/modules/meilisearch/index.md b/modules/meilisearch/index.md
@@ -32,6 +32,23 @@ docs:
       ```bash
       go get github.com/testcontainers/testcontainers-go/modules/meilisearch
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/meilisearch/struct.Meilisearch.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::meilisearch::Meilisearch::default().start()
+
+      let dashboard = format!(
+          "http://{}:{}",
+          meilisearch_instance.get_host().unwrap(),
+          meilisearch_instance.get_host_port_ipv4(7700).unwrap()
+      );
+      ```
+    installation: |
+      ```bash
+      cargo add -F meilisearch --dev testcontainers-modules
+      ```
 description: |
   Meilisearch is a flexible and powerful user-focused search engine that can be added to any website or application.
 ---
diff --git a/modules/minio/index.md b/modules/minio/index.md
@@ -68,6 +68,17 @@ docs:
       ```bash
       npm install @testcontainers/minio --save-dev
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/minio/struct.MinIO.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::minio::MinIO::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F minio --dev testcontainers-modules
+      ```
 description: |
   MinIO is a high performance object storage solution. It is API compatible with the Amazon S3 cloud storage service and can handle unstructured data such as photos, videos, log files, backups, and container images with a current maximum supported object size of 5TB.
 ---
diff --git a/modules/mongodb/index.md b/modules/mongodb/index.md
@@ -68,6 +68,17 @@ docs:
       ```bash
       pip install testcontainers[mongodb]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/mongo/struct.Mongo.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::mongo::Mongo::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F mongo --dev testcontainers-modules
+      ```
 description: |
   MongoDB is a source-available cross-platform document-oriented database program.
 ---
diff --git a/modules/mosquitto/index.md b/modules/mosquitto/index.md
@@ -15,6 +15,23 @@ docs:
       ```bash
       pip install testcontainers[mqtt]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/mosquitto/struct.Mosquitto.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::mosquitto::Mosquitto::default().start()
+
+      let broker_url = format!(
+          "{}:{}",
+          mosquitto_instance.get_host().unwrap(),
+          mosquitto_instance.get_host_port_ipv4(1883).unwrap()
+      );
+      ```
+    installation: |
+      ```bash
+      cargo add -F mosquitto --dev testcontainers-modules
+      ```
 description: |
   Eclipse Mosquitto is an open source message broker which implements MQTT version 5, 3.1.1 and 3.1.
 ---
diff --git a/modules/mssql/index.md b/modules/mssql/index.md
@@ -74,6 +74,17 @@ docs:
       ```bash
       pip install testcontainers[mssql]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/mssql_server/struct.MssqlServer.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::mssql_server::MssqlServer::default().with_accept_eula().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F mssql_server --dev testcontainers-modules
+      ```
 description: |
   Microsoft SQL Server is a relational database management system.
 ---
diff --git a/modules/mysql/index.md b/modules/mysql/index.md
@@ -68,6 +68,17 @@ docs:
       ```bash
       pip install testcontainers[mysql]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/mysql/struct.Mysql.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::mysql::Mysql::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F mysql --dev testcontainers-modules
+      ```
 description: |
   MySQL is an open-source relational database management system.
 ---
diff --git a/modules/nats/index.md b/modules/nats/index.md
@@ -51,6 +51,17 @@ docs:
       ```bash
       pip install testcontainers[nats]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/nats/struct.Nats.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::nats::Nats::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F nats --dev testcontainers-modules
+      ```
 description: |
   NATS is an open-source messaging system that enables applications to securely communicate across any combination of cloud vendors, on-premise, edge, web and mobile, and devices.
 ---
diff --git a/modules/neo4j/index.md b/modules/neo4j/index.md
@@ -77,6 +77,18 @@ docs:
       ```bash
       pip install testcontainers[neo4j]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/oracle/free/struct.Oracle.html
+    maintainer: community
+    example: |
+      ```rust
+      // On slower machines more time needed than 60 seconds may be required (see `with_startup_timeout`).
+      testcontainers_modules::oracle::free::Oracle::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F oracle --dev testcontainers-modules
+      ```
 description: |
   Neo4j is a highly scalable open source graph database management system.
 ---
diff --git a/modules/orientdb/index.md b/modules/orientdb/index.md
@@ -20,6 +20,17 @@ docs:
           <scope>test</scope>
       </dependency>
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/orientdb/struct.OrientDb.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::orientdb::OrientDb::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F orientdb --dev testcontainers-modules
+      ```
 description: |
   OrientDB is an open source NoSQL database management system. It is a Multi-model database, supporting graph, document, key/value, and object models, but the relationships are managed as in graph databases with direct connections between records.
 ---
diff --git a/modules/postgis/index.md b/modules/postgis/index.md
@@ -63,6 +63,18 @@ docs:
       ```bash
       npm install @testcontainers/postgresql --save-dev
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/postgres/struct.Postgres.html
+    maintainer: community
+    example: |
+      ```rust
+      use testcontainers::core::ImageExt;
+      testcontainers_modules::postgres::Postgres::default().with_name("postgis/postgis").with_tag("16-3.5-alpine").start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F postgres --dev testcontainers-modules
+      ```
 description: |
   PostGIS extends the capabilities of the PostgreSQL relational database by adding support for storing, indexing, and querying geospatial data.
 ---
diff --git a/modules/postgresql/index.md b/modules/postgresql/index.md
@@ -74,6 +74,17 @@ docs:
       ```bash
       pip install testcontainers[postgres]
       ```
+  - id: rust
+    url: https://docs.rs/testcontainers-modules/latest/testcontainers_modules/postgres/struct.Postgres.html
+    maintainer: community
+    example: |
+      ```rust
+      testcontainers_modules::postgres::Postgres::default().start()
+      ```
+    installation: |
+      ```bash
+      cargo add -F postgres --dev testcontainers-modules
+      ```
 description: |
   PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
 ---
diff --git a/modules/pulsar/index.md b/modules/pulsar/index.md
diff --git a/modules/rabbitmq/index.md b/modules/rabbitmq/index.md
diff --git a/modules/redis/index.md b/modules/redis/index.md
diff --git a/modules/scylladb/index.md b/modules/scylladb/index.md
diff --git a/modules/solr/index.md b/modules/solr/index.md
diff --git a/modules/surrealdb/index.md b/modules/surrealdb/index.md
diff --git a/modules/valkey/index.md b/modules/valkey/index.md
