Skip to content

Relation Paging

API operations described above provide a way to retrieve a limited (initial) set of related data. In most real world scenarios, there may be more related objects than returned by Single Step, Two Step or Relation Depth Retrieval APIs. To obtain a complete set of related objects Backendless supports Relation Paging API described below.

Important

  1. To understand the concept of paged data retrieval, see the Data retrieval with Paging section of the documentation.
    2. When working with paging, it may be important to know the total size of the related collection. See the Get Object Count section for details on how to get the related objects count.

JS applications must use the Backendless.LoadRelationsQueryBuilder class which facilitates retrieval of related objects for a parent object. The class is responsible for maintaining the page size and offset parameters used in the paging process.

Before an instance of Backendless.LoadRelationsQueryBuilder can be used in a data retrieval request, it must be initialized as shown below. Notice the setRelationName call which identifies a related column for which the related objects will be loaded:

var loadRelationsQueryBuilder = Backendless.LoadRelationsQueryBuilder.create();
loadRelationsQueryBuilder.setRelationName( "NAME-OF-RELATED-COLUMN" );
var loadRelationsQueryBuilder = Backendless.LoadRelationsQueryBuilder.of( CHILDCLASS );
loadRelationsQueryBuilder.setRelationName( "NAME-OF-RELATED-COLUMN" );

where:

Argument                Description
CHILDCLASS Used in the "Custom Class/Function" approach only. A JS function/class which identifies the related table.
NAME-OF-RELATED-COLUMN Name of the related column in the parent table for which the related objects will be retrieved.

Once a query builder object is created, the following API can be used to retrieve a page of related objects:

// non-blocking API
Backendless.Data.of( "PARENT-TABLE-NAME" ).loadRelations( 
                            parentObjectId,
                            queryBuilder )
 .then( function( relatedObjectsArray ) {
  })
 .catch( function( error ) {
  });

// blocking API
var relatedObjectsArray = Backendless.Data.of( "PARENT-TABLE-NAME" ).loadRelationsSync( 
                            parentObjectId,
                            queryBuilder );
// non-blocking API
Backendless.Data.of( PARENT-CLASS ).loadRelations( queryBuilder )
 .then( function( relatedChildrenArray ) {
  })
 .catch( function( error ) {
 });

// blocking API
var relatedObjectsArray = Backendless.Data.of( PARENT-CLASS ).loadRelationsSync( queryBuilder );

where:

Argument                Description
parentObjectId  id of the object for which the related objects will be retrieved.
PARENT-TABLE-NAME name of the table which contains the parent object identified by parentObjectId.
queryBuilder Backendless.LoadRelationsQueryBuilder initialized as shown above. Used in subsequent calls to request additional pages of related data objects.

The LoadRelationsQueryBuilder class contains methods which recalculate offset in order to obtain next, previous or a specific page. After loadRelationsQueryBuilder is modified, call the API shown above to get next, previous or a specific page of data.