Enum DataExecutionErrorCode
Stay organized with collections
Save and categorize content based on your preferences.
DataExecutionErrorCode
An enumeration of data execution error codes.
To call an enum, you call its parent class, name, and property. For example,
SpreadsheetApp.DataExecutionErrorCode.TIME_OUT
.
Properties
Property | Type | Description |
DATA_EXECUTION_ERROR_CODE_UNSUPPORTED | Enum | A data execution error code that is not supported in Apps Script. |
NONE | Enum | The data execution has no error. |
TIME_OUT | Enum | The data execution timed out. Please update the data source specification . |
TOO_MANY_ROWS | Enum | The data execution returns more rows than the limit. Please update the data source specification . |
TOO_MANY_COLUMNS | Enum | The data execution returns more columns than the limit. Please update the data source specification . |
TOO_MANY_CELLS | Enum | The data execution returns more cells than the limit. Please update the data source specification . |
ENGINE | Enum | Data execution engine error. Use DataExecutionStatus.getErrorMessage() for details. |
PARAMETER_INVALID | Enum | Invalid data execution parameter. The source cell must exist and contain only a number or text.
Please update the data source specification . |
UNSUPPORTED_DATA_TYPE | Enum | The data execution returns unsupported data type. Please update the data source specification .
For BigQuery, ARRAY or STRUCT type is not supported.
|
DUPLICATE_COLUMN_NAMES | Enum | The data execution returns duplicate column names. Please update the data source specification . |
INTERRUPTED | Enum | The data execution is interrupted. Please refresh later. |
OTHER | Enum | Other errors. |
TOO_MANY_CHARS_PER_CELL | Enum | The data execution returns values that exceed the maximum characters allowed in a single cell.
Please update the data source specification . |
DATA_NOT_FOUND | Enum | The database referenced by the data source is not found. Please update the data source specification . |
PERMISSION_DENIED | Enum | The user does not have access to the database referenced by the data source. Please update the
data source specification or contact the owner of the billing
project to request access. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eDataExecutionErrorCode\u003c/code\u003e is an enumeration of error codes that can occur during data execution in Google Apps Script.\u003c/p\u003e\n"],["\u003cp\u003eThese error codes provide information about the nature of the error, such as timeouts, exceeding data limits, or invalid parameters.\u003c/p\u003e\n"],["\u003cp\u003eMost errors can be addressed by updating the data source specification using \u003ccode\u003eDataSourceSpec\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eTo access a specific error code, use the syntax: \u003ccode\u003eSpreadsheetApp.DataExecutionErrorCode.ERROR_CODE\u003c/code\u003e, replacing \u003ccode\u003eERROR_CODE\u003c/code\u003e with the desired code (e.g., \u003ccode\u003eTIME_OUT\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eFor engine-specific or detailed error messages, refer to \u003ccode\u003eDataExecutionStatus.getErrorMessage()\u003c/code\u003e.\u003c/p\u003e\n"]]],["`DataExecutionErrorCode` enumerates errors during data execution. Errors include `TIME_OUT`, `TOO_MANY_ROWS/COLUMNS/CELLS`, `ENGINE` failure, `PARAMETER_INVALID`, `UNSUPPORTED_DATA_TYPE`, `DUPLICATE_COLUMN_NAMES`, `INTERRUPTED`, `OTHER`, `TOO_MANY_CHARS_PER_CELL`, `DATA_NOT_FOUND`, `PERMISSION_DENIED`, `NONE`, and `DATA_EXECUTION_ERROR_CODE_UNSUPPORTED`. To use an error code, use `SpreadsheetApp.DataExecutionErrorCode.ERROR_NAME`. Several errors suggest updating the data source specification. The `ENGINE` error uses `DataExecutionStatus.getErrorMessage()` for details.\n"],null,["# Enum DataExecutionErrorCode\n\nDataExecutionErrorCode\n\nAn enumeration of data execution error codes.\n\nTo call an enum, you call its parent class, name, and property. For example, `\nSpreadsheetApp.DataExecutionErrorCode.TIME_OUT`. \n\n### Properties\n\n| Property | Type | Description |\n|-----------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `DATA_EXECUTION_ERROR_CODE_UNSUPPORTED` | `Enum` | A data execution error code that is not supported in Apps Script. |\n| `NONE` | `Enum` | The data execution has no error. |\n| `TIME_OUT` | `Enum` | The data execution timed out. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `TOO_MANY_ROWS` | `Enum` | The data execution returns more rows than the limit. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `TOO_MANY_COLUMNS` | `Enum` | The data execution returns more columns than the limit. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `TOO_MANY_CELLS` | `Enum` | The data execution returns more cells than the limit. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `ENGINE` | `Enum` | Data execution engine error. Use [DataExecutionStatus.getErrorMessage()](/apps-script/reference/spreadsheet/data-execution-status#getErrorMessage()) for details. |\n| `PARAMETER_INVALID` | `Enum` | Invalid data execution parameter. The source cell must exist and contain only a number or text. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `UNSUPPORTED_DATA_TYPE` | `Enum` | The data execution returns unsupported data type. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). For BigQuery, `ARRAY` or `STRUCT` type is not supported. |\n| `DUPLICATE_COLUMN_NAMES` | `Enum` | The data execution returns duplicate column names. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `INTERRUPTED` | `Enum` | The data execution is interrupted. Please refresh later. |\n| `OTHER` | `Enum` | Other errors. |\n| `TOO_MANY_CHARS_PER_CELL` | `Enum` | The data execution returns values that exceed the maximum characters allowed in a single cell. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `DATA_NOT_FOUND` | `Enum` | The database referenced by the data source is not found. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)). |\n| `PERMISSION_DENIED` | `Enum` | The user does not have access to the database referenced by the data source. Please update the data source [specification](/apps-script/reference/spreadsheet/data-source#updateSpec(DataSourceSpec)) or contact the owner of the billing project to request access. |"]]