Introduction

Below is a list of methods grouped by the resource they interact with. These methods are available to the page under the fb_client object that is injected into the browser window.

Methods

Database

runQuery(String sql)

Executes a SQL string, and returns an array of records as JSON objects. If there is an error, it returns an object. Note: All result properties will be returned in lowercase.

Examples

Return a basic query with a single row.

var results = fb_client.runQuery("select * from company");

Return a basic query with multiple rows.

var results = fb_client.runQuery("select * from so limit 10");

What happens with a syntax error.

var results = fb_client.runQuery("select *, from so limit 10");

runQueryParameters(String sql, String json_parameters);

Executes a SQL string like runQuery, but accepts a single object with parameters serialized as JSON. To define a parameter use :name syntax, and use all lower case parameter names in SQL and in the JSON object.

Examples

Query sales orders by a specific customer id.

var params = JSON.stringify({customer_id:5});
var results = fb_client.runQueryParameters("select * from so where customerid = :customer_id", params );

API

Window

Client

File

getResourceFileString(String filename)

Retrieves a file name from the root of the page folder. Warning: We do check for path traversal.

Example

Read a SQL file as a string.

var query_sql = fb_client.getResourceFileString("sql/test.sql");

getResourceFileAsBase64(String filename)

Retrieves a file name from the root page of the folder, as a Base64 string of bytes. Warning: We do check for path traversal.

Example

Read an image file as Base64 string.

var image_b64 = fb_client.getResourceFileString("images/example.png");

console.log(image_b64);
# > .....