Find

Find documents in a MongoDB collection.

yaml
type: "io.kestra.plugin.mongodb.Find"

Examples

yaml
id: mongodb_find
namespace: company.team

tasks:
  - id: find
    type: io.kestra.plugin.mongodb.Find
    connection:
      uri: "mongodb://root:example@localhost:27017/?authSource=admin"
    database: "my_database"
    collection: "my_collection"
    filter:
      _id:
        $oid: 60930c39a982931c20ef6cd6

Find documents in MongoDB based on a filter condition using MongoDB Query Language.

yaml
id: filter_mongodb
namespace: company.team

tasks:
  - id: filter
    type: io.kestra.plugin.mongodb.Find
    connection:
      uri: mongodb://host.docker.internal:27017/
    database: local
    collection: pokemon
    store: true
    filter:
      base_experience:
        $gt: 100

Properties

collection *string

MongoDB collection.

connection *MongoDbConnection

MongoDB connection properties.

database *string

MongoDB database.

filter object

MongoDB BSON filter.

Can be a BSON string or a map.

limit integerstring

The number of records to return.

projection object

MongoDB BSON projection.

Can be a BSON string or a map.

skip integerstring

The number of records to skip.

sort object

MongoDB BSON sort.

Can be a BSON string or a map.

store booleanstring

Default false

Whether to store the data from the query result into an ion serialized data file.

Outputs

rows array

List containing the fetched data.

Only populated if store parameter is set to false.

size integer

The number of rows fetched.

uri string

Format uri

URI of the file containing the fetched results.

Only populated if store parameter is set to true.

Definitions

io.kestra.plugin.mongodb.MongoDbConnection

uri *string

Connection string to MongoDB server.

URL format like mongodb://mongodb0.example.com: 27017

​Find

Find