Myna. DataManager

Constructs a Myna.DataManager Object for the supplied datasource

Parameters

Constructs a ManagerObject for the supplied table.

Parameters

Options

An extension of getManager that specifically manages Modified Pre-order Tree Traversal (MPTT) organized tables.

Parameters

Options

See

• TreeManagerObject for More Detail on MPTT See Also:
• Storing Hierarchical Data in a Database - http://articles.sitepoint.com- /article- /hierarchical-data-database

returns true if a manager with a given name can be created form this DataManager

Parameters

adds a validation function to this manager’s validation object

Parameters

Validator Function

The validator function will be called with a parameters object with these properties

Validator Options

Returns

this validation instance

Examples

manager.addValidator("first_name","length",{
    min:3,
    max:25
})

//only validate spouse_name when married is true
manager.addValidator("spouse_name","required",{
    when:function(params){
        return params.obj.married
    }
})

function isBob(params){
    var vr = new Myna.ValidationResult();
    if (params.value != "Bob"){
        var msg = params.options.message || params.label + " is not Bob!"
        vr.addError(msg,colname)
    }
    return vr;
}

manager.addValidator("first_name",isBob,{
    message:"Inferior name entered."
})

See

• Myna.Validation
• validation property
• addValidators
• BeanObject.validate

add multiple validators to this manager’s validation object

Parameters

Returns

this validation instance

Example

manager.addValidators({
    name:{
        required:{},
        type:"string",
        regex:{
            pattern:/^[A-Za-z ]+$/,
            message:"Names must only contain Letters and spaces"
        },

    },
    dob:{
        type:"date",
        value:{
            min:new Date().add(Date.YEAR,-150),
            max:new Date()
        }
    },
    children:{
        type:"array",
        length:{
            max:12
        },
        custom:function(params){
            var vr = new Myna.ValidationResult();
                params.value.forEach(function(child,index){
                    vr.merge(this.validate(child),"child_" + index "_")
                })

            return vr;
        }
    }
})

See

• Myna.Validation
• validation property
• addValidator
• BeanObject.validate

internal function to load table data into the manager

Removes or invalidates a row from the managed table matching the supplied primary key

Parameters

Detail

This function checks for the existence of softDeleteCol and will update it to the current time if available.  If no softDeleteCol is defined, then forceDelete is called to remove the row form the table.

Removes a row from the managed table matching the supplied primary key

Parameters

Detail

If this manager hasOne or hasMany related managers with cascading deletes, these related rows will be deleted regardless of the existence of softDeleteCol in the related managers

Creates a record in the database, optionally generating a primary key

Parameters

Detail

requiredFields must contain entries for all non-null columns without default values, except the primary key.  If the primary key is not specified, and the column does not have a default value, genKey is called to generate a key.  Any extra columns supplied will be inserted as well.

Returns

instance of the Bean that represents the new row.  See getById

Example

         +- - - - - - - - - - - - - - - - - -+
         |   table employees                 |
         +- - - - - - - - - - - - - - - - - -+
         |  emp_id       int4    primary key |
         |  fname        varchar             |
         |  mname        varchar             |
         |  lname        varchar             |
         |  manager_id   int4                |
         |  hire_date    date                |
         +- - - - - - - - - - - - - - - - - -+

var dm = new Myna.DataManager("hr_datasource");

var empManager = dm.getManager("employees");

var newEmpBean = empManager.create({
    fname:"Bob",
    lname:"Dobb",
    hire_date:Date.parse("02/21/1992","m/d/Y")
})

returns a Myna.DataSet of information from this table

Parameters

Special Pattern Properties

Options

Note

The Myna.DataSet returned has an extra property, “totalRows” that contains the number of items that would be returned if the query was not constrained.  This is useful if page, or startRow are passed as options

Examples

var employees = new Myna.DataManager("some_ds").getManager("employees");

//Find all employees of a given supervisor
var grunts = man.query({
    supervisor_id:"0102236",
    "inactive is not":null
})


