blob: 8e4b7fb7fe07a502978e06933013fafc42753489 [file] [log] [blame]
// Do not edit directly!
// This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page
[id="extensions-mongodb-gridfs"]
= MongoDB GridFS
:page-aliases: extensions/mongodb-gridfs.adoc
:linkattrs:
:cq-artifact-id: camel-quarkus-mongodb-gridfs
:cq-native-supported: true
:cq-status: Stable
:cq-status-deprecation: Stable
:cq-description: Interact with MongoDB GridFS.
:cq-deprecated: false
:cq-jvm-since: 1.0.0
:cq-native-since: 1.0.0
ifeval::[{doc-show-badges} == true]
[.badges]
[.badge-key]##JVM since##[.badge-supported]##1.0.0## [.badge-key]##Native since##[.badge-supported]##1.0.0##
endif::[]
Interact with MongoDB GridFS.
[id="extensions-mongodb-gridfs-whats-inside"]
== What's inside
* xref:{cq-camel-components}::mongodb-gridfs-component.adoc[MongoDB GridFS component], URI syntax: `mongodb-gridfs:connectionBean`
Please refer to the above link for usage and configuration details.
[id="extensions-mongodb-gridfs-maven-coordinates"]
== Maven coordinates
https://{link-quarkus-code-generator}/?extension-search=camel-quarkus-mongodb-gridfs[Create a new project with this extension on {link-quarkus-code-generator}, window="_blank"]
Or add the coordinates to your existing project:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-mongodb-gridfs</artifactId>
</dependency>
----
ifeval::[{doc-show-user-guide-link} == true]
Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications.
endif::[]
[id="extensions-mongodb-gridfs-additional-camel-quarkus-configuration"]
== Additional Camel Quarkus configuration
The extension leverages the https://quarkus.io/guides/mongodb[Quarkus MongoDB Client] extension. The Mongo client can be configured
via the Quarkus MongoDB Client https://quarkus.io/guides/mongodb#configuration-reference[configuration options].
The Camel Quarkus MongoDB extension automatically registers a MongoDB client bean named `camelMongoClient`. This can be referenced in the mongodb endpoint URI
`connectionBean` path parameter. For example:
from("direct:start")
.to("mongodb-gridfs:camelMongoClient?database=test&operation=listAll")