> For the complete documentation index, see [llms.txt](https://docs.rootcause.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rootcause.ai/more-details/applications/application-modules/connectorread.md).

# Connector read

> Read a table or query through a bound connector without writing a dataset, cached for ttlS.

Reads a table or query through a bound connector without landing a dataset, caching for `ttlS` seconds.

The live-read counterpart of ConnectorImport: nothing is written to the workspace, so it is reactive and suits a dashboard that should show the warehouse as it is now. Set `table` or `query`; the handler rejects neither being set.

## At a glance

|                          |                           |
| ------------------------ | ------------------------- |
| Module type              | `ConnectorRead`           |
| Category                 | Primitives · Twins and IO |
| Default tier             | `reactive`                |
| Runs on                  | `reactive`, `durable`     |
| Starts a flow            | no                        |
| Holds a body             | no                        |
| Keeps state between runs | no                        |
| Available in             | every application type    |

## Parameters

### `credentialSlotId`

`string` · required · defaults to `""`

The slot holding the connector's credentials.

### `table`

`string | null` · required · defaults to `null`

The table to read; set this or `query`.

### `query`

`string | null` · required · defaults to `null`

The query to run; set this or `table`.

### `ttlS`

`number` · required · defaults to `300`

Seconds a read is cached for before the connector is asked again.

## Inputs

| Port     | Kind    | Required | Description                                                                                                                           |
| -------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `on`     | `event` | no       | Implicit on every module that does not itself start a flow: wire an event here to make this module the start of what that event runs. |
| `params` | `json`  | no       | Values for a parameterised query.                                                                                                     |

## Outputs

| Port     | Kind        | Connects to           | Description                                                                      |
| -------- | ----------- | --------------------- | -------------------------------------------------------------------------------- |
| `output` | `dataframe` | `dataframe`, `signal` | The rows read, or the cached rows when the previous read is younger than `ttlS`. |

***

[← All application modules](/more-details/applications/application-modules.md)