Records

List

Listing records in a class

Class.list();

Response:

• list (Array) - List of record objects.

Example:

MyClass.list()
  .then(function(records) {
    console.log('Found ' + records.length + ' records:', records);
  });

## Get Loading a record by RID. ```javascript db.record.get(recordId); ```

Parameters:

• recordId (String) - Record id of record to retrieve.

Response:

• record (Object) - Record object.

Example:

db.record.get('#1:1')
  .then(function(record) {
    console.log('Loaded record:', record);
  });

## Add Create a new record. ```javascript db.record.create(properties); ```

Parameters:

• properties (Object) - Record properties to set.

Response:

• record (Object|Array) - Updated record(s).

Example:

db.record.create({
    '@class': 'OUser',
    name: 'testuser',
    password: 'testpassword',
    status: 'ACTIVE'
  })
  .then(function (record) {
    console.log('Created record:', record);
  });

#### Creating a record for a class. ```javascript Class.create(properties); ```

Example:

MyClass.create({
    name: 'John McFakerton',
    email: 'fake@example.com'
  })
  .then(function (record) {
    console.log('Created record: ', record);
  });

## Update Modify an existing record. ```javascript db.record.update(properties, options); ```

Parameters:

• properties (Object) - Record properties to set.
• options (Object) - Update options.

Response:

• record (Object|Array) - Updated record(s).

Example:

db.record.update({
    '@rid': createdRID,
    name: 'testuserrenamed'
  },
  {
    preserve: true
  })
  .then(function (record) {
    record.name.should.equal('testuserrenamed');
  });

## Delete Deleting a record. ```javascript db.record.delete(recordId); ```

Parameters:

• recordId (String) - Record id of record to delete.

Response:

• results (Boolean) - If record was deleted, returns true. Otherwise false.

Example:

db.record.delete('#1:1')
  .then(function() {
    console.log('Record deleted');
  });