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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
|
<refentry id="vc_isql">
<refmeta>
<refentrytitle>isql</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>isql</refname>
<refpurpose>An interactive SQL control that allows the user to type an SQL statement and to see the result of its execution.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="vc_syn_isql">
<funcprototype id="vc_proto_isql">
<funcdef>
<<function>isql</function> <attribute>
<parameter>name</parameter> (required) </attribute>
<attribute>
<parameter>annotation</parameter> (optional) </attribute>
<attribute>
<parameter>initial-enable</parameter> (optional) </attribute>
<attribute>
<parameter>enabled</parameter> (optional) </attribute>
<attribute>
<parameter>instantiate</parameter> (optional) </attribute>
<attribute>
<parameter>control-udt</parameter> (optional) </attribute>
<attribute>
<parameter>xsd-stub-xhtml</parameter> (optional) </attribute>
<attribute>
<parameter>width</parameter> (optional) </attribute>
<attribute>
<parameter>height</parameter> (optional) </attribute>
<attribute>
<parameter>isolation</parameter> (optional) </attribute>
<attribute>
<parameter>timeout</parameter> (optional) </attribute>
<attribute>
<parameter>maxrows</parameter> (optional) </attribute>
<attribute>
<parameter>user</parameter> (optional) </attribute>
<attribute>
<parameter>password</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcfile</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcline</parameter> (optional) </attribute>
<attribute>
<parameter>debug-log</parameter> (optional) </attribute>
/></funcdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="vc_desc_isql">
<title>Description</title>
</refsect1>
<refsect1 id="vc_attrs_isql">
<title>Attributes</title>
<formalpara>
<title>name = <link linkend="vc_type_SqlName">SqlName</link>
</title>
<para>A page level unique name identifying a control.</para>
</formalpara>
<formalpara>
<title>annotation</title>
<para>A human readable comment.</para>
</formalpara>
<formalpara>
<title>initial-enable = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control is initially visible. True by default. Could be data-bound to an SQL expression.</para>
</formalpara>
<formalpara>
<title>enabled = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control is visible. True by default. Could be data-bound to an SQL expression.</para>
</formalpara>
<formalpara>
<title>instantiate = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Determines whether a control instantiate its children. It is true by default. It could be data-bound to an SQL expression. Unlike most of calcucateable attributes, the value of this attribute for a control is calcluated before calling 'on-init' event handler of the control; other values are calculated before calling 'before-data-bind' event handler.</para>
</formalpara>
<formalpara>
<title>control-udt = <link linkend="vc_type_SqlName">SqlName</link>
</title>
<para>At run time every control is represented as an instance of some user-defined type (UDT). VSPX compiles selects the UDT to use depending on name of the XML element that represents the control and maybe some of its attributes. In some specific cases the application developer may instruct VSPX compiler to use some other UDT, e.g. an application-specific UDT that is derived from the preset one. If specified, the value of 'control-udt' attribute should be equal to the name of the desired target UDT.</para>
</formalpara>
<formalpara>
<title>xsd-stub-xhtml</title>
<para>This attribute is for internal use only. It has no effect if added to the source VSPX file.</para>
</formalpara>
<formalpara>
<title>width</title>
<para>Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited.
The value of this attribute will not be used when the resulting HTML is rendered.</para>
</formalpara>
<formalpara>
<title>height</title>
<para>Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited.
The value of this attribute will not be used when the resulting HTML is rendered.</para>
</formalpara>
<formalpara>
<title>isolation</title>
<para>Transaction isolation level to be used.</para>
<table>
<title>Allowed values of the 'isolation' attribute</title>
<tgroup cols="2">
<tbody>
<row>
<entry>uncomitted</entry>
<entry>
<para>'uncomitted' transaction isolation level</para>
</entry>
</row>
<row>
<entry>committed</entry>
<entry>
<para>'committed' transaction isolation level</para>
</entry>
</row>
<row>
<entry>repeatable</entry>
<entry>
<para>'repeatable' transaction isolation level</para>
</entry>
</row>
<row>
<entry>serializable</entry>
<entry>
<para>'serializable' transaction isolation level</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</formalpara>
<formalpara>
<title>timeout = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Query time-out in seconds (currently not supported)</para>
</formalpara>
<formalpara>
<title>maxrows = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>Maximum number of rows to be displayed.</para>
</formalpara>
<formalpara>
<title>user = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>SQL user account to perform the query, if not specified
the SQL account used to run the VSPX page will be used.
</para>
</formalpara>
<formalpara>
<title>password = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>When the 'user' attribute is supplied, this is
the user's password.
</para>
</formalpara>
<formalpara>
<title>debug-srcfile</title>
<para>URI of the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-srcline</title>
<para>Line number in the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-log</title>
<para>This defines what sort of data are saved to the debugging log.
</para>
</formalpara>
</refsect1>
<refsect1 id="vc_udt_isql">
<title>Declaration of type vspx_isql</title>
<para>
A isql control
</para>
<screen>
create type vspx_isql under vspx_form
as
(
-- parameters
isql_custom_exec integer default 0, -- do nothing to allow vspx code to perform actual exec (i.e. dataset open)
isql_explain integer default 0, -- explain instead of execute
isql_maxrows integer default 20,
isql_chunked integer default 0,
isql_current_stmt varchar default null,
isql_current_state any default null,
isql_current_meta any default null,
isql_current_pos int default 0,
isql_current_row int default 0,
isql_rows_fetched int default 0,
isql_user varchar default null,
isql_password varchar default null,
isql_isolation varchar default 'committed',
isql_timeout integer default 60,
isql_text varchar default '', -- sql text to execute
--results
--also used vc_error_message as vector(vector('sqlstate','sqlmessage'), ... ) for multiple statements
isql_mtd any default null, --as vector(mtd, ... ) for multiple statements
isql_res any default null, --as vector(res, ... ) for multiple statements
isql_stmts any default null -- array of statements to be executed on render as cursors
)
temporary self as ref
constructor method vspx_isql (name varchar, parent vspx_control),
method isql_exec () returns any
</screen>
</refsect1>
</refentry>
|
