/
rdebug_api.html
161 lines (152 loc) · 7.58 KB
/
rdebug_api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>rdebug_api: common_schema documentation</title>
<meta name="description" content="rdebug_api: common_schema" />
<meta name="keywords" content="rdebug_api: common_schema" />
<link rel="stylesheet" type="text/css" href="css/style.css" />
</head>
<body>
<div id="main">
<div id="header">
<h1>common_schema</h1> <strong>2.2</strong> documentation
<div class="subtitle">DBA's framework for MySQL</div>
</div>
<div id="contentwrapper">
<div id="content">
<h2><a href="rdebug_api.html">rdebug_api</a></h2>
<h3>rdebug API</h3>
<p>
<strong>rdebug</strong> provides a debugging API, via stored routine calls.
</p>
<p>
Essentially, one can debug her stored routines by directly invoking <i>rdebug</i>'s
functionality, or may use/write custom GUI tools to do that.
</p>
<p>
<i>rdebug</i> is in <strong>alpha</strong> stage, and API or functionality are
still subjected to change.
</p>
<a name="api"></a>
<h4>API</h4>
<p>
Initialization and attachment:
<ul>
<li><a href="rdebug_compile_routine.html">rdebug_compile_routine()</a>: Rebuild a routine with/without debugging info.</li>
<li><a href="rdebug_start.html">rdebug_start()</a>: Attach debugger to worker; begin a debugging session.</li>
<li><a href="rdebug_stop.html">rdebug_stop()</a>: Clear debugging session; reset debugging data.</li>
</ul>
Stepping/running/breakpoints:
<ul>
<li><a href="rdebug_run.html">rdebug_run()</a>: Run worker until next breakpoint.</li>
<li><a href="rdebug_set_breakpoint.html">rdebug_set_breakpoint()</a>: Set/clear a breakpoint</li>
<li><a href="rdebug_step_into.html">rdebug_step_into()</a>: Enter next routine call (requires routine in debug mode); drill down the stack state.</li>
<li><a href="rdebug_step_out.html">rdebug_step_out()</a>: Run current routine to completion, stop upon returning to calling routine.</li>
<li><a href="rdebug_step_over.html">rdebug_step_over()</a>: Execute next statement without drilling down to possible routine code.</li>
</ul>
Variable manipulation:
<ul>
<li><a href="rdebug_get_variable.html">rdebug_get_variable()</a>: Get value of local or user defined variable.</li>
<li><a href="rdebug_set_variable.html">rdebug_set_variable()</a>: Modify value of local or user defined variable.</li>
<li><a href="rdebug_watch_variables.html">rdebug_watch_variables()</a>: List user defined variables and local variables visible and used within current scope, with their current values.</li>
</ul>
Verbose, metadata:
<ul>
<li><a href="rdebug_set_verbose.html">rdebug_set_verbose()</a>: Turn verbose mode on/off</li>
<li><a href="rdebug_show_routine.html">rdebug_show_routine()</a>: Show a routine's code, along with the outline of breakpoint positions.</li>
<li><a href="rdebug_show_routine_statements.html">rdebug_show_routine_statements()</a>: Show statement (breakpoint) IDs for a given routine.</li>
<li><a href="rdebug_show_stack_state.html">rdebug_show_stack_state()</a>: Show worker's current stack state (applies to debugged routines only).</li>
<li><a href="rdebug_show_statement.html">rdebug_show_statement()</a>: Show next statement to be executed by worker</li>
<li><a href="rdebug_verbose.html">rdebug_verbose()</a>: Invoke dump of worker's status: stack, variables, statement</li>
</ul>
Views:
<ul>
<li><a href="debugged_routines.html">debugged_routines</a>: List routines with rdebug's debugging info.</li>
</ul>
</p>
<h3>SEE ALSO</h3>
<a href="query_script.html">Query Script</a>,
<a href="rdebug.html">rdebug</a>
<h3>AUTHOR</h3>
Shlomi Noach
<br/>
</div>
<div id="sidebarwrapper">
<div id="search">
Search online documentation
<form id="search_form" name="search_form" method="GET"
action="http://www.google.com/search"
onsubmit="document.forms['search_form']['q'].value = 'site:http://common-schema.googlecode.com/svn/trunk/common_schema/doc/html/ '+document.forms['search_form']['search_term'].value;">
<input type="text" name="search_term" value=""/>
<input type="hidden" name="q" value=""/>
<input type="submit" value="go"/>
</form>
</div>
<div id="menu">
<ul>
<li><a title="Introduction" href="introduction.html">Introduction</a></li>
<li><a title="Documentation" href="documentation.html">Documentation</a></li>
<li><a title="Download" href="download.html">Download</a></li>
<li><a title="Install" href="install.html">Install</a></li>
<li><a title="Risks" href="risks.html">Risks</a></li>
</ul>
<h3>QUERY SCRIPT</h3>
<ul>
<li><a title="QueryScript" href="query_script.html">QueryScript</a></li>
<li><a title="Execution" href="query_script_execution.html">Execution</a></li>
<li><a title="Flow control" href="query_script_flow_control.html">Flow control</a></li>
<li><a title="Statements" href="query_script_statements.html">Statements</a></li>
<li><a title="Expressions" href="query_script_expressions.html">Expressions</a></li>
<li><a title="Variables" href="query_script_variables.html">Variables</a></li>
</ul>
<h3>DEBUG</h3>
<ul>
<li><a title="rdebug" href="rdebug.html">rdebug</a></li>
<li><a title="rdebug API" href="rdebug_api.html">rdebug API</a></li>
<li><a title="rdebug workflow" href="rdebug_workflow.html">Workflow</a></li>
</ul>
<h3>ROUTINES</h3>
<ul>
<li><a title="Execution & flow control" href="execution_routines.html">Execution & flow control</a></li>
<li><a title="General" href="general_routines.html">General</a></li>
<li><a title="Process" href="process_routines.html">Process</a></li>
<li><a title="Query analysis" href="query_analysis_routines.html">Query analysis</a></li>
<li><a title="Schema analysis" href="schema_analysis_routines.html">Schema analysis</a></li>
<li><a title="Security" href="security_routines.html">Security</a></li>
<li><a title="Text" href="text_routines.html">Text</a></li>
<li><a title="Time & date" href="temporal_routines.html">Time & date</a></li>
<li><a title="Charting" href="charting_routines.html">Charting</a></li>
</ul>
<h3>VIEWS</h3>
<ul>
<li><a title="Schema analysis" href="schema_analysis_views.html">Schema analysis</a></li>
<li><a title="Data dimension" href="data_dimension_views.html">Data dimension</a></li>
<li><a title="Process" href="process_views.html">Process</a></li>
<li><a title="Security" href="security_views.html">Security</a></li>
<li><a title="Monitoring" href="monitoring_views.html">Monitoring</a></li>
<li><a title="InnoDB Plugin" href="innodb_plugin_views.html">InnoDB Plugin</a></li>
<li><a title="Percona server" href="percona_server_views.html">Percona Server</a></li>
<li><a title="TokuDB" href="tokudb_views.html">TokuDB</a></li>
</ul>
<h3>DATA</h3>
<ul>
<li><a title="tables" href="tables.html">Tables</a></li>
<li><a title="variables" href="variables.html">Variables</a></li>
</ul>
<h3>META</h3>
<ul>
<li><a title="Help" href="help.html">help</a></li>
<li><a title="Metadata" href="metadata.html">metadata</a></li>
<li><a title="status" href="status.html">status</a></li>
</ul>
</div>
</div>
<div class="clear"> </div>
<div id="footnote" align="center">
<a href="">common_schema</a> documentation
</div>
</div>
</div>
</body>
</html>