Quick Query Helper functions

We've included helper functions to make creating certain queries quicker and easier when using the Prismic Ruby development kit. This page provides the description and examples for each of the helper functions.

getByUID

The getByUID function is used to query the specified custom type by a certain UID. 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.

Copy

getByUID( custom_type, uid, options )

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 to retrieve

options

array

(optional) An array with option parameters and values

Here is an example that queries a document of the type "page" by its uid "about-us".

Copy

document = api.getByUID("page", "about-us")
# document contains the document content

Here is an example with options that specifies a particular language to query.

Copy

options = { "lang" => "en-us" }
document = api.getByUID("page", "about-us", options)
# document contains the document content

getByID

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.

Copy

getByID( id, options )

string

(required) The id of the document you want to retrieve

options

array

(optional) An array with option parameters and values

Here is an example that queries a document by its id "WAjgAygABN3B0a-a".

Copy

document = api.getByID("WAjgAygABN3B0a-a")
# document contains the document content

Here is an example with options.

Copy

options = { "fetch" => "product.title" }
document = api.getByID("WAjgAygABN3B0a-a", options)
# document contains the document content

getByIDs

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.

Copy

getByIDs( ids, options )

ids

array

(required) An array of strings with the ids of the documents you want to retrieve

options

array

(optional) An array with option parameters and values

Here is an example that queries multiple documents by their ids.

Copy

ids = [ "WAjgAygAAN3B0a-a", "WC7GECUAAHBHQd-Y", "WEE_gikAAC2feA-z" ]
response = api.getByIDs(ids)
# response is the response object, response.results holds the documents

Here is an example with options that sort the documents by their titles.

Copy

ids = [ "WAjgAygAAN3B0a-a", "WC7GECUAAHBHQd-Y", "WEE_gikAAC2feA-z" ]
options = { "orderings" => "[my.page.title]" }
response = api.getByIDs(ids, options)
# response is the response object, response.results holds the documents

getSingle

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.

Copy

getSingle( custom_type, options )

custom_type

string

(required) The API ID of the single custom type you want to retrieve

options

array

(optional) An array with option parameters and values

Here is an example that retrieves the document of the Single type "navigation".

Copy

document = api.getSingle("navigation")
# document contains the document content

Was this article helpful?

Not really

Yes, Thanks

Can't find what you're looking for? Get in touch with us on our Community Forum.