steampipe-plugin-mongodb

README

MongoDB Atlas Plugin for Steampipe

Use SQL to query data that is stored on collections in MongoDB databases.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install jreyesr/mongodb

Set up a MongoDB database. If you don't have one yet, use MongoDB Atlas's sample data.

Run a query (here we're using the sample_analytics database):

select
  *
from
  mongodb.transactions
where
  transaction_count < 10 

Engines

This plugin is available for the following engines:

Engine	Description
Steampipe	The Steampipe CLI exposes APIs and services as a high-performance relational database, giving you the ability to write SQL-based queries to explore dynamic data. Mods extend Steampipe's capabilities with dashboards, reports, and controls built with simple HCL. The Steampipe CLI is a turnkey solution that includes its own Postgres database, plugin management, and mod support.

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/jreyesr/steampipe-plugin-mongodb.git
cd steampipe-plugin-mongodb

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/mongodb.spc

Try it!

steampipe query
> .inspect mongodb

Test:

1. Install BATS
2. Set up this plugin on your local Steampipe instance, pointing to a MongoDB database with the sample_analytics database loaded
3. Ensure that you can run steampipe query "select * from mongodb.accounts"

./test/bats/bin/bats test/test.bats

To test the Mongo schema analyzer in isolation, which is on a separate package mongodb/analyzer, run:

go test -v ./mongodb/analyzer

Further reading:

• Writing plugins
• Writing your first table

Open Source & Contributing

This repository is published under the Apache 2.0 (source code) and CC BY-NC-ND (docs) licenses. Please see our code of conduct. We look forward to collaborating with you!

Steampipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #steampipe on Slack →

Want to help but don't know where to start? Pick up one of the help wanted issues:

• Steampipe
• MongoDB Plugin