Skip to content

Add Relation with objects

This API request adds related objects to the existing collection. Child objects to add to the relation must be explicitly defined by referencing their IDs.

Method

Future<int> Backendless.data.of("TABLE-NAME").addRelation(
                   String parentObjectId, 
                   String relationColumnName, 
                  {List<String> childrenObjectIds, 
                   String whereClause});
Future<int> Backendless.data.withClass<E>().addRelation(
                    String parentObjectId, 
                    String relationColumnName, 
                   {List<String> childrenObjectIds, 
                    String whereClause});

where:

Argument                Description
TABLE-NAME Name of the table where the parent object is stored.
E Dart class of the parent object. The class name identifies the table where the parent object is stored.
parentObjectId The ID of an object which will be assigned related children for relatedColumnName. When this argument is an instance of Map (for the map-based approach), it must contain the "objectId" property.
relationColumnName Name of the column identifying the relation. Objects from the children collection will be added as related for the  column in parentObject. The column name may optionally include table name separated by the colon character as well as cardinality which determines the type of relationship (one to one or one to many) (see the note below):

Important

If the column does not exist in the parent table at the time when the API is called, the value of the "relationColumnName" argument must include the name of the child table separated by colon and the cardinality notation. The cardinality is expressed as ":1" for one-to-one relations and ":n" for one-to-many relations. For example, the value of "myOrder:Order:1" will create a one-to-one relation column "myOrder" in the parent table. The column will point to the Order child table. Likewise, the value of "myOrder:Order:n" will create a one-to-many relation column "myOrder" pointing to the Order table.

Argument                Description
childrenObjectIds A collection of child object IDs to add to the relation identified by relatedColumnName.

Return Value

Number of child objects added to the relation.

Example

The example below adds a related object for a one-to-one column named address declared in the Person table. If the relation already contains an object, server returns an error since the addRelation API for one-to-one relations can add an object only once. The column must be declared in the table prior to the execution of the request shown below. This necessity is explained by missing table name qualifier in the relationColumnName argument - notice the relation column name is "address". If it were specified as "address:Address", then the column would be created automatically.
relation-column

Map parentObject = // parentObject retrieval is out of scope in this example
Map childObject = // childObject retrieval is out of scope in this example

Backendless.data.of("Person").addRelation(parentObject['objectId'], "address", 
  children: [childObject['objectId']]).then((response) {
    // related object has been added
});
Person personObject = // personObject retrieval is out of scope in this example
Address addressObject = // addressObject retrieval is out of scope in this example

Backendless.data.withClass<Person>().addRelation(personObject.objectId, "address", 
  children: [addressObject.objectId]).then((response) {
    // related object has been added
});