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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:xse="http://wixtoolset.org/schemas/XmlSchemaExtension"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:wxs="http://wixtoolset.org/schemas/v4/wxs"
targetNamespace="http://wixtoolset.org/schemas/v4/wxs/sql"
xmlns="http://wixtoolset.org/schemas/v4/wxs/sql">
<xs:annotation>
<xs:documentation>
The source code schema for the WiX Toolset SQL Server Extension.
</xs:documentation>
</xs:annotation>
<xs:import namespace="http://wixtoolset.org/schemas/v4/wxs" />
<xs:element name="SqlDatabase">
<xs:annotation>
<xs:appinfo>
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Component" />
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Fragment" />
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Module" />
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Package" />
<xse:remarks>
Nesting SqlDatabase under a Component element will result in a SqlDatabase being installed to the machine as the package is installed.
Nesting SqlDatabase under Package, Fragment, or Module
results in a database "locator" record being created in
the SqlDatabase table. This means that the database
itself is neither installed nor uninstalled by the MSI
package. It does make the database available for referencing
from a SqlString or SqlScript record. This allows MSI to install
SqlScripts or SqlStrings to already existing databases on the machine.
The install will fail if the database does not exist in these cases.
The User attribute references credentials specified in a User element.
If a user is not specified then Windows Authentication will be used by default
using the credentials of the user performing the install to execute sql
strings, etc.
</xse:remarks>
<xse:seeAlso namespace="http://wixtoolset.org/schemas/v4/wxs/util" ref="User"/>
</xs:appinfo>
<xs:documentation>SQL Database</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:element ref="SqlFileSpec" />
<xs:element ref="SqlLogFileSpec" />
<xs:element ref="SqlScript"/>
<xs:element ref="SqlString"/>
<xs:any namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:attribute name="Id" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier in your installation package for this database. If an Id is not provided, one will generated for you.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Server" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Database server name.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Instance" type="xs:string">
<xs:annotation>
<xs:documentation>Optional database server instance.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Database" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name of the database. The value can be a literal value or derived from a
Property element using the [Formatted](https://learn.microsoft.com/en-us/windows/win32/msi/formatted)
syntax.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="User" type="xs:string">
<xs:annotation>
<xs:documentation>Optional user used to connect to database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="CreateOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Create the database during installation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="CreateOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>
Specifies whether to create the database when the associated component is reinstalled. Setting CreateOnInstall to yes does <html:b>not</html:b> imply CreateOnReinstall is set to yes. CreateOnReinstall must be set in addition to CreateOnInstall for it to be created during both install and reinstall.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="CreateOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Create the database during uninstallation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="DropOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Drop the database during installation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="DropOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>
Specifies whether to drop the database when the associated component is reinstalled. Setting DropOnInstall to yes does <html:b>not</html:b> imply DropOnReinstall is set to yes. DropOnReinstall must be set in addition to DropOnInstall for it to be dropped during both install and reinstall.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="DropOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Drop the database during uninstallation.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ContinueOnError" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Continue even if the database operation fails.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ConfirmOverwrite" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Prompt the user to overwrite the database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:anyAttribute>
</xs:complexType>
</xs:element>
<xs:element name="SqlFileSpec">
<xs:annotation>
<xs:documentation>File specification for a Sql database.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:any namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:attribute name="Id" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier in your installation package for this file specification. If an Id is not provided, one will generated for you.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Name" type="xs:string">
<xs:annotation>
<xs:documentation>Specifies the logical name for the database file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Filename" use="required" type="xs:string">
<xs:annotation>
<xs:documentation>Specifies the operating-system file name for the database file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Size" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the size of the database file. The GB, MB and KB suffixes can be used to specify gigabytes,
megabytes or kilobytes. The default is megabytes if no suffix is specified. When a Size is not
supplied for a database file, SQL Server uses the size of the primary file in the model database.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MaxSize" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the maximum size to which the database file can grow. The GB, MB and KB suffixes can be used to
to specify gigabytes, megabytes or kilobytes. The default is megabytes if no suffix is specified. If
MaxSize is not specified, the file will grow until the disk is full.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="GrowthSize" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the growth increment of the database file. The GB, MB and KB and % suffixes can be used to
specify gigabytes, megabytes, kilobytes or a percentage of the current file size to grow. The default is
megabytes if no suffix is specified. The default value is 10% if GrowthSize is not specified, and the
minimum value is 64 KB. The GrowthSize setting for a file cannot exceed the MaxSize setting.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:anyAttribute>
</xs:complexType>
</xs:element>
<xs:element name="SqlLogFileSpec">
<xs:annotation>
<xs:documentation>File specification for a Sql database.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:any namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:attribute name="Id" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier in your installation package for this log file specification. If an Id is not provided, one will generated for you.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Name" type="xs:string">
<xs:annotation>
<xs:documentation>Specifies the logical name for the log file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Filename" type="xs:string">
<xs:annotation>
<xs:documentation>Specifies the operating-system file name for the log file.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Size" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the size of the log file. The GB, MB and KB suffixes can be used to specify gigabytes,
megabytes or kilobytes. The default is megabytes if no suffix is specified. When a Size is not
supplied for a log file, SQL Server makes the file 1 MB.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="MaxSize" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the maximum size to which the log file can grow. The GB, MB and KB suffixes can be used to
to specify gigabytes, megabytes or kilobytes. The default is megabytes if no suffix is specified. If
MaxSize is not specified, the file will grow until the disk is full.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="GrowthSize" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the growth increment of the log file. The GB, MB and KB and % suffixes can be used to
specify gigabytes, megabytes, kilobytes or a percentage of the current file size to grow. The default is
megabytes if no suffix is specified. The default value is 10% if GrowthSize is not specified, and the
minimum value is 64 KB. The GrowthSize setting for a file cannot exceed the MaxSize setting.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:anyAttribute>
</xs:complexType>
</xs:element>
<xs:element name="SqlScript">
<xs:annotation>
<xs:appinfo>
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Component" />
</xs:appinfo>
<xs:documentation>SQL Script</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:any namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:attribute name="Id" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier in your installation package for this sql script. If an Id is not provided, one will generated for you.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SqlDb" type="xs:string">
<xs:annotation>
<xs:documentation>Id of the SqlDatabase to execute the script against. Required when not child of SqlDatabase.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="User" type="xs:string">
<xs:annotation>
<xs:documentation>Optional user used to connect to database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="BinaryRef" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Reference to Binary stream that contains the SQL script to execute.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies to execute the script when the associated component is installed. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the script when the associated component is reinstalled. Setting ExecuteOnInstall to yes does <html:b>not</html:b> imply ExecuteOnReinstall is set to yes. ExecuteOnReinstall must be set in addition to ExecuteOnInstall for it to be executed during both install and reinstall. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies to execute the script when the associated component is uninstalled. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the script on rollback if an attempt is made to install the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the script on rollback if an attempt is made to reinstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the script on rollback if an attempt is made to uninstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ContinueOnError" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Continue executing scripts even if this one fails.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Sequence" type="wxs:Integer">
<xs:annotation>
<xs:documentation>Specifes the order to run the SQL Scripts. It is recommended that rollback scripts be scheduled before their complementary execution script. This order is also relative across the SqlString element.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:anyAttribute>
</xs:complexType>
</xs:element>
<xs:element name="SqlString">
<xs:annotation>
<xs:appinfo>
<xse:parent namespace="http://wixtoolset.org/schemas/v4/wxs" ref="Component" />
</xs:appinfo>
<xs:documentation>SQL String</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:choice minOccurs="0" maxOccurs="unbounded">
<xs:any namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
elements at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:any>
</xs:choice>
<xs:attribute name="Id" type="xs:string">
<xs:annotation>
<xs:documentation>Unique identifier in your installation package for this sql command. If an Id is not provided, one will generated for you.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SqlDb" type="xs:string">
<xs:annotation>
<xs:documentation>Id of the SqlDatabase to execute the script against. Required when not child of SqlDatabase.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="User" type="xs:string">
<xs:annotation>
<xs:documentation>Optional user used to connect to database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="SQL" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>SQL command to execute against the database.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies to execute the string when the associated component is installed. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the string when the associated component is reinstalled. Setting ExecuteOnInstall to yes does <html:b>not</html:b> imply ExecuteOnReinstall is set to yes. ExecuteOnReinstall must be set in addition to ExecuteOnInstall for it to be executed during both install and reinstall. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ExecuteOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies to execute the string when the associated component is uninstalled. This attribute is mutually exclusive with the RollbackOnInstall, RollbackOnReinstall and RollbackOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnInstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the string on rollback if an attempt is made to install the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnReinstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the string on rollback if an attempt is made to reinstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="RollbackOnUninstall" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Specifies whether to execute the string on rollback if an attempt is made to uninstall the associated component. This attribute is mutually exclusive with the ExecuteOnInstall, ExecuteOnReinstall and ExecuteOnUninstall attributes.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ContinueOnError" type="wxs:YesNoTypeUnion">
<xs:annotation>
<xs:documentation>Continue executing strings even if this one fails.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="Sequence" type="wxs:Integer">
<xs:annotation>
<xs:documentation>Specifes the order to run the SQL Strings. It is recommended that rollback strings be scheduled before their complementary execution string. This order is also relative across the SqlScript element.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:anyAttribute namespace="##other" processContents="lax">
<xs:annotation>
<xs:documentation>
Extensibility point in the WiX XML Schema. Schema extensions can register additional
attributes at this point in the schema.
</xs:documentation>
</xs:annotation>
</xs:anyAttribute>
</xs:complexType>
</xs:element>
</xs:schema>
|
