Skip to main content
Version: 8.1

system.dataset.toDataSet

This function is used in Python Scripting.

Description

This function is used to convert a PyDataset to a dataset. In addition it can also create new datasets from a raw Python list. When creating a new dataset, headers should have unique names. For more information on datasets and PyDatasets, see the Datasets page.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax - Convert PyDataset

system.dataset.toDataSet(dataset)

Parameters

TypeParameterDescription
PyDatasetdatasetA PyDataset object to convert.

Returns

Dataset - The newly created dataset.

Scope

Gateway, Vision Client, Perspective Session

Syntax - Create from list

system.dataset.toDataSet(headers, data)

Parameters

TypeParameterDescription
List[String]headersThe column names for the dataset to create.
List[Any]dataA list of rows for the new dataset. Each row must have the same length as the headers list, and each value in a column must be the same type.

Returns

Dataset - The newly created dataset.

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Code Snippet - Create a simple dataset
# This example create a single column dataset.
header = ['myColumn']
rows = [[1], [2]]
dataset = system.dataset.toDataSet(header, rows)
Code Snippet - Converting Database Query Results into a Dataset
# This second example shows how this function can be used to convert from a PyDataSet 
# (which is what system.db.runQuery returns) to a normal DataSet, which is the data type
# of a Table component's data property.

pyDataSet = system.db.runQuery("SELECT * FROM example1 LIMIT 100")
table = event.source.parent.getComponent("Table")
normalDataSet = system.dataset.toDataSet(pyDataSet)
table.data = normalDataSet

Keywords

system dataset toDataSet, dataset.toDataSet