Query API

Query layer provides server API and composables to search and query contents.

Endpoints

Query server exposes one API:

• /api/_content/query
  Query content in all sources, should be a POST request. GET requests can be made but are limited to simple values (first, skip and limit).

  $fetch('/api/_content/query', {
    method: 'POST',
    body: {
      first: false, // set to true for returning only one document
      skip: 0,
      limit: 0,
      sort: [],
      where: [],
      only:[],
      without:[]
    },
  })
  // returns an array
  // [{ path: 'posts/hello-world' }, ...]
  

Composables

@nuxt/content provide composables to work with content server:

• queryContent(...pathParts)
  Query and fetch list of contents based on actions and conditions provides.

  const post = await queryContent('posts')
    .where({ category: { $in: ['nature', 'people'] } })
    .limit(10)
    .find()
  
  const doc = await queryContent('/').findOne()
  

Plugins

The layer can be extend using custom plugins.

With plugins users can extend query behaviors and add new features to it.

Create plugin

// file `~/plugin-version.ts`
import { defineQueryPlugin } from '#imports'

export default defineQueryPlugin({
  name: 'version',
  queries: {
    version: params => {
      return v => {
        params.version = v
      }
    }
  },
  execute: (data, params) => {
    if (params.version) {
      return data.filter(v => v.version === params.version)
    }
  }
})

Register plugin

// file `nuxt.config.ts`
import { defineNuxtConfig } from 'nuxt3'
import { resolveModule } from '@nuxt/kit'

export default defineNuxtConfig({
  content: {
    query: {
      plugins: [resolveModule('./plugin-version', { paths: __dirname })]
    }
  }
})

Usage

const contents = await queryContent()
  .where({ category: { $in: ['nature', 'people'] } })
  .version('3.x')
  .limit(10)
  .find()