> For clean Markdown content of this page, append .md to this URL. For the complete documentation index, see https://learning.postman.com/llms.txt. For full content including API reference and SDK examples, see https://learning.postman.com/llms-full.txt. # Dataset commands This topic covers dataset commands for the [Postman CLI](/docs/postman-cli/postman-cli-overview/). [Datasets](/docs/tests-and-scripts/datasets/overview/) enable you to define reusable data sources and views for use in Postman workflows. You can use dataset commands to create and manage datasets, configure data sources, run SQL queries, and run saved views. In your CI/CD script, you can use the `--iteration-data-dataset`, `--iteration-data-view`, and `--dataset` options with the `postman collection run` command to run a collection with a dataset or a saved view. To learn more, see [Collection commands](/docs/postman-cli/postman-cli-collections). ## `postman dataset create` Creates a new dataset. ### Usage ```bash postman dataset create [options] ``` Path where the dataset file will be created. ### Options The dataset name. A description for the dataset. Unique identifier for the dataset. If not provided, a random v4 UUID is generated. Overwrites an existing dataset file. ### Examples ```bash postman dataset create ./postman/datasets/customers.dataset.yaml \ -n "Customer Data" ``` ## `postman dataset source` Dataset source commands enable you to manage the data sources associated with a dataset. ### `postman dataset source list` Lists the data sources configured for a dataset. #### Usage ```bash postman dataset source list [options] ``` Path to a dataset file. #### Options Displays results in JSON format. #### Examples ```bash postman dataset source list ./postman/datasets/customers.dataset.yaml ``` ### `postman dataset source add` Adds a data source to a dataset. #### Usage ```bash postman dataset source add [options] ``` Path to a dataset file. #### Options The data source name. Unique identifier for the data source. If not provided, a random v4 UUID is generated. Update the default format for the data source. Specifies the source type. If not provided, the type is inferred from `--file`. Path to a local CSV or JSON file to add as a source. If you specify a file, the data source type is set to `local`. References the source file without copying it into the dataset resources directory. Overwrites an existing file when copying a data source file. Database host name. Database port number. Database user name. Database password. Database name. Database table name. Slug for the data source. #### Examples ```bash postman dataset source add ./postman/datasets/customers.dataset.yaml \ --name customers \ --file customers.csv postman dataset source add ./postman/datasets/customers.dataset.yaml \ --name customers \ --file customers.csv \ --ref-only postman dataset source add ./postman/datasets/customers.dataset.yaml \ --name production-db \ --type postgresql \ --host db.example.com \ --port 5432 \ --database customers \ --table customer_records ``` ### `postman dataset source update` Updates an existing data source. Only the options you provide are updated. #### Usage ```bash postman dataset source update [options] ``` Path to a dataset file. The data source name or unique identifier. #### Options The `postman dataset source update` command supports the same options as `postman dataset source add` for updating the data source configuration. You can use this command to modify connection details for a database source or change the file path for a file-based source. #### Examples ```bash postman dataset source update ./postman/datasets/customers.dataset.yaml \ production-db \ --host new-db.example.com postman dataset source update ./postman/datasets/customers.dataset.yaml \ production-db \ --port 5433 ``` ### `postman dataset source remove` Removes a data source from a dataset. #### Usage ```bash postman dataset source remove [options] ``` Path to a dataset file. The data source name or unique identifier. #### Options Deletes the local file. #### Examples ```bash postman dataset source remove ./postman/datasets/customers.dataset.yaml customers postman dataset source remove ./postman/datasets/customers.dataset.yaml \ customers \ --purge-file ``` ## `postman dataset list` Lists datasets in a directory or displays summary information for a single dataset. ### Usage ```bash postman dataset list [options] ``` A path to a dataset file or a directory with one or more dataset files. ### Options Displays results in JSON format. ### Examples ```bash postman dataset list ./postman/datasets postman dataset list ./postman/datasets/customers.dataset.yaml ``` ## `postman dataset get` Displays metadata for a dataset. ### Usage ```bash postman dataset get [options] ``` Path to a dataset file. ### Options Displays results in JSON format. ### Examples ```bash postman dataset get ./postman/datasets/customers.dataset.yaml ``` ## `postman dataset query` Runs a SQL query against a dataset. ### Usage ```bash postman dataset query [options] ``` Path to a dataset file. ### Options The SQL query to run. Positional parameters for queries. You can specify multiple parameters by repeating this option. For example: `-p value1 -p value2`. Displays query results in JSON format. ### Examples ```bash postman dataset query ./postman/datasets/customers.dataset.yaml \ -q "SELECT * FROM customers LIMIT 10" postman dataset query ./postman/datasets/customers.dataset.yaml \ -q "SELECT * FROM customers WHERE status = ?" \ -p active ``` ## `postman dataset view` Dataset view commands enable you to create, manage, and run saved SQL queries. To learn more, see [Example dataset views in Postman](/docs/tests-and-scripts/datasets/example-dataset-views/). ### `postman dataset view list` Lists saved views in a dataset. #### Usage ```bash postman dataset view list [options] ``` Path to a dataset file. #### Options Displays results in JSON format. #### Examples ```bash postman dataset view list ./postman/datasets/customers.dataset.yaml ``` ### `postman dataset view create` Saves a view to a dataset. #### Usage ```bash postman dataset view create [options] ``` Path to a dataset file. #### Options The view name. The SQL query. Unique identifier for the view. If not provided, a random v4 UUID is generated. #### Examples ```bash postman dataset view create ./postman/datasets/customers.dataset.yaml \ -n "active-customers" \ -q "SELECT * FROM customers WHERE active = true" ``` ### `postman dataset view update` Updates a saved view. #### Usage ```bash postman dataset view update [options] ``` Path to a dataset file. The view name or unique identifier. #### Options The view name. The SQL query. #### Examples ```bash postman dataset view update ./postman/datasets/customers.dataset.yaml \ active-customers \ --name current-customers postman dataset view update ./postman/datasets/customers.dataset.yaml \ active-customers \ --query "SELECT * FROM customers WHERE status='active'" ``` ### `postman dataset view delete` Deletes a saved view from a dataset. #### Usage ```bash postman dataset view delete ``` Path to a dataset file. The view name or unique identifier. #### Examples ```bash postman dataset view delete ./postman/datasets/customers.dataset.yaml active-customers ``` ### `postman dataset view run` Runs a saved view against a dataset and displays the rows. #### Usage ```bash postman dataset view run [options] ``` Path to a dataset file. The view name or unique identifier. #### Options Positional parameters for queries. You can specify multiple parameters by repeating this option. For example: `-p value1 -p value2`. Displays query results in JSON format. #### Examples ```bash postman dataset view run ./postman/datasets/customers.dataset.yaml active-customers ``` ## `postman dataset delete` Deletes a dataset. ### Usage ```bash postman dataset delete [options] ``` Path to a dataset file. ### Options Skips the confirmation prompt. Deletes the dataset file but preserves the associated resources directory. ### Examples ```bash postman dataset delete ./postman/datasets/customers.dataset.yaml postman dataset delete ./postman/datasets/customers.dataset.yaml \ -y \ --keep-resources ```