<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Database - Siminov Hybrid</title>
<link rel="stylesheet" href="">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="stylesheet" href="../assets/css/custom.css">
<link rel="stylesheet" href="../assets/vendor/bootstrap/css/bootstrap.css">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
</head>
<body class="yui3-skin-sam">
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<h1 class="brand" style="padding: 10px 16px 10px; height: 20px; line-height: 20px; margin-left: 0;">
<img alt="Siminov Hybrid" src="../resources/siminov-logo.gif" style="max-height: 65%;" title="Siminov Hybrid">
Siminov Hybrid
</h1>
<div class="nav">
<li class="divider-vertical"></li>
<li>
<p class="navbar-text">
API Docs for Version: <b>2.0</b>
</p>
</li>
</div>
<form class="navbar-form pull-right" style="line-height: 40px; height: 40px;">
<input style="margin-top: 0;" type="text" class="search-query" placeholder="Search for classes/modules..." data-obj='["classes/Adapter", "classes/AdapterDescriptor.Handler", "classes/AdapterDescriptor.Handler.Parameter", "classes/ApplicationDescriptor", "classes/Clause", "classes/ConnectionRequest", "classes/ConnectionResponse", "classes/Constants", "classes/Database", "classes/DatabaseDescriptor", "classes/DatabaseException", "classes/DeploymentException", "classes/Dictionary", "classes/EntityDescriptor", "classes/EntityDescriptor.Attribute", "classes/EntityDescriptor.Index", "classes/EntityDescriptor.Relationship", "classes/EventHandler", "classes/Function", "classes/IAverage", "classes/IAverageClause", "classes/ICount", "classes/ICountClause", "classes/IDatabaseEvents", "classes/IDelete", "classes/IDeleteClause", "classes/IGroupConcat", "classes/IGroupConcatClause", "classes/IMax", "classes/IMaxClause", "classes/IMin", "classes/IMinClause", "classes/INotificationEvents", "classes/IResource", "classes/ISelect", "classes/ISelectClause", "classes/IService", "classes/IServiceEvents", "classes/ISiminovEvents", "classes/ISum", "classes/ISumClause", "classes/ISyncEvents", "classes/ITotal", "classes/ITotalClause", "classes/LibraryDescriptor", "classes/Log", "classes/Message", "classes/NotificationDescriptor", "classes/NotificationException", "classes/NotificationManager", "classes/Registration", "classes/Resources", "classes/Select", "classes/Service", "classes/ServiceDescriptor", "classes/ServiceDescriptor.Request", "classes/ServiceDescriptor.Request.HeaderParameter", "classes/ServiceDescriptor.Request.QueryParameter", "classes/ServiceEventHandler", "classes/ServiceException", "classes/ServiceHandler", "classes/SIDatasHelper", "classes/Siminov", "classes/SiminovException", "classes/SiminovExceptionHandler", "classes/StringBuilder", "classes/SyncDescriptor", "classes/SyncException", "classes/SyncHandler", "classes/SyncRequest", "classes/Transaction", "classes/Utils", "modules/Adapter", "modules/Collection", "modules/Connection", "modules/Database", "modules/Design", "modules/Events", "modules/Exception", "modules/Function", "modules/Impl", "modules/Log", "modules/Model", "modules/Notification", "modules/Parser", "modules/Resource", "modules/Service", "modules/Sync", "modules/Utils"]'>
</form>
</div>
</div>
<div class="container">
<div class="row">
<div class="span3">
<div>
<h3>APIs</h3>
<div id="sidebar">
<ul id="main-nav" class="nav nav-tabs" style="margin-bottom:0;">
<li class="active"><a href="#classes" data-toggle="tab">Classes</a></li>
<li><a href="#modules" data-toggle="tab">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" placeholder="Type to filter APIs">
</div>
<div class="tab-content" style="border: 1px solid #DDD; border-top:0;">
<div class="tab-pane active" id="classes">
<ul id="api-classes" class="nav nav-list">
<li><a href="../classes/Adapter.html">Adapter</a></li>
<li><a href="../classes/AdapterDescriptor.Handler.html">AdapterDescriptor.Handler</a></li>
<li><a href="../classes/AdapterDescriptor.Handler.Parameter.html">AdapterDescriptor.Handler.Parameter</a></li>
<li><a href="../classes/ApplicationDescriptor.html">ApplicationDescriptor</a></li>
<li><a href="../classes/Clause.html">Clause</a></li>
<li><a href="../classes/ConnectionRequest.html">ConnectionRequest</a></li>
<li><a href="../classes/ConnectionResponse.html">ConnectionResponse</a></li>
<li><a href="../classes/Constants.html">Constants</a></li>
<li><a href="../classes/Database.html">Database</a></li>
<li><a href="../classes/DatabaseDescriptor.html">DatabaseDescriptor</a></li>
<li><a href="../classes/DatabaseException.html">DatabaseException</a></li>
<li><a href="../classes/DeploymentException.html">DeploymentException</a></li>
<li><a href="../classes/Dictionary.html">Dictionary</a></li>
<li><a href="../classes/EntityDescriptor.html">EntityDescriptor</a></li>
<li><a href="../classes/EntityDescriptor.Attribute.html">EntityDescriptor.Attribute</a></li>
<li><a href="../classes/EntityDescriptor.Index.html">EntityDescriptor.Index</a></li>
<li><a href="../classes/EntityDescriptor.Relationship.html">EntityDescriptor.Relationship</a></li>
<li><a href="../classes/EventHandler.html">EventHandler</a></li>
<li><a href="../classes/Function.html">Function</a></li>
<li><a href="../classes/IAverage.html">IAverage</a></li>
<li><a href="../classes/IAverageClause.html">IAverageClause</a></li>
<li><a href="../classes/ICount.html">ICount</a></li>
<li><a href="../classes/ICountClause.html">ICountClause</a></li>
<li><a href="../classes/IDatabaseEvents.html">IDatabaseEvents</a></li>
<li><a href="../classes/IDelete.html">IDelete</a></li>
<li><a href="../classes/IDeleteClause.html">IDeleteClause</a></li>
<li><a href="../classes/IGroupConcat.html">IGroupConcat</a></li>
<li><a href="../classes/IGroupConcatClause.html">IGroupConcatClause</a></li>
<li><a href="../classes/IMax.html">IMax</a></li>
<li><a href="../classes/IMaxClause.html">IMaxClause</a></li>
<li><a href="../classes/IMin.html">IMin</a></li>
<li><a href="../classes/IMinClause.html">IMinClause</a></li>
<li><a href="../classes/INotificationEvents.html">INotificationEvents</a></li>
<li><a href="../classes/IResource.html">IResource</a></li>
<li><a href="../classes/ISelect.html">ISelect</a></li>
<li><a href="../classes/ISelectClause.html">ISelectClause</a></li>
<li><a href="../classes/IService.html">IService</a></li>
<li><a href="../classes/IServiceEvents.html">IServiceEvents</a></li>
<li><a href="../classes/ISiminovEvents.html">ISiminovEvents</a></li>
<li><a href="../classes/ISum.html">ISum</a></li>
<li><a href="../classes/ISumClause.html">ISumClause</a></li>
<li><a href="../classes/ISyncEvents.html">ISyncEvents</a></li>
<li><a href="../classes/ITotal.html">ITotal</a></li>
<li><a href="../classes/ITotalClause.html">ITotalClause</a></li>
<li><a href="../classes/LibraryDescriptor.html">LibraryDescriptor</a></li>
<li><a href="../classes/Log.html">Log</a></li>
<li><a href="../classes/Message.html">Message</a></li>
<li><a href="../classes/NotificationDescriptor.html">NotificationDescriptor</a></li>
<li><a href="../classes/NotificationException.html">NotificationException</a></li>
<li><a href="../classes/NotificationManager.html">NotificationManager</a></li>
<li><a href="../classes/Registration.html">Registration</a></li>
<li><a href="../classes/Resources.html">Resources</a></li>
<li><a href="../classes/Select.html">Select</a></li>
<li><a href="../classes/Service.html">Service</a></li>
<li><a href="../classes/ServiceDescriptor.html">ServiceDescriptor</a></li>
<li><a href="../classes/ServiceDescriptor.Request.html">ServiceDescriptor.Request</a></li>
<li><a href="../classes/ServiceDescriptor.Request.HeaderParameter.html">ServiceDescriptor.Request.HeaderParameter</a></li>
<li><a href="../classes/ServiceDescriptor.Request.QueryParameter.html">ServiceDescriptor.Request.QueryParameter</a></li>
<li><a href="../classes/ServiceEventHandler.html">ServiceEventHandler</a></li>
<li><a href="../classes/ServiceException.html">ServiceException</a></li>
<li><a href="../classes/ServiceHandler.html">ServiceHandler</a></li>
<li><a href="../classes/SIDatasHelper.html">SIDatasHelper</a></li>
<li><a href="../classes/Siminov.html">Siminov</a></li>
<li><a href="../classes/SiminovException.html">SiminovException</a></li>
<li><a href="../classes/SiminovExceptionHandler.html">SiminovExceptionHandler</a></li>
<li><a href="../classes/StringBuilder.html">StringBuilder</a></li>
<li><a href="../classes/SyncDescriptor.html">SyncDescriptor</a></li>
<li><a href="../classes/SyncException.html">SyncException</a></li>
<li><a href="../classes/SyncHandler.html">SyncHandler</a></li>
<li><a href="../classes/SyncRequest.html">SyncRequest</a></li>
<li><a href="../classes/Transaction.html">Transaction</a></li>
<li><a href="../classes/Utils.html">Utils</a></li>
</ul>
</div>
<div class="tab-pane" id="modules">
<ul id="api-modules" class="nav nav-list">
<li><a href="../modules/Adapter.html">Adapter</a></li>
<li><a href="../modules/Collection.html">Collection</a></li>
<li><a href="../modules/Connection.html">Connection</a></li>
<li><a href="../modules/Database.html">Database</a></li>
<li><a href="../modules/Design.html">Design</a></li>
<li><a href="../modules/Events.html">Events</a></li>
<li><a href="../modules/Exception.html">Exception</a></li>
<li><a href="../modules/Function.html">Function</a></li>
<li><a href="../modules/Impl.html">Impl</a></li>
<li><a href="../modules/Log.html">Log</a></li>
<li><a href="../modules/Model.html">Model</a></li>
<li><a href="../modules/Notification.html">Notification</a></li>
<li><a href="../modules/Parser.html">Parser</a></li>
<li><a href="../modules/Resource.html">Resource</a></li>
<li><a href="../modules/Service.html">Service</a></li>
<li><a href="../modules/Sync.html">Sync</a></li>
<li><a href="../modules/Utils.html">Utils</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="span9">
<form id="options-form" class="form-inline pull-right">
Show:
<label for="api-show-inherited" class="checkbox">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected" class="checkbox">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private" class="checkbox">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated" class="checkbox">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</form>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<div class="page-header">
<h1>Database <small>Class</small></h1>
</div>
<div class="well well-small">
<div class="foundat">
Defined in: <a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l77"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:77</code></a>
</div>
Module: <a href="../modules/Database.html">Database</a>
</div>
<div class="well well-small">
<p>Exposes methods to deal with database.
It has methods to create, delete, and perform other common database management tasks.</p>
</div>
<div>
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#index">Index</a></li>
<li><a data-toggle="tab" href="#methods">Methods</a></li>
</ul>
<div class="tab-content">
<div id="index" class="tab-pane active">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_avg" data-tablink="avg">avg</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_count" data-tablink="count">count</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_delete" data-tablink="delete">delete</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getColumnNames" data-tablink="getColumnNames">getColumnNames</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getColumnNamesAsync" data-tablink="getColumnNamesAsync">getColumnNamesAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getColumnTypes" data-tablink="getColumnTypes">getColumnTypes</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getColumnTypesAsync" data-tablink="getColumnTypesAsync">getColumnTypesAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getDatabaseDescriptor" data-tablink="getDatabaseDescriptor">getDatabaseDescriptor</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getDatabaseDescriptorAsync" data-tablink="getDatabaseDescriptorAsync">getDatabaseDescriptorAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getEntityDescriptor" data-tablink="getEntityDescriptor">getEntityDescriptor</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getEntityDescriptor" data-tablink="getEntityDescriptor">getEntityDescriptor</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getForeignKeys" data-tablink="getForeignKeys">getForeignKeys</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getForeignKeysAsync" data-tablink="getForeignKeysAsync">getForeignKeysAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getMandatoryFields" data-tablink="getMandatoryFields">getMandatoryFields</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getMandatoryFieldsAsync" data-tablink="getMandatoryFieldsAsync">getMandatoryFieldsAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getPrimaryKeys" data-tablink="getPrimaryKeys">getPrimaryKeys</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getPrimaryKeysAsync" data-tablink="getPrimaryKeysAsync">getPrimaryKeysAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getTableName" data-tablink="getTableName">getTableName</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getTableNameAsync" data-tablink="getTableNameAsync">getTableNameAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getUniqueFields" data-tablink="getUniqueFields">getUniqueFields</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_getUniqueFieldsAsync" data-tablink="getUniqueFieldsAsync">getUniqueFieldsAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_groupConcat" data-tablink="groupConcat">groupConcat</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_max" data-tablink="max">max</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_min" data-tablink="min">min</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_save" data-tablink="save">save</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_saveAsync" data-tablink="saveAsync">saveAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_saveOrUpdate" data-tablink="saveOrUpdate">saveOrUpdate</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_saveOrUpdateAsync" data-tablink="saveOrUpdateAsync">saveOrUpdateAsync</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_select" data-tablink="select">select</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_sum" data-tablink="sum">sum</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_total" data-tablink="total">total</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_update" data-tablink="update">update</a>
</li>
<li class="index-item method">
<a href="#" data-tabid="#methods" data-anchor="#method_updateAsync" data-tablink="updateAsync">updateAsync</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="tab-pane">
<h2 class="off-left">Methods</h2>
<div id="method_avg" class="method item">
<h3 class="name"><code>avg</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/IAverage.html" class="crosslink">IAverage</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l659"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:659</code></a>
</p>
</div>
<div class="description">
<p>Returns the average based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var average = 0;
try {
average = new Book().avg()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/IAverage.html" class="crosslink">IAverage</a></span>:
<p>IAverage to provide extra information based on which average will be calculated.</p>
</div>
</div>
</div>
<div id="method_count" class="method item">
<h3 class="name"><code>count</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/ICount.html" class="crosslink">ICount</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l685"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:685</code></a>
</p>
</div>
<div class="description">
<p>Returns the count of rows based on information provided.</p>
<pre class="code prettyprint"><code> Example:
var count = 0;
try {
count = new Book().count().
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ICount.html" class="crosslink">ICount</a></span>:
<p>ICount to provide extra information based on which count will be calculated.</p>
</div>
</div>
</div>
<div id="method_delete" class="method item">
<h3 class="name"><code>delete</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l626"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:626</code></a>
</p>
</div>
<div class="description">
<p>It deletes a record to any single table in a relational database.</p>
<p>Example:</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(beer_link));
try {
cBook.delete();
} catch(DatabaseException de) {
//Log it.
}
OR
try {
new Book().delete().execute();
} catch(DatabaseException de) {
//Log It.
}</code></pre>
</div>
</div>
<div id="method_getColumnNames" class="method item">
<h3 class="name"><code>getColumnNames</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1010"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1010</code></a>
</p>
</div>
<div class="description">
<p>Returns all column names of mapped table.</p>
<pre class="code prettyprint"><code> Example:
var columnNames = null;
try {
columnNames = new Book().getColumnNames();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
<p>All column names of mapped table.</p>
</div>
</div>
</div>
<div id="method_getColumnNamesAsync" class="method item">
<h3 class="name"><code>getColumnNamesAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1118"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1118</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all column names of mapped table.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getColumnNamesCallback = function Callback();
getColumnNamesCallback.onSuccess = function(columnNames) {
}
new Book().getColumnNamesAsync(getColumnNamesCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getColumnNamesAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getColumnTypes" class="method item">
<h3 class="name"><code>getColumnTypes</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Dictionary.html" class="crosslink">Dictionary</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1176"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1176</code></a>
</p>
</div>
<div class="description">
<p>Returns all columns with there data types for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var columnTypes = null;
try {
columnTypes = new Book().getColumnTypes();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Dictionary.html" class="crosslink">Dictionary</a></span>:
<p>All columns with there data types.</p>
</div>
</div>
</div>
<div id="method_getColumnTypesAsync" class="method item">
<h3 class="name"><code>getColumnTypesAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1290"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1290</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all columns with there data types for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getColumnTypesCallback = function Callback();
getColumnTypesCallback.onSuccess = function(columnNames) {
}
new Book().getColumnTypesAsync(getColumnTypesCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getColumnTypesAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getDatabaseDescriptor" class="method item">
<h3 class="name"><code>getDatabaseDescriptor</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/DatabaseDescriptor.html" class="crosslink">DatabaseDescriptor</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l2003"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:2003</code></a>
</p>
</div>
<div class="description">
<p>Returns database descriptor object based on the POJO class called.</p>
<pre class="code prettyprint"><code> Example:
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
} catch(DatabaseException databaseException) {
//Log It.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/DatabaseDescriptor.html" class="crosslink">DatabaseDescriptor</a></span>:
<p>Database Descriptor Object.</p>
</div>
</div>
</div>
<div id="method_getDatabaseDescriptorAsync" class="method item">
<h3 class="name"><code>getDatabaseDescriptorAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l2035"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:2035</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous database descriptor object based on the POJO class called.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function() {
var getDatabaseDescriptorCallback = new Callback();
getDatabaseDescriptorCallback.onSuccess = function(databaseDescriptor) {
}
new Lession().getDatabaseDescriptorAsync(getDatabaseDescriptorCallback, transaction);
}
callback.onSuccess = function() {
}
var databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
- Using Callback
var callback = new Callback();
callback.onSuccess = function(databaseDescriptor) {
}
new Book().getDatabaseDescriptorAsync(callback);</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getEntityDescriptor" class="method item">
<h3 class="name"><code>getEntityDescriptor</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/EntityDescriptor.html" class="crosslink">EntityDescriptor</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l2078"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:2078</code></a>
</p>
</div>
<div class="description">
<p>Returns the actual entity descriptor object mapped for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
EntityDescriptor entityDescriptor = null;
try {
entityDescriptor = new Book().getEntityDescriptor();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EntityDescriptor.html" class="crosslink">EntityDescriptor</a></span>:
<p>Entity Descriptor Object</p>
</div>
</div>
</div>
<div id="method_getEntityDescriptor" class="method item">
<h3 class="name"><code>getEntityDescriptor</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/EntityDescriptor.html" class="crosslink">EntityDescriptor</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l2111"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:2111</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous the actual entity descriptor object mapped for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function() {
var getEntityDescriptorCallback = new Callback();
getEntityDescriptorCallback.onSuccess = function(entityDescriptor) {
}
new Lession().getEntityDescriptorAsync(getEntityDescriptorCallback, transaction);
}
callback.onSuccess = function() {
}
var databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
- Using Callback
var callback = new Callback();
callback.onSuccess = function(entityDescriptor) {
}
new Book().getEntityDescriptorAsync(callback);</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/EntityDescriptor.html" class="crosslink">EntityDescriptor</a></span>:
<p>Entity Descriptor Object</p>
</div>
</div>
</div>
<div id="method_getForeignKeys" class="method item">
<h3 class="name"><code>getForeignKeys</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1836"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1836</code></a>
</p>
</div>
<div class="description">
<p>Returns all foreign keys of mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var foreignKeys = null;
try {
foreignKeys = new Book().getForeignKeys();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
<p>All foreign keys of mapped table.</p>
</div>
</div>
</div>
<div id="method_getForeignKeysAsync" class="method item">
<h3 class="name"><code>getForeignKeysAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1945"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1945</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all foreign keys of mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getForeignKeysCallback = function Callback();
getForeignKeysCallback.onSuccess = function(primaryKeys) {
}
new Book().getForeignKeysAsync(getForeignKeysCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getForeignKeysAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getMandatoryFields" class="method item">
<h3 class="name"><code>getMandatoryFields</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1512"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1512</code></a>
</p>
</div>
<div class="description">
<p>Returns all mandatory fields which are associated with mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var mandatoryFields = null;
try {
mandatoryFields = new Book().getMandatoryFields();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
<p>All mandatory fields for mapped table.</p>
</div>
</div>
</div>
<div id="method_getMandatoryFieldsAsync" class="method item">
<h3 class="name"><code>getMandatoryFieldsAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1620"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1620</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all mandatory fields which are associated with mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getMandatoryFieldsCallback = function Callback();
getMandatoryFieldsCallback.onSuccess = function(primaryKeys) {
}
new Book().getMandatoryFieldsAsync(getMandatoryFieldsCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getMandatoryFieldsAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getPrimaryKeys" class="method item">
<h3 class="name"><code>getPrimaryKeys</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1348"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1348</code></a>
</p>
</div>
<div class="description">
<p>Returns all primary keys of mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var primaryKeys = null;
try {
primaryKeys = new Book().getPrimeryKeys();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
<p>All primary keys.</p>
</div>
</div>
</div>
<div id="method_getPrimaryKeysAsync" class="method item">
<h3 class="name"><code>getPrimaryKeysAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1454"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1454</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all primary keys of mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getPrimaryKeysCallback = function Callback();
getPrimaryKeysCallback.onSuccess = function(primaryKeys) {
}
new Book().getPrimaryKeysAsync(getPrimaryKeysCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getPrimaryKeysAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getTableName" class="method item">
<h3 class="name"><code>getTableName</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l840"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:840</code></a>
</p>
</div>
<div class="description">
<p>Returns the mapped table name for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var tableName = null;
try {
tableName = new Book().getTableName();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
<p>Mapped Table name.</p>
</div>
</div>
</div>
<div id="method_getTableNameAsync" class="method item">
<h3 class="name"><code>getTableNameAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l953"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:953</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous the mapped table name for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getTableNameCallback = function Callback();
getTableNameCallback.onSuccess = function(tableName) {
}
new Book().getTableName(getTableNameCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getTableNameAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_getUniqueFields" class="method item">
<h3 class="name"><code>getUniqueFields</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1677"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1677</code></a>
</p>
</div>
<div class="description">
<p>Returns all unique fields which are associated with mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
var uniqueFields = null;
try {
uniqueFields = new Book().getUniqueFields();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
<p>All unique fields for mapped table.</p>
</div>
</div>
</div>
<div id="method_getUniqueFieldsAsync" class="method item">
<h3 class="name"><code>getUniqueFieldsAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l1777"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:1777</code></a>
</p>
</div>
<div class="description">
<p>Returns asynchronous all unique fields which are associated with mapped table for invoked class object.</p>
<pre class="code prettyprint"><code> Example:
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var getUniqueFieldsCallback = function Callback();
getUniqueFieldsCallback.onSuccess = function(primaryKeys) {
}
new Book().getUniqueFieldsAsync(getUniqueFieldsCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
DatabaseDescriptor databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(DatabaseException de) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function(tableName) {
}
try {
new Book().getUniqueFieldsAsync(callback);
} catch(e) {
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_groupConcat" class="method item">
<h3 class="name"><code>groupConcat</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/IGroupConcat.html" class="crosslink">IGroupConcat</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l814"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:814</code></a>
</p>
</div>
<div class="description">
<p>Returns the group concat based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var groupConcat = 0;
try {
groupConcat = new Book().groupConcat()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/IGroupConcat.html" class="crosslink">IGroupConcat</a></span>:
<p>IGroupConcat to provide extra information based on which group concat will be calculated.</p>
</div>
</div>
</div>
<div id="method_max" class="method item">
<h3 class="name"><code>max</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/IMax.html" class="crosslink">IMax</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l710"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:710</code></a>
</p>
</div>
<div class="description">
<p>Returns the minimum based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var maximum = 0;
try {
maximum = new Book().max()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/IMax.html" class="crosslink">IMax</a></span>:
<p>IMax to provide extra information based on which maximum will be calculated.</p>
</div>
</div>
</div>
<div id="method_min" class="method item">
<h3 class="name"><code>min</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/IMin.html" class="crosslink">IMin</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l736"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:736</code></a>
</p>
</div>
<div class="description">
<p>Returns the minimum based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var minimum = 0;
try {
minimum = new Book().min()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/IMin.html" class="crosslink">IMin</a></span>:
<p>IMin to provide extra information based on which minimum will be calculated.</p>
</div>
</div>
</div>
<div id="method_save" class="method item">
<h3 class="name"><code>save</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l89"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:89</code></a>
</p>
</div>
<div class="description">
<p>It adds a record to any single table in a relational database.</p>
<pre class="code prettyprint"><code> <pre>
</code></pre>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(c_link));
try {
cBook.save();
} catch(DatabaseException de) {
//Log it.
}
</pre></code></pre>
</div>
</div>
<div id="method_saveAsync" class="method item">
<h3 class="name"><code>saveAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l184"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:184</code></a>
</p>
</div>
<div class="description">
<p>It adds a record to any single table in a relational database asynchronous.</p>
<pre class="code prettyprint"><code> <pre>
</code></pre>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(beer_link));
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var saveCallback = new Callback();
saveCallback.onSuccess = function() {
}
cBook.saveAsync(saveCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
var databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(e) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
cBook.saveAsync(callback);
} catch(e) {
//Log it.
}
</pre></code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_saveOrUpdate" class="method item">
<h3 class="name"><code>saveOrUpdate</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l415"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:415</code></a>
</p>
</div>
<div class="description">
<p>It finds out whether tuple exists in table or not.
IF NOT EXISTS:
adds a record to any single table in a relational database.
ELSE:
updates a record to any single table in a relational database.</p>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(c_link));
try {
cBook.saveOrUpdate();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
</div>
<div id="method_saveOrUpdateAsync" class="method item">
<h3 class="name"><code>saveOrUpdateAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l508"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:508</code></a>
</p>
</div>
<div class="description">
<p>It finds out whether tuple exists in table or not.
IF NOT EXISTS:
adds a record to any single table in a relational database.
ELSE:
updates a record to any single table in a relational database.</p>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(c_link));
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var saveOrUpdateCallback = new Callback();
saveOrUpdateCallback.onSuccess = function() {
}
cBook.saveOrUpdateAsync(saveOrUpdateCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
var databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(e) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
cBook.saveOrUpdateAsync(callback);
} catch(e) {
//Log it.
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_select" class="method item">
<h3 class="name"><code>select</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/ISelect.html" class="crosslink">ISelect</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l581"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:581</code></a>
</p>
</div>
<div class="description">
<p>Fetch tuples from table.</p>
<pre class="code prettyprint"><code> Example:
var books = new Book().select()
.where(Book.TITLE).equalTo("C")
.and(Book.AUTHOR).equalTo("C Author")
.execute();</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ISelect.html" class="crosslink">ISelect</a></span>:
<p>ISelect to provide extra information based on which tuples will be fetched from table.</p>
</div>
</div>
</div>
<div id="method_sum" class="method item">
<h3 class="name"><code>sum</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/ISum.html" class="crosslink">ISum</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l762"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:762</code></a>
</p>
</div>
<div class="description">
<p>Returns the sum based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var sum = 0;
try {
sum = new Book().sum()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ISum.html" class="crosslink">ISum</a></span>:
<p>ISum to provide extra information based on which sum will be calculated.</p>
</div>
</div>
</div>
<div id="method_total" class="method item">
<h3 class="name"><code>total</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/ITotal.html" class="crosslink">ITotal</a></span>
</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l788"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:788</code></a>
</p>
</div>
<div class="description">
<p>Returns the total based on column name provided.</p>
<pre class="code prettyprint"><code> Example:
var total = 0;
try {
total = new Book().total()
.column(Book.COLUMN_NAME_WHICH_CONTAIN_NUMBRIC_VALUE)
.where(Book.TITLE).equalTo("C")
.execute();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/ITotal.html" class="crosslink">ITotal</a></span>:
<p>ITotal to provide extra information based on which total will be calculated.</p>
</div>
</div>
</div>
<div id="method_update" class="method item">
<h3 class="name"><code>update</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l256"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:256</code></a>
</p>
</div>
<div class="description">
<p>It updates a record to any single table in a relational database.</p>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(c_link));
try {
cBook.update();
} catch(DatabaseException de) {
//Log it.
}</code></pre>
</div>
</div>
<div id="method_updateAsync" class="method item">
<h3 class="name"><code>updateAsync</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>callback</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/_private_var_user_Documents_App_Hybrid_JavaScript_Siminov_Database_Database.js.html#l346"><code>/private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Database/Database.js:346</code></a>
</p>
</div>
<div class="description">
<p>It updates asynchronous a record to any single table in a relational database.</p>
<p>Example: Make Book Object</p>
<pre class="code prettyprint"><code>var cBook = new Book();
cBook.setTitle(Book.BOOK_TYPE_C);
cBook.setDescription(c_description));
cBook.setAuthor(c_author));
cBook.setLink(c_link));
- Using Transaction
var callback = new Callback();
callback.onExecute = function(transaction) {
var updateCallback = new Callback();
updateCallback.onSuccess = function() {
}
cBook.updateAsync(updateCallback, transaction);
}
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
var databaseDescriptor = new Book().getDatabaseDescriptor();
Database.beginTransactionAsync(databaseDescriptor, callback);
} catch(e) {
//Log it.
}
- Using Callback
var callback = new Callback();
callback.onSuccess = function() {
}
callback.onFailure = function() {
}
try {
cBook.updateAsync(callback);
} catch(e) {
//Log it.
}</code></pre>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">callback</code>
<span class="type">Callback</span>
<div class="param-description">
<p>Request Callback</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="../classes/Transaction.html" class="crosslink">Transaction</a></span>
<div class="param-description">
<p>Request Transaction</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/jquery/jquery-1.8.2.min.js"></script>
<script src="../assets/vendor/bootstrap/js/bootstrap.js"></script>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script src="../assets/js/yuidoc-bootstrap.js"></script>
<script>prettyPrint();</script>
</body>
</html>