.. _auto_dataset_get_column_names:

*DATASET GET COLUMN NAMES*
==========================

Retrieves column names from a dataset, optionally filtering them by a search pattern (exact match, contains, starts/ends with, excludes, etc.). Use this worker to inspect or select column headers programmatically within a workflow, with optional token-splitting for multi-value column name matching.

When to use
-----------

Classification: **process**.

Tagged: ``column_filter``, ``column_names``, ``dataset``, ``header``, ``introspection``, ``search``, ``transformations``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Dataset
     - dataset_1
     - dataset
     - —
     - 
     - The input dataset whose column names are to be retrieved and optionally filtered; any tabular dataset type is accepted.
   * - Search Type
     - search_type
     - string
     - eq
     - 
     - Matching strategy applied to column names: 'eq' (exact), 'contains', 'starts_with', 'not_starts_with', 'ends_with', 'not_ends_with', or 'excludes'; defaults to 'eq'.
   * - Target
     - target_value
     - string
     - —
     - 
     - The string pattern to match against column names using the chosen search type; leave blank to return all column names without filtering.
   * - Split names and look for each token
     - split_names
     - scalar
     - no
     - 
     - When set to 'yes', splits the target value into individual tokens (using the split delimiter) and matches each token separately; defaults to 'no'.
   * - Split Delimiter
     - split_delimiter
     - string
     - ,
     - 
     - The delimiter character used to split the target value into tokens when split_names is 'yes'; defaults to comma (',').

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - dataset_get_column_names_output_1
     - dataset_get_column_names_output_1
     - scalar
     - A scalar (comma-separated or single) string containing the column name(s) from the input dataset that match the specified search criteria.

Disciplines
-----------

- data.dataset.transform

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=dataset_get_column_names <https://www.d3view.com/api/workflow/example?id=dataset_get_column_names>`_

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>transformation</code> schema. Worker id: <code>dataset_get_column_names</code>. Schema hash: <code>f660e794f3f8</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>