steampipe-plugin-appwrite

README

Appwrite Plugin for Steampipe

Use SQL to query account and more from Appwrite.

• Get started →
• Documentation: Table definitions & examples
• Community: Slack Channel
• Get involved: Issues

Quick start

Install the plugin with Steampipe:

steampipe plugin install mr-destructive/appwrite

Configure your plugin in ~/.steampipe/config/appwrite.spc:

connection "appwrite" {
  plugin = "mr-destructive/appwrite"

  # Secret key for requests. Required.
  # This can also be set via the `APPWRITE_SECRET_KEY` environment variable.
  # secret_key = "7a1f0d410a6ab90110232e3f9578a0e5ac33453493930e195c7"

  # Project Id for specific appwrite project. Required
  # This can also be set via the `APPWRITE_PROJECT_ID` environment variable.
  # project_id = "68a121f3e41164679a30"
}

Or through environment variables:

export APPWRITE_SECRET_KEY="7a1f0d410a6ab90110232e3f9578a0e5ac33453493930e195c7"
export APPWRITE_PROJECT_ID="68a121f3e41164679a30"

Run steampipe:

steampipe query

Run a query:

select
  id,
  name,
  fields
from
  appwrite_document
where
  database_id = 'readlits-db'
  and
  collection_id = '64ce0aa746ea4ecb6e62';

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/mr-destructive/steampipe-plugin-appwrite.git
cd steampipe-plugin-appwrite

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

make

Configure the plugin:

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

Try it!

steampipe query
> .inspect appwrite

Further reading:

• Writing plugins
• Writing your first table

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• AppwritePlugin