index.md

organization	category	icon_url	brand_color	display_name	name	description	og_description	og_image
Turbot	saas	/images/plugins/turbot/algolia.svg	#5468FF	Algolia	algolia	Steampipe plugin for querying Algolia indexes, logs and more.	Query Algolia with SQL! Open source CLI. No DB required.	/images/plugins/turbot/algolia-social-graphic.png

Algolia + Steampipe

Steampipe is an open source CLI to instantly query cloud APIs using SQL.

Algolia provides search as a service, offering web search across a client's website using an externally hosted search engine.

For example:

select
  rank,
  hit
from
  algolia_search
where
  index = 'offices'
  and query = 'usa'
order by
  rank;

+------+---------------------------------------------------------+
| rank | hit                                                     |
+------+---------------------------------------------------------+
| 1    | { "name": "Scranton", "state": "PA", "country": "USA" } |
| 2    | { "name": "Stamford", "state": "CT", "country": "USA" } |
+------+---------------------------------------------------------+

Documentation

• Table definitions & examples →

Get started

Install

Download and install the latest Algolia plugin:

steampipe plugin install algolia

Configuration

Installing the latest algolia plugin will create a config file (~/.steampipe/config/algolia.spc) with a single connection named algolia:

connection "algolia" {
  plugin  = "algolia"
  app_id  = "D902ND8AK3"
  api_key = "dba7ac3a72a41306c5b34207b9fd9d95"
}

• app_id - Unique application ID, available in your Algolia settings.
• api_key - API key, available in your Algolia settings.

Get involved

• Open source: https://github.com/turbot/steampipe-plugin-algolia
• Community: Slack Channel