//more complicated search with wildcards
var assitants = employees.find({
    supervisor_id:"0102236"
    job_title:"%assistant%"
})

// an even more complicated search with "select",
//  "where" and "orderBy" pattern properties
//  and including soft deleted records
var bobs_helpers = employees.find({
    select:"name",
    where:<ejs>
        supervisor_id = {supervisor_id}
        and (
            job_title like {job_title}
            or start_date > {start_date:date}
        )
    </ejs>,
    orderBy:"name desc",

    supervisor_id:"55652315",
    job_title:"%assitant%",
    start_date:new Date().add(Date.year,-1)
},{
    includeSoftDeleted:true
})

See

<queryCol> <queryValue> find findBeans

returns an array of primaryKey values that match a search

Parameters

”where” pattern property

This pattern property works much like the sql property of Myna.Query.  Any valid SQL that makes sense in a where clause can be used here, and parameter placeholders can be used just as in Myna.Query.  Parameters are replaced from the other properties of pattern.  See example below

Examples

var employees = new Myna.DataManager("some_ds").getManager("employees");

// a primary key search
var bob_exists = employees.find("55652315").length

//one column search for exact match
var bobs_emps = employees.find({
    manager_id:"55652315"
})

//Who are Bob's employees?
bobs_emps.forEach(function(employee_id){
    Myna.print(employees.getById(employee_id).get_name() +"<br>");
})

//more complicated search with wildcards
var bobs_helpers = employees.find({
    manager_id:"55652315",
    job_title:"%assitant%"
})

//an even more complicated search with where property
var bobs_helpers = employees.find({
    where:<ejs>
        manager_id = {manager_id}
        and (
            job_title like {job_title}
            or start_date > {start_date:date}
        )
    </ejs>,
    manager_id:"55652315",
    job_title:"%assitant%",
    start_date:new Date().add(Date.year,-1)
})

//include deleted "helpers"
var bobs_helpers = employees.find({
    manager_id:"55652315",
    job_title:"%assitant%",
},{
    includeSoftDeleted:true
})

See

findBeans

returns a Myna.DataSet of bean objects that match a search

Parameters

Note

The Myna.DataSet returned has an extra property, “totalRows” that contains the number of items that would be returned if the query was not constrained.  This is useful if page, or startRow are passed as options

Examples

var employees = new Myna.DataManager("some_ds").getManager("employees");

// a primary key search
var bob_exists = employees.find("55652315").length

//one column search for exact match
var bobs_emps = employees.findBeans({
    manager_id:"55652315"
})

//Who are Bob's employees?
bobs_emps.forEach(function(employee){
    Myna.print(employee.get_name() +"<br>");
})
//What are their email addresses?
Myna.printDump(bobs_emps.valueArray("email"),"Bob's Emloyees' Email")


//more complicated search with wildcards
var bobs_helpers = employees.findBeans({
    manager_id:"55652315",
    job_title:"%assitant%"
})

//Using aggregate math: Bob's employees average salary
//See Myna.DataSet
var bobs_emps_avg_sal = employees.findBeans({
    manager_id:"55652315"
}).average("salary")

See

find

generates a primary key value

Detail

By default this function checks the type of the primary key and returns Myna.createUuid for text keys or returns the maximum value of the primary key column + 1 for numeric keys.  This is not the ideal algorithm and should be replaced with a database specific means of generating a primary key.

(end)

generates a display label from a column name

The default implementation either uses one of the special replacements below, or replaces all underbars with spaces and calls String.titleCap on the result.  You can override this function in your models for custom behavior

Special Replacements

Returns a BeanObject representing the row identified by the supplied primary key

Parameters

Detail

This function loads the data from the indicated row into into a <Myna.DataManager.prototype.BeanBase> object.  Each bean is generated with get_<column name> and set_<column name> functions.  The set functions will immediately set the value in the underlying row.

If a an object with the specified id cannot be found, an exception is thrown

See

• BeanObject
• ManagerObject.find
• ManagerObject.findBeans

