Table: algolia_search - Query Algolia Search Indices using SQL
Algolia is a hosted search engine API that provides developers with a powerful and flexible search solution. It offers a variety of features such as typo-tolerance, filters and facets, geo search, and language-agnostic full-text search. Algolia's Search Indices are the core resources where search operations are performed, and they contain the searchable data of an application.
Table Usage Guide
The algolia_search
table provides insights into search operations performed within Algolia's Search Indices. As a developer or data analyst, explore search-specific details through this table, including query text, number of hits, and processing time. Utilize it to uncover information about search patterns, such as frequently searched queries or queries with high processing time, aiding in potential optimizations and improvements to your application's search functionality.
Examples
Search the offices index for the term "usa"
Analyze the 'offices' index to pinpoint specific entries related to 'USA'. This can be beneficial in understanding the distribution and presence of offices across the United States.
select rank, object_id, jsonb_pretty(hit) as resultfrom algolia_searchwhere index = 'offices' and query = 'usa'order by rank;
select rank, object_id, hit as resultfrom algolia_searchwhere index = 'offices' and query = 'usa'order by rank;
Get all records from all indexes
Explore all indexed records to gain insights into the data stored in your Algolia search system. This can be useful for understanding the breadth and variety of information available for search operations. Warning: This is a very large query, use carefully!
select *from algolia_search;
select *from algolia_search;
Schema for algolia_search
Name | Type | Operators | Description |
---|---|---|---|
_ctx | jsonb | Steampipe context in JSON form, e.g. connection_name. | |
highlight_result | jsonb | Highlight information. | |
hit | jsonb | Hit data of the search result. | |
index | text | = | Name of the index for the search result. |
object_id | text | Object ID for this search result. | |
query | text | = | Query used to obtain the search result. |
rank | bigint | Rank (position) of the search result. The top result is number 1. | |
ranking_info | jsonb | Ranking information for the search result. | |
snippet_result | jsonb | Snippet information. |
Export
This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.
You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh
script:
/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- algolia
You can pass the configuration to the command with the --config
argument:
steampipe_export_algolia --config '<your_config>' algolia_search