Query Helper Functions
We’ve included helper functions to make creating certain queries quicker and easier with React. This page provides the description and examples for each of the helper functions.
Before Reading
This page assumes that you've already imported the Prismic library and retrieved the Client object. If you want to learn how to do this, then refer to the How to Query the API page.
getByUID( custom-type, uid, options )
The getByUID function is used to query the specified custom type by a certain UID value. This requires that the custom type of the document contains the UID field.
This function will only ever retrieve one document as there can only be one instance of a given UID value for each custom type & language.
custom-type
string (required)
The API ID of the custom type you are searching for
uid
string (required)
The uid of the document you want
options
object (optional)
The option parameters and values
Here is an example that queries a document of the type "page" by its uid "about-us".
const doc = await client.getByUID('page', 'about-us')
// doc contains the document content
Here is an example with options that specifies a particular language to query.
var options = { lang : 'en-us' };
const doc = await client.getByUID('page', 'about-us', options)
// doc contains the document content
getByID( id, options )
The getByID function is used to query a certain document by its id. Every document is automatically assigned a unique id when it is created. The id will look something like this: ‘WAjgAygABN3B0a-a’.
This function will only ever retrieve one document as each document has a unique id value.
id
string (required)
The id of the document you want
options
object (optional)
The option parameters and values
Here is an example that queries a document by its id “WAjgAygABN3B0a-a”.
const doc = await client.getByID('WAjgAygABN3B0a-a')
// doc contains the document content
Here is an example with options.
var options = { fetch : 'product.title'};
const doc = await client.getByID('WAjgAygABN3B0a-a', options)
// document contains the document content
getByIDs( ids, options )
The getByIDs function is used to query multiple documents by their ids. This will return the documents in the same order specified in the array, unless options are added to sort them otherwise.
ids
array (required)
An array of strings with the ids of the documents you want
options
object (optional)
The option parameters and values
Here is an example that queries multiple documents by their ids.
var ids = ['WAjgAygAAN3B0a-a', 'WC7GECUAAHBHQd-Y', 'WEE_gikAAC2feA-z'];
const res = await client.getByIDs(ids)
// res is the response object, response.results holds the documents
Here is an example with options that sort the documents by their titles.
var ids = ['WAjgAygAAN3B0a-a', 'WC7GECUAAHBHQd-Y', 'WEE_gikAAC2feA-z'];
var options = { orderings : '[my.page.title]' };
const res = await client.getByIDs(ids, options)
// res is the response object, response.results holds the documents
getSingle( custom-type, options )
The getSingle function is used to query the document of a Single custom type. Single custom types only allow for the creation of one document of that type.
This will only ever retrieve one document.
custom-type
string (required)
The API ID of the single custom type you are searching for
options
object (optional)
The option parameters and values
Here is an example that retrieves the document of the Single type "navigation".
const doc = await client.getSingle(‘navigation’)
// doc contains the document content