returns either an instance of an existing row or the result of getNew

Parameters

Detail

This function attempts to create a usable bean even if there is no matching record.  If values is provided with a valid primary key, then getById is called, BeanObject.deferred is set to true, and BeanObject.setFields is called with values.  Otherwise getNew is called with values.  Regardless, the resulting bean will be deferred and BeanObject.save must be called to persist changes

Note

Any defaults set by setDefault will be applied before returning the bean object

Example

//crate or update an order from form data:
var order = new Myna.DataManager(ds).getManager("orders").get($req.rawData)
var result = order.save();
if (result.success) {
    ...
} else{
    ...
}

returns the default value for a column name

Parameters

If an explicit default for this column has been set via setDefault, or setDefaults, that is returned.  Otherwise, null is returned

See Also

getDefaults

returns a structure of all the default values for this table

See

getDefault

returns the display label for a column name

Parameters

If an explicit label for this column has been set via setLabel, that is returned.  Otherwise, the result of genLabel is returned

Returns a BeanObject representing a new row not yet inserted

Parameters

Note

Any defaults set by setDefault will be applied before returning the bean object

See

• BeanObject.deferred
• BeanObject.save

Sets a “belongsTo” relationship with another table.

This function has 3 parameter patterns

Model Name

//these are equivalent
var Person = dm.getManager("Person")
Person.belongsTo("Profile")
Person.belongsTo("profiles")

Model Definition object

