Tutorial 7 - Sorting

You can change the type and order of sorting. You can also sort by multiple properties at once.

Introduction

In this Article, we'll look at how you can instruct the query to return items in an order of your choice.

Using sort along with pagination means you can make sure the first pagen of results shows you the items you're interested in. Using sort along with variables allows you to let your end-User customise the sort order themselves.

Sorting by a Single Property

In this example, we'll start with a query which fetches the Categories.

Code:

query sorted_categories {
  records(per_page: 2000, filter: {table: {contains: "category"}}) {
    results {
      table
      id
      properties
    }
  }
}

Step 1) First, we'll add in a sort parameter

Code:

query sorted_categories {

  records(per_page: 2000, sort: {}) {

    results {

      table

      id

      properties

    }

  }

}

Notes:

• As a parameter, sort is contained within the round brackets after the query type

Explorer:

Step 2) Next, you can add a sort method.

You can either use:

2) a) A field from the main options

Code:

query sorted_categories {

  records(per_page: 2000, sort: {created_at: {}}) {

    results {

      table

      id

      properties

    }

  }

}

Explorer:

2) b) a property from properties

Code:

query sorted_categories {

  records(per_page: 2000, sort: {properties: {name: "weighting"}}) {

    results {

      table

      id

      properties

    }

  }

}

Notes:

• Remember, any field which is not a Platform default field will be a property. This means any field not listed in the other options, including several Siteglide fields such as "weighting". Default fields tend to be like created_at automatically filled in when an item is created.

Explorer:

Step 3) Select a sort order

You can choose between the keywords DESC (descending) and ASC (ascending).

Code:

query sorted_categories {

  records(per_page: 2000, sort: {properties: {name: "weighting", order: DESC}}) {

    results {

      table

      id

      properties

    }

  }

}

Explorer:

Sorting by Multiple Properties

Sometimes you may want to initially sort by one property, e.g. weighting, but then some items may have a blank weighting property. Those items where the sort field is blank will go to the end of the results list, but you can add additional sort conditions to sort these further.

Let's say we wish to firstly sort by "weighting", then sort those items without a weighting by the "release date".

Code:

query sorted_categories {

  records(per_page: 2000, sort: {

    properties: [

      {name: "weighting", order: DESC}, 
      {name: "release_date", order: DESC}

    ]

  }) {

    results {

      table

      id

      properties

    }

  }

}

Notes:

• Here we use an array with square brackets [] to add multiple sorting objects with curly braces {}

• Unfortunately, arrays are not yet supported by the Explorer, so you'll need to add this code manually.

• You can use different sort orders for each condition

Next Time

If you want to challenge yourself, you could choose to try making a query which uses variables to change the order and field by which results are sorted.

Next time, we'll look at how you use what you've learned so far to start to build your own Application Programming Interface (API). This will use GraphQL to query the database, Liquid to display the results on an endpoint Page and JavaScript to GET those results on the client side.