2014-03-31 13:32:35 -04:00
<!DOCTYPE html> < html lang = "en" >
< head >
< meta http-equiv = "Content-Type" content = "text/html; charset=UTF-8" >
< meta name = "viewport" content = "width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;" >
< meta charset = "utf-8" >
< title > Query » \SQL_Interface< / title >
< meta name = "author" content = "Mike van Riel" >
< meta name = "description" content = "" >
< link href = "../css/template.css" rel = "stylesheet" media = "all" >
< script src = "../js/jquery-1.7.1.min.js" type = "text/javascript" > < / script > < script src = "../js/jquery-ui-1.8.2.custom.min.js" type = "text/javascript" > < / script > < script src = "../js/jquery.mousewheel.min.js" type = "text/javascript" > < / script > < script src = "../js/bootstrap.js" type = "text/javascript" > < / script > < script src = "../js/template.js" type = "text/javascript" > < / script > < script src = "../js/prettify/prettify.min.js" type = "text/javascript" > < / script > < link rel = "shortcut icon" href = "../img/favicon.ico" >
< link rel = "apple-touch-icon" href = "../img/apple-touch-icon.png" >
< link rel = "apple-touch-icon" sizes = "72x72" href = "../img/apple-touch-icon-72x72.png" >
< link rel = "apple-touch-icon" sizes = "114x114" href = "../img/apple-touch-icon-114x114.png" >
< / head >
< body >
< div class = "navbar navbar-fixed-top" >
< div class = "navbar-inner" > < div class = "container" >
< a class = "btn btn-navbar" data-toggle = "collapse" data-target = ".nav-collapse" > < span class = "icon-bar" > < / span > < span class = "icon-bar" > < / span > < span class = "icon-bar" > < / span > < / a > < a class = "brand" href = "../index.html" > Query< / a > < div class = "nav-collapse" > < ul class = "nav" >
< li class = "dropdown" >
< a href = "#api" class = "dropdown-toggle" data-toggle = "dropdown" >
API Documentation < b class = "caret" > < / b > < / a > < ul class = "dropdown-menu" >
< li > < a > Packages< / a > < / li >
< li > < a href = "../packages/Query.html" > < i class = "icon-folder-open" > < / i > < / a > < / li >
< / ul >
< / li >
< li class = "dropdown" id = "charts-menu" >
< a href = "#charts" class = "dropdown-toggle" data-toggle = "dropdown" >
Charts < b class = "caret" > < / b > < / a > < ul class = "dropdown-menu" > < li > < a href = "../graph_class.html" > < i class = "icon-list-alt" > < / i > < / a > < / li > < / ul >
< / li >
< li class = "dropdown" id = "reports-menu" >
< a href = "#reports" class = "dropdown-toggle" data-toggle = "dropdown" >
Reports < b class = "caret" > < / b > < / a > < ul class = "dropdown-menu" >
< li > < a href = "../errors.html" > < i class = "icon-remove-sign" > < / i >
< span class = "label label-info" > 0< / span > < / a > < / li >
< li > < a href = "../markers.html" > < i class = "icon-map-marker" > < / i >
< ul > < / ul > < / a > < / li >
< li > < a href = "../deprecated.html" > < i class = "icon-stop" > < / i >
< span class = "label label-info" > 0< / span > < / a > < / li >
< / ul >
< / li >
< / ul > < / div >
< / div > < / div >
< div class = "go_to_top" > < a href = "#___" style = "color: inherit" > Back to top < i class = "icon-upload icon-white" > < / i > < / a > < / div >
< / div >
< div id = "___" class = "container" >
< noscript > < div class = "alert alert-warning" >
Javascript is disabled; several features are only available
if Javascript is enabled.
< / div > < / noscript >
< div class = "row" >
< div class = "span4" >
< div class = "btn-toolbar" >
< div class = "btn-group visibility" data-toggle = "buttons-checkbox" >
< button class = "btn public active" title = "Show public elements" > Public< / button > < button class = "btn protected" title = "Show protected elements" > Protected< / button > < button class = "btn private" title = "Show private elements" > Private< / button > < button class = "btn inherited active" title = "Show inherited elements" > Inherited< / button >
< / div >
< div class = "btn-group view pull-right" data-toggle = "buttons-radio" >
< button class = "btn details" title = "Show descriptions and method names" > < i class = "icon-list" > < / i > < / button > < button class = "btn simple" title = "Show only method names" > < i class = "icon-align-justify" > < / i > < / button >
< / div >
< / div >
< ul class = "side-nav nav nav-list" > < li class = "nav-header" >
< i title = "Methods" class = "icon-custom icon-method" > < / i >
< ul >
< li class = "method public " > < a href = "#method_column_list" title = "column_list() :: Get information about the columns in the
specified table">< span class = "description" > Get information about the columns in the
specified table< / span > < pre > column_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_db_list" title = "db_list() :: Returns sql to list other databases" > < span class = "description" > Returns sql to list other databases< / span > < pre > db_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_explain" title = "explain() :: Modify the query to get the query plan" > < span class = "description" > Modify the query to get the query plan< / span > < pre > explain()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_function_list" title = "function_list() :: Return sql to list functions" > < span class = "description" > Return sql to list functions< / span > < pre > function_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_limit" title = "limit() :: Get database specific sql for limit clause" > < span class = "description" > Get database specific sql for limit clause< / span > < pre > limit()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_procedure_list" title = "procedure_list() :: Return sql to list stored procedures" > < span class = "description" > Return sql to list stored procedures< / span > < pre > procedure_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_random" title = "random() :: Get the sql for random ordering" > < span class = "description" > Get the sql for random ordering< / span > < pre > random()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_sequence_list" title = "sequence_list() :: Return sql to list sequences" > < span class = "description" > Return sql to list sequences< / span > < pre > sequence_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_system_table_list" title = "system_table_list() :: Returns sql to list system tables" > < span class = "description" > Returns sql to list system tables< / span > < pre > system_table_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_table_list" title = "table_list() :: Returns sql to list tables" > < span class = "description" > Returns sql to list tables< / span > < pre > table_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_trigger_list" title = "trigger_list() :: Returns sql to list triggers" > < span class = "description" > Returns sql to list triggers< / span > < pre > trigger_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_type_list" title = "type_list() :: Return sql to list database field types" > < span class = "description" > Return sql to list database field types< / span > < pre > type_list()< / pre > < / a > < / li >
< li class = "method public " > < a href = "#method_view_list" title = "view_list() :: Returns sql to list views" > < span class = "description" > Returns sql to list views< / span > < pre > view_list()< / pre > < / a > < / li >
< / ul >
< / li > < / ul >
< / div >
< div class = "span8" >
< a id = "\SQL_Interface" > < / a > < ul class = "breadcrumb" >
< li >
< a href = "../index.html" > < i title = "Classes" class = "icon-custom icon-class" > < / i > < / a > < span class = "divider" > \< / span >
< / li >
< li class = "active" >
< span class = "divider" > \< / span > < a href = "../classes/SQL_Interface.html" > SQL_Interface< / a >
< / li >
< / ul >
< div class = "element interface" >
< p class = "short_description" > parent for database manipulation subclasses< / p >
< div class = "details" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" >
< tr >
< th > package< / th >
2014-03-31 16:01:58 -04:00
< td > < a href = "../packages/Query.Drivers.html" > Query< / a > < / td >
2014-03-31 13:32:35 -04:00
< / tr >
< tr >
< th > subpackage< / th >
2014-03-31 16:01:58 -04:00
< td > Drivers< / td >
2014-03-31 13:32:35 -04:00
< / tr >
< / table >
< h3 >
< i title = "Methods" class = "icon-custom icon-method" > < / i > < / h3 >
< a id = "method_column_list" > < / a > < div class = "element clickable method public method_column_list" data-toggle = "collapse" data-target = ".method_column_list .collapse" title = "public" >
< h2 > Get information about the columns in the
specified table< / h2 >
< pre > column_list(string < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $table< / h4 >
< code > string< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_db_list" > < / a > < div class = "element clickable method public method_db_list" data-toggle = "collapse" data-target = ".method_db_list .collapse" title = "public" >
< h2 > Returns sql to list other databases< / h2 >
< pre > db_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_explain" > < / a > < div class = "element clickable method public method_explain" data-toggle = "collapse" data-target = ".method_explain .collapse" title = "public" >
< h2 > Modify the query to get the query plan< / h2 >
< pre > explain(string < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
< code > string< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_function_list" > < / a > < div class = "element clickable method public method_function_list" data-toggle = "collapse" data-target = ".method_function_list .collapse" title = "public" >
< h2 > Return sql to list functions< / h2 >
< pre > function_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > NULL< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_limit" > < / a > < div class = "element clickable method public method_limit" data-toggle = "collapse" data-target = ".method_limit .collapse" title = "public" >
< h2 > Get database specific sql for limit clause< / h2 >
< pre > limit(string < code > < / code > ) < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" > < tr >
< th > abstract< / th >
< td > < / td >
< / tr > < / table >
< h3 > Parameters< / h3 >
< div class = "subelement argument" >
< h4 > $sql< / h4 >
< code > string< / code >
< / div >
< div class = "subelement argument" >
< h4 > $limit< / h4 >
< code > int< / code >
< / div >
< div class = "subelement argument" >
< h4 > $offset< / h4 >
< code > int< / code >
< / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_procedure_list" > < / a > < div class = "element clickable method public method_procedure_list" data-toggle = "collapse" data-target = ".method_procedure_list .collapse" title = "public" >
< h2 > Return sql to list stored procedures< / h2 >
< pre > procedure_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_random" > < / a > < div class = "element clickable method public method_random" data-toggle = "collapse" data-target = ".method_random .collapse" title = "public" >
< h2 > Get the sql for random ordering< / h2 >
< pre > random() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< table class = "table table-bordered" > < tr >
< th > abstract< / th >
< td > < / td >
< / tr > < / table >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_sequence_list" > < / a > < div class = "element clickable method public method_sequence_list" data-toggle = "collapse" data-target = ".method_sequence_list .collapse" title = "public" >
< h2 > Return sql to list sequences< / h2 >
< pre > sequence_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_system_table_list" > < / a > < div class = "element clickable method public method_system_table_list" data-toggle = "collapse" data-target = ".method_system_table_list .collapse" title = "public" >
< h2 > Returns sql to list system tables< / h2 >
< pre > system_table_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_table_list" > < / a > < div class = "element clickable method public method_table_list" data-toggle = "collapse" data-target = ".method_table_list .collapse" title = "public" >
< h2 > Returns sql to list tables< / h2 >
< pre > table_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_trigger_list" > < / a > < div class = "element clickable method public method_trigger_list" data-toggle = "collapse" data-target = ".method_trigger_list .collapse" title = "public" >
< h2 > Returns sql to list triggers< / h2 >
< pre > trigger_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_type_list" > < / a > < div class = "element clickable method public method_type_list" data-toggle = "collapse" data-target = ".method_type_list .collapse" title = "public" >
< h2 > Return sql to list database field types< / h2 >
< pre > type_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > mixed< / code > < / div >
< / div > < / div >
< / div >
< a id = "method_view_list" > < / a > < div class = "element clickable method public method_view_list" data-toggle = "collapse" data-target = ".method_view_list .collapse" title = "public" >
< h2 > Returns sql to list views< / h2 >
< pre > view_list() < / pre >
< div class = "labels" > < / div >
< div class = "row collapse" > < div class = "detail-description" >
< div class = "long_description" > < / div >
< h3 > Returns< / h3 >
< div class = "subelement response" > < code > string< / code > < / div >
< / div > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div class = "row" > < footer class = "span12" >
Template is built using < a href = "http://twitter.github.com/bootstrap/" > Twitter Bootstrap 2< / a > and icons provided by < a href = "http://glyphicons.com/" > Glyphicons< / a > .< br >
Documentation is powered by < a href = "http://www.phpdoc.org/" > phpDocumentor 2.2.0
< / a > and< br >
2014-03-31 16:01:58 -04:00
generated on 2014-03-31T15:56:17-04:00.< br > < / footer > < / div >
2014-03-31 13:32:35 -04:00
< / div >
< / body >
< / html >
