> For the complete documentation index, see [llms.txt](https://docs.redivis.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform.md).

# Transform

## *class* <mark style="color:purple;">Transform</mark>

Transforms are a series of data processing steps within a [workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow.md), defined in SQL, which produce an output table. Various methods allow you to create, update, run, and delete transforms, and to reference their source and output tables.

## Constructors

| Method                                                                                                                                                 | Description                                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**`redivis.transform`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/redivis/redivis.transform.md)(\[name, options])           | Return a Transform within the [default workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference.md#environment-variables), or given its fully qualified reference (`owner.workflow.transform`). |
| [**`Workflow.transform`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow/workflow.transform.md)(\[name])                 | Return a Transform within a specific [workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow.md).                                                                                    |
| [**`Workflow.listTransforms`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow/workflow.listtransforms.md)(\[maxResults]) | List the Transforms of a workflow.                                                                                                                                                                                  |

## Examples

```javascript
const workflow = redivis.workflow('jane.my_workflow');

// Create a transform, whose name is generated
const transform = await workflow.transform().create({
  sourceTable: workflow.table('iris'),
  query: 'SELECT * FROM _source_ WHERE SepalLengthCm > 5',
});

// Run the transform, waiting for it to finish
await transform.run();

const outputTable = await transform.outputTable();
const rows = await outputTable.toRowsArray();

// Update an existing transform
await workflow.transform('my_transform').update({ query: 'SELECT * FROM _source_ LIMIT 100' });

// Delete a transform, along with its output table
await workflow.transform('my_transform').delete();
```

## Attributes

| Name                     | Description                                                                                                                                                                                                                           |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`name`**               | The transform's name.                                                                                                                                                                                                                 |
| **`workflow`**           | The [Workflow](https://docs.redivis.com/api/client-libraries/redivis-js/reference/workflow.md) that the transform belongs to.                                                                                                         |
| **`properties`**         | An object containing the [API resource representation of the transform](https://docs.redivis.com/api/resource-definitions/transform.md). This will only be populated after certain methods are called, particularly the `get` method. |
| **`qualifiedReference`** | The [fully qualified reference](https://docs.redivis.com/api/referencing-resources.md) to the transform.                                                                                                                              |
| **`scopedReference`**    | The canonical reference for the transform, without its workflow.                                                                                                                                                                      |

## Methods

| Method                                                                                                                                           | Description                                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| [**`Transform.cancel`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.cancel.md)()                     | Cancel the transform's current run.                                                                                              |
| [**`Transform.create`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.create.md)(options)              | Create the transform.                                                                                                            |
| [**`Transform.delete`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.delete.md)()                     | Delete the transform and its output table.                                                                                       |
| [**`Transform.exists`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.exists.md)()                     | Check whether the transform exists.                                                                                              |
| [**`Transform.get`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.get.md)()                           | Fetch the transform's metadata, populating `transform.properties`.                                                               |
| [**`Transform.outputTable`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.outputtable.md)()           | Return the transform's output [Table](https://docs.redivis.com/api/client-libraries/redivis-js/reference/table.md).              |
| [**`Transform.referencedTables`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.referencedtables.md)() | Return every [Table](https://docs.redivis.com/api/client-libraries/redivis-js/reference/table.md) that the transform references. |
| [**`Transform.run`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.run.md)(\[options])                 | Run the transform.                                                                                                               |
| [**`Transform.sourceTable`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.sourcetable.md)()           | Return the transform's source [Table](https://docs.redivis.com/api/client-libraries/redivis-js/reference/table.md).              |
| [**`Transform.update`**](https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform/transform.update.md)(options)              | Update the transform's name, source table, or query.                                                                             |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.redivis.com/api/client-libraries/redivis-js/reference/transform.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
