#1825: correctly document msilib.add_data.

This commit is contained in:
Georg Brandl 2008-02-23 22:55:18 +00:00
parent c12b9888f7
commit b0b0317ba2
1 changed files with 11 additions and 5 deletions

View File

@ -67,7 +67,7 @@ structures.
.. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer) .. function:: init_database(name, schema, ProductName, ProductCode, ProductVersion, Manufacturer)
Create and return a new database *name*, initialize it with *schema*, and set Create and return a new database *name*, initialize it with *schema*, and set
the properties *ProductName*, *ProductCode*, *ProductVersion*, and the properties *ProductName*, *ProductCode*, *ProductVersion*, and
*Manufacturer*. *Manufacturer*.
@ -79,11 +79,17 @@ structures.
function returns. function returns.
.. function:: add_data(database, records) .. function:: add_data(database, table, records)
Add all *records* to *database*. *records* should be a list of tuples, each one Add all *records* to the table named *table* in *database*.
containing all fields of a record according to the schema of the table. For
optional fields, ``None`` can be passed. The *table* argument must be one of the predefined tables in the MSI schema,
e.g. ``'Feature'``, ``'File'``, ``'Component'``, ``'Dialog'``, ``'Control'``,
etc.
*records* should be a list of tuples, each one containing all fields of a
record according to the schema of the table. For optional fields,
``None`` can be passed.
Field values can be int or long numbers, strings, or instances of the Binary Field values can be int or long numbers, strings, or instances of the Binary
class. class.