DataSourceColumn

Access and modify a data source column.


**Only use this class with data that's connected to a database.**

### Methods

| Method | Return type | Brief description |
|---|---|---|
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#getDataSource()` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source` | Gets the data source associated with the data source column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#getFormula()` | `String` | Gets the formula for the data source column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#getName()` | `String` | Gets the name for the data source column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#hasArrayDependency()` | `Boolean` | Returns whether the column has an array dependency. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#isCalculatedColumn()` | `Boolean` | Returns whether the column is a calculated column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#remove()` | `void` | Removes the data source column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#setFormula(String)` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#` | Sets the formula for the data source column. |
| `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#setName(String)` | `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#` | Sets the name of the data source column. |

## Detailed documentation

### `getDataSource()`

Gets the data source associated with the data source column.

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source` --- The data source.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `getFormula()`

Gets the formula for the data source column. Returns an empty string if the data source column
is not a `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#isCalculatedColumn()`.

#### Return


`String` --- The formula.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `getName()`

Gets the name for the data source column.

#### Return


`String` --- The column name.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `hasArrayDependency()`

Returns whether the column has an array dependency.

#### Return


`Boolean` --- `true` if the column has an array dependency, or `false` otherwise.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `isCalculatedColumn()`

Returns whether the column is a calculated column.

#### Return


`Boolean` --- `true` if the column is a calculated column, or `false` otherwise.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `remove()`

Removes the data source column.

Only supported for `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#isCalculatedColumn()`.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `setFormula(formula)`

Sets the formula for the data source column.

Only supported for `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#isCalculatedColumn()`.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `formula` | `String` | The new formula. |

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#` --- The data source column, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`

*** ** * ** ***

### `setName(name)`

Sets the name of the data source column.

Only supported for `https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#isCalculatedColumn()`.

#### Parameters

| Name | Type | Description |
|---|---|---|
| `name` | `String` | The name to set. |

#### Return


`https://developers.google.com/apps-script/reference/spreadsheet/data-source-column#` --- The data source column, for chaining.

#### Authorization

Scripts that use this method require authorization with one or more of the following [scopes](https://developers.google.com/apps-script/concepts/scopes#setting_explicit_scopes):

- `https://www.googleapis.com/auth/spreadsheets.currentonly`
- `https://www.googleapis.com/auth/spreadsheets`