FRecord

FRecord is a unique syntax for the F8 platform. It’s primarily used for database operations (read, write, etc) instead of writing SQL queries.

Common Usage

Listed here are several common usage examples of FRecord

Query Syntax

Most FRecord searches performed within the platform will leverage the following format

var variableName = new FRecord(bucketName);
variableName.addSearch(slotName, slotValue);
variableName.addSearch(slotName, slotValue);
variableName.search();
while (variableName.next()) {
   //Do something with each FRecord found
}

Insert/Update Syntax

To insert or update using FRecord, you'll use the following format

var recordVar = new FRecord(bucketName);
recordVar.slotName = newValue;
recordVar.slotName = newValue;
recordVar.slotName = newValue;
recordVar.slotName = newValue;
recordVar.update(); // or .insert()

Basic Search

Show a list of all users and log out the first and last name of each user found

var userVar = new FRecord('user');
userVar.search();
while (userVar.next()) {
   console.log('Found user - ' + userVar.first_name + ' ' + userVar.last_name);
}

Advanced Search

Show a list of all active male users

var userVar = new FRecord('user');
userVar.addSearch('gender', 'male');
userVar.addSearchIsTrue('active');
userVar.search();
while (userVar.next()) {
   console.log('Found user - ' + userVar.name);
}

Search and Update

Show a list of all active users created before 2016 and update their active status to false

var firstOf2016InMilliseconds = 1451606400000;
var userVar = new FRecord('user');
userVar.addSearchLessThan('created', firstOf2016InMilliseconds);
userVar.addSearchIsTrue('active');
userVar.search();
while (userVar.next()) {
   //Now update each record's active flag
   userVar.active = false;
   userVar.update();
}

Search, Update, and then Insert a Speak

Same as above. Show a list of all active users created before 2016 and update their active status to false. But then add a "Speak" record

//Lookup the active users created before this year
var firstOf2016InMilliseconds = 1451606400000;
var userVar = new FRecord('user');
userVar.addSearchLessThan('created', firstOf2016InMilliseconds);
userVar.addSearchIsTrue('active');
userVar.search();
while (userVar.next()) {
   //Now update each record's active flag
   userVar.active = false;
   userVar.update();

   //Now add a speak record to log the change
   var speakVar = new FRecord('speaks');
   speakVar.bucket = 'user';
   speakVar.record = userVar.id;  //Note that we used the userVar variable from the above query
   speakVar.text = "User inactivated as it was created prior to 2016";
   speakVar.insert();
}

FRecord OR Query

Here is an example of an OR query. Note that the system defaults to an AND query.

var fr = new FRecord('user');
fr.addSearch('first_name', 'John');
fr.getSearchGroup().OR();
fr.addSearch('last_name', 'Doe');
fr.search(function(row) {
console.log(row.name);
});

Methods (work in progress)

Method Detail

accessToRead

public boolean jsFunction_accessToRead()

Check to see if there is access to read the FRecord

Returns:

Boolean - true if can read and false if can not read.

Example:

var userVar = new FRecord('user');
userVar.search();
if (userVar.next()) {
   var hasRead = userVar.accessToRead();
}

accessToWrite

public boolean jsFunction_accessToRead()

Check to see if there is access to write to the FRecord

Returns:

Boolean - true if can read and false if can not write.

Example:

var userVar = new FRecord('user');
userVar.search();
if (userVar.next()) {
   var hasWrite = userVar.accessToWrite();
}

isNewRecord

public boolean jsFunction_isNewRecord()

Check to see if the FRecord is new (e.g. hasn't been inserted yet)

Returns:

Boolean - true if record is new and false not

Example:

if ($record.isNewRecord()) {
   //Set name to first + last
   $record.name = $record.first_name + '  ' + $record.last_name;
   $record.update();
}

addSort

public boolean jsFunction_addSort()(slotName, descending (boolean, default false))

Sort the results returned by a column value, and sort either ascending or descending

Example:

var userVar = new FRecord('user');
userVar.addSort('created', true);
userVar.search();
if (userVar.next()) {
   console.log('Found user record - ' + userVar.name);
}

addEncodedSearch

void jsFunction_addEncodedSearch(searchQuery, variables(optional))

FRecord search via encoded search query

Example:

var userVar = new FRecord('user');
userVar.addEncodedSearch([["first_name","begins","Chris"],["last_name","contains","Burk"]])
userVar.search();
if (userVar.next()) {
   console.log("User: " + userVar.name);
}

Note: For an easy way to build a search query create a filter using the filter builder on the list component, copy everything after the q= in the URL