Sorting on collection attribute

[gmjordan]

Is sorting provided for on edge and vertex collections?

[colinfindlay]

Hi Greg, sorry for the delayed response - I've been on vacation.

There is currently no support for sorting. The AQL query that is generated basically outputs a list of paths which is probably not particularly useful for sorting, other than perhaps the top level root vertices.

I assume by the question you are looking to sort nested relationships so something like the following pseudo-GraphQL query

{ clients { name @sort age address { line1 line2 city @sort } }

i.e. Sort Clients by name, sort each client's address by city.

Is that right?

[gmjordan]

yes, but top level sort would cover many use cases. For example, list of accounts ordered by account # or "friendly" name on the account, e.g. checking, savings ArangoDB-Community/arangodb-graphql-spring-boot-starter#1 , savings ArangoDB-Community/arangodb-graphql-spring-boot-starter#2

it would be ideal to have this with skip and limit, also, for pagination

[colinfindlay]

I've pushed a commit to my fork that should handle this.

The way it should work is if you declare arguments on your query operation named,"limit", "skip", or "sort" it will handle them accordingly.

Limit and Skip have the same meaning as the AQL documentation for Limit and Skip, and should be declared as Int type. Sort can be declared as a custom input type, as long as all its properties are scalar and can represent the String "ASC" or "DESC". An enum is a good choice here I think.

Example Schema:

enum SortDirection {
    ASC,
    DESC
}

input ClientSort {
    firstName: SortDirection
    lastName: SortDirection
}

type Query {
    getClients(limit: Int, skip: Int, sort: ClientSort): [Client]
}

Example Query

query {
  getClients(limit: 1, skip: 1, sort: { lastName: ASC }) {
    firstName
    lastName
  }
}

If you think that works for your use case let me know and I will open a PR with the community repo, and update the docs.

[gmjordan]

I've tested it locally and it works well. Nicely done.

[colinfindlay]

Functionality included in v1.2