4.41. index
Creates an index for the specified table.
4.41.1. Summary
[index table other_named_attributes]
| Parameters | Description | Default |
| base | Alias for table | DEFAULT_VALUE |
| basefile | Database filename. Exports the table to this filename if old or missing before indexing. See also the export tag for additional relevant attributes such as delimiter type, etc. | DEFAULT_VALUE |
| col | alias for fields | DEFAULT_VALUE |
| columns | alias for fields | DEFAULT_VALUE |
| database | Alias for table | DEFAULT_VALUE |
| export_only | Just do the export if necessary (not the index). | DEFAULT_VALUE |
| extension | Index file extension (default "idx") | DEFAULT_VALUE |
| fields | field(s) to index | DEFAULT_VALUE |
| fn | alias for fields | DEFAULT_VALUE |
| show_status | Return '1' to the page if successful | DEFAULT_VALUE |
| spec | The index specification | DEFAULT_VALUE |
| table | DEFAULT_VALUE |
| Attributes | Default |
| interpolate (reparse) | No |
| Other_Characteristics | |
| Invalidates cache | YES |
| Container tag | No |
| Has Subtags | No |
| Nests | Yes |
Tag expansion example:
[index table]
---
TODO: (tag result)
ASP-like Perl call:
$Tag->index( { table => VALUE_table
}, $body );
or similarly with positional parameters,
$Tag->index(table, $attribute_hash_reference, $body);
4.41.2. Description
Creates an index for the specified table.
4.41.2.1. basefile
Database filename. Exports the table to this filename if old or missing before indexing. See also the export tag for additional relevant attributes such as delimiter type, etc.
4.41.2.2. col
alias for fields
4.41.2.3. columns
alias for fields
4.41.2.4. export_only
Just do the export if necessary (not the index).
4.41.2.5. extension
Index file extension (default "idx")
4.41.2.6. fields
field(s) to index
4.41.2.7. fn
alias for fields
4.41.2.8. show_status
Return '1' to the page if successful
4.41.2.9. spec
The index specification