Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

added db._explain() convenience function

This commit is contained in:
Jan Steemann 2015-10-21 12:52:40 +02:00
parent f40cb79040
commit 3396214a63
5 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
js/apps/system/_admin/aardvark/APP/frontend/js/modules/org/arangodb/arango-database.js
View File

@ -827,6 +827,22 @@ ArangoDatabase.prototype._query = function (query, bindVars, cursorOptions, opti
return new ArangoStatement(this, data).execute();
};
////////////////////////////////////////////////////////////////////////////////
/// @brief explains a query
////////////////////////////////////////////////////////////////////////////////
ArangoDatabase.prototype._explain = function (query, bindVars, options) {
if (typeof query === 'object' && typeof query.toAQL === 'function') {
query = { query: query.toAQL() };
}
if (arguments.length > 1) {
query = { query: query, bindVars: bindVars, options: options };
}
require("org/arangodb/aql/explainer").explain(query);
};
// -----------------------------------------------------------------------------
// --SECTION-- database functions
// -----------------------------------------------------------------------------

1
js/apps/system/_admin/aardvark/APP/frontend/js/modules/org/arangodb/arangosh.js
View File

@ -129,6 +129,7 @@ exports.HELP = exports.createHelpHeadline("Help") +
'Examples: ' + "\n" +
' > db._collections() list all collections ' + "\n" +
' > db._query(<query>).toArray() execute an AQL query ' + "\n" +
' > db._explain(<query>) explain an AQL query ' + "\n" +
' > help show help pages ' + "\n" +
' > exit ' + "\n" +
'Note: collection names and statuses may be cached in arangosh. ' + "\n" +

16
js/client/modules/org/arangodb/arango-database.js
View File

@ -826,6 +826,22 @@ ArangoDatabase.prototype._query = function (query, bindVars, cursorOptions, opti
return new ArangoStatement(this, data).execute();
};
////////////////////////////////////////////////////////////////////////////////
/// @brief explains a query
////////////////////////////////////////////////////////////////////////////////
ArangoDatabase.prototype._explain = function (query, bindVars, options) {
if (typeof query === 'object' && typeof query.toAQL === 'function') {
query = { query: query.toAQL() };
}
if (arguments.length > 1) {
query = { query: query, bindVars: bindVars, options: options };
}
require("org/arangodb/aql/explainer").explain(query);
};
// -----------------------------------------------------------------------------
// --SECTION-- database functions
// -----------------------------------------------------------------------------

1
js/client/modules/org/arangodb/arangosh.js
View File

@ -128,6 +128,7 @@ exports.HELP = exports.createHelpHeadline("Help") +
'Examples: ' + "\n" +
' > db._collections() list all collections ' + "\n" +
' > db._query(<query>).toArray() execute an AQL query ' + "\n" +
' > db._explain(<query>) explain an AQL query ' + "\n" +
' > help show help pages ' + "\n" +
' > exit ' + "\n" +
'Note: collection names and statuses may be cached in arangosh. ' + "\n" +

16
js/server/modules/org/arangodb/arango-database.js
View File

@ -106,6 +106,22 @@ ArangoDatabase.prototype._query = function (query, bindVars, cursorOptions, opti
return new ArangoStatement(this, payload).execute();
};
////////////////////////////////////////////////////////////////////////////////
/// @brief explains a query
////////////////////////////////////////////////////////////////////////////////
ArangoDatabase.prototype._explain = function (query, bindVars, options) {
if (typeof query === 'object' && typeof query.toAQL === 'function') {
query = { query: query.toAQL() };
}
if (arguments.length > 1) {
query = { query: query, bindVars: bindVars, options: options };
}
require("org/arangodb/aql/explainer").explain(query);
};
// -----------------------------------------------------------------------------
// --SECTION-- transactions
// -----------------------------------------------------------------------------