this.belongsTo({
    name:"Profile",
    conditions:{
        where:"public = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    }
})

Model definition object array

this.belongsTo([{
    name:"Profile",
    conditions:{
        where:"public = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    }]
},{
    name:"Employee"
}])

Detail

This maps a one-to-one relationship with the related table to this one.  Once set, any beans returned by this manager will include a function with the same name as the related model that represents the result of <relatedModel>.get() for the related row in the related table.  This is best shown by example

// --- from a FlightPath MVC app ---
//Person Model
function init(){
    this.belongsTo("Profile")
}
//Person controller
function edit(params){
    this.set("person",this.Person.get({id:params.id}));
}
//person_edit view
Name: <input name="name" value:"<%=person.name%>"><br>
<!--
    this is the same as
    $FP.getModel("Profile").findBeans({person_id:person.id}).first().email
-->
Email: <input name="Profile.email" value:"<%=person.Profile().email%>"><br>

Note that calling Profile() in the above code will cause the “parent” bean to be created if it doesn’t exist and set this bean to BeanObject.deferred.  When this bean is saved the parent bean will be inserted, if any changes have been made.  To avoid this (and intentionally create an orphan bean) set the related column to an explicit null value, or just don’t make any changes to the returned “parent” bean

Sets a “hasOne” relationship with another table.

This function has 3 parameter patterns

Model Name

//these are equivalent
var Person = dm.getManager("Person")
Person.hasOne("Profile")
Person.hasOne("profiles")

Model Definition object

var Person = dm.getManager("Person")
Person.hasOne({
    name:"Profile",
    alias:"RecentPublicProfile",
    conditions:{
        where:"public = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    }
})

Model definition object array

var Person = dm.getManager("Person")
Person.hasOne([{
    name:"Profile",
    alias:"RecentPublicProfile",
    conditions:{
        where:"public = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    }]
},{
    name:"Profile"
}])

Detail

This maps a one-to-one relationship with the related table to this one.  Once set, any beans returned by this manager will include a property with the same name as the related model that represents the result of <relatedModel>.get() for the related row in the related table.  This is best shown by example

// --- from a FlightPath MVC app ---
//Person Model (a DataManager.ManagerObject)
function init(){
    this.hasOne("Profile")
}
//Person controller
function edit(params){
    this.set("person",this.Person.get({id:params.id}));
}
//person_edit view
Name: <input name="name" value:"<%=person.name%>"><br>
<!--
    this is the same as
    $FP.getModel("Profile").findBeans({person_id:person.id}).first().email
-->
Email: <input name="Profile.email" value:"<%=person.Profile().email%>"><br>

Note that calling Profile() in the above code will cause the bean to be created if it doesn’t exist and set this bean to BeanObject.deferred.  If any changes are made to the related bean, it will be inserted when this bean is saved.  To force an empty related bean to save, set BeanObject.isDirty to true for the related bean

Sets a “hasMany” relationship with another table.

This function has 3 parameter patterns

Model Name

//these are equivalent
var Person = dm.getManager("Person")
Person.hasMany("Posts")
Person.hasMany("posts")

Model Definition object

var Person = dm.getManager("Person")
Person.hasMany({
    name:"Posts",
    alias:"RecentPosts",
    conditions:{
        where:"published = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    },
    orderBy:"category_title ASC, date_published DESC"
})

Model definition object array

var Person = dm.getManager("Person")
Person.hasMany([{
    name:"Posts",
    alias:"RecentPosts",
    conditions:{
        where:"published = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    },
    orderBy:"category_title ASC, date_published DESC"
},{
    name:"Posts",
    orderBy:"category_title ASC, date_published DESC"
},{
    name:"Favorites"
}])

Detail

This maps a one-to-many relationship with the related table to this one.  Once set, any beans returned by this manager will include a function with the same name as the related alias that represents the result of <relatedModel>.findBeans(), constrained by the foreign key relationship.  This is best shown by example

// --- from a FlightPath MVC app ---
//Person Model
function init(){
    this.hasMany("Posts")
}
//Person controller
function edit(params){
    this.set("person",this.Person.get({id:params.id}));
}
//person_edit view
Name: <input name="name" value:"<%=person.name%>"><br>
<!--
    person.Posts is the same as
    $FP.getModel("Post").findBeans({person_id:person.person_id})
-->
Posts:
<ul>
<@loop array="person.Posts()" element="post" index="i">
    <li> <%=post.title%>
</@loop>
</ul>

Note that the DataSet result from Posts() above will also contain a getNew() function that is an alias for the related Manager’s getNew() function.  Calling this will create a new instance of the related bean and add it to this object’s relatedBean array.  The related column will be set to this bean’s localKey value

Sets a “many-to-many” relationship with another table.

This function has 3 parameter patterns

Model Name

//these are equivalent
var Person = dm.getManager("Person")
Person.hasBridgeTo("Tags")
Person.hasBridgeTo("tags")

Model Definition object

var Person = dm.getManager("Person")
Person.hasBridgeTo({
    name:"Tags",
    alias:"RecentTags",
    conditions:{
        where:"published = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    },
    orderBy:"category_title ASC, date_published DESC"
})

Model definition object array

var Person = dm.getManager("Person")
Person.hasBridgeTo([{
    name:"Tags",
    alias:"RecentTags",
    conditions:{
        where:"published = 1 and modified > {oneYearAgo:date}",
        oneYearAgo:new Date().add(Date.YEAR,-1).clearTime()
    },
    orderBy:"category_title ASC, date_published DESC"
},{
    name:"Tags",
    orderBy:"category_title ASC, date_published DESC"
}])

Detail

This maps a many-to-many relationship with the related table to this one.  This requires a “bridge” table i.e a table that maps the primary keys of both tables.  Once defined, any beans returned by this manager will include a function with the same name as the related alias that represents the result of <relatedModel>.findBeans(), constrained by the foreign key relationship.  This is best shown by example

// --- from a FlightPath MVC app ---
//Person Model
function init(){
    this.hasMany("Tags")
}
//Person controller
function edit(params){
    this.set("person",this.Person.get({id:params.id}));
}
//person_edit view
Name: <input name="name" value:"<%=person.name%>"><br>
<!--
    person.Posts is the same as
    $FP.getModel("Post").findBeans({person_id:person.person_id})
-->
Posts:
<ul>
<@loop array="person.Tags()" element="tag" index="i">
    <li> <%=tag.title%>
</@loop>
</ul>

Note that the DataSet result from Tags() above will also contain a getNew() function.  Calling this will create a new instance of the related bean and add it to this object’s relatedBean array.  The related column will be set to this bean’s localKey value

Converts this manager into a TreeManagerObject

Parameters

See

• TreeManagerObject

sets an explicit default value for a column

Parameters

Note

Defaults are automatically applied by getNew and get to the resulting deferred bean.  Direct calls to findBeans, getById and create will not apply defaults.

See Also

• setDefaults

sets several default values at once

Parameters

See

• setDefault

sets an explicit display label for a column

Parameters

sets an explicit display label for multiple columns at once

Parameters

A DataManager-specific validator that validates a value is unique in a column

Parameters

Detail

This will perform a query against the current table looking for any instances of this value, NOT associated with this primary key.  If any are found this validator will add an error .

See

• addValidator

Inserts a row in the table relative to an existing node, and re-orders affected nodes.

Parameters

Location

Note

If both underNode and beforeNode are null, then this node will be inserted as the root node, if the table is empty, or as the last child of the root node.  This function calls ManagerObject.create.

See

• ManagerObject.create

removes a row in the table and also deletes any descending nodes

Parameters

Note

When removing the root node of the tree the entire tree will be deleted

See

• ManagerObject.remove

returns true if there is a root node in this table.

returns the root node of this table, or throws an exception

recalculates left, right, and depth values based on parent ids

If an MPTT organized table has correct parent ids defined but inaccurate or missing right, left and depth values, this function will rebuild them.  This is useful for converting an existing table to an MPTT organized table, or if an non-MPTT aware process modifies the table.

Note

This is a recursive function and may run out of memory for very large trees

gets a value for <columnName>

Detail

This function is generated for every column in the associated table.

sets a value for <columnName>

Parameters

Returns

Myna.ValidationResult object representing the result of the set.

Detail

This function is generated for every column in the associated table, except for the primary key.

Sets multiple fields at once

Parameters

Returns

Myna.ValidationResult representing the result of this action.

Detail

This function will examine each non-function property of fields and call the corresponding “set” function, if available.  Properties that do not match a “set” function are ignored

Persists a value to its underlying row

Parameters

Returns

Myna.ValidationResult representing the result of this action.

Detail

This function is normally called from the “set” function, but may be useful when overriding the generated “set” function.

alias for ManagerObject.forceDelete, which passes this bean’s id

returns a structure of this bean’s data

Parameters

alias for ManagerObject.getLabel

return a bean representing this bean’s parent record

Parameters

Example

var orderBean = new Myna.DataManager("myapp")
                    .getManager("orders")
                    .getById(curOrderId);
var customerBean = orderBean.getParent("customer_id");
Myna.print(customerBean.last_name);

return a Myna.DataSet of beans representing this bean’s child records

Parameters

Example

var customerBean = new Myna.DataManager("myapp")
                    .getManager("customers")
                    .getById(curCustomerId);
var orders = customerBean.getChildren("orders");
Myna.print("Orders Total: " +orders.sumByCol("order_total"));

alias for ManagerObject.remove, which passes this bean’s id

Saves a deferred bean and returns a Myna.ValidationResult object

If called against a deferred BeanObject, then validate is called.  If successful, then all values in data are persisted to the database.  Afterwards, this bean’s deferred status is set to the manager’s deferred status

If this bean is not deferred then a successful Myna.ValidationResult is immediately returned

Validates this bean.

Calls all of the validator functions added via ManagerObject.addValidator against this bean and returns the merged Myna.ValidationResult object

Parameters

• ManagerObject.addValidator
• ManagerObject.validation
• Myna.Validation

Moves this node to another location in the tree, only applies to nodes access through <ManagerObject.getTreeManager>

Parameters

Location

Note

If both underNode and beforeNode are null, then this node will be moved to the last child of the root node.

returns the value of this node’s “left” property.

returns the value of this node’s “right” property.

returns the value of this node’s “parent” property.

returns this node’s parent node

returns true if this node is the root node