entitiesConnection
Reads and enables pagination through a set of Entity.
entitiesConnection(
first: Int
last: Int
offset: Int
before: Cursor
after: Cursor
orderBy: [EntitiesOrderBy!] = [PRIMARY_KEY_ASC]
condition: EntityCondition
filter: EntityFilter
spaceId: UUID
spaceIds: UUIDFilter
typeId: UUID
typeIds: UUIDFilter
): EntitiesConnection
Arguments
entitiesConnection.first ● Int scalar
Only read the first n values of the set.
entitiesConnection.last ● Int scalar
Only read the last n values of the set.
entitiesConnection.offset ● Int scalar
Skip the first n values from our after cursor, an alternative to cursor
based pagination. May not be used with last.
entitiesConnection.before ● Cursor scalar
Read all values in the set before (above) this cursor.
entitiesConnection.after ● Cursor scalar
Read all values in the set after (below) this cursor.
entitiesConnection.orderBy ● [EntitiesOrderBy!] list enum
The method to use when ordering Entity.
entitiesConnection.condition ● EntityCondition input
A condition to be used in determining which values should be returned by the collection.
entitiesConnection.filter ● EntityFilter input
A filter to be used in determining which values should be returned by the collection.
entitiesConnection.spaceId ● UUID scalar
Filter entities that have data in this space (efficient indexed lookup)
entitiesConnection.spaceIds ● UUIDFilter input
Filter entities by space with operators (in, notIn, is, isNot, etc.)
entitiesConnection.typeId ● UUID scalar
Filter entities that have this type (efficient indexed lookup)
entitiesConnection.typeIds ● UUIDFilter input
Filter entities by type with operators (in, notIn, is, isNot, etc.)
Type
EntitiesConnection object
A connection to a list of Entity values.
:::tip See also
Cookbook recipes that use this:
- Paginate Large Result Sets — this is the connection variant — use for cursor pagination
- List Entities of a Type in a Space
- Deduplicate Before Ingestion — paginate every existing entity to build a name → id map
:::