Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

Gatsby plugin Algolia

with support for Partial Updates

You can specify a list of queries to run and how to transform them into an array of objects to index. When you run gatsby build, it will publish those to Algolia.

Here we have an example with some data that might not be very relevant, but will work with the default configuration of gatsby new

$ npm install --save gatsby-plugin-algolia-search

First add credentials to a .env file, which you won’t commit. If you track this in your file, and especially if the site is open source, you will leak your admin API key. This would mean anyone is able to change anything on your Algolia index.

// .env.production
  path: `.env.${process.env.NODE_ENV}`,

// gatsby-config.js
const myQuery = `{
  allSitePage {
    edges {
      node {
        # try to find a unique id for each node
        # if this field is absent, it's going to
        # be inserted by Algolia automatically
        # and will be less simple to update etc.
        objectID: id
        internal {

const queries = [
    query: myQuery,
    transformer: ({ data }) => data.allSitePage.edges.map(({ node }) => node), // optional
    indexName: 'index name to target', // overrides main index name, optional
    settings: {
      // optional, any index settings
    matchFields: ['slug', 'modified'], // Array<String> overrides main match fields, optional

module.exports = {
  plugins: [
      resolve: `gatsby-plugin-algolia-search`,
      options: {
        appId: process.env.ALGOLIA_APP_ID,
        apiKey: process.env.ALGOLIA_API_KEY,
        indexName: "index name to target", // for all queries
        chunkSize: 10000, // default: 1000
        settings: {
          // optional, any index settings
        enablePartialUpdates: true, // default: false
        matchFields: ['slug', 'modified'], // Array<String> default: ['modified']

Partial Updates v0.4.0

By default all records will be reindexed on every build. To enable only indexing the new, changed and deleted records include the following in the options of the plugin:

  resolve: `gatsby-plugin-algolia-search`,
  options: {
    /* ... */
    enablePartialUpdates: true,
    /* (optional) Fields to use for comparing if the index object is different from the new one */
    /* By default it uses a field called "modified" which could be a boolean | datetime string */
    matchFields: ['slug', 'modified'] // Array<String> default: ['modified']

This saves a lot of Algolia operations since you don’t reindex everything on everybuild.


You can also specify matchFields per query to check for different fields based on the type of objects you are indexing.

© 2023 Gatsby, Inc.