This function is used in Python Scripting.

Description

Takes a dataset and returns a new dataset with all of the same column names and types, but no rows.

Note: Datasets are immutable, which means they cannot be directly modified once created. Instead, this scripting function returns a new dataset with some modification applied, which must be assigned to a variable to be used. See Altering a Dataset.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.dataset.clearDataset(dataset)

  • Parameters

Dataset dataset - The starting dataset.

  • Returns

Dataset - A new dataset with no rows.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code Snippet
# This example pulls in the dataset from a Vision Table component, clears it, then writes the empty dataset back to the table.

data = event.source.parent.getComponent('Table').data
event.source.parent.getComponent('Table').data = system.dataset.clearDataset(data)
Keywords

system dataset clearDataset, dataset.clearDataset