Skip to main content

Create Object

Create top-level model object​

You can create a top-level model object by calling the create method. It creates a top-level model object using the values and options.

// Insert a new top-level model object to the database using the object manager
let result = await altogic.db.model("employee").object().create({
  name: "Rooby the Robot",
  birthDate: "1999-10-10T10:00:00.000+00:00",
  mail: "[email protected]",
  hireDate: "2019-10-10T10:00:00.000+00:00",
  title: "Robot",
});
Example response
{
  "data": {
    "_id": "62363dad1182562412d85b9b",
    "title": "Robot",
    "hireDate": "2019-10-10T10:00:00.000Z",
    "mail": "[email protected]",
    "birthDate": "1999-10-10T10:00:00.000Z",
    "name": "Rooby the Robot"
  },
  "errors": null
}

Parameters​

Here you can find parameters for the create method.

#

Name

Data type

Required

Description

1valuesObjectYesAn object that contains the fields and their values to create in the database
2optionsCreateOptionsNoCreate operation options.
By default no caching of the newly created object in Redis store
info

This method is valid only for top-level models, models without a parent.

  • If this method is called for a sub-model object or object-list, an error will be returned.

  • If the id is provided as input to this database object, its value will be ignored by this method since Altogic will automatically assign an id for new objects created in the database.

note

If the client library key is set to enforce session, an active user session is required (e.g., user needs to be logged in) to call this method.

Set sub-model object​

You can set a sub-model object by calling the set method. It sets object field value of a parent object identified by parentId.

//Sets a sub-level model object with parentId to the database using the object manager
let result = await altogic.db
  .model("employee.department")
  .object()
  .set(
    {
      code: 31415,
      name: "Robot Office",
      address: [
        {
          city: "Chicago",
          state: "IL",
          postalCode: "60601",
        },
      ],
    },
    "623643d845aba7a69557996c"
  );
Example response
{
  "data": {
    "_id": "623643d845aba7a69557996c",
    "title": "Robot",
    "hireDate": "2019-10-10T10:00:00.000Z",
    "mail": "[email protected]",
    "birthDate": "1999-10-10T10:00:00.000Z",
    "name": "Rooby the Robot",
    "department": {
      "_id": "623643e225de47092f4d536b",
      "_parent": "623643d845aba7a69557996c",
      "name": "Robot Office",
      "code": 31415,
      "address": [
        {
          "_id": "623643e225de47092f4d536c",
          "_parent": "623643e225de47092f4d536b",
          "postalCode": 10112,
          "city": "Chicago",
          "state": "IL"
        }
      ]
    }
  },
  "errors": null
}

Parameters​

Here you can find parameters for the set method.

#

Name

Data type

Required

Description

1valuesObjectYesAn object that contains the fields and their values to set in the database.
2parentIdStringYesThe id of the parent object is required.
If the parent object is not found, an error will be returned.
3optionsSetOptionsNoSet operation options.
By default no caching of the newly created object in Redis store.
info

This method is valid only for sub-model objects, objects with a parent.

  • If this method is called for a top-level model object or sub-model object-list, an error will be returned.

  • If the id is provided as input, its value will be ignored by this method since Altogic will automatically assign an id for new objects created in the database.

note

If the client library key is set to enforce session, an active user session is required (e.g., user needs to be logged in) to call this method.

Add child-list object​

You can add a child object to the object-list field by calling the append method. It appends the input object to the object-list field of a parent object identified by parentId.

//Appends a child-list object with parentId to the database using the object manager
let result = await altogic.db
  .model("employee.department.address")
  .object()
  .append(
    {
      city: "Los Angeles",
      state: "CA",
      postalCode: "10112",
    },
    "623643e225de47092f4d536b"
  );
Example response
{
  "data": {
    "_id": "6236441e161326736e4ffd2c",
    "_parent": "623643e225de47092f4d536b",
    "postalCode": 10112,
    "city": "Los Angeles",
    "state": "CA"
  },
  "errors": null
}

Parameters​

Here you can find parameters for the append method.

#

Name

Data type

Required

Description

1valuesObjectYesAn object that contains the fields and their values to create in the database.
2parentIdStringYesThe id of the parent object is required.
If the parent object is not found, an error will be returned.
3optionsAppendOptionsNoAppend operation options.
By default no caching of the newly created object in Redis store and no top level object return.
info

This method is valid only for sub-model object-lists, object-lists with a parent.

  • If this method is called for a top-level model object or sub-model object, an error will be returned.

  • If the id is provided as input to this database object, its value will be ignored by this method since Altogic will automatically assign an id for newly created objects in the database.

note

If the client library key is set to enforce session, an active user session is required (e.g., user needs to be logged in) to call this method.

CreateOptions properties​

Here you can find properties for the CreateOptions

#

Name

Data type

Description

1cacheStringSpecify whether to cache the created object using its id as the cache key or not.
If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache.
It can be nocache noexpiry 30sec 1min 2mins 5mins 10mins 15mins 30mins 1hour 6hours 12hours 1day 1week 1month 6months 1year

AppendOptions properties​

Here you can find properties for the AppendOptions

#

Name

Data type

Description

1cacheStringSpecify whether to cache the appended object using its id as the cache key or not.
If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache. br/> It can be nocache noexpiry 30sec 1min 2mins 5mins 10mins 15mins 30mins 1hour 6hours 12hours 1day 1week 1month 6months 1year
2returnTopbooleanWhen you create a submodel object (a child object of a top-level object), you can specify whether to return the newly created child object or the updated top-level object.
By default returnTop=false.

SetOptions properties​

Here you can find properties for the SetOptions

#

Name

Data type

Description

1cacheStringSpecify whether to cache the set object using its id as the cache key or not.
If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache.
It can be nocache noexpiry 30sec 1min 2mins 5mins 10mins 15mins 30mins 1hour 6hours 12hours 1day 1week 1month 6months 1year
2returnTopbooleanWhen you create a submodel object (a child object of a top-level object), you can specify whether to return the newly created child object or the updated top-level object.
By default returnTop